更新时间:2025-08-01 GMT+08:00
分享

创建分组

功能介绍

创建应用/子应用/组件下的分组,统一管理资源。

调试

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

URI

POST /v1/groups

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释:

应用名称。

约束限制:

由中文、英文字母、数字、中划线、下划线组成。

取值范围:

长度在3~50个字符之间。

默认取值:

不涉及。

component_id

String

参数解释:

组件id。

约束限制:

不涉及。

取值范围:

选择组件时,创建分组后,对应的组件id。

默认取值:

不涉及。

vendor

String

参数解释:

厂商信息。

约束限制:

不涉及。

取值范围:

  • RMS:华为云厂商。

  • ALI:阿里云厂商。

  • OTHER:其他厂商。

默认取值:

不涉及。

region_id

String

参数解释:

区域id。

约束限制:

不涉及。

取值范围:

应用关联的区域region的id。

默认取值:

不涉及。

application_id

String

参数解释:

应用id。

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

sync_mode

String

参数解释:

资源同步方式。

约束限制:

不涉及。

取值范围:

  • MANUAL:表示手动关联:用户在对应分组下,手动将对应资源数据关联至分组内进行管理。

  • AUTO:表示智能关联:用户通过企业项目和标签的形式,将企业项目下的相同标签资源创建至同一资源分组。

默认取值:

默认MANUAL。

sync_rules

Array of sync_rules objects

参数解释:

智能关联规则。

约束限制:

不涉及。

取值范围:

智能关联已选择的企业项目和对应标签的现存及未来创建的资源。

默认取值:

不涉及。

relation_configurations

Array of GroupRelationConfiguration objects

参数解释:

分组配置信息。

约束限制:

不涉及。

取值范围:

分组的关联配置信息,比如对应的APM的配置信息。

默认取值:

不涉及。

表2 sync_rules

参数

是否必选

参数类型

描述

ep_id

String

参数解释:

企业项目id。

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

rule_tags

String

参数解释:

关联标签。

企业项目中的资源满足配置的所有标签时,应用分组将智能关联。

约束限制:

不涉及。

取值范围:

可自定义。

默认取值:

不涉及。

表3 GroupRelationConfiguration

参数

是否必选

参数类型

描述

type

String

参数解释:

配置类型。

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

parameters

Map<String,String>

参数解释:

配置参数。

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data

data object

参数解释:

应用管理信息。

取值范围:

不涉及。

表5 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。

取值范围:

不涉及。

path

String

参数解释:

分组路径。

取值范围:

不涉及。

create_time

String

参数解释:

创建时间,参考ISO8601标准格式。

取值范围:

不涉及。

update_time

String

参数解释:

更新时间,参考ISO8601标准格式。

取值范围:

不涉及。

sync_mode

String

参数解释:

更新时间。

取值范围:

  • MANUAL:手动关联。

  • AUTO:智能关联。

sync_rules

Array of sync_rules objects

参数解释:

智能关联规则。

取值范围:

不涉及。

related_domain_id

String

参数解释:

跨账号资源所属的domainId。

取值范围:

不涉及。

relation_configurations

Array of GroupRelationConfiguration objects

参数解释:

分组配置信息。

取值范围:

不涉及。

表6 sync_rules

参数

参数类型

描述

ep_id

String

参数解释:

企业项目id。

取值范围:

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

rule_tags

String

参数解释:

关联标签。

取值范围:

不涉及。

表7 GroupRelationConfiguration

参数

参数类型

描述

type

String

参数解释:

配置类型。

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

parameters

Map<String,String>

参数解释:

配置参数。

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

请求示例

创建分组。

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

{
  "name" : "test1212",
  "region_id" : "string",
  "related_domain_id" : null,
  "component_id" : "678236a93f1b240bc02b3e4f",
  "sync_mode" : "AUTO",
  "vendor" : "RMS",
  "sync_rules" : [ {
    "ep_id" : "0",
    "rule_tags" : "string"
  } ],
  "relation_configurations" : null
}

响应示例

状态码:200

创建分组返回体。

{
  "data" : {
    "id" : "685cff9aa2cf591eae464a6a",
    "name" : "test1212",
    "code" : null,
    "domainId" : "dc2d76541f754d68a4c8d150262d92c2",
    "regionId" : "string",
    "applicationId" : "6780dec23f1b240bc0295d11",
    "componentId" : "678236a93f1b240bc02b3e4f",
    "path" : "string",
    "vendor" : "RMS",
    "createTime" : "string",
    "updateTime" : "string",
    "syncMode" : "AUTO",
    "syncRules" : null,
    "relationConfigurations" : null,
    "relatedDomainId" : null
  }
}

状态码

状态码

描述

200

创建分组返回体。

错误码

请参见错误码

相关文档