# 批量查询指标数据 - BatchListSpecifiedMetricData #### 功能介绍 批量查询指标数据 #### 接口约束 目前只上线上海一、西南-贵阳一、华北-乌兰察布一、华北-北京四、华南-广州、华北-北京一、华南-深圳、亚太-新加坡、中国-香港、华东-上海二 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CES/doc?api=BatchListSpecifiedMetricData&version=v2)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ces/ces_03_0045.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | ces:metricData:list | List | - | - | - | - | #### URI POST /v2/{project_id}/batch-query-metric-data 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-ces/ces_03_0057.html)。 **约束限制**: 不涉及。 **取值范围**: 字符串的长度必须在 1 到 64个字符之间。 **默认取值**: 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 否 | String | **参数解释**: 发送的实体的MIME类型。 **约束限制**: 不涉及。 **取值范围**: 最小字符数量为1，最大为64。 **默认取值**: 默认使用application/json; charset=UTF-8。 | | X-Auth-Token | 否 | String | **参数解释**: 用户Token。Token认证，具体操作请参考[认证鉴权](https://support.huaweicloud.com/api-ces/ces_03_0011.html)。 **约束限制**: 不涉及。 **取值范围**: 最小字符数量为1，最大为16384。 **默认取值**: 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | namespace | 是 | String | **参数解释**： 查询服务的命名空间，各服务命名空间请参阅[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)。 **约束限制**： 不涉及。 **取值范围**： 格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。字符串的长度必须在 3 到 32个字符之间。 **默认取值**： 不涉及。 | | metric_name | 是 | String | **参数解释**： 资源的监控指标名称，各服务资源的指标名称，请参阅具体云服务的文档。您可以直接从[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)页面导航至相应文档。 **约束限制**： 不涉及。 **取值范围**： 必须以字母开头，只能包含0-9/a-z/A-Z/_/-。字符长度最短为1，最大为64。如：弹性云服务器中的监控指标cpu_util，表示弹性服务器的CPU使用率；文档数据库中的指标mongo001_command_ps，表示command执行频率。 **默认取值**： 不涉及。 | | metric_dimension | 是 | String | **参数解释**: 资源维度信息, 多维度逗号分隔。 **约束限制**: 不涉及。 **取值范围**: 必须以字母开头，只能包含0-9/a-z/A-Z/_/-/,。每个维度必须以字母开头，每个维度长度最短1，最长32，多个维度直接用,分隔。 **默认取值**: 不涉及。 | | from | 否 | Long | **参数解释**: 查询监控数据的开始时间，格式为时间戳, 单位毫秒。 **约束限制**: from必须小于to, to和from的时间间隔必须在5分钟内。 **取值范围**: 毫秒级时间戳为\[1111111111111,9999999999999\] **默认取值**: 不涉及。 | | to | 否 | Long | **参数解释**: 查询监控数据的结束时间，格式为时间戳, 单位毫秒。 **约束限制**: from必须小于to, to和from的时间间隔必须在5分钟内。 **取值范围**: 毫秒级时间戳为\[1111111111111,9999999999999\] **默认取值**: 不涉及。 | | limit | 否 | Integer | **参数解释**: 分页大小。 **约束限制**: 不涉及。 **取值范围**: 最小值为1，最大值为1000。 **默认取值**: 100。 | | offset | 否 | Integer | **参数解释**: 分页偏移量。默认值为 0，后续传值根据前一次请求返回结果中的 *data_points* 数组长度进行累加。若某次查询结果为空，则表示已获取全量的指标数据。 **约束限制**: 不涉及。 **取值范围**: 最小值为0，最大值为9999999。 **默认取值**: 0。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | namespace | String | **参数解释**： 查询服务的命名空间，各服务命名空间请参阅[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)。 **取值范围**： 格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。字符串的长度必须在 3 到 32个字符之间。 | | metric_name | String | **参数解释**： 资源的监控指标名称，各服务资源的指标名称，请参阅具体云服务的文档。您可以直接从[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)页面导航至相应文档。 **取值范围**： 必须以字母开头，只能包含0-9/a-z/A-Z/_/-。字符长度最短为1，最大为96。如：弹性云服务器中的监控指标cpu_util，表示弹性服务器的CPU使用率；文档数据库中的指标mongo001_command_ps，表示command执行频率。 | | metric_dimension | String | **参数解释**: 资源维度, 多维度逗号分隔。 **取值范围**: 必须以字母开头，只能包含0-9/a-z/A-Z/_/-/,。每个维度必须以字母开头，每个维度长度最短1，最长32，多个维度直接用,分隔。 | | data_points | Array of [MetricDataPoint] objects | **参数解释** 监控数据列表 | 表5MetricDataPoint | 参数 | 参数类型 | 描述 | |:---|:---|:---| | dimensions | Array of [dimensions] objects | **参数解释**： 维度信息 | | timestamp | Integer | **参数解释**： 指标采集时间 **取值范围**： 最小值为0 | | value | Double | **参数解释**： 指标值 **取值范围**： 不涉及 | | unit | String | **参数解释**： 数据的单位。 **取值范围**： 长度为\[0,32\]个字符。 | 表6dimensions | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**： 资源维度名称 **取值范围**： 最小长度1，最大长度32 | | value | String | **参数解释**： 资源维度值 **取值范围**： 最小长度1，最大长度256 | | origin_value | String | **参数解释**： 实际维度信息。 **取值范围**： 字符串长度在 1 到 1024 之间。 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 用于标识请求异常的具体原因。 **取值范围**： 字符串长度为0到256个字符。 | | error_msg | String | **参数解释**： 用于描述请求异常的具体信息。 **取值范围**： 字符串长度为0到256个字符。 | | request_id | String | **参数解释**： 用于唯一标识一次请求，便于问题追踪。 **取值范围**： 字符串长度为0到256个字符。 | **状态码：401** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 用于标识请求异常的具体原因。 **取值范围**： 字符串长度为0到256个字符。 | | error_msg | String | **参数解释**： 用于描述请求异常的具体信息。 **取值范围**： 字符串长度为0到256个字符。 | | request_id | String | **参数解释**： 用于唯一标识一次请求，便于问题追踪。 **取值范围**： 字符串长度为0到256个字符。 | **状态码：403** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 用于标识请求异常的具体原因。 **取值范围**： 字符串长度为0到256个字符。 | | error_msg | String | **参数解释**： 用于描述请求异常的具体信息。 **取值范围**： 字符串长度为0到256个字符。 | | request_id | String | **参数解释**： 用于唯一标识一次请求，便于问题追踪。 **取值范围**： 字符串长度为0到256个字符。 | **状态码：500** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 用于标识请求异常的具体原因。 **取值范围**： 字符串长度为0到256个字符。 | | error_msg | String | **参数解释**： 用于描述请求异常的具体信息。 **取值范围**： 字符串长度为0到256个字符。 | | request_id | String | **参数解释**： 用于唯一标识一次请求，便于问题追踪。 **取值范围**： 字符串长度为0到256个字符。 | #### 请求示例 查询资源维度为"instance_id,disk"，指标名为disk_agt_write_bytes_rate，在2024-11-14 16:50:00到2024-11-14 16:55:00时间内所有资源的监控数据，分页大小为2 ``` /v2/d946d6a5b221400185e9db592a5329c6/batch-query-metric-data { "namespace" : "AGT.ECS", "metric_name" : "disk_agt_write_bytes_rate", "metric_dimension" : "instance_id,disk", "from" : 1731574200000, "to" : 1731574500000, "limit" : 2, "offset" : 0 } ``` #### 响应示例 **状态码：200** OK, 批量查询指标数据返回体 ``` { "namespace" : "AGT.ECS", "metric_name" : "disk_agt_write_bytes_rate", "metric_dimension" : "instance_id,disk", "data_points" : [ { "dimensions" : [ { "name" : "disk", "value" : "2e84018fc8b4484b94e89aae212fe615", "origin_value" : "vda" }, { "name" : "instance_id", "value" : "57259492-54c8-475c-8bff-1c3c60d9ed4e" } ], "timestamp" : 1731574202332, "value" : 4232.53, "unit" : "Byte/s" }, { "dimensions" : [ { "name" : "disk", "value" : "2e84018fc8b4484b94e89aae212fe615", "origin_value" : "vda" }, { "name" : "instance_id", "value" : "8f3058e2-64aa-42d7-ba68-9df1cee811db" } ], "timestamp" : 1731574206166, "value" : 17885.87, "unit" : "Byte/s" } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK, 批量查询指标数据返回体 | | 400 | Bad Request, 请求错误 | | 401 | Unauthorized, 未提供认证信息，或认证信息错误 | | 403 | Forbidden, 请求页面被禁止访问 | | 500 | Internal Server Error, 请求未完成, 服务异常 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-ces/ErrorCode.html)。