文档首页/ 云监控服务 CES/ API参考/ API/ 资源分组/ 资源分组管理/ 查询资源分组列表 - ListResourceGroups
更新时间：2026-01-05 GMT+08:00
查看PDF
分享

查询资源分组列表 - ListResourceGroups

功能介绍

查询资源分组列表

调试

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

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    ces:resourceGroups:list

    List

    -

    g:EnterpriseProjectId

    ces:resourceGroups:get

    -

URI

GET /v2/{project_id}/resource-groups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

参数解释:

归属企业项目ID。

约束限制:

不涉及。

取值范围:

只能包含小写字母、数字、“-”、“_”，长度为36个字符。或者为0（代表默认企业项目ID），或者为all_granted_eps（代表所有企业项目ID）。

默认取值:

不涉及。

group_name

否

String

参数解释

资源分组名称，支持模糊查询。

约束限制

不涉及。

取值范围

包含字母、数字、_、-或汉字，长度为[1,128]个字符。

默认取值

不涉及。

group_id

否

String

参数解释

资源分组ID。

约束限制

不涉及。

取值范围

以"rg"开头，后跟22位由字母或数字组成的字符串。

默认取值

不涉及。

offset

否

Integer

参数解释

分页起始值。

约束限制

不涉及。

取值范围

在[0,10000]区间内。

默认取值

0

limit

否

Integer

参数解释

分页查询时每页的条目数。

约束限制

不涉及。

取值范围

在[1,100]区间内。

默认取值

100

type

否

String

参数解释

资源分组添加资源方式，不传代表查询所有资源分组类型。

约束限制

不涉及。

取值范围

  • EPS: 表示匹配企业项目

  • TAG: 表示匹配标签

  • Manual: 表示手动添加

  • COMB: 表示组合匹配

  • NAME: 表示匹配实例名称

默认取值

不涉及。

status

否

String

参数解释

资源分组健康状态。

约束限制

不涉及。

取值范围

  • health: 表示无告警

  • unhealthy: 表示告警中

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

默认取值

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

count

Integer

参数解释

资源分组总数。

取值范围

在[0,1000]区间内。

resource_groups

Array of OneResourceGroupResp objects

参数解释

资源分组列表。
表5 OneResourceGroupResp

参数

参数类型

描述

group_name

String

参数解释

资源分组的名称。

取值范围

只能为字母、数字、汉字、-或_，长度为[1,128]个字符。

group_id

String

参数解释

资源分组ID。

取值范围

以rg开头，后跟22位由字母或数字组成的字符串。

create_time

String

参数解释

资源分组的创建时间，UNIX时间戳，单位毫秒；如：1603819753000。

update_time

String

参数解释

资源分组的修改时间，UNIX时间戳，单位毫秒；如：1603819753000。

enterprise_project_id

String

参数解释

资源分组归属企业项目ID。

取值范围

只能包含小写字母、数字或-，长度为36个字符。或者为0，代表默认企业项目ID。

type

String

参数解释

资源分组添加资源方式。

取值范围

  • EPS: 表示匹配企业项目

  • TAG: 表示匹配标签

  • Manual: 表示手动添加

  • COMB: 表示组合匹配

  • NAME: 表示匹配实例名称

status

String

参数解释

资源分组指标告警状态。

取值范围

  • health: 表示无告警

  • unhealthy: 表示告警中

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

event_status

String

参数解释

资源分组事件告警状态。

取值范围

  • health: 表示无告警

  • unhealthy: 表示告警中

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

resource_statistics

resource_statistics object

参数解释

资源分组中的资源信息统计。

related_ep_ids

Array of strings

参数解释

当资源匹配规则为匹配企业项目时，指定的企业项目列表。

association_alarm_templates

Array of AssociationAlarmTemplate objects

参数解释

关联的告警模板列表。

resource_level

String

参数解释

资源层级，资源生效范围。

取值范围

  • product: 云产品

  • dimension: 子维度
表6 resource_statistics

参数

参数类型

描述

unhealthy

Integer

参数解释

该资源分组中当前处在告警状态的资源个数。

取值范围

在[0,9999999]区间内。

total

Integer

参数解释

该资源分组中资源的总个数。

取值范围

在[0,9999999]区间内。

event_unhealthy

Integer

参数解释

该资源分组中已触发的资源个数。

取值范围

在[0,9999999]区间内。

namespaces

Integer

参数解释

该资源分组中选择的资源类型个数，如资源分组添加了弹性云服务、弹性公网IP和带宽则值为2。

取值范围

在[0,9999999]区间内。
表7 AssociationAlarmTemplate

参数

参数类型

描述

template_id

String

参数解释

告警模板ID。

取值范围

以at开头，后跟字母、数字，长度在[2,64]区间内。

template_name

String

参数解释

告警模板名称。

取值范围

以字母或汉字开头，可包含字母、数字、汉字、_、-，长度在[1,128]区间内。

状态码：400

表8 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

状态码：401

表9 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

状态码：403

表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?offset=0&limit=100

/v2/{project_id}/resource-groups?offset=0&limit=100

响应示例

状态码：200

OK

{
  "resource_groups" : [ {
    "group_name" : "group1",
    "create_time" : "2006-01-02T15:04:05.000Z",
    "update_time" : "2006-01-02T15:04:05.000Z",
    "group_id" : "rg0123456789xxxx",
    "enterprise_project_id" : "0",
    "type" : "Manual",
    "status" : "health",
    "event_status" : "no_alarm_rule",
    "resource_statistics" : {
      "event_unhealthy" : 0,
      "namespaces" : 1,
      "total" : 14,
      "unhealthy" : 0
    },
    "related_ep_ids" : [ ],
    "association_alarm_templates" : [ ],
    "resource_level" : "product"
  }, {
    "group_name" : "band",
    "type" : "EPS",
    "create_time" : "2006-01-02T15:04:05.000Z",
    "update_time" : "2006-01-02T15:04:05.000Z",
    "group_id" : "rg0123456789xxxx",
    "enterprise_project_id" : "d61d4705-5658-42f5-8e0c-70eb34d17b02",
    "status" : "health",
    "event_status" : "no_alarm_rule",
    "resource_statistics" : {
      "event_unhealthy" : 0,
      "namespaces" : 0,
      "total" : 0,
      "unhealthy" : 0
    },
    "related_ep_ids" : [ "0" ],
    "association_alarm_templates" : [ ],
    "resource_level" : "product"
  }, {
    "group_name" : "group2",
    "type" : "TAG",
    "create_time" : "2006-01-02T15:04:05.000Z",
    "update_time" : "2006-01-02T15:04:05.000Z",
    "group_id" : "rg0123456789xxxx",
    "enterprise_project_id" : "0",
    "status" : "unhealthy",
    "event_status" : "no_alarm_rule",
    "resource_statistics" : {
      "event_unhealthy" : 0,
      "namespaces" : 1,
      "total" : 14,
      "unhealthy" : 1
    },
    "related_ep_ids" : [ ],
    "association_alarm_templates" : [ {
      "template_id" : "at12321321",
      "template_name" : "templatexxx"
    } ],
    "resource_level" : "dimension"
  } ],
  "count" : 3
}

状态码

状态码

描述

200

OK

400

参数校验失败

401

未认证

403

认证鉴权失败

500

系统内部错误

错误码

请参见错误码。

父主题： 资源分组管理

相关文档