全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

获取指标接口

最近更新时间:2024-04-28 19:03:10

获取监控指标

1.接口描述

2.输入参数

3.输出参数

4.示例

1.接口描述

域名:monitor.api.ksyun.com

VPC内调用域名:monitor.internal.api.ksyun.com

接口名: ListMetrics

查询实例的监控指标。查询到对应的名字空间下对应实例的监控指标类型,容器引擎产品见容器引擎获取指标接口

用户单位时间内调动单API次数,除特殊机房外其他机房每分钟最多3600次请求。

用户获取监控数据返回值,单次最多返回60000条数据。

2.输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见公共请求参数页面。
其中此接口的Action字段为ListMetrics。

参数名称

必选

类型

描述

Namespace

String

表示一类云产品,指定命名空间。

InstanceID

String

监控实例的ID

备注:MongoDB产品,请在相应监控实例ID前添加user前缀

MetricName

String

监控项名称,传入该参数将返回对应监控项的详细信息。

PageIndex

Interger

返回列表的分页索引

PageSize

Interger

返回列表显示的对象数量

3.输出参数

参数名称

类型

描述

Metrics

Array

监控指标的集合

RequestId

String

请求ID

Metrics的内容:

参数名称

类型

描述

InstanceId

String

监控实例的ID

Interval

String

监控周期

MetricName

String

指标名称

Namespace

String

云产品类型

Type

String

数值类型,Integer/Float

Unit

String

指标单位

4.示例

输入

https://monitor.${region}.api.ksyun.com?
Action=ListMetrics
&Version=2010-05-25
&InstanceID=instanceId
&Namespace=KEC
&PageIndex=1
&PageSize=1
&公共参数

${region}可替换相应区域,详见region说明

输出

<ListMetricsResponse xmlns="https://ksyun.kingeyes.com/">
    <ListMetricsResult>
        <Metrics>
            <member>
                <InstanceId>instanceId</InstanceId>
                <Interval>60</Interval>
                <MetricName>cpu.utilizition.total</MetricName>
                <Namespace>KEC</Namespace>
                <Type>Float</Type>
                <Unit>%</Unit>
            </member>
        </Metrics>
    </ListMetricsResult>
    <ResponseMetadata>
        <RequestId>b46a778c-d73e-4b24-a478-0f448218ddb6</RequestId>
    </ResponseMetadata>
</ListMetricsResponse>

文档导读
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