Help Center/ Cloud Eye/ API Reference/ API V2/ Resource Groups/ Modifying a Resource Group
Updated on 2025-10-30 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.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    ces:resourceGroups:put

    Write

    -

    g:EnterpriseProjectId

    -

    -

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project 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

Definition

Matching resources by combined conditions.

Constraints

N/A

Table 4 ResourceGroupTagRelation

Parameter

Mandatory

Type

Description

key

Yes

String

Definition

TMS tag key specifications.

Constraints

N/A

Range

[1,128]

Default Value

N/A

operator

No

String

Definition

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

Constraints

N/A

Range

  • include: include

  • prefix: prefix

  • suffix: suffix

  • notInclude: not included

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

  • all: all

Default Value

N/A

value

No

String

Definition

TMS tag value specifications.

Constraints

N/A

Range

[0,255]

Default Value

N/A

Table 5 EnterpriseProjectIdAndTags

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID.

Constraints

N/A

Range

The value allows 1 to 128 characters and can only contain letters, digits, underscores (_), and hyphens (-).

Default Value

N/A

tag

No

ResourceGroupTagRelation object

Definition

Tag matching rule.

Constraints

N/A

Table 6 Instance

Parameter

Mandatory

Type

Description

product_name

Yes

String

Definition

Cloud product name.

Constraints

N/A

Range

1 to 16 characters

Default Value

N/A

logical_operator

Yes

String

Definition

Logical operator.

Constraints

N/A

Range

ALL: All conditions are matched.

ANY: Any condition is matched.

Default Value

N/A

instance_names

Yes

Array of ResourceNameItem objects

Definition

Parameter array for matching resources by resource name.

Constraints

Max. 10 names

Table 7 ResourceNameItem

Parameter

Mandatory

Type

Description

resource_name

No

String

Definition

Resource name condition value.

Constraints

N/A

Range

[0,128]

Default Value

N/A

operator

Yes

String

Definition

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

Constraints

N/A

Range

  • include: include

  • prefix: prefix

  • suffix: suffix

  • notInclude: not included

  • equal: equal

  • all: all

Default Value

N/A

resource_name_is_ignore_case

No

Boolean

Definition

Resource name (case insensitive).

Constraints

N/A

Range

  • true: case insensitive

  • false: case sensitive

Default Value

false

Table 8 CombRelation

Parameter

Mandatory

Type

Description

logical_operator

Yes

String

Definition

Logical operator.

Constraints

N/A

Range

  • ALL: All conditions are matched.

  • ANY: Any condition is matched.

Default Value

N/A

conditions

Yes

Array of Condition objects

Definition

Combined matching conditions for resource groups.

Constraints

A maximum of 50 conditions are allowed.

Table 9 Condition

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID.

Constraints

N/A

Range

The value can be 0 (ID of the default enterprise project) or consists of digits, letters, or hyphens (-).

Default Value

N/A

instance_name

No

CombResourceName object

Matching resources by resource name.

tag

No

ResourceGroupTagRelation object

Definition

Tag matching rule.

Constraints

N/A

Table 10 CombResourceName

Parameter

Mandatory

Type

Description

resource_name

No

String

Definition

Resource name condition value.

Constraints

N/A

Range

1 to 128 characters

Default Value

N/A

operator

Yes

String

Definition

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

Constraints

N/A

Range

  • include: include

  • prefix: prefix

  • suffix: suffix

  • notInclude: not included

  • equal: equal

Default Value

N/A

resource_name_is_ignore_case

No

Boolean

Definition

Resource name (case insensitive).

Constraints

N/A

Range

  • true: The name is case insensitive.

  • false: The name is case sensitive.

Default Value

false

Response Parameters

Status code: 204

No Content

Status code: 400

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: 401

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: 403

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: 404

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.

Status code: 500

Table 15 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.