请求示例 通过指标接口查询从6月25日至当前的告警等级分布 https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/sa/metrics/hits { "metric_ids" : [ "1f0f5e29-5a92-17a5-2c16-5f37c6dc109c" ], "params" : [ { "start_date" : "2024-06-25T00:00:00.000+08:00" } ] }

响应示例 状态码：200 请求成功 [ { "metric_id" : "1f0f5e29-5a92-17a5-2c16-5f37c6dc109c", "result" : { "labels" : [ "label1" ], "datarows" : [ [ { } ] ], "effective_column" : "0:1" }, "status" : "SUC CES S" } ]

URI POST /v1/{project_id}/workspaces/{workspace_id}/sa/metrics/hits 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID workspace_id 是 String 工作空间ID 表2 Query参数 参数 是否必选 参数类型 描述 timespan 否 String 查询指标的时间范围，ISO8601格式，例如：2007-03-01T13:00:00Z/2008-05-11T15:30:00Z或2007-03-01T13:00:00Z/P1Y2M10DT2H30M或P1Y2M10DT2H30M/2008-05-11T15:30:00Z cache 否 Boolean 是否启用缓存，默认true, 禁用缓存 false

请求示例 查询指标维度为"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.E CS ", "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 表4 响应Body参数 参数 参数类型 描述 namespace String 参数解释： 查询服务的命名空间，各服务命名空间请参考“服务命名空间”。 取值范围： 格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。字符串的长度必须在 3 到 32个字符之间。 metric_name String 参数解释： 资源的监控指标名称，各服务的指标名称可查看：“服务指标名称”。 取值范围： 必须以字母开头，只能包含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 参数解释： 监控数据列表 表5 MetricDataPoint 参数 参数类型 描述 dimensions Array of dimensions objects 参数解释： 维度信息 timestamp Integer 参数解释： 指标采集时间 取值范围： 最小值为0 value Double 参数解释： 指标值 取值范围： 不涉及 unit String 参数解释： 数据的单位。 取值范围： 长度为[0,32]个字符。 表6 dimensions 参数 参数类型 描述 name String 参数解释： 指标维度值 取值范围： 最小长度1，最大长度32 value String 参数解释： 指标维度值 取值范围： 最小长度1，最大长度256 状态码：400 表7 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码：401 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码：403 表9 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码：500 表10 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 参数解释: 发送的实体的MIME类型。 约束限制: 不涉及。 取值范围: 最小字符数量为1，最大为64。 默认取值: 默认使用application/json; charset=UTF-8。 X-Auth-Token 否 String 参数解释: 用户Token。 约束限制: 不涉及。 取值范围: 最小字符数量为1，最大为16384。 默认取值: 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 namespace 是 String 参数解释： 查询服务的命名空间，各服务命名空间请参考“服务命名空间”。 约束限制： 不涉及。 取值范围： 格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。字符串的长度必须在 3 到 32个字符之间。 默认取值： 不涉及。 metric_name 是 String 参数解释： 资源的监控指标名称，各服务的指标名称可查看：“服务指标名称”。 约束限制： 不涉及。 取值范围： 必须以字母开头，只能包含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分钟内。 取值范围: 最小值为0。 默认取值: 不涉及。 to 否 Long 参数解释: 查询监控数据的结束时间，格式为时间戳, 单位毫秒。 约束限制: from必须小于to, to和from的时间间隔必须在5分钟内。 取值范围: 最小值为0。 默认取值: 不涉及。 limit 否 Integer 参数解释: 分页大小。 约束限制: 不涉及。 取值范围: 最小值为1，最大值为1000。 默认取值: 100。 offset 否 Integer 参数解释: 分页偏移量。 约束限制: 不涉及。 取值范围: 最小值为0，最大值为9999999。 默认取值: 0。

URI POST /v2/{project_id}/batch-query-metric-data 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见“获取项目ID”。 约束限制: 不涉及。 取值范围: 字符串的长度必须在 1 到 64个字符之间。 默认取值: 不涉及。

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

