文档首页/ 云监控服务 CES/ API参考/ API/ 资源分组/ 资源分组管理/ 查询资源分组下的资源
更新时间：2025-09-23 GMT+08:00
查看PDF
分享

查询资源分组下的资源

功能介绍

根据资源分组ID查询资源分组下的资源。

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

group_id

是

String

参数解释

资源分组ID。

约束限制

不涉及

取值范围

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

默认取值

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

status

否

String

参数解释

资源分组健康状态

约束限制

不涉及

取值范围

  • health: 表示健康

  • unhealth: 表示不健康

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

默认取值

不涉及

namespace

否

String

参数解释

资源类型，即命名空间，如弹性云服务器的资源命名空间为：SYS.ECS；各服务命名空间可查看：“服务命名空间”。

约束限制

不涉及

取值范围

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

默认取值

不涉及

dname

否

String

参数解释

资源维度，如：弹性云服务器，则维度为instance_id，各资源的监控维度名称可查看：“服务指标维度”。

约束限制

不涉及

取值范围

包含字母、数字、_、-、/、#、\或括号，长度为[1,131]个字符

默认取值

不涉及

start

否

String

参数解释

分页起始值

约束限制

不涉及

取值范围

[0,9999999]

默认取值

0

limit

否

String

参数解释

单次查询的条数限制

约束限制

不涉及

取值范围

[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参数

参数

参数类型

描述

group_name

String

参数解释

资源分组的名称

约束限制

不涉及

取值范围

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

默认取值

不涉及

group_id

String

参数解释：

资源分组ID

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

resources

Array of ResourceGroup objects

参数解释

创建的资源分组选择一个或者多个资源。

约束限制

不超过1000个资源。

status

String

参数解释

资源分组健康状态

约束限制

不涉及

取值范围

  • health: 表示健康

  • unhealth: 表示不健康

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

默认取值

不涉及

create_time

Long

参数解释：

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

约束限制：

不涉及。

取值范围：

在[1,9223372036854775807]区间内

默认取值：

不涉及。

meta_data

MetaData object

查询结果元数据信息，包括分页信息等。

enterprise_project_id

String

参数解释：

创建资源分组时关联的企业项目，默认值为0，表示企业项目为default。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。
表5 ResourceGroup

参数

参数类型

描述

namespace

String

参数解释

资源类型。即命名空间，如弹性云服务器的资源命名空间为：SYS.ECS；各服务的命名空间可查看：“服务命名空间”。

约束限制

不涉及

取值范围

格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。

默认取值

不涉及

dimensions

Array of MetricsDimension objects

参数解释

资源的维度信息

约束限制

不超过4个维度

status

String

参数解释

资源分组健康状态

约束限制

不涉及

取值范围

  • health: 表示健康

  • unhealth: 表示不健康

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

默认取值

不涉及

event_type

Integer

事件类型，默认为0。
表6 MetricsDimension

参数

参数类型

描述

name

String

参数解释

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

约束限制

不涉及

取值范围

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

默认取值

不涉及

value

String

参数解释

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

约束限制

不涉及

取值范围

长度为[1,256]个字符

默认取值

不涉及
表7 MetaData

参数

参数类型

描述

count

Integer

参数解释：

当前返回结果条数。

约束限制：

不涉及。

取值范围：

在[0,2147483647]区间内

默认取值：

不涉及。

total

Integer

参数解释：

总条数。

约束限制：

不涉及。

取值范围：

在[0,2147483647]区间内

默认取值：

不涉及。

marker

String

参数解释：

下一个开始的标记，用于分页。

约束限制：

不涉及。

取值范围：

长度为[1,9999]个数字

默认取值：

不涉及。

状态码：400

表8 响应Body参数

参数

参数类型

描述

-

String

请求错误。

状态码：401

表9 响应Body参数

参数

参数类型

描述

-

String

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

状态码：403

表10 响应Body参数

参数

参数类型

描述

-

String

请求页面被禁止访问。

状态码：408

表11 响应Body参数

参数

参数类型

描述

-

String

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

状态码：429

表12 响应Body参数

参数

参数类型

描述

-

String

前请求过多。

状态码：500

表13 响应Body参数

参数

参数类型

描述

-

String

请求未完成，服务异常。

状态码：503

表14 响应Body参数

参数

参数类型

描述

-

String

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

请求示例

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

响应示例

状态码：200

OK

{
  "group_name" : "ResourceGroup-Test-01",
  "resources" : [ {
    "namespace" : "SYS.ECS",
    "dimensions" : [ {
      "name" : "instance_id",
      "value" : "6cffb0bd-fd37-400f-ae6f-8f4be021ff7e"
    } ],
    "status" : "health",
    "event_type" : 0
  }, {
    "namespace" : "SYS.ECS",
    "dimensions" : [ {
      "name" : "instance_id",
      "value" : "e37d6238-9dd3-4720-abcc-eb9f8fb08ca0"
    } ],
    "status" : "health",
    "event_type" : 0
  } ],
  "create_time" : 1604476378000,
  "group_id" : "rg16044763786104XvXvl00a",
  "status" : "health",
  "meta_data" : {
    "count" : 0,
    "marker" : "",
    "total" : 2
  },
  "enterprise_project_id" : "0"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

408

Request Timeout

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

错误码

请参见错误码。

父主题： 资源分组管理

相关文档