获取数据接口

最近更新时间:2019-11-21 11:28:51

获取监控数据

1.接口描述

2.输入参数

3.输出参数

4.示例

1.接口描述

域名:monitor.region.api.ksyun.com

接口名: GetMetricStatistics

Version=2019-08-12

本接口适用于获取容器服务监控数据,分为多个查询维度,以下分别详述。

2.输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见公共请求参数页面。

参数名称 必选 类型 描述
Namespace String 表示一类云产品,这里指定KCE。
MetricName String 监控项名称
Dimensions.n.Name String 维度的名称,与 dimensions.n.value 配合使用
Dimensions.n.Value String 对应的维度的值,与 dimensions.n.name 配合使用
StartTime String 开始时间戳,如2017-02-28T17:00:00Z
EndTime String 结束时间戳,如2017-02-28T18:00:00Z
Period Interger 采样周期,60的整数倍,支持60-900
Aggregate String 数据聚合的方法,Average,Sum,Count,Max,Min

3.输出参数

参数名称 类型 描述
Datapoints Array 按照指定的统计方法获取的监控数据
Label String 监控指标
RequestId String 请求ID

4.示例

输入

https://monitor.${region}.api.ksyun.com/?
Action=GetMetricStatistics
&Version=2019-08-12
&Namespace=KCE
&Dimensions.0.Name=ClusterId
&Dimensions.0.Value=clusterId
&MetricName=cluster.cpu.usage
&StartTime=2019-11-14T15:00:00Z
&EndTime=2019-11-14T15:10:00Z
&Period=300
&Aggregate=Average,Sum,Max,Min,Count
&公共参数

输出

<GetMetricStatisticsResponse xmlns="https://ksyun.kingeyes.com/">
    <GetMetricStatisticsResult>
        <Datapoints>
            <member>
                <Average>9.41</Average>
                <Max>14.5</Max>
                <Min>6.126</Min>
                <SampleCount>1</SampleCount>
                <Sum>47</Sum>
                <Timestamp>2019-11-14T15:00:00Z</Timestamp>
            </member>
            <member>
                <Average>6.661</Average>
                <Max>8.497</Max>
                <Min>5.893</Min>
                <SampleCount>1</SampleCount>
                <Sum>33</Sum>
                <Timestamp>2019-11-14T15:05:00Z</Timestamp>
            </member>
            <member>
                <Average>6.322</Average>
                <Max>7.468</Max>
                <Min>5.864</Min>
                <SampleCount>1</SampleCount>
                <Sum>32</Sum>
                <Timestamp>2019-11-14T15:10:00Z</Timestamp>
            </member>
        </Datapoints>
        <Label>cluster.cpu.usage</Label>
    </GetMetricStatisticsResult>
    <ResponseMetadata>
        <RequestId>7c895f70-d5e0-4091-b9f0-ea8361a8d15b</RequestId>
    </ResponseMetadata>
</GetMetricStatisticsResponse>

金山云,开启您的云计算之旅

免费注册