响应消息 响应参数 表3 响应参数 名称 参数类型 说明 metrics Array of objects 参数解释： 指标对象列表。 详细参数请参见表4。 meta_data Object 参数解释： 查询结果元数据信息，包括分页信息等。 详细参数请参见表6。 表4 metrics字段数据结构说明 名称 参数类型 说明 namespace String 参数解释： 指标所属命名空间。 取值范围： 不涉及。 dimensions Array of objects 参数解释： 指标维度列表。 详细参数请参见表5。 metric_name String 参数解释： 指标名称，如cpu_util。 取值范围： 不涉及。 unit String 参数解释： 指标单位。 取值范围： 不涉及。 表5 dimensions字段数据结构说明 名称 参数类型 说明 name String 参数解释： 监控维度名称，例如弹性云服务器的维度为instance_id。各服务维度请参考支持监控的服务列表，可参考维度中key字段。 取值范围： 不涉及。 value String 参数解释： 维度取值，例如弹性云服务器的ID。 取值范围： 不涉及。 表6 meta_data字段数据结构说明 名称 参数类型 说明 count Integer 参数解释： 当前返回结果条数。 取值范围： 不涉及。 marker String 参数解释： 下一个开始的标记，用于分页。 如本次查询10条数据，第十条为cpu_util，下次start配置为cpu_util可从该指标开始查询。 取值范围： 不涉及。 total Integer 参数解释： 指标总条数。 取值范围： 不涉及。 响应样例 { "metrics": [ { "namespace": "SYS.ECS", "dimensions": [ { "name": "instance_id", "value": "d9112af5-6913-4f3b-bd0a-3f96711e004d" } ], "metric_name": "cpu_util", "unit": "%" } ], "meta_data": { "count": 1, "marker": "SYS.ECS.cpu_util.instance_id:d9112af5-6913-4f3b-bd0a-3f96711e004d", "total": 7 } }

URI GET /V1.0/{project_id}/metrics 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见获取项目ID。 约束限制： 不涉及。 取值范围： 字符串长度在1 ~64 之间。 默认取值： 不涉及。 表2 查询检索参数说明 名称 是否必选 参数类型 说明 namespace 否 String 参数解释： 服务指标命名空间。各服务命名空间请参考支持监控的服务列表。 约束限制： 不涉及 取值范围： 格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_，其中service不能为“SYS”、“AGT”和“SRE”，namespace不能为SERVICE.BMS，因为此namespace已被系统使用。总长度最短为3，最大为32。如：弹性云服务器的命名空间为SYS.ECS，文档数据库的命名空间为SYS.DDS。 默认取值： 不涉及。 metric_name 否 String 参数解释： 指标ID，例如弹性云服务器的监控指标CPU使用率，对应的metric_name为cpu_util。各服务监控指标请参考支持监控的服务列表。 约束限制： 不涉及。 取值范围： 必须以字母开头，只能包含0-9/a-z/A-Z/_/-；如：弹性云服务器中的监控指标cpu_util，表示弹性服务器的CPU使用率；文档数据库中的指标mongo001_command_ps，表示command执行频率。字符长度最短为1，最大为96。 默认取值： 不涉及。 dim 否 String 参数解释： 指标的维度。若指标的维度存在层级关系，需要使用多层级维度方式进行查询。 约束限制： 目前最大支持4个层级维度，维度编号从0开始，编号3为最深层级。 取值范围： 维度格式为dim.{i}=key,value，key的最大长度32，value的最大长度为256。 CloudTable仅支持多层级维度查询。 以下维度说明仅为示例，具体是否支持多维度请参见各服务中监控指标说明中的维度说明。 单层级维度：如弹性云服务器的CPU使用率（cpu_util），其维度为instance_id，且instance_id为0层，维度信息代入方式如下： dim.0=instance_id,i-1234 多层级维度：如弹性云服务器的(Agent) 磁盘读速率（disk_agt_read_bytes_rate）维度为disk，disk上层维度为instance_id。instance_id为0层，disk为1层，其维度信息代入方式如下： dim.0=instance_id,i-12345&dim.1=disk,i-1234 默认取值： 不涉及。 start 否 String 参数解释： 分页起始值。 约束限制： 不涉及。 取值范围： 格式为：namespace.metric_name.key:value 例如：start=SYS.ECS.cpu_util.instance_id:d9112af5-6913-4f3b-bd0a-3f96711e004d 默认取值： 不涉及。 limit 否 Integer 参数解释： 单次查询的条数限制，用于限制结果数据条数。 约束限制： 不涉及。 取值范围： [1, 1000] 默认取值： 1000 order 否 String 参数解释： 用于标识结果排序方法，按时间戳排序。 约束限制： 不涉及。 取值范围： 只能是asc或者desc。 asc为升序 desc为降序 默认取值： asc 请求样例 请求样例一：查询当前可监控所有指标列表。 GET https://{ 云监控 的终端节点}/V1.0/{project_id}/metrics 请求样例二：查询弹性云服务器ID为6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d的监控指标CPU使用率，结果按时间戳降序保留10条数据。 GET https://{云监控的终端节点}/V1.0/{project_id}/metrics?namespace=SYS.ECS&metric_name=cpu_util&dim.0=instance_id,6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d&limit=10&order=desc

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： 用户Token。 通过调用 IAM 服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 X-Language 否 String 参数解释： 语言。 约束限制： 不涉及。 取值范围： zh-cn en-us 默认取值： en-us

