文档中心 云监控 API文档 各产品监控接口 容器服务-服务维度监控接口

容器服务-服务维度监控接口

最近更新时间:2019-06-27 20:07:28

1. 接口描述

接口:GetMonitorData
接口请求域名: monitor.tencentcloudapi.com

获取云产品的监控数据。传入产品的命名空间、对象维度描述和监控指标即可获得相应的监控数据。

接口调用频率限制为:20次/秒,1200次/分钟。 单请求最多可支持批量拉取10个实例的监控数据,单请求的数据点数限制为1440个。

若您需要调用的指标、对象较多,可能存在因限频出现拉取失败的情况,建议尽量将请求按时间维度均摊。

查询容器服务服务维度监控数据,入参取值如下:
&Namespace=QCE/DOCKER
&Instances.N.Dimensions.0.Name=clusterId
&Instances.N.Dimensions.0.Value 为集群 ID

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,正式调用时需要加上公共请求参数,详情请参见 公共请求参数 文档。

2.1输入参数

2.1.1 输入参数总览

参数名称 是否必选 类型 描述
Action String 公共参数,本接口取值:GetMonitorData
Version String 公共参数,本接口取值: 2018-07-24
Region String 公共参数,表示查询的是哪个地域实例的监控数据;支持的地域可查看云服务器支持的 地域列表
Namespace String 命名空间,每个云产品会有一个命名空间,API 3.0接口版本的必须是大写,如: QCE/DOCKER
MetricName String 指标名称,具体名称见2.2
Instances.N Array of Instance 实例对象的维度组合
Period Integer 监控统计周期。默认为取值为300,单位为s
StartTime Timestamp 起始时间,如"2016-01-01 10:25:00"。 默认时间为当天的”00:00:00”
EndTime Timestamp 结束时间,默认为当前时间。 endTime 不能小于 startTime

2.1.2 各维度对应参数总览

参数名称 维度名称 维度解释 格式
Instances.N.Dimensions.0.Name clusterId 为集群 ID String 类型维度名称:clusterId
Instances.N.Dimensions.0.Value clusterId 具体的集群 ID,查询集群列表 接口中返回的 clusterId(集群的 ID)字段 具体实例名称,如 cls-xxxxx
Instances.N.Dimensions.1.Name serviceName 为服务名称 String 类型维度名称:serviceName
Instances.N.Dimensions.1.Value serviceName 具体的集服务名称,查询服务列表 接口中返回的 serviceName(服务名)字段 具体实例名称,如 test
Instances.N.Dimensions.2.Name namespace 为命名空间名称 String 类型维度名称:namespace
Instances.N.Dimensions.2.Value namespace 具体的空间名称,查询服务列表 接口中返回的namespace(命名空间)字段 具体实例名称,如 default

2.2 指标名称

每个指标对应的统计粒度(Period)及维度(dimension)可取值不一定相同,可通过 DescribeBaseMetrics 接口获取每个指标支持的统计粒度及维度信息。

监控项 指标名称 单位 说明
服务 CPU 使用情况 ServiceCpuUsed 服务内所有容器实例 CPU 使用之和
服务 CPU 使用率(占集群) ServiceCpuUsageForCluster % 服务使用 CPU 占集群比率
服务内存使用情况 ServiceMemUsed MiB 服务内所有容器实例内存使用之和
服务内存使用率(占集群) ServiceMemUsageForCluster % 服务使用内存占集群比率
服务网络入流量 ServiceInFlux MB 服务内所有实例在该时间窗口入流量之和
服务网络出流量 ServiceOutFlux MB 服务内所有实例在该时间窗口出流量之和
服务网络入带宽 ServiceInBandwidth Mbps 服务内所有实例的入带宽之和
服务网络出带宽 ServiceOutBandwidth Mbps 服务内所有实例的出带宽之和
服务网络入包量 ServiceInPackets 个/s 服务内所有实例的入包量之和
服务网络出包量 ServiceOutPackets 个/s 服务内所有实例的出包量之和

3. 输出参数

参数名称 类型 描述
MetricName String 监控指标
StartTime Timestamp 数据点起始时间
EndTime Timestamp 数据点结束时间
Period Integer 数据统计周期
DataPoints Array of PointsObject 监控数据列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId

4. 错误码表

