返回值 正常 200 异常 返回值 说明 400 Bad Request 请求错误。 401 Unauthorized 未提供认证信息，或认证信息错误。 403 Forbidden 请求页面被禁止访问。 408 Request Timeout 请求超出了服务器的等待时间。 429 Too Many Requests 当前请求过多。 500 Internal Server Error 请求未完成，服务异常。 503 Service Unavailable 系统暂时不可用，请求受限。

响应消息 响应参数 表5 响应参数 名称 参数类型 说明 metrics Arrays of objects 指标数据。 详细参数请参见表6。 表6 metrics字段数据结构说明 名称 参数类型 说明 unit String 指标单位。 datapoints Arrays of objects 指标数据列表。由于查询数据时，云监控会根据所选择的聚合粒度向前取整from参数，所以datapoints中包含的数据点有可能会多于预期，最多返回3000个数据点。 详细参数请参见表8。 namespace String 指标命名空间，格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_，service.item总长度最短为3，最大为32。 dimensions Arrays of objects 指标维度列表。 单个维度为json对象，结构说明如下： { "name": "instance_id", "value": "33328f02-3814-422e-b688-bfdba93d4050" } 详细参数请参见表7。 metric_name String 指标名称，必须以字母开头，只能包含0-9/a-z/A-Z/_，长度最短为1，最大为64。 表7 dimensions字段数据结构说明 名称 参数类型 说明 name String 监控维度名称，例如弹性云服务器的维度为instance_id。各服务维度请参考支持监控的服务列表，可参考维度中key字段。 必须以字母开头，只能包含0-9/a-z/A-Z/_/-，长度最短为1，最大为32。 value String 维度取值，例如弹性云服务器的ID。 必须以字母或数字开头，只能包含0-9/a-z/A-Z/_/-，长度最短为1，最大为256。 表8 datapoints字段数据结构说明 名称 参数类型 说明 average Double 聚合周期内指标数据的平均值。 max Double 聚合周期内指标数据的最大值。 min Double 聚合周期内指标数据的最小值。 sum Double 聚合周期内指标数据的求和值。 variance Double 聚合周期内指标数据的方差。 timestamp Long 指标采集时间，UNIX时间戳，单位毫秒。 响应样例 响应样例一：维度是instance_id为faea5b75-e390-4e2b-8733-9226a9026070的弹性云服务器的监控数据cpu_util的平均值和维度是instance_id为06b4020f-461a-4a52-84da-53fa71c2f42b的弹性云服务器的监控数据network_vm_connections的平均值。 { "metrics": [ { "namespace": "SYS.ECS", "metric_name": "cpu_util", "dimensions": [ { "name": "instance_id", "value": "faea5b75-e390-4e2b-8733-9226a9026070" } ], "datapoints": [ { "average": 0.69, "timestamp": 1556625610000 }, { "average": 0.7, "timestamp": 1556625715000 } ], "unit": "%" }, { "namespace": "SYS.ECS", "metric_name": "network_vm_connections", "dimensions": [ { "name": "instance_id", "value": "06b4020f-461a-4a52-84da-53fa71c2f42b" } ], "datapoints": [ { "average": 1, "timestamp": 1556625612000 }, { "average": 3, "timestamp": 1556625717000 } ], "unit": "count" } ] } 响应样例二：维度是rds_cluster_id为3c8cc15614ab46f5b8743317555e0de2in01的关系性数据库和维度是rds_cluster_id为3b2fa8b55a9b4adca3713962a9d31884in01的关系性数据库的监控数据rds021_myisam_buf_usage的求和值。 { "metrics": [ { "unit": "Ratio", "datapoints": [ { "sum": 0.07, "timestamp": 1556625628000 }, { "sum": 0.07, "timestamp": 1556625688000 } ], "namespace": "SYS.RDS", "dimensions": [ { "name": "rds_cluster_id", "value": "3c8cc15614ab46f5b8743317555e0de2in01" } ], "metric_name": "rds021_myisam_buf_usage" }, { "unit": "Ratio", "datapoints": [ { "sum": 0.06, "timestamp": 1556625614000 }, { "sum": 0.07, "timestamp": 1556625674000 } ], "namespace": "SYS.RDS", "dimensions": [ { "name": "rds_cluster_id", "value": "3b2fa8b55a9b4adca3713962a9d31884in01" } ], "metric_name": "rds021_myisam_buf_usage" } ] } 响应样例三：维度是instance_id为cd841102-f6b1-407d-a31f-235db796dcbb和proc为b28354b543375bfa94dabaeda722927f的主机监控的监控数据rds021_myisam_buf_usage的最小值。 { "metrics": [ { "unit": "Ratio", "datapoints": [ { "min": 0, "timestamp": 1556625612000 }, { "min": 0, "timestamp": 1556625672000 } ], "namespace": "AGT.ECS", "dimensions": [ { "name": "instance_id", "value": "cd841102-f6b1-407d-a31f-235db796dcbb" }, { "name": "proc", "value": "b28354b543375bfa94dabaeda722927f" } ], "metric_name": "rds021_myisam_buf_usage" } ] }

