文档首页/ 云监控服务 CES/ API参考/ API V2/ 资源分组关联资源/ 查询资源分组下指定服务类别特定维度的资源列表
更新时间：2024-12-26 GMT+08:00
查看PDF
分享

查询资源分组下指定服务类别特定维度的资源列表

功能介绍

查询资源分组下指定服务类别特定维度的资源列表

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/resource-groups/{group_id}/services/{service}/resources

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户ID

最小长度：1

最大长度：64

group_id

是

String

资源分组ID，以rg开头，后跟22位由字母或数字组成的字符串

最小长度：2

最大长度：24

service

是

String

服务类别，如SYS.ECS

最小长度：3

最大长度：32
表2 Query参数

参数

是否必选

参数类型

描述

dim_name

否

String

资源维度信息，多个维度按字母序使用逗号分割

最小长度：1

最大长度：131

limit

否

String

分页查询时每页的条目数，取值[1,100]，默认值为100

最小长度：1

最大长度：100

offset

否

Integer

分页查询时查询的起始位置，表示从第几条数据开始，默认为0

最小值：0

最大值：10000

status

否

String

按状态信息进行过滤，取值只能为health（已设置告警规则且无告警触发的资源）、unhealthy（已设置告警规则且有告警触发的资源）、no_alarm_rule（未设置告警规则的资源）

枚举值：

  • health

  • unhealthy

  • no_alarm_rule

dim_value

否

String

资源维度值，不支持模糊匹配，但是多维度资源可以只指定一个维度值

最小长度：1

最大长度：1027

tag

否

String

资源的标签信息，格式："[key]":"[value]"，样例参考："ssss":"1111"

最小长度：0

最大长度：500

extend_relation_id

否

String

企业项目ID

最小长度：0

最大长度：128

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

租户Token

最小长度：1

最大长度：16384

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

count

Integer

资源总数

最小值：0

最大值：10000

resources

Array of GetResourceGroupResources objects

资源分组资源列表

数组长度：0 - 100
表5 GetResourceGroupResources

参数

参数类型

描述

status

String

资源健康状态，取值为health（已设置告警规则且无告警触发的资源）、unhealthy（已设置告警规则且有告警触发的资源）、no_alarm_rule（未关联告警规则）

枚举值：

  • health

  • unhealthy

  • no_alarm_rule

dimensions

Array of Dimension objects

资源的维度信息

数组长度：1 - 4
表6 Dimension

参数

参数类型

描述

name

String

资源维度，如：弹性云服务器，则维度为instance_id；目前最大支持4个维度，各服务资源的指标维度名称可查看：“服务指标维度”。

正则匹配：^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$

value

String

资源维度值，为资源的实例ID，如：4270ff17-aba3-4138-89fa-820594c39755。

正则匹配：^((([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-|\.)*)|\*){1,256}$

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度：0

最大长度：256

error_msg

String

请求异常信息

最小长度：0

最大长度：256

request_id

String

请求ID

最小长度：0

最大长度：256

状态码： 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度：0

最大长度：256

error_msg

String

请求异常信息

最小长度：0

最大长度：256

request_id

String

请求ID

最小长度：0

最大长度：256

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度：0

最大长度：256

error_msg

String

请求异常信息

最小长度：0

最大长度：256

request_id

String

请求ID

最小长度：0

最大长度：256

状态码： 404

表10 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度：0

最大长度：256

error_msg

String

请求异常信息

最小长度：0

最大长度：256

request_id

String

请求ID

最小长度：0

最大长度：256

状态码： 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度：0

最大长度：256

error_msg

String

请求异常信息

最小长度：0

最大长度：256

request_id

String

请求ID

最小长度：0

最大长度：256

请求示例

查询资源分组下指定服务类别特定维度的资源列表

'/v2/{project_id}/resource-groups/{group_id}/services/{service}/resources'

响应示例

状态码： 200

OK

{
  "count" : 1000,
  "resources" : [ {
    "status" : "health",
    "dimensions" : [ {
      "name" : "instance_id",
      "value" : "4270ff17-aba3-4138-89fa-820594c39755"
    } ]
  } ]
}

状态码

状态码

描述

200

OK

400

参数校验失败

401

未认证

403

认证鉴权失败

404

资源不存在

500

系统内部错误

错误码

请参见错误码。