Help Center/ Cloud Eye/ API Reference/ API V2/ Resource Groups/ Modifying a Resource Group
Updated on 2025-08-27 GMT+08:00

Modifying a Resource Group

Function

This API is used to modify 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

PUT /v2/{project_id}/resource-groups/{group_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant ID.

group_id

Yes

String

Resource group ID, which starts with rg and is followed by 22 characters, including letters and digits.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Tenant token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

group_name

Yes

String

Resource group name. The value can contain up to 128 characters, including letters, digits, hyphens (-), and underscores (_).

tags

No

Array of ResourceGroupTagRelation objects

Associated tag during dynamic tag matching. This parameter must be specified when type is set to TAG.

enterprise_project_id_and_tags

No

Array of EnterpriseProjectIdAndTags objects

Parameter transferred when Matching Resource By is set to Multiple criteria.

extend_relation_ids

No

Array of strings

Parameter transferred for matching resources by enterprise project when Add Resources is set to Automatically.

instances

No

Array of Instance objects

Parameter transferred for matching resources by instance name.

product_names

No

String

Value of a cloud product when the resource level is changed to cloud product. Generally, the value format is Service namespace,First-level dimension of the service, for example, SYS.ECS,instance_id. Multiple cloud products are separated by semicolons (;), for example, SERVICE.BMS,instance_id;SYS.ECS,instance_id.

comb_relation

No

CombRelation object

Matching resources by multiple criteria.

Table 4 ResourceGroupTagRelation

Parameter

Mandatory

Type

Description

key

Yes

String

TMS tag key specifications.

operator

No

String

Tag operator, which indicates the relationship between the tag key and value.

include: indicates include.

prefix: indicates the prefix.

suffix: indicates the suffix.

notInclude: indicates not included.

equal: indicates equal.

If operator is equal and value is an empty string, all tag values of the key are matched.

all: indicates all.

Enumeration values:

  • include

  • prefix

  • suffix

  • notInclude

  • equal

  • all

value

No

String

TMS tag value specifications.

Table 5 EnterpriseProjectIdAndTags

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Enterprise Project ID.

Regex Pattern: ^([a-z]|[A-Z]|[0-9]|_|-)+$

tag

No

ResourceGroupTagRelation object

Tag matching rule.

Table 6 Instance

Parameter

Mandatory

Type

Description

product_name

Yes

String

Cloud product name.

logical_operator

Yes

String

Logical operator.

ALL: All conditions are matched.

ANY: Any condition is matched.

Enumeration values:

  • ALL

  • ANY

instance_names

Yes

Array of ResourceName objects

Parameter array for matching resources by resource name.

Table 7 ResourceName

Parameter

Mandatory

Type

Description

resource_name

No

String

Resource name condition value.

operator

Yes

String

Instance operator, which indicates the operation relationship between the actual resource name and the resource name condition value.

include: indicates include.

prefix: indicates the prefix.

suffix: indicates the suffix.

notInclude: indicates not included.

equal: indicates equal.

all: indicates all.

Enumeration values:

  • include

  • prefix

  • suffix

  • notInclude

  • equal

  • all

resource_name_is_ignore_case

No

Boolean

The resource name is case-insensitive.

Table 8 CombRelation

Parameter

Mandatory

Type

Description

logical_operator

Yes

String

Logical operator.

ALL: All conditions are matched.

ANY: Any condition is matched.

Enumeration values:

  • ALL

  • ANY

conditions

Yes

Array of Condition objects

Combined matching conditions for resource groups.

Table 9 Condition

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Enterprise Project ID.

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)$

instance_name

No

ResourceName object

Resource name.

tag

No

ResourceGroupTagRelation object

Tag matching rule.

Response Parameters

Status code: 204

No Content

Status code: 400

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Status codes customized by each cloud service when a request error occurs.

error_msg

String

Request error message.

request_id

String

Request ID.

Status code: 401

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Status codes customized by each cloud service when a request error occurs.

error_msg

String

Request error message.

request_id

String

Request ID.

Status code: 403

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Status codes customized by each cloud service when a request error occurs.

error_msg

String

Request error message.

request_id

String

Request ID.

Status code: 404

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Status codes customized by each cloud service when a request error occurs.

error_msg

String

Request error message.

request_id

String

Request ID.

Status code: 500

Table 14 Response body parameters

Parameter

Type

Description

error_code

String

Status codes customized by each cloud service when a request error occurs.

error_msg

String

Request error message.

request_id

String

Request ID.

Example Requests

Modify the resource group named rg_test.

{
  "group_name" : "test",
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  } ]
}

Example Responses

None

Status Codes

Status Code

Description

204

No Content

400

Parameter verification failed.

401

Not authenticated.

403

Authentication failed.

404

Resource not found.

500

Internal system error.

Error Codes

See Error Codes.