请求消息 单次POST请求消息体大小不能超过512KB，否则请求会被服务端拒绝。 对于不同的period取值和查询的指标数量，其对应的默认最大查询区间(to - from)也不同，计算规则为“指标数量 * (to - from) / 监控周期 ≤ 3000”。 当period值为“1”时，监控周期为60*1000ms=60000ms。 当period值为"300" 时，监控周期为300*1000ms=300000ms。 当period值为"1200" 时，监控周期为1200*1000ms=1200000ms。 当period值为"3600" 时，监控周期为3600*1000ms=3600000ms。 当period值为"14400" 时，监控周期为14400*1000ms=14400000ms。 当period值为"86400" 时，监控周期为86400*1000ms=86400000ms。 例如批量查询300个指标，监控周期为60000ms，可算出(to - from)最大值为"600000"，若设定的请求参数使(to - from)超出最大值，from值会自动调整为"to-600000"。 请求参数 表2 请求参数 名称 是否必选 参数类型 说明 metrics 是 Arrays of objects 指标数据。数组长度最大500。 详细参数请参见表3。 from 是 Long 查询数据起始时间，UNIX时间戳，单位毫秒。建议from的值相对于当前时间向前偏移至少1个周期。由于聚合运算的过程是将一个聚合周期范围内的数据点聚合到周期起始边界上，如果将from和to的范围设置在聚合周期内，会因为聚合未完成而造成查询数据为空，所以建议from参数相对于当前时间向前偏移至少1个周期。以5分钟聚合周期为例：假设当前时间点为10:35，10:30~10:35之间的原始数据会被聚合到10:30这个点上，所以查询5分钟数据点时from参数应为10:30。 说明： 云监控会根据所选择的聚合粒度向前取整from参数。 to 是 Long 查询数据截止时间UNIX时间戳，单位毫秒。from必须小于to。 period 是 String 监控数据粒度。 枚举值，取值范围： "1"，原始数据 "300"，5分钟粒度 "1200"，20分钟粒度 "3600"，1小时粒度 "14400"，4小时粒度 "86400"，1天粒度 filter 是 String 数据聚合方式，支持的聚合方式如下: average：聚合周期内指标数据的平均值。 max：聚合周期内指标数据的最大值。 min：聚合周期内指标数据的最小值。 sum：聚合周期内指标数据的求和值。 variance：聚合周期内指标数据的方差。 filter参数的值不会影响原始数据（period为1）的查询结果。 表3 metrics字段数据结构说明 名称 是否必选 参数类型 说明 namespace 是 String 查询服务的命名空间，各服务命名空间请参考支持监控的服务列表。 格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_，service.item总长度最短为3，最大为32。 metric_name 是 String 指标ID，例如弹性云服务器的监控指标CPU使用率，对应的metric_name为cpu_util。各服务监控指标请参考支持监控的服务列表 中的监控指标参考文档列。 字符格式必须以字母开头，只能包含0-9/a-z/A-Z/_-，字符长度最短为1，最大为64。 dimensions 是 Arrays of objects 指标维度列表。数组最大长度为4。 单个维度为json对象，结构说明如下： { "name": "instance_id", "value": "33328f02-3814-422e-b688-bfdba93d4050" } 详细说明请参见表4。 表4 dimensions字段数据结构说明 名称 是否必选 参数类型 说明 name 是 String 监控维度名称，例如弹性云服务器的维度为instance_id。各服务维度请参考支持监控的服务列表，可参考维度中key字段。 必须以字母开头，只能包含0-9/a-z/A-Z/_/-，长度最短为1，最大为32。 value 是 String 维度取值，例如弹性云服务器的ID。可通过调用查询指标列表接口，在其响应体的相关指标数据中获取 必须以字母或数字开头，只能包含0-9/a-z/A-Z/_/-，长度最短为1，最大为256。 对于dimensions字段里value的值，可通过调用查询指标列表接口，在其响应体的相关指标数据中获取。 对于OBS相关指标数据，当进行了相关OBS接口操作时可查询到相关指标数据，否则查询结果为空。 请求样例 请求样例一：查看维度是instance_id为faea5b75-e390-4e2b-8733-9226a9026070的弹性云服务器的监控数据cpu_util和维度instance_id为06b4020f-461a-4a52-84da-53fa71c2f42b的弹性云服务器的监控数据network_vm_connections，在2019-04-30 20:00:00到2019-04-30 22:00:00时间内，原始数据的平均值。 { "metrics": [ { "namespace": "SYS.ECS", "dimensions": [ { "name": "instance_id", "value": "faea5b75-e390-4e2b-8733-9226a9026070" } ], "metric_name": "cpu_util" }, { "namespace": "SYS.ECS", "dimensions": [ { "name": "instance_id", "value": "06b4020f-461a-4a52-84da-53fa71c2f42b" } ], "metric_name": "network_vm_connections" } ], "from": 1556625600000, "to": 1556632800000, "period": "1", "filter": "average" } 请求样例二：查看维度是rds_cluster_id为3c8cc15614ab46f5b8743317555e0de2in01的关系性数据库的监控数据rds021_myisam_buf_usage和维度是rds_cluster_id为3b2fa8b55a9b4adca3713962a9d31884in01的关系性数据库的监控数据rds021_myisam_buf_usage，在2019-04-30 20:00:00到2019-04-30 22:00:00时间内，原始数据的求和值。 { "metrics": [ { "namespace": "SYS.RDS", "dimensions": [ { "name": "rds_cluster_id", "value": "3c8cc15614ab46f5b8743317555e0de2in01" } ], "metric_name": "rds021_myisam_buf_usage" }, { "namespace": "SYS.RDS", "dimensions": [ { "name": "rds_cluster_id", "value": "3b2fa8b55a9b4adca3713962a9d31884in01" } ], "metric_name": "rds021_myisam_buf_usage" } ], "from": 1556625600000, "to": 1556632800000, "period": "1", "filter": "sum" } 请求样例三：查看维度是instance_id为cd841102-f6b1-407d-a31f-235db796dcbb和proc为b28354b543375bfa94dabaeda722927f的主机监控的监控数据proc_specified_count，在2019-04-30 20:00:00到2019-04-30 22:00:00时间内，周期为20分钟时，指标数据的最小值。 { "metrics": [ { "namespace": "AGT.ECS", "dimensions": [ { "name": "instance_id", "value": "cd841102-f6b1-407d-a31f-235db796dcbb" }, { "name": "proc", "value": "b28354b543375bfa94dabaeda722927" } ], "metric_name": "proc_specified_count" } ], "from": 1556625600000, "to": 1556632800000, "period": "1200", "filter": "min" }

