文档首页/ 云监控服务 CES/ API参考/ API V2/ 资源分组/ 查询指定资源分组详情 - ShowResourceGroup
更新时间：2025-10-29 GMT+08:00
查看PDF
分享

查询指定资源分组详情 - ShowResourceGroup

功能介绍

查询指定资源分组详情

调试

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

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    ces:resourceGroups:get

    Read

    -

    g:EnterpriseProjectId

    -

    -

URI

GET /v2/{project_id}/resource-groups/{group_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

group_id

是

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

租户Token

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

group_name

String

资源分组的名称

group_id

String

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

create_time

String

资源分组的创建时间

enterprise_project_id

String

资源分组归属企业项目ID

type

String

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

association_ep_ids

Array of strings

该资源分组内包含的资源来源的企业项目ID，type为EPS时必传

tags

Array of ResourceGroupTagRelation objects

当资源匹配规则为匹配标签时,所指定的标签规则

instances

Array of Instance objects

实例名称匹配参数

comb_relation

CombRelation object

参数解释

组合匹配参数。

约束限制

不涉及。

related_ep_ids

Array of strings

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

enterprise_project_id_and_tags

Array of EnterpriseProjectIdAndTags objects

匹配企业项目或匹配标签参数

status

String

指标告警状态，取值为health（告警中）、unhealthy（已触发）、no_alarm_rule（未设置告警规则）

event_status

String

事件告警状态，取值为health（告警中）、unhealthy（已触发）、no_alarm_rule（未设置告警规则）

resource_statistics

resource_statistics object

资源数量统计信息

resource_level

String

dimension: 子维度,product: 云产品

product_names

String

创建资源层级为云产品时的云产品的取值，一般由"服务命名空间,服务首层维度名称"组成，如"SYS.ECS,instance_id"。多个云产品则用“;”隔开，如"SERVICE.BMS,instance_id;SYS.ECS,instance_id"。

ep_resource_statistics

Array of EpResourceStatistics objects

每个企业项目关联的资源状态
表4 ResourceGroupTagRelation

参数

参数类型

描述

key

String

参数解释

TMS标签键规范

约束限制

不涉及

取值范围

长度为[1,128]个字符

默认取值

不涉及

operator

String

参数解释

tag操作符，含义是标签key与value的关系

约束限制

不涉及

取值范围

  • include: 表示包含

  • prefix: 表示前缀

  • suffix: 表示后缀

  • notInclude: 表示不包含

  • equal: 表示相等，当operator为equal，value为空字符串时表示为全部

  • all: 表示全部

默认取值

不涉及

value

String

参数解释

TMS标签值规范

约束限制

不涉及

取值范围

长度为[0，255]个字符

默认取值

不涉及
表5 Instance

参数

参数类型

描述

product_name

String

参数解释

云产品名称

约束限制

不涉及

取值范围

长度为[1,16]个字符

默认取值

不涉及

logical_operator

String

参数解释

逻辑运算符

约束限制

不涉及

取值范围

  • ALL: 所有条件匹配成功

  • ANY: 任意条件匹配成功

默认取值

不涉及

instance_names

Array of ResourceNameItem objects

参数解释

资源名称匹配参数数组

约束限制

不超过10个名称
表6 ResourceNameItem

参数

参数类型

描述

resource_name

String

参数解释

资源名称条件值

约束限制

不涉及

取值范围

长度[0,128]个字符

默认取值

不涉及

operator

String

参数解释

实例操作符，含义是真实资源的名称与资源名称条件值的运算关系。

约束限制

不涉及

取值范围

  • include: 表示包含

  • prefix: 表示前缀

  • suffix: 表示后缀

  • notInclude: 表示不包含

  • equal: 表示相等

  • all: 表示全部

默认取值

不涉及

resource_name_is_ignore_case

Boolean

参数解释

资源名称忽略大小写

约束限制

不涉及

取值范围

  • true: 名称忽略大小写

  • false: 名称不忽略大小写

默认取值

false
表7 CombRelation

参数

参数类型

描述

logical_operator

String

参数解释

逻辑运算符。

约束限制

不涉及。

取值范围

  • ALL: 所有条件匹配成功。

  • ANY: 任意条件匹配成功。

默认取值

不涉及。

conditions

Array of Condition objects

参数解释

组合匹配资源分组的匹配条件。

约束限制

不超过50个条件。
表8 Condition

参数

参数类型

描述

enterprise_project_id

String

参数解释

企业项目ID

约束限制

不涉及

取值范围

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

默认取值

不涉及

instance_name

CombResourceName object

资源名称匹配规则

tag

ResourceGroupTagRelation object

参数解释

标签的匹配规则

约束限制

不涉及
表9 CombResourceName

参数

参数类型

描述

resource_name

String

参数解释

资源名称条件值

约束限制

不涉及

取值范围

长度[1,128]个字符

默认取值

不涉及

operator

String

参数解释

实例操作符，含义是真实资源的名称与资源名称条件值的运算关系。

约束限制

不涉及

取值范围

  • include: 表示包含

  • prefix: 表示前缀

  • suffix: 表示后缀

  • notInclude: 表示不包含

  • equal: 表示相等

默认取值

不涉及

resource_name_is_ignore_case

Boolean

参数解释

资源名称忽略大小写

约束限制

不涉及

取值范围

  • true: 名称忽略大小写

  • false: 名称不忽略大小写

默认取值

false
表10 EnterpriseProjectIdAndTags

参数

参数类型

描述

enterprise_project_id

String

参数解释

企业项目ID

约束限制

不涉及

取值范围

由字母、数字、_和-组成，长度为[1,128]个字符

默认取值

不涉及

tag

ResourceGroupTagRelation object

参数解释

标签的匹配规则

约束限制

不涉及
表11 resource_statistics

参数

参数类型

描述

unhealthy

Integer

告警中的资源数

total

Integer

资源总数

event_unhealthy

Integer

已触发的资源数

namespaces

Integer

资源类型数
表12 EpResourceStatistics

参数

参数类型

描述

extend_relation_id

String

企业项目ID

unhealthy

Integer

告警中的资源数

total

Integer

资源总数

event_unhealthy

Integer

已触发的资源数

namespaces

Integer

资源类型数

状态码：400

表13 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

状态码：401

表14 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

状态码：403

表15 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

状态码：404

表16 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

状态码：500

表17 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

请求示例

查询指定资源分组详情

/v2/{project_id}/resource-groups/{group_id}

响应示例

状态码：200

OK

{
  "group_name" : "band",
  "type" : "TAG",
  "tags" : [ {
    "key" : "Resource",
    "value" : "VPC"
  }, {
    "key" : "Usage",
    "value" : "Tmp"
  } ],
  "create_time" : "2006-01-02T15:04:05.000Z",
  "group_id" : "rg0123456789xxxx",
  "enterprise_project_id" : "0"
}

状态码

状态码

描述

200

OK

400

参数校验失败

401

未认证

403

认证鉴权失败

404

资源不存在

500

系统内部错误

错误码

请参见错误码。

父主题： 资源分组