获取数据接口-文档中心-金山云

云监控

查看更多结果

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

页面目录

全部展开全部收起

产品更新动态

未找到含该关键词的产品

文档中心

云监控

API参考

云服务监控

获取数据接口

最近更新时间：2025-07-15 10:36:01



调用 GetMetricStatistics 接口，本接口支持查询最近15min以前的历史数据（30天以内）。

容器引擎产品见容器引擎获取数据接口。

1.接口描述

接口名：GetMetricStatistics

请求方式：GET

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

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

接口调用限制说明：

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

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

若需查询最近15min内的实时数据，且为高并发量数据，请使用批量获取数据接口。

2.接口调试

荐使用 API Explorer

点击调试

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

3.输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：GetMetricStatistics。
Version	是	String	公共参数，本接口取值：2010-05-25。
Namespace	是	String	表示一类云产品，指定命名空间。
InstanceID	是	String	监控实例的ID。特别注意：需要额外关注部分产品线实例ID，具体如下： KS3: 实例ID为 BucketName，并非 BucketID； MongoDB：实例ID前添加`user` 前缀；
MetricName	是	String	监控项名称。
StartTime	是	String	起始时间。时间格式： `2023-07-19T16:00:50Z` 示例值：2023-07-19T16:00:50Z
EndTime	是	String	结束时间。时间格式： `2023-07-19T16:09:50Z` 特别注意：数据采集可能存在有2分钟左右的延迟，EndTime的值应当比当前时间延迟两分钟，假设当前时间为：2023-07-19T16:11:50Z，那么 EndTime=2023-07-19T16:09:50Z。示例值：2023-07-19T16:09:50Z
Aggregate	是	String	数据聚合的方法。目前支持： Average Max Min 注意：如果查询的数据与控制台监控视图不一致，可能是由于该参数导致。示例值：Max
Period	否	String	统计粒度，单位为秒。注意：该参数值应为60的整数倍，值的大小可能会导致数据与控制台展示不一致。默认值为空时，将不对数据进行降采样，按产品线的推送频率进行展示。

4.输出参数

名称	类型	说明
getMetricStatisticsResult	Object	查询结果。
datapoints	Object
member	Array of MetricDataPoint	监控数据。
label	String	监控指标。示例值：cpu.utilizition.total
responseMetadata	Object
requestId	String	请求ID。

5. 请求示例

示例1：查询云主机CPU监控数据

输入示例

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

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

curl -X GET 'https://monitor.${region}.api.ksyun.com/?Action=GetMetricStatistics&Version=2010-05-25&Namespace=KEC&StartTime=2021-12-13T17:52:00Z&EndTime=2021-12-13T17:56:00Z&InstanceID=6e98888-4bbe-4da5-baef-91306bce03e9&MetricName=cpu.utilizition.total&Period=60&Aggregate=average,max,min,sum,count' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'host: monitor.api.ksyun.com' \
-H 'cache-control: no-cache' \
-H ${公共参数}

正常输出

支持 XML 和 JSON

JSON格式

{
    "getMetricStatisticsResult": {
        "datapoints": {
            "member": [
                {
                    "timestamp": "2021-12-13T17:52:00Z",
                    "unixTimestamp": 1639389120000,
                    "average": "0.136",
                    "max": "0.136",
                    "min": "0.136",
                    "sampleCount": "1",
                    "sum": "0"
                },
                {
                    "timestamp": "2021-12-13T17:53:00Z",
                    "unixTimestamp": 1639389180000,
                    "average": "0.136",
                    "max": "0.136",
                    "min": "0.136",
                    "sampleCount": "1",
                    "sum": "0"
                },
                {
                    "timestamp": "2021-12-13T17:54:00Z",
                    "unixTimestamp": 1639389240000,
                    "average": "0.136",
                    "max": "0.136",
                    "min": "0.136",
                    "sampleCount": "1",
                    "sum": "0"
                },
                {
                    "timestamp": "2021-12-13T17:55:00Z",
                    "unixTimestamp": 1639389300000,
                    "average": "0.136",
                    "max": "0.136",
                    "min": "0.136",
                    "sampleCount": "1",
                    "sum": "0"
                },
                {
                    "timestamp": "2021-12-13T17:56:00Z",
                    "unixTimestamp": 1639389360000,
                    "average": "0.136",
                    "max": "0.136",
                    "min": "0.136",
                    "sampleCount": "1",
                    "sum": "0"
                }
            ]
        },
        "label": "cpu.utilizition.total"
    },
    "responseMetadata": {
        "requestId": "3a037487-33c6-4c01-b68a-1545f7312fed"
    }
}

XML格式

<GetMetricStatisticsResponse xmlns="https://ksyun.kingeyes.com/">
    <GetMetricStatisticsResult>
        <Datapoints>
            <member>
                <Average>0.136</Average>
                <Max>0.136</Max>
                <Min>0.136</Min>
                <SampleCount>1</SampleCount>
                <Sum>0</Sum>
                <Timestamp>2021-12-13T17:52:00Z</Timestamp>
                <UnixTimestamp>1639389120000</UnixTimestamp>
            </member>
            <member>
                <Average>0.136</Average>
                <Max>0.136</Max>
                <Min>0.136</Min>
                <SampleCount>1</SampleCount>
                <Sum>0</Sum>
                <Timestamp>2021-12-13T17:53:00Z</Timestamp>
                <UnixTimestamp>1639389180000</UnixTimestamp>
            </member>
            <member>
                <Average>0.136</Average>
                <Max>0.136</Max>
                <Min>0.136</Min>
                <SampleCount>1</SampleCount>
                <Sum>0</Sum>
                <Timestamp>2021-12-13T17:54:00Z</Timestamp>
                <UnixTimestamp>1639389240000</UnixTimestamp>
            </member>
            <member>
                <Average>0.136</Average>
                <Max>0.136</Max>
                <Min>0.136</Min>
                <SampleCount>1</SampleCount>
                <Sum>0</Sum>
                <Timestamp>2021-12-13T17:55:00Z</Timestamp>
                <UnixTimestamp>1639389300000</UnixTimestamp>
            </member>
            <member>
                <Average>0.136</Average>
                <Max>0.136</Max>
                <Min>0.136</Min>
                <SampleCount>1</SampleCount>
                <Sum>0</Sum>
                <Timestamp>2021-12-13T17:56:00Z</Timestamp>
                <UnixTimestamp>1639389360000</UnixTimestamp>
            </member>
        </Datapoints>
        <Label>cpu.utilizition.total</Label>
    </GetMetricStatisticsResult>
    <ResponseMetadata>
        <RequestId>3a037487-33c6-4c01-b68a-1545f7312fed</RequestId>
    </ResponseMetadata>
</GetMetricStatisticsResponse>

异常输出

支持 XML 和 JSON

JSON格式

{
    "requestid": "7106664e-bce9-4871-b5df-9cf6e25ce142",
    "error": {
        "type": "sender",
        "code": "InvalidParameterValue",
        "message": "Invalid `StartTime` parameter value, time type should be 'yyyy-MM-ddTHH:mm:ssZ', like '2016-05-11T15:00:00Z'."
    }
}

6. 错误码

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

文档导读

上一篇：获取指标接口

下一篇：获取产品列表

纯净模式常规模式

纯净模式

点击可全屏预览文档内容