响应示例 { "instances" : [ { "id" : "ad8cd1440aa94a02ae4580fcbebb3143in14", "name" : "user1-v3-independent", "status" : "BUILD", "mode" : "集中式版", "engine_name" : " GaussDB ", "engine_version" : "8.0.92", "solution" : "1主2备", "disk_used_size" : 1.05, "disk_total_size" : 160, "disk_usage" : 0.62, "p80" : 342, "p95" : 501, "deadlocks" : 0, "buffer_hit_ratio" : 0, "nodes" : [ { "id" : "6b7616dfb1c14721b1a11dd5654c1515no14", "name" : "DataNode1", "role":"master", "component_ids" : [ "dn_6001", "dn_6002" ] } ] } ], "total_count" : 100 }

URI GET /v3/{project_id}/instances/metric-data 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 参数解释： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。例如：该参数指定为1，limit指定为10，则只展示第2~11条数据。 约束限制： 不涉及。 取值范围： [0, 2^31-1] 默认取值: 默认为0（偏移0条数据，表示从第一条数据开始查询）。 limit 否 Integer 参数解释： 查询记录数。例如该参数设定为10，则查询结果最多只显示10条记录。 约束限制： 不涉及。 取值范围： [1, 50] 默认取值: 默认为50。 name 否 String 参数解释： 实例名称。 用于表示实例的名称，同一租户下，同类型的实例名可重名。 约束限制： 不涉及。 取值范围： 4~64个字符之间，必须以字母开头，区分大小写，可以包含字母、数字、中划线或者下划线，不能包含其他的特殊字符。 默认取值: 不涉及。 instance_id 否 String 参数解释： 实例ID，此参数是用户创建实例的唯一标识。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为36个字符。 默认取值: 不涉及。

响应参数 表4 响应Body参数 参数 参数类型 描述 instances Array of InstancesMetricResult objects 参数解释： 实例信息。详情请参见 表5 。 total_count Integer 参数解释： 总记录数。 取值范围： 不涉及。 表5 InstancesMetricResult字段数据结构说明 参数 参数类型 描述 id String 参数解释： 实例ID。 取值范围： 不涉及。 name String 参数解释： 实例名称。 取值范围： 不涉及。 status String 参数解释： 实例状态。 取值范围： creating：实例正在创建。 normal：实例正常。 abnormal：实例异常。 createfail：实例创建失败。 mode String 参数解释： 实例类型。 取值范围： 不涉及。 engine_name String 参数解释： 引擎名称。 取值范围： 不涉及。 engine_version String 参数解释： 引擎版本。 取值范围： 不涉及。 solution String 参数解释： 部署形态。 取值范围： 不涉及。 disk_used_size String 参数解释： 实例数据磁盘已使用大小。 取值范围： 不涉及。 disk_total_size String 参数解释： 实例数据磁盘总大小。 取值范围： 不涉及。 disk_usage String 参数解释： 实例数据磁盘已使用百分比。 取值范围： 不涉及。 p80 String 参数解释： 80% SQL的响应时间。 取值范围： 不涉及。 p95 String 参数解释： 95% SQL的响应时间。 取值范围： 不涉及。 deadlocks String 参数解释： 死锁次数。 取值范围： 不涉及。 buffer_hit_ratio String 参数解释： buffer 命中率。 取值范围： 不涉及。 nodes Array of InstancesNodesResult objects 参数解释： 实例节点信息列表。详情请参见 表6 。 表6 InstancesNodesResult字段数据结构说明 参数 参数类型 描述 id String 参数解释： 节点ID。 取值范围： 不涉及。 name String 参数解释： 节点名称。 取值范围： 不涉及。 role String 参数解释： 节点角色。 取值范围： master：主节点。 slave：备节点。 secondary：日志节点。 readreplica：只读节点。 component_ids Array of Strings 参数解释： 组件ID列表。