Batch Adding Resources to a Resource Group
Function
This API is used to batch add resources to a resource group whose type is Manual.
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:addResources
Write
-
g:EnterpriseProjectId
ces:resourceGroups:put
-
URI
POST /v2/{project_id}/resource-groups/{group_id}/resources/batch-create
| 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 of letters, digits, or a combination of both. Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | No | String | Definition User token. Constraints: None Value range: The value can contain 1 to 16,384 characters. Default value: None |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| resources | No | Array of Resource objects | When the resource adding mode is manual creation and the resource level is sub-dimension, only the information about the new resource needs to be transferred when the resource is added to the resource group. |
| product_resources | No | Array of ProductResource objects | If resources are added manually and the resources are at the cloud product level, information about both existing and new resources needs to be transferred when you add resources to a resource group. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| namespace | Yes | String | Definition Namespace of the service. For details, see Services Interconnected with Cloud Eye. Constraints N/A Range The value is in the service.item format. The values of service and item must start with a letter and contain only letters, digits, and underscores (_). It can contain 3 to 32 characters. Default Value N/A |
| dimensions | Yes | Array of ResourceDimension objects | Definition Resource dimension information. The value * indicates all resources. Constraints You can specify 1 to 4 dimensions. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| name | Yes | String | Definition Dimension of a resource. For example, the dimension of an ECS is instance_id . For details about the dimension names of each resource, see their service documentation. You can navigate there from Services Interconnected with Cloud Eye. Constraints N/A Range The value starts with a letter and allows 1 to 32 characters. It can contain only letters, digits, underscores (_), and hyphens (-). Default Value N/A |
| value | Yes | String | Definition Resource dimension value, which is an instance ID, for example, 4270ff17-aba3-4138-89fa-820594c39755. Constraints N/A Range 1 to 256 characters Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| product_name | Yes | String | Definition Name of the cloud product that the resource belongs to. Generally, the value format is Service namespace,First-level dimension of the service, for example, SYS.ECS,instance_id. Constraints N/A Range 0 to 128 characters. Default Value N/A |
| namespace | Yes | String | Definition Namespace of the service. For details, see Services Interconnected with Cloud Eye. Constraints N/A Range The value is in the service.item format. The values of service and item must start with a letter and contain only letters, digits, and underscores (_). It can contain 3 to 32 characters. Default Value N/A |
| product_instances | Yes | Array of ProductInstance objects | Definition Product instance details. Constraints N/A Range Max. 1,000 instances |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| first_dimension_name | Yes | String | Definition First-level dimension of a resource. For example, the dimension of an ECS is instance_id. Constraints N/A Range Resource dimension name. The value must start with a letter and allows up to 32 characters. It can contain only letters, digits, underscores (_), and hyphens (-). Default Value N/A |
| first_dimension_value | Yes | String | Definition First-level dimension value of the resource, which is the resource ID, for example, 4270ff17-aba3-4138-89fa-820594c39755. Constraints N/A Range 1 to 256 characters Default Value N/A |
| resource_name | Yes | String | Definition Resource name. Constraints N/A Range 1 to 128 characters Default Value N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| succeed_count | Integer | Definition Number of resources that were added. Range 0 to 1,000. |
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: 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
Batch adding resources to a custom resource group.
{
"resources" : [ {
"namespace" : "SYS.ECS",
"dimensions" : [ {
"name" : "instance_id",
"value" : "4270ff17-aba3-4138-89fa-820594c39755"
} ]
} ]
} Example Responses
Status code: 200
Resources added.
{
"succeed_count" : 4
} Status Codes
| Status Code | Description |
|---|---|
| 200 | Resources added. |
| 400 | Parameter verification 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