错误代码 错误描述 英文描述
-502 资源不存在 OperationDenied.SourceNotExists
-503 请求参数有误 InvalidParameter
-505 参数缺失 InvalidParameter.MissingParameter
-507 超出限制 OperationDenied.ExceedLimit
-509 错误的维度组合 InvalidParameter.DimensionGroupError
-513 DB 操作失败 InternalError.DBoperationFail

5. 示例

示例1

拉取某个容器服务服务维度某段时间内统计周期为60秒的服务 CPU 使用情况监控数据。

输入示例

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace=QCE/DOCKER
&MetricName=ServiceCpuUsed
&Period=60
&StartTime=2019-06-17T16:35:00+08:00
&EndTime=2019-06-17T16:40:00+08:00
&Instances.0.Dimensions.0.Name=clusterId
&Instances.0.Dimensions.0.Value=cls-12345
&Instances.0.Dimensions.1.Name=namespace
&Instances.0.Dimensions.1.Value=default
&Instances.0.Dimensions.2.Name=serviceName
&Instances.0.Dimensions.2.Value=monitor
&<公共请求参数>

输出示例

{
  "Response": {
    "StartTime": "2019-06-17 16:35:00",
    "EndTime": "2019-06-17 16:40:00",
    "Period": 60,
    "MetricName": "ServiceCpuUsed",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "clusterId",
            "Value": "cls-12345"
          },
          {
            "Name": "namespace",
            "Value": "default"
          },
          {
            "Name": "serviceName",
            "Value": "monitor"
          }
        ],
        "Timestamps": [
          1560760500,
          1560760560,
          1560760620,
          1560760680,
          1560760740,
          1560760800
        ],
        "Values": [
          0.000004,
          0.000002,
          0.000005,
          0.000001,
          0.000004,
          0.000002
        ]
      }
    ],
    "RequestId": "7dde43ca-9fba-4ef9-8973-d0007a7dc628"
  }
}

示例2

拉取多个容器服务服务维度某段时间内统计周期为60秒的服务 CPU 使用情况监控数据。

输入示例

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace=QCE/DOCKER
&MetricName=ServiceCpuUsed
&Period=60
&StartTime=2019-06-17T16:35:00+08:00
&EndTime=2019-06-17T16:40:00+08:00
&Instances.0.Dimensions.0.Name=clusterId
&Instances.0.Dimensions.0.Value=cls-12345
&Instances.0.Dimensions.1.Name=namespace
&Instances.0.Dimensions.1.Value=default
&Instances.0.Dimensions.2.Name=serviceName
&Instances.0.Dimensions.2.Value=monitor
&Instances.1.Dimensions.0.Name=clusterId
&Instances.1.Dimensions.0.Value=cls-123456
&Instances.1.Dimensions.1.Name=namespace
&Instances.1.Dimensions.1.Value=default
&Instances.1.Dimensions.2.Name=serviceName
&Instances.1.Dimensions.2.Value=monitor
&<公共请求参数>

输出示例

{
  "Response": {
    "StartTime": "2019-06-17 16:35:00",
    "EndTime": "2019-06-17 16:40:00",
    "Period": 60,
    "MetricName": "ServiceCpuUsed",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "clusterId",
            "Value": "cls-12345"
          },
          {
            "Name": "namespace",
            "Value": "default"
          },
          {
            "Name": "serviceName",
            "Value": "monitor"
          }
        ],
        "Timestamps": [
          1560760500,
          1560760560,
          1560760620,
          1560760680,
          1560760740,
          1560760800
        ],
        "Values": [
          0.000004,
          0.000002,
          0.000005,
          0.000001,
          0.000004,
          0.000002
        ]
      },
      {
        "Dimensions": [
          {
            "Name": "clusterId",
            "Value": "cls-123456"
          },
          {
            "Name": "namespace",
            "Value": "default"
          },
          {
            "Name": "serviceName",
            "Value": "monitor"
          }
        ],
        "Timestamps": [
          1560760500,
          1560760560,
          1560760620,
          1560760680,
          1560760740,
          1560760800
        ],
        "Values": [
          0.000004,
          0.000002,
          0.000005,
          0.000001,
          0.000004,
          0.000002
        ]
      }
    ],
    "RequestId": "7dde43ca-9fba-4ef9-8973-d0007a7dc628"
  }
}