对象存储监控接口

最近更新时间:2019-03-21 11:24:05

1. 接口描述

域名:monitor.api.qcloud.com
接口:GetMonitorData

对象存储服务 COS(Cloud Object Storage)是腾讯云提供的一种基于 Web 的安全稳定、海量、便捷、低延迟、低成本的云端存储服务,有关产品的简介信息,请参阅 对象存储产品页

查询对象存储的监控数据,入参取值如下:

namespace: qce/cos

dimensions.0.name=appid

dimensions.0.value 为主账号的 APPID

dimensions.1.name=bucket

dimensions.1.value 为存储桶名称

2. 输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,详见 公共请求参数 页面。其中,此接口的 Action 字段为 GetMonitorData。

2.1 输入参数

2.1.1 输入参数总览

参数名称 必选 类型 输入内容 描述
namespace String qce/cos 命名空间,每个云产品会有一个命名空间,具体名称见输入内容一栏
metricName String 具体的指标名称 指标名称,具体名称见2.2
dimensions.n.name String 维度的名称 维度的名称,具体维度名称见第2.1.2小节,与dimensions.n.value配合使用
dimensions.n.value String 对应的维度的值 对应的维度的值,具体维度名称见第2.1.2小节,与dimensions.n.name配合使用
period Int 60/300 监控统计周期,绝大部分指标支持60s统计粒度,部分指标仅支持300s统计粒度,统计粒度根据指标的不同而变,输入参数时可参考下方的指标详情列表
startTime Datetime 起始时间 起始时间,如"2016-01-01 10:25:00", 默认时间为当天的”00:00:00”
endTime Datetime 结束时间 结束时间,默认为当前时间, endTime不能小于startTime

2.1.2 各维度对应参数总览

参数名称 维度名称 维度解释 格式
dimensions.0.name appid 主账号 APPID String 类型
dimensions.0.value appid 主账号 APPID 主账号 APPID,如 1250000000
dimensions.1.name bucket 存储桶名称 String 类型
dimensions.1.value bucket 存储桶名称 存储桶名称,如 examplebucket-1250000000

2.2 指标名称

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

存储类

存储类指标支持的最小统计周期(period)为300,并支持使用3600、86400为拉取周期。

指标名称(metricName) 含义 单位
std_storage 标准存储-存储空间 MB
sia_storage 低频存储-存储空间 MB
nel_storage 近线存储-存储空间 MB
arc_storage 归档存储-存储空间 MB

流量类

流量类指标支持的最小统计周期(period)为60,并支持使用300、3600、86400为拉取周期。

指标名称(metricName) 含义 单位
internet_traffic 外网流量 B
internal_traffic 内网流量 B
cdn_origin_traffic CDN 回源流量 B
inbound_traffic 上传流量 B

数据读取类

数据读取类指标支持的最小统计周期(period)为60,并支持使用300、3600、86400为拉取周期。

指标名称(metricName) 含义 单位
std_retrieval 标准数据读取 B
ia_retrieval 低频数据读取 B
nl_retrieval 近线数据读取 B

请求类

请求类指标支持的最小统计周期(period)为60,并支持使用 300、3600、86400为拉取周期。

指标名称(metricName) 含义 单位
std_read_requests 标准存储读请求 次数
std_write_requests 标准存储写请求 次数
ia_read_requests 低频存储读请求 次数
ia_write_requests 低频存储写请求 次数
nl_read_requests 近线存储读请求 次数
nl_write_requests 近线存储写请求 次数

返回码类

指标名称(metricName) 含义 单位
2xx_response 2xx 状态码 次数
3xx_response 3xx 状态码 次数
4xx_response 4xx 状态码 次数
5xx_response 5xx 状态码 次数

3. 输出参数

参数名称 类型 描述
code Int 错误码,0:成功,其他值表示失败
message String 返回信息
startTime Datetime 起始时间
endTime Datetime 结束时间
metricName String 指标名称
period Int 监控统计周期
dataPoints Array 监控数据列表

4. 错误码表

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

5. 示例

输入

https://monitor.api.qcloud.com/v2/index.php?
&公共请求参数
&namespace=qce/cos
&metricName=internet_traffic
&dimensions.0.name=appid
&dimensions.0.value=125232125

&dimensions.0.name=bucket
&dimensions.0.value=testbucket-125232125

&startTime=2016-06-28 14:10:00
&endTime=2016-06-28 14:20:00

输出

{
    "code": 0,
    "message": "",
    "metricName": "internet_traffic",
    "startTime": "2016-06-28 14:10:00",
    "endTime": "2016-06-28 14:20:00",
    "period": 300,
    "dataPoints": [
        5,
        6,
        7
    ]
}