请求消息 单次POST请求消息体大小不能超过512KB，否则请求会被服务端拒绝。 POST请求发送周期应小于最小聚合周期，否则会出现聚合数据点不连续。例如：聚合周期为5分钟，发送周期为7分钟，则5分钟情况的聚合数据会出现每10分钟才出现一个点。 POST请求体中时间戳（collect_time）的值必须从当前时间的前三天到当前时间后的十分钟之内某一时间，如果不在这个范围内，则不允许插入指标数据。 请求参数 表2 参数说明 名称 参数类型 是否必选 说明 数组元素 Array of objects 是 添加一条或多条自定义指标监控数据。 单次POST请求消息体大小不能超过512KB 详细参数请参见表3。 表3 数组元素 名称 是否必选 参数类型 说明 metric 是 Object 指标数据。 详细参数请参见表4。 ttl 是 Integer 数据的有效期，超出该有效期则自动删除该数据，单位秒，取值范围(0-604800]。 collect_time 是 Long 数据收集时间 UNIX时间戳，单位毫秒。 说明： 因为客户端到服务器端有延时，因此插入数据的时间戳应该在[当前时间-3天+20秒，当前时间+10分钟-20秒]区间内，保证到达服务器时不会因为传输时延造成数据不能插入数据库。 value 是 Double 待添加的监控指标数据的值。 数值类型支持“整数”或“浮点数”。 unit 否 String 数据的单位。 最大长度为32位。 type 否 String 枚举型。 取值范围： int float 表4 metric字段数据结构说明 名称 是否必选 参数类型 说明 namespace 是 String 自定义的命名空间，各服务命名空间请参考支持监控的服务列表。 格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_，service.item总长度最短为3，最大为32，其中service不能为“SYS”、“AGT”和“SRE”，namespace不能为SERVICE.BMS，因为此namespace已被系统使用。 当alarm_type为(EVENT.SYS| EVENT.CUSTOM)时允许为空。 dimensions 是 Array of objects 指标的维度，目前最大支持3个维度。 详细参数请参见表5。 metric_name 是 String 指标ID，例如弹性云服务器的监控指标CPU使用率，对应的metric_name为cpu_util。各服务监控指标请参考支持监控的服务列表。 表5 dimensions字段数据结构说明 名称 是否必选 参数类型 说明 name 是 String 监控维度名称，例如弹性云服务器的维度为instance_id。各服务维度请参考支持监控的服务列表，可参考维度中key字段。 必须以字母开头，只能包含0-9/a-z/A-Z/_/-，长度最短为1，最大为32。 value 是 String 维度取值，例如弹性云服务器的ID。 必须以字母或数字开头，只能包含0-9/a-z/A-Z/_/-，长度最短为1，最大为256。 请求样例 请求样例一：添加自定义的维度instance_id为6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d的监控指标数据cpu_util。 [ { "metric": { "namespace": "MINE.APP", "dimensions": [ { "name": "instance_id", "value": "6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d" } ], "metric_name": "cpu_util" }, "ttl": 172800, "collect_time": 1463598260000, "type": "float", "value": 0.09, "unit": "%" }, { "metric": { "namespace": "MINE.APP", "dimensions": [ { "name": "instance_id", "value": "6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d" } ], "metric_name": "cpu_util" }, "ttl": 172800, "collect_time": 1463598270000, "type": "float", "value": 0.12, "unit": "%" } ] 请求样例二：添加关系型数据库的维度rds_cluster_id为3c8cc15614ab46f5b8743317555e0de2in01的监控指标数据rds021_myisam_buf_usage。 [ { "metric": { "namespace": "SYS.RDS", "dimensions": [ { "name": "rds_cluster_id", "value": "3c8cc15614ab46f5b8743317555e0de2in01" } ], "metric_name": "rds021_myisam_buf_usage" }, "ttl": 172800, "collect_time": 1463598260000, "type": "float", "value": 0.01, "unit": "Ratio" } ] 请求样例三：添加分布式缓存服务的维度dcs_instance_id为1598b5d4-3cb5-4f4d-8d99-2425d8e9ed54和dcs_cluster_redis_node为6666cd76f96956469e7be39d750cc7d9的监控指标数据connections_usage。 [ { "metric": { "namespace": "SYS.DCS", "dimensions": [ { "name": "dcs_instance_id", "value": "1598b5d4-3cb5-4f4d-8d99-2425d8e9ed54" }, { "name": "dcs_cluster_redis_node", "value": "6666cd76f96956469e7be39d750cc7d9" } ], "metric_name": "connections_usage" }, "ttl": 172800, "collect_time": 1463598260000, "type": "float", "value": 8.3, "unit": "%" } ]

返回值 正常 201 异常 返回值 说明 400 Bad Request 请求错误。 401 Unauthorized 未提供认证信息，或认证信息错误。 403 Forbidden 请求页面被禁止访问。 408 Request Timeout 请求超出了服务器的等待时间。 429 Too Many Requests 当前请求过多。 500 Internal Server Error 请求未完成，服务异常。 503 Service Unavailable 系统暂时不可用，请求受限。