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

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

功能介绍

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

调试

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

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    ces:resourceGroups:getServiceResources

    Read

    -

    g:EnterpriseProjectId

    ces:resourceGroups:get

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID。用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取方式请参见获取项目ID

约束限制:

不涉及。

取值范围:

字符串的长度必须在 1 到 64个字符之间。

默认取值:

不涉及。

group_id

String

参数解释

资源分组ID。

约束限制

不涉及

取值范围

以"rg"开头,后面跟着22个字母或数字

默认取值

不涉及

service

String

参数解释

服务类别,如SYS.ECS

约束限制

不涉及

取值范围

格式为service.item;service和item必须是字符串,必须以字母开头,只能包含0-9/a-z/A-Z/_。字符串的长度在 [3,32]个字符之间

默认取值

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

参数解释

分页偏移量

约束限制

不涉及

取值范围

整数,[0,10000]

默认取值

0

limit

String

参数解释

分页大小。

约束限制

不涉及。

取值范围

大小为1-100。

默认取值

不涉及。

dim_name

String

参数解释

资源维度。

约束限制

不涉及。

取值范围

多维度用","分隔,只能包含0-9、a-z、A-Z、_、-、#、/、(、),每个维度的最大长度为32。字符串总长度最小为1,最大为131。

默认取值

不涉及。

status

String

参数解释

告警规则按状态信息进行过滤。

约束限制

不涉及。

取值范围

枚举值。

  • health: 已设置告警规则且无告警触发的资源

  • unhealthy: 已设置告警规则且有告警触发的资源

  • no_alarm_rule: 未设置告警规则的资源

默认取值

不涉及。

dim_value

String

参数解释

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

约束限制

不涉及。

取值范围

字符串长度范围[1,1027]

默认取值

不涉及。

tag

String

参数解释

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

约束限制

不涉及。

取值范围

字符串长度范围[0,500]

默认取值

不涉及。

extend_relation_id

String

参数解释

企业项目ID。

约束限制

不涉及。

取值范围

由数字、字母和-组成,字符串长度范围[1,128]

默认取值

不涉及。

product_name

String

参数解释

资源所属的云产品名称,一般由"服务命名空间,服务首层维度名称"组成,如"SYS.ECS,instance_id"。

约束限制

不涉及。

取值范围

长度为[0,128]个字符。

默认取值

不涉及。

resource_name

String

参数解释

资源名称

约束限制

不涉及

取值范围

长度[1,128]个字符

默认取值

不涉及

event_status

String

参数解释

按事件告警状态信息进行过滤。

约束限制

不涉及。

取值范围

枚举值。

  • health: 已设置事件告警规则且无事件告警触发的资源

  • unhealthy: 已设置事件告警规则且有事件告警触发的资源

  • no_alarm_rule: 未设置事件告警规则的资源

默认取值

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

约束限制:

不涉及。

取值范围:

最小字符数量为1,最大为16384。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

count

Integer

参数解释

资源总数。

取值范围

0-10000

resources

Array of GetResourceGroupResources objects

资源分组资源列表

表5 GetResourceGroupResources

参数

参数类型

描述

status

String

参数解释

按事件告警状态信息进行过滤。

取值范围

枚举值。

  • health: 表示无告警

  • unhealthy: 表示告警中

  • no_alarm_rule: 表示未设置告警规则

dimensions

Array of ResourceDimension objects

资源的维度信息

tags

String

参数解释

资源的tag信息,格式为key/value的json字符串,样例为"{"sss":"aaa"}"。

取值范围

枚举值。

字符串长度[0, 10240]

enterprise_project_id

String

参数解释

企业项目ID。

取值范围

由数字、字母和-组成,字符串长度范围[1,128]

event_status

String

参数解释

按事件告警状态信息进行过滤。

取值范围

枚举值。

  • health: 表示无告警

  • unhealthy: 表示告警中

  • no_alarm_rule: 表示未设置告警规则

resource_name

String

参数解释

资源名称

取值范围

长度[0,128]个字符

表6 ResourceDimension

参数

参数类型

描述

name

String

参数解释

资源维度名称,如:弹性云服务器,则维度为instance_id;各服务资源的维度名称,请参阅具体云服务的文档。您可以直接从支持监控的服务列表页面导航至相应文档。

约束限制

不涉及

取值范围

由字母开头,后面可以包含字母、数字、_或-,长度为[1,32]个字符

默认取值

不涉及

value

String

参数解释

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

约束限制

不涉及

取值范围

长度为[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

状态码:404

表10 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

状态码:500

表11 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

请求示例

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

'/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

系统内部错误

错误码

请参见错误码

相关文档