文档首页/ 云运维中心 COC/ API参考/ API/ 应用资源管理/ 分组/ 查询分组
更新时间：2025-09-04 GMT+08:00
查看PDF
分享

查询分组

功能介绍

查询分组，查询应用/子应用/组件下的分组，统一管理资源。

若在应用下无组件，则无组件信息。

调试

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

URI

GET /v1/groups

表1 Query参数

参数

是否必选

参数类型

描述

id_list

否

Array of strings

参数解释：

分组id值组合成的分组id列表

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

component_id

否

String

参数解释：

组件id。

约束限制：

不涉及。

取值范围：

创建分组时选择的组件对应的组件id，长度24个字符。

默认取值：

不涉及。

application_id

否

String

参数解释：

应用id。

约束限制：

不涉及。

取值范围：

分组对应的组件，此组件对应的应用id，有一级一级关系。

默认取值：

不涉及。

name_like

否

String

参数解释：

分组名称模糊匹配。

约束限制：

不涉及。

取值范围：

字符串，长度1~50之间。

默认取值：

不涉及。

code

否

String

参数解释：

分组code。

约束限制：

不涉及。

取值范围：

字符串，长度在3~50之间。

默认取值：

不涉及。

marker

否

String

参数解释：

用于分页查询。

约束限制：

不涉及。

取值范围：

上一次查询的最后一条记录ID。

默认取值：

不涉及。

limit

是

Integer

参数解释：

分页查询每页显示的条目数量。

约束限制：

不涉及。

取值范围：

自定义，在1-500范围。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

data

Array of data objects

参数解释：

分组id。

取值范围：

不涉及。
表3 data

参数

参数类型

描述

id

String

参数解释：

CloudCMDB分配的uuid。

取值范围：

不涉及。

name

String

参数解释：

分组名称。

取值范围：

由中文、英文字母、数字、中划线、下划线组成，长度在3~50个字符之间。

vendor

String

参数解释：

厂商。

取值范围：

  • RMS：华为云厂商。

  • ALI：阿里云厂商。

  • OTHER：其他厂商。

code

String

参数解释：

分组code。

取值范围：

不涉及。

domain_id

String

参数解释：

租户id。

取值范围：

不涉及。

region_id

String

参数解释：

区域id。

取值范围：

不涉及。

component_id

String

参数解释：

组件id。

取值范围：

不涉及。

application_id

String

参数解释：

应用id。

取值范围：

不涉及。

ep_id

String

参数解释：

企业项目id。

取值范围：

请选择企业管理中存在的项目ID。

sync_mode

String

参数解释：

资源同步方式。

取值范围：

  • MANUAL：手动关联。

  • AUTO：智能关联。

rule_tags

String

参数解释：

关联标签。

取值范围：

不涉及。

relation_configurations

Array of GroupRelationConfiguration objects

参数解释：

分组配置信息。

取值范围：

不涉及。
表4 GroupRelationConfiguration

参数

参数类型

描述

type

String

参数解释：

配置类型，配置本分组所对应的APM服务中的应用-组件-环境，故障诊断时可获取APM服务相关性能信息。

约束限制：

不涉及。

取值范围：

  • APM：apm服务自研探针。

  • OTEL：OpenTelemetry开源探针。

  • SKYWALKING：SkyWalking开源探针。

默认取值：

不涉及。

parameters

Map<String,String>

参数解释：

配置参数。

约束限制：

不涉及。

取值范围：

apm相关配置参数 app_id->business_id->env_id。

包含多个字段，最大长度仅供参考。

默认取值：

不涉及。

请求示例

查询应用或者子应用下的组件信息。

GET https://{Endpoint}/v1/groups

响应示例

状态码：200

查询分组信息成功。

{
  "data" : [ {
    "id" : "64898bf60224b9730ccb577f",
    "name" : "testgroup",
    "vendor" : "RMS",
    "code" : "testgroup",
    "domain_id" : "dc2d76541f754d68a4c8d150262d92c2",
    "region_id" : "string",
    "component_id" : "64898bf60224b9730ccb577f",
    "application_id" : "64898bf60224b9730ccb577f",
    "ep_id" : "0",
    "sync_mode" : "MANUAL",
    "rule_tags" : null,
    "relation_configurations" : [ { } ]
  } ]
}

状态码

状态码

描述

200

查询分组信息成功。

错误码

请参见错误码。

父主题： 分组

相关文档