文档中心 云监控 API文档 各产品监控接口 私有网络-云联网监控接口

私有网络-云联网监控接口

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

1. 接口描述

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

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

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

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

查询私有网络云联网监控数据,入参取值如下:
&Namespace=QCE/VBC
&Instances.N.Dimensions.0.Name=CcnId
&Instances.N.Dimensions.0.Value=ccn-c889docn

2. 输入参数

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

2.1输入参数

2.1.1 输入参数总览

参数名称 是否必选 类型 描述
Action String 公共参数,本接口取值:GetMonitorData
Version String 公共参数,本接口取值: 2018-07-24
Region String 公共参数,表示查询的是哪个地域实例的监控数据;支持的地域可查看云服务器支持的 地域列表
Namespace String 命名空间,每个云产品会有一个命名空间,API 3.0接口版本的必须是大写,如:QCE/VBC
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 CcnId 云联网 ID String 类型维度名称:CcnId
Instances.N.Dimensions.0.Value CcnId 具体的云联网 ID 具体实例名称,如 ccn-12345adc
Instances.N.Dimensions.0.Name SRegion 源地域 String 类型维度名称:SRegion
Instances.N.Dimensions.0.Value SRegion 具体的源地域 具体实例名称,如 ap-shanghai
Instances.N.Dimensions.0.Name DRegion 目的地域 String 类型维度名称:DRegion
Instances.N.Dimensions.0.Value DRegion 具体的目的地域 具体实例名称,如 ap-guangzhou

2.2 指标名称

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

2.2.1 单地域指标名称

指标名称 含义 单位 维度
RegionOutPkg 单地域总出包量 个/秒 单地域: CcnId
RegionInPkg 单地域总入包量 个/秒 单地域: CcnId
RegionOutBandwidth 单地域总出带宽 Mbps 单地域: CcnId
RegionInBandwidth 单地域总入带宽 Mbsp 单地域: CcnId

2.2.2 地域间指标名称

指标名称 含义 单位 维度
OutPkg 地域间出包量 个/秒 地域间: CcnId, SRegion, DRegion
InPkg 地域间入包量 个/秒 地域间: CcnId, SRegion, DRegion
OutBandwidth 地域间出带宽 Mbps 地域间: CcnId, SRegion, DRegion
InBandwidth 地域间入带宽 Mbps 地域间: CcnId, SRegion, DRegion

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秒的单地域总出包量监控数据。

输入示例

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace=QCE/VBC
&MetricName=RegionOutPkg
&Period=60
&StartTime=2019-06-11T16:40:00+08:00
&EndTime=2019-06-11T16:45:00+08:00
&Instances.0.Dimensions.0.Name=CcnId
&Instances.0.Dimensions.0.Value=ccn-12345adc
&<公共请求参数>

输出示例

{
  "Response": {
    "StartTime": "2019-06-11 16:40:00",
    "EndTime": "2019-06-11 16:45:00",
    "Period": 60,
    "MetricName": "RegionOutPkg",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "CcnId",
            "Value": "ccn-12345adc"
          }
        ],
        "Timestamps": [
          1560242400,
          1560242460,
          1560242520,
          1560242580,
          1560242640,
          1560242700
        ],
        "Values": [
          0,
          0,
          0,
          0,
          0,
          0
        ]
      }
    ],
    "RequestId": "e3b37b87-b077-4601-9bb2-53b2fd529bea"
  }
}

示例2

拉取多个私有网络云联网某段时间内统计周期为60秒的单地域总出包量监控数据。

输入示例

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace=QCE/VBC
&MetricName=RegionOutPkg
&Period=60
&StartTime=2019-06-11T16:40:00+08:00
&EndTime=2019-06-11T16:45:00+08:00
&Instances.0.Dimensions.0.Name=CcnId
&Instances.0.Dimensions.0.Value=ccn-12345adc
&Instances.1.Dimensions.0.Name=CcnId
&Instances.1.Dimensions.0.Value=ccn-12345adcd
&<公共请求参数>

输出示例

{
  "Response": {
    "StartTime": "2019-06-11 16:40:00",
    "EndTime": "2019-06-11 16:45:00",
    "Period": 60,
    "MetricName": "RegionOutPkg",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "CcnId",
            "Value": "ccn-12345adc"
          }
        ],
        "Timestamps": [
          1560242400,
          1560242460,
          1560242520,
          1560242580,
          1560242640,
          1560242700
        ],
        "Values": [
          0,
          0,
          0,
          0,
          0,
          0
        ]
      },
      {
        "Dimensions": [
          {
            "Name": "CcnId",
            "Value": "ccn-12345adcd"
          }
        ],
        "Timestamps": [
          1560242400,
          1560242460,
          1560242520,
          1560242580,
          1560242640,
          1560242700
        ],
        "Values": [
          0,
          0,
          0,
          0,
          0,
          0
        ]
      }
    ],
    "RequestId": "e3b37b87-b077-4601-9bb2-53b2fd529bea"
  }
}