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

创建资源分组(V1)

功能介绍

创建资源分组,资源分组支持将各类资源按照业务集中进行分组管理,可以从分组角度查看监控与告警信息,以提升运维效率。

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

参数解释:

发送的实体的MIME类型。

约束限制:

不涉及。

取值范围:

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

默认取值:

默认使用 application/json; charset=UTF-8,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。

X-Auth-Token

String

参数解释:

用户Token。

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

group_name

String

参数解释

资源分组的名称

约束限制

不涉及

取值范围

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

默认取值

不涉及

resources

Array of CreateResourceGroup objects

参数解释

手动创建时的资源详情。

约束限制

不超过1000个资源。

type

String

参数解释

资源分组添加资源方式

约束限制

不涉及

取值范围

取值只能为EPS(同步企业项目),TAG(标签动态匹配),不传为手动添加。

默认取值

不涉及

relation_ids

Array of strings

参数解释

该资源分组内包含的资源来源的企业项目ID。

约束限制

type为EPS时必传,不超过50个企业项目ID。

tags

Array of ResourceGroupTagRelation objects

参数解释

标签动态匹配时的关联标签。

约束限制

type为TAG时必传,不超过50个标签。

enterprise_project_id

String

参数解释

资源分组归属企业项目ID

约束限制

不涉及

取值范围

由数字、字母和-组成,或者为0(默认企业项目ID)。

默认取值

不涉及

表4 CreateResourceGroup

参数

是否必选

参数类型

描述

namespace

String

参数解释

查询服务的命名空间,各服务命名空间请参考“服务命名空间

约束限制

不涉及

取值范围

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

默认取值

不涉及

dimensions

Array of MetricsDimension objects

参数解释

资源的维度信息

约束限制

不超过4个维度

表5 MetricsDimension

参数

是否必选

参数类型

描述

name

String

参数解释

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

约束限制

不涉及

取值范围

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

默认取值

不涉及

value

String

参数解释

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

约束限制

不涉及

取值范围

长度为[1,256]个字符

默认取值

不涉及

表6 ResourceGroupTagRelation

参数

是否必选

参数类型

描述

key

String

参数解释

TMS标签键规范

约束限制

不涉及

取值范围

长度为[1,128]个字符

默认取值

不涉及

operator

String

参数解释

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

约束限制

不涉及

取值范围

  • include: 表示包含

  • prefix: 表示前缀

  • suffix: 表示后缀

  • notInclude: 表示不包含

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

  • all: 表示全部

默认取值

不涉及

value

String

参数解释

TMS标签值规范

约束限制

不涉及

取值范围

长度为[0,43]个字符

默认取值

不涉及

响应参数

状态码:201

表7 响应Body参数

参数

参数类型

描述

group_id

String

参数解释

资源分组ID,如:rg1606377637506DmVOENVyL

约束限制

不涉及

取值范围

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

默认取值

不涉及

状态码: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

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

请求示例

{
  "group_name" : "Resource-Group-Test01",
  "resources" : [ {
    "namespace" : "SYS.ECS",
    "dimensions" : [ {
      "name" : "instance_id",
      "value" : "063a83da-a2b5-4630-ab6b-9b4fcfc261ea"
    } ]
  }, {
    "namespace" : "SYS.ECS",
    "dimensions" : [ {
      "name" : "instance_id",
      "value" : "518ace88-abde-46bf-829b-0d1f0f2fb2e9"
    } ]
  } ]
}

响应示例

状态码:201

OK

{
  "group_id" : "rg1606377637506DmVOENVyL"
}

状态码

状态码

描述

201

OK

400

Bad Request

401

Unauthorized

403

Forbidden

408

Request Timeout

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

错误码

请参见错误码

相关文档