文件存储监控接口

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

1. 接口描述

接口:GetMonitorData

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

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

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

查询文件存储监控数据,入参取值如下: &Namespace:QCE/CFS
&Instances.N.Dimensions.0.Name=cfsId
&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/CFS
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 cfsId 入参为文件系统ID String类型维度名称:cfsId
Instances.N.Dimensions.0.Value cfsId 具体文件系统ID 输入具体文件系统ID,如cfs-fjojeogej

2.2 指标名称

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

指标名称(metricName) 指标中文名 含义 单位
Storage 文件系统存储量 文件系统当前时刻的存储量 GB
DataReadIoBytes 读取带宽 文件系统平均每秒钟读取的数据量 KB/s
DataWriteIoBytes 写入带宽 文件系统平均每秒钟写入的数据量 KB/s
DataReadIoCount 读取IOPS 文件系统平均每秒钟读操作次数 次/s
DataWriteIoCount 写入IOPS 文件系统平均每秒钟写操作次数 次/s

3. 输出参数

参数名称 类型 描述
MetricName String 监控指标
StartTime Timestamp 数据点起始时间
EndTime Timestamp 数据点结束时间
Period Integer 数据统计周期
DataPoints Array of Float 监控数据列表
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

拉取某个文件系统某段时间内统计周期为5分钟的读取带宽监控数据。

输入示例

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace=QCE/CFS
&MetricName=DataReadIoBytes
&Period=300
&StartTime=2019-04-16 20:00:00
&EndTime=2019-04-16 20:05:00
&Instances.0.Dimensions.0.Name=cfsId
&Instances.0.Dimensions.0.Value=cfs-foaejoigr
&<公共请求参数>

输出示例

{
  "Response": {
    "StartTime": "2019-06-05 00:00:00",
    "EndTime": "2019-06-05 00:05:00",
    "Period": 300,
    "MetricName": "DataReadIoBytes",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "cfsId",
            "Value": "cfs-foaejoigr"
          }
        ],
        "Timestamps": [
        1555416000,
        1559664300
        ],
        "Values": [
        1.2,
        1.3
        ]
      }
    ],
    "RequestId": "f37c03ce-0f54-492b-a378-78aa268e5d54"
  }
}

示例2

拉取多个文件系统某段时间内统计周期为5分钟的读取带宽监控数据。

请求参数

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace=QCE/CFS
&MetricName=DataReadIoBytes
&Period=300
&StartTime=2019-06-05T00:00:00+08:00
&EndTime=2019-06-05T00:05:00+08:00
&Instances.0.Dimensions.0.Name=cfsId
&Instances.0.Dimensions.0.Value=cfs-foaejoigr
&Instances.1.Dimensions.0.Name=cfsId
&Instances.1.Dimensions.0.Value=cfs-esasd12da
&<公共请求参数>

返回参数

{
  "Response": {
    "StartTime": "2019-06-05 00:00:00",
    "EndTime": "2019-06-05 00:05:00",
    "Period": 300,
    "MetricName": "DataReadIoBytes",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "cfsId",
            "Value": "cfs-foaejoigr"
          }
        ],
        "Timestamps": [
        1555416000,
        1559664300
        ],
        "Values": [
        1.2,
        1.3
        ]
      },
      {
        "Dimensions": [
          {
            "Name": "cfsId",
            "Value": "cfs-esasd12da"
          }
        ],
        "Timestamps": [
        1555416000,
        1559664300
        ],
        "Values": [
        1.2,
        1.3
        ]
      }
    ],
    "RequestId": "f37c03ce-0f54-492b-a378-78aa268e5d54"
  }
}