创建资源分组(推荐)
功能介绍
创建资源分组
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/resource-groups
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户ID 最小长度:1 最大长度:64 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
租户Token 最小长度:1 最大长度:16384 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
group_name |
是 |
String |
参数解释 资源分组的名称 约束限制 不涉及 取值范围 只能为字母、数字、汉字、-或_,长度为[1,128]个字符 默认取值 不涉及 最小长度:1 最大长度:128 正则匹配:^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$ |
enterprise_project_id |
否 |
String |
参数解释 资源分组归属企业项目ID 约束限制 不涉及 取值范围 由数字、字母和-组成,或者为0(默认企业项目ID)。 默认取值 不涉及 正则匹配:^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$ |
type |
否 |
String |
参数解释 资源分组添加资源方式 约束限制 不涉及 取值范围 取值只能为EPS(同步企业项目),TAG(标签动态匹配),NAME(实例名称),COMB(组合匹配),不传为手动添加。 默认取值 不涉及 正则匹配:^(EPS|TAG|Manual|COMB|NAME)$ |
tags |
否 |
Array of ResourceGroupTagRelation objects |
参数解释 标签动态匹配时的关联标签。 约束限制 type为TAG时必传,不超过50个标签。 数组长度:1 - 50 |
association_ep_ids |
否 |
Array of strings |
参数解释 该资源分组内包含的资源来源的企业项目ID。 约束限制 type为EPS时必传,不超过50个企业项目ID。 最小长度:1 最大长度:128 数组长度:1 - 50 |
providers |
否 |
String |
参数解释 云服务名称,格式为"dcs,ecs",支持的云服务providers请参考《配置审计API参考》中的"支持的服务和资源类型"章节 约束限制 不涉及 取值范围 长度为[0,512]个字符 默认取值 不涉及 最小长度:0 最大长度:512 |
enterprise_project_id_and_tags |
否 |
Array of EnterpriseProjectIdAndTags objects |
参数解释 匹配企业项目或匹配标签参数。 约束限制 不超过50个条件。 数组长度:1 - 50 |
resources |
否 |
Array of Resource objects |
参数解释 手动创建时的资源详情。 约束限制 不超过1000个资源。 数组长度:0 - 1000 |
product_resources |
否 |
Array of ProductResource objects |
参数解释 手动创建,选择资源层级为云产品时的资源详情。 约束限制 不超过50个资源。 数组长度:1 - 50 |
instances |
否 |
Array of Instance objects |
参数解释 实例名称匹配参数。 约束限制 type为NAME时必传,不超过50个实例。 数组长度:1 - 50 |
product_names |
否 |
String |
参数解释 创建资源层级为云产品时的云产品的取值,一般由"服务命名空间,服务首层维度名称"组成,如"SYS.ECS,instance_id"。多个云产品则用“;”隔开,如"SERVICE.BMS,instance_id;SYS.ECS,instance_id"。 约束限制 不涉及。 取值范围 长度[0,10240]个字符 默认取值 不涉及。 最小长度:0 最大长度:10240 |
resource_level |
否 |
String |
参数解释 资源层级,资源生效范围。选择云产品,则云产品及其子层级均可进入该资源分组,选择子维度,则只生效具体的子维度。 约束限制 不涉及。 取值范围
默认取值 不涉及。 枚举值:
|
comb_relation |
否 |
CombRelation object |
参数解释 组合匹配参数。 约束限制 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
key |
是 |
String |
参数解释 TMS标签键规范 约束限制 不涉及 取值范围 长度为[1,128]个字符 默认取值 不涉及 |
operator |
否 |
String |
参数解释 tag操作符,含义是标签key与value的关系 约束限制 不涉及 取值范围
默认取值 不涉及 枚举值:
|
value |
否 |
String |
参数解释 TMS标签值规范 约束限制 不涉及 取值范围 长度为[0,255]个字符 默认取值 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
参数解释 企业项目ID 约束限制 不涉及 取值范围 由字母、数字、_和-组成,长度为[1,128]个字符 默认取值 不涉及 最小长度:1 最大长度:128 正则匹配:^([a-z]|[A-Z]|[0-9]|_|-)+$ |
tag |
否 |
ResourceGroupTagRelation object |
参数解释 标签的匹配规则 约束限制 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
namespace |
是 |
String |
参数解释 查询服务的命名空间,各服务命名空间请参考“服务命名空间” 约束限制 不涉及 取值范围 格式为service.item;service和item必须是字符串,必须以字母开头,只能包含0-9/a-z/A-Z/_。字符串的长度必须在 3 到 32个字符之间。 默认取值 不涉及 |
dimensions |
是 |
Array of ResourceDimension objects |
参数解释 资源的维度信息 约束限制 不超过4个维度 数组长度:1 - 4 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
参数解释 资源维度,如:弹性云服务器,则维度为instance_id;目前最大支持4个维度,各服务资源的指标维度名称可查看:“服务指标维度”。 约束限制 不涉及 取值范围 由字母开头,后面可以包含字母、数字、_或-,长度为[1,32]个字符 默认取值 不涉及 最小长度:1 最大长度:32 正则匹配:^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-)*$ |
value |
是 |
String |
参数解释 资源维度值,为资源的实例ID,如:4270ff17-aba3-4138-89fa-820594c39755。 约束限制 不涉及 取值范围 长度为[1,256]个字符 默认取值 不涉及 最小长度:1 最大长度:256 正则匹配:^((([a-z]|[A-Z]|[0-9]|\*|_|/|#|\(|\)){1}([a-z]|[A-Z]|[0-9]|_|-|\.|\*|/|#|\(|\))*))$ |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
product_name |
是 |
String |
参数解释 资源所属的云产品,一般由"服务命名空间,服务首层维度名称"组成,如"SYS.ECS,instance_id" 约束限制 不涉及 取值范围 长度[0,128]个字符 默认取值 不涉及 最小长度:0 最大长度:128 |
namespace |
是 |
String |
参数解释 查询服务的命名空间,各服务命名空间请参考“服务命名空间” 约束限制 不涉及 取值范围 格式为service.item;service和item必须是字符串,必须以字母开头,只能包含0-9/a-z/A-Z/_。字符串的长度必须在 3 到 32个字符之间。 默认取值 不涉及 最小长度:3 最大长度:32 正则匹配:^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*\.([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*$ |
product_instances |
是 |
Array of ProductInstance objects |
参数解释 产品实例详情 约束限制 不涉及 取值范围 不超过1000个实例 数组长度:1 - 1000 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
first_dimension_name |
是 |
String |
参数解释 资源首层维度,如:弹性云服务器,则维度为instance_id 约束限制 不涉及 取值范围 资源维度,必须以字母开头,只能包含0-9/a-z/A-Z/_/-,维度的最大长度为32。 默认取值 不涉及 正则匹配:^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$ |
first_dimension_value |
是 |
String |
参数解释 资源首层维度值,为资源的实例ID,如:4270ff17-aba3-4138-89fa-820594c39755。 约束限制 不涉及 取值范围 长度为[1,256]个字符。 默认取值 不涉及 最小长度:1 最大长度:256 正则匹配:^([a-z]|[A-Z]|[0-9]|\*|_|/|#|\(|\)){1}([a-z]|[A-Z]|[0-9]|_|-|\.|/|#|\(|\))*$ |
resource_name |
是 |
String |
参数解释 资源名称 约束限制 不涉及 取值范围 长度[1,128]个字符 默认取值 不涉及 最小长度:0 最大长度:128 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
product_name |
是 |
String |
参数解释 云产品名称 约束限制 不涉及 取值范围 长度为[1,16]个字符 默认取值 不涉及 最小长度:1 最大长度:16 |
logical_operator |
是 |
String |
参数解释 逻辑运算符 约束限制 不涉及 取值范围
默认取值 不涉及 枚举值:
|
instance_names |
是 |
Array of ResourceName objects |
参数解释 资源名称匹配参数数组 约束限制 不超过10个名称 数组长度:1 - 10 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
resource_name |
否 |
String |
参数解释 资源名称条件值 约束限制 不涉及 取值范围 长度[0,128]个字符 默认取值 不涉及 最小长度:0 最大长度:128 |
operator |
是 |
String |
参数解释 实例操作符,含义是真实资源的名称与资源名称条件值的运算关系。 约束限制 不涉及 取值范围
默认取值 不涉及 枚举值:
|
resource_name_is_ignore_case |
否 |
Boolean |
参数解释 资源名称忽略大小写 约束限制 不涉及 取值范围
默认取值 false |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
logical_operator |
是 |
String |
参数解释 逻辑运算符。 约束限制 不涉及。 取值范围
默认取值 不涉及。 枚举值:
|
conditions |
是 |
Array of Condition objects |
参数解释 组合匹配资源分组的匹配条件。 约束限制 不超过50个条件。 数组长度:1 - 50 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
参数解释 企业项目ID 约束限制 不涉及 取值范围 由数字、字母和-组成,或者为0(默认企业项目ID) 默认取值 不涉及 正则匹配:^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$ |
instance_name |
否 |
CombResourceName object |
组合匹配资源名称 |
tag |
否 |
ResourceGroupTagRelation object |
参数解释 标签的匹配规则 约束限制 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
resource_name |
否 |
String |
参数解释 资源名称条件值 约束限制 不涉及 取值范围 长度[1,128]个字符 默认取值 不涉及 最小长度:1 最大长度:128 |
operator |
是 |
String |
参数解释 实例操作符,含义是真实资源的名称与资源名称条件值的运算关系。 约束限制 不涉及 取值范围
默认取值 不涉及 枚举值:
|
resource_name_is_ignore_case |
否 |
Boolean |
参数解释 资源名称忽略大小写 约束限制 不涉及 取值范围
默认取值 false |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
group_id |
String |
参数解释: 资源分组ID 约束限制: 不涉及。 取值范围: 以rg开头,后跟22位由字母或数字组成的字符串。长度为[2,24]个字符。 默认取值: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
请求异常内部业务状态码 最小长度:0 最大长度:256 |
error_msg |
String |
请求异常信息 最小长度:0 最大长度:256 |
request_id |
String |
请求ID 最小长度:0 最大长度:256 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
请求异常内部业务状态码 最小长度:0 最大长度:256 |
error_msg |
String |
请求异常信息 最小长度:0 最大长度:256 |
request_id |
String |
请求ID 最小长度:0 最大长度:256 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
请求异常内部业务状态码 最小长度:0 最大长度:256 |
error_msg |
String |
请求异常信息 最小长度:0 最大长度:256 |
request_id |
String |
请求ID 最小长度:0 最大长度:256 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
请求异常内部业务状态码 最小长度:0 最大长度:256 |
error_msg |
String |
请求异常信息 最小长度:0 最大长度:256 |
request_id |
String |
请求ID 最小长度:0 最大长度:256 |
请求示例
创建名称为rg_test,且资源分组添加资源方式为TAG的资源分组。
{ "group_name" : "rg_test", "enterprise_project_id" : "0", "type" : "TAG", "tags" : [ { "key" : "key1", "value" : "value1" } ], "association_ep_ids" : [ "d61d4705-5658-42f5-8e0c-70eb34d17b02" ] }
响应示例
状态码:200
Created
{ "group_id" : "rg0123456789xxx" }
状态码
状态码 |
描述 |
---|---|
200 |
Created |
400 |
参数校验失败 |
401 |
未认证 |
403 |
认证鉴权失败 |
500 |
系统内部错误 |
错误码
请参见错误码。