Help Center> Cloud Eye> API Reference> API v2> Resource Groups> Creating a Resource Group

Updated on 2024-05-16 GMT+08:00

View PDF

Creating a Resource Group

Function

This API is used to create a resource group.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

POST /v2/{project_id}/resource-groups

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the tenant ID. Minimum: 1 Maximum: 64

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the tenant token. Minimum: 1 Maximum: 16384

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
group_name	Yes	String	Specifies the resource group name. The value can contain up to 128 characters, including letters, digits, hyphens (-), and underscores (_). Minimum: 1 Maximum: 128 Regex Pattern: ^([\u4E00-\u9FFF]\|[a-z]\|[A-Z]\|[0-9]\|_\|-)+$
enterprise_project_id	No	String	Specifies the ID of the enterprise project to which a resource group belongs. Regex Pattern: ^((([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	No	String	Specifies the method for adding resources to a resource group. The value can only be EPS (synchronizing resources from enterprise projects) or TAG (dynamic tag matching). If this parameter is not specified, resources are manually added. Regex Pattern: ^(EPS\|TAG)$
tags	No	Array of ResourceGroupTagRelation objects	Specifies the associated tag during dynamic tag matching. This parameter is mandatory when type is set to TAG. Array Length: 1 - 10
association_ep_ids	No	Array of strings	Specifies the ID of the enterprise project from which resources in the resource group come. This parameter is mandatory when type is set to EPS. Array Length: 1 - 1

**Table 4** ResourceGroupTagRelation
Parameter	Mandatory	Type	Description
key	Yes	String	Specifies the tag key. Minimum: 1 Maximum: 36
value	No	String	Specifies the tag value. Minimum: 1 Maximum: 42

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
group_id	String	Specifies the resource group ID, which starts with rg and is followed by 22 characters, including letters and digits.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the status codes customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Specifies the request error message. Minimum: 0 Maximum: 256
request_id	String	Specifies the request ID. Minimum: 0 Maximum: 256

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the status codes customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Specifies the request error message. Minimum: 0 Maximum: 256
request_id	String	Specifies the request ID. Minimum: 0 Maximum: 256

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the status codes customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Specifies the request error message. Minimum: 0 Maximum: 256
request_id	String	Specifies the request ID. Minimum: 0 Maximum: 256

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the status codes customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Specifies the request error message. Minimum: 0 Maximum: 256
request_id	String	Specifies the request ID. Minimum: 0 Maximum: 256

Example Requests

Creating a resource group whose group _name is rg_test and type is TAG

{
  "group_name" : "rg_test",
  "enterprise_project_id" : "0",
  "type" : "TAG",
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  } ],
  "association_ep_ids" : [ "d61d4705-5658-42f5-8e0c-70eb34d17b02" ]
}