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

查询所有资源分组 - ListResourceGroup

功能介绍

查询所创建的所有资源分组。

调试

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

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    ces:resourceGroups:list

    List

    -

    g:EnterpriseProjectId

    ces:resourceGroups:get

    -

URI

GET /V1.0/{project_id}/resource-groups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

长度为[1,64]个字符。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

group_name

否

String

参数解释

资源分组名称。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

group_id

否

String

参数解释

资源分组ID。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

status

否

String

参数解释

资源分组健康状态。

约束限制

不涉及。

取值范围

  • health: 表示无告警

  • unhealth: 表示告警中

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

默认取值

不涉及。

start

否

Integer

参数解释

分页起始值。

约束限制

不涉及。

取值范围

在[0,9999999]区间内。

默认取值

0

limit

否

Integer

参数解释

单次查询的条数限制。

约束限制

不涉及。

取值范围

在[1,100]区间内。

默认取值

100

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

否

String

参数解释:

发送的实体的MIME类型。

约束限制:

不涉及。

取值范围:

长度为[1,64]个字符。

默认取值:

默认使用 application/json; charset=UTF-8，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。

X-Auth-Token

否

String

参数解释:

用户Token。

约束限制:

不涉及。

取值范围:

长度为[1,16384]个字符。

默认取值:

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

resource_groups

Array of ResourceGroupInfo objects

参数解释：

一个或者多个资源分组信息。

meta_data

TotalMetaData object

参数解释：

查询结果元数据统计个数。

表5 ResourceGroupInfo

参数

参数类型

描述

group_name

String

参数解释

资源分组名称。

取值范围

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

type

String

参数解释

资源添加/匹配方式。

取值范围

取值只能为EPS（匹配企业项目），TAG（匹配标签），NAME（匹配实例名称），COMB（组合匹配），Manual/空值（手动添加）。

relation_ids

Array of strings

参数解释

企业项目ID列表。

group_id

String

参数解释：

资源分组ID。

取值范围：

以rg开头，后跟22位由字母或数字组成的字符串。长度为[2,24]个字符。

create_time

Long

参数解释

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

取值范围

在[0,9223372036854775807]区间内

instance_statistics

InstanceStatistics object

参数解释：

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

status

String

参数解释

资源分组健康状态

取值范围

  • health: 表示无告警

  • unhealth: 表示告警中

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

enterprise_project_id

String

参数解释

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

取值范围

由数字、字母和-组成，或者为0（默认企业项目ID）。

resources

Array of Resource objects

参数解释

一组或者多个资源信息，默认为空。

表6 InstanceStatistics

参数

参数类型

描述

unhealth

Integer

参数解释：

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

取值范围：

在[0,2147483647]区间内。

total

Integer

参数解释：

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

取值范围：

在[0,2147483647]区间内。

type_statistics

Integer

参数解释：

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

取值范围：

在[0,2147483647]区间内。

表7 Resource

参数

参数类型

描述

relation_id

String

参数解释：

告警规则的ID或者资源分组ID。

取值范围：

不涉及

namespace

String

参数解释：

服务指标命名空间。

取值范围：

不涉及

dimensions

Array of DimensionResp objects

参数解释

指标维度信息

status

String

参数解释

资源健康状态

取值范围

  • health: 表示无告警

  • unhealth: 表示告警中

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

表8 DimensionResp

参数

参数类型

描述

name

String

参数解释：

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

取值范围：

以字母开头，只能包含字母、数字、“_”、“-”。长度[1,32]个字符。

value

String

参数解释：

监控维度取值，例如ECS的ID。

取值范围：

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

表9 TotalMetaData

参数

参数类型

描述

total

Integer

参数解释：

总条数。

取值范围：

在[0,2147483647]区间内。

状态码：400

表10 响应Body参数

参数

参数类型

描述

-

String

请求错误。

状态码：401

表11 响应Body参数

参数

参数类型

描述

-

String

未提供认证信息，或认证信息错误。

状态码：403

表12 响应Body参数

参数

参数类型

描述

-

String

请求页面被禁止访问。

状态码：408

表13 响应Body参数

参数

参数类型

描述

-

String

请求超出了服务器的等待时间。

状态码：429

表14 响应Body参数

参数

参数类型

描述

-

String

请求过多。

状态码：500

表15 响应Body参数

参数

参数类型

描述

-

String

请求未完成，服务异常。

状态码：503

表16 响应Body参数

参数

参数类型

描述

-

String

系统暂时不可用，请求受限。

请求示例

/V1.0/{project_id}/resource-groups?start=0&limit=10

响应示例

状态码：200

OK

{
  "resource_groups" : [ {
    "group_name" : "ResourceGroup-Test01",
    "type" : "TAG",
    "relation_ids" : [ "0" ],
    "resources" : [ ],
    "create_time" : 1606374365000,
    "group_id" : "rg16063743652226ew93e64p",
    "instance_statistics" : {
      "unhealth" : 2,
      "total" : 10,
      "type_statistics" : 1
    },
    "status" : "unhealth",
    "enterprise_project_id" : "0"
  }, {
    "group_name" : "RS",
    "type" : "TAG",
    "relation_ids" : [ "0" ],
    "resources" : [ ],
    "create_time" : 1606327955000,
    "group_id" : "rg1606327955657LRj1lrE4y",
    "instance_statistics" : {
      "unhealth" : 0,
      "total" : 2,
      "type_statistics" : 1
    },
    "status" : "no_alarm_rule",
    "enterprise_project_id" : "0"
  }, {
    "group_name" : "RS",
    "type" : "TAG",
    "relation_ids" : [ "0" ],
    "resources" : [ ],
    "create_time" : 1606327947000,
    "group_id" : "rg1606327947514v9OWqAD3N",
    "instance_statistics" : {
      "unhealth" : 0,
      "total" : 2,
      "type_statistics" : 1
    },
    "status" : "no_alarm_rule",
    "enterprise_project_id" : "0"
  }, {
    "group_name" : "RS",
    "type" : "TAG",
    "relation_ids" : [ "0" ],
    "resources" : [ ],
    "create_time" : 1606327946000,
    "group_id" : "rg1606327946625PYogr059N",
    "instance_statistics" : {
      "unhealth" : 0,
      "total" : 2,
      "type_statistics" : 1
    },
    "status" : "no_alarm_rule",
    "enterprise_project_id" : "0"
  }, {
    "group_name" : "ResourceGroupCorrect_2",
    "type" : "TAG",
    "relation_ids" : [ "0" ],
    "resources" : [ ],
    "create_time" : 1606325669000,
    "group_id" : "rg1606325669900Rk4eKkLMZ",
    "instance_statistics" : {
      "unhealth" : 0,
      "total" : 1,
      "type_statistics" : 1
    },
    "status" : "no_alarm_rule",
    "enterprise_project_id" : "0"
  } ],
  "meta_data" : {
    "total" : 5
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

408

Request Timeout

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

错误码

请参见错误码。

父主题：资源分组管理

相关文档