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}
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID. It is used to specify the project that an asset belongs to. You can query the assets of a project by project ID. You can obtain the project ID from the API or console. For details, see Obtaining a Project ID. Constraints N/A Range 1 to 64 characters. Default Value N/A |
| group_id | Yes | String | Definition Resource group ID. Constraints N/A Range The value starts with rg and is followed by 22 characters that can include letters and digits. Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Tenant token. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| group_name | Yes | String | Definition Resource group name. Constraints N/A Range It allows 1 to 128 characters and can contain letters, digits, underscores (_), and hyphens (-). Default Value N/A |
| tags | No | Array of ResourceGroupTagRelation objects | Definition Associated tags during dynamic tag matching. Constraints This parameter is mandatory when type is set to TAG. Up to 50 tags are allowed. |
| enterprise_project_id_and_tags | No | Array of EnterpriseProjectIdAndTags objects | Definition Transferred for matching resources by multiple criteria. This parameter has been deprecated. Constraints This parameter is mandatory when type is set to COMB. Up to 50 conditions are allowed. |
| extend_relation_ids | No | Array of strings | Definition ID of the enterprise project associated when resources are matched by enterprise project. Constraints This parameter is mandatory when type is set to EPS. Up to 50 enterprise projects are allowed. |
| instances | No | Array of Instance objects | Definition Instance names for matching resources. Constraints This parameter is mandatory when type is set to NAME. Up to 50 instances are allowed. |
| product_names | No | String | Definition Name of a cloud product when the resource level is cloud product. Constraints N/A Range 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. Max. 10,240 characters. Default Value N/A |
| comb_relation | No | CombRelation object | Definition Combined conditions for matching resources. Constraints N/A |
| 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 |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| product_name | Yes | String | Definition Cloud product name. Constraints N/A Range 0 to 128 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 |
| 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 Default Value N/A |
| resource_name_is_ignore_case | No | Boolean | Definition Resource name (case insensitive). Constraints N/A Range Default Value false |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| logical_operator | Yes | String | Definition Logical operator. Constraints N/A Range 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. |
| 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 |
| 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 Default Value N/A |
| resource_name_is_ignore_case | No | Boolean | Definition Resource name (case insensitive). Constraints N/A Range Default Value false |
Response Parameters
Status code: 204
No Content
Status code: 400
| 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
| 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
| 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
| 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
| 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" : "rg_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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot