获取指标接口-文档中心-金山云

云监控

查看更多结果

未找到含当前关键字的文档标题

页面目录

全部展开全部收起

产品更新动态

未找到含该关键词的产品

文档中心

云监控

API参考

云服务监控

获取指标接口

最近更新时间：2025-07-03 17:03:49



调用 ListMetrics 接口，查询对应云产品资源监控项（容器产品除外，具体可参考：容器引擎获取指标接口）。

1.接口描述

接口名：ListMetrics

请求方式：GET

请求域名：monitor.api.ksyun.com

VPC内域名：monitor.internal.api.ksyun.com

接口调用限制说明：

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

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

2.接口调试

荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

3.输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ListMetrics。
Version	是	String	公共参数，本接口取值：2010-05-25。
Namespace	是	String	表示一类云产品，指定命名空间。命名空间可参考示例值：KEC
InstanceID	是	String	指定实例ID。 Tips：部分产品线指定实例ID时，需额外进行调整，具体如下： MongoDB：实例ID前需添加 `user`前缀。示例： KS3：实例ID前添加buckname。示例：686ce5e2-XXX-XXX-XXX-a221e4922862
MetricName	否	String	指定查询监控项。 Tips: 传入该参数将返回对应监控项的详细信息。
PageIndex	是	Interger	页号，起始值：1 示例值：1
PageSize	否	Interger	每页显示的数据行数。默认值：获取实例下所有监控项默认值：0

4.输出参数

名称	类型	说明
listMetricsResult	Object	查询结果。
metrics	Object
member	Array of MetricSet	监控指标的集合。
responseMetadata	Object
requestId	String	请求ID。

5. 请求示例

示例1：查询云主机监控项列表

输入示例

${region}可替换相应区域，详见：Region 参考

${公共参数} 可替换相应区域，详见：公共参数

curl -X GET 'https://monitor.${region}.api.ksyun.com/?Action=ListMetrics&Version=2010-05-25&Namespace=KEC&InstanceID=6e98888-4bbe-4da5-baef-91306bce03e9&PageIndex=1&PageSize=2' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'host: monitor.api.ksyun.com' \
-H 'cache-control: no-cache' \
-H ${公共参数}

正常输出

支持 XML 和 JSON

JSON格式

{
    "listMetricsResult": {
        "metrics": {
            "member": [
                {
                    "instanceId": "6e98888-4bbe-4da5-baef-91306bce03e9",
                    "metricName": "memory.utilizition.total",
                    "metricDesc": "",
                    "namespace": "KEC",
                    "interval": "60",
                    "type": "float",
                    "unit": "%"
                }
            ]
        }
    },
    "responseMetadata": {
        "requestId": "7106664e-bce9-4871-b5df-9cf6e25ce142"
    }
}

XML格式

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ListMetricsResponse>
    <ListMetricsResult>
        <Metrics>
            <member>
                <InstanceId>6e98888-4bbe-4da5-baef-91306bce03e9</InstanceId>
                <MetricName>memory.utilizition.total</MetricName>
                <MetricDesc></MetricDesc>
                <Namespace>KEC</Namespace>
                <Interval>60</Interval>
                <Type>float</Type>
                <Unit>%</Unit>
            </member>
        </Metrics>
    </ListMetricsResult>
    <ResponseMetadata>
        <RequestId>7106664e-bce9-4871-b5df-9cf6e25ce142</RequestId>
    </ResponseMetadata>
</ListMetricsResponse>

异常输出

支持 XML 和 JSON

JSON格式

{
    "requestid": "7106664e-bce9-4871-b5df-9cf6e25ce142",
    "error": {
        "type": "sender",
        "code": "InvalidParameterValue",
        "message": "Invalid `InstanceID` parameter value, length must be 36 characters."
    }
}

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

文档导读

上一篇：云服务监控

下一篇：获取数据接口

纯净模式常规模式

纯净模式

点击可全屏预览文档内容