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.
URI
POST /v2/{project_id}/resource-groups/{group_id}/resources/batch-create
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
group_id |
Yes |
String |
Resource group ID, which starts with rg and is followed by 22 characters, including letters and digits. |
project_id |
Yes |
String |
Tenant ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. |
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 the resource adding mode is manual creation and the resource level is cloud product, information about both existing and new resources needs to be transferred when resources are added to a resource group. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
namespace |
Yes |
String |
Namespace of a service. For details about the namespace of each service, see Namespace. |
dimensions |
Yes |
Array of ResourceDimension objects |
Resource dimension information. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Dimension of a resource. For example, the dimension of an ECS can be instance_id. A maximum of four dimensions are supported. For the metric dimension of each resource, see Service metric dimension. Regex Pattern: ^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-)*$ |
value |
Yes |
String |
Value of a resource dimension. It is the instance ID, for example, 4270ff17-aba3-4138-89fa-820594c39755. Regex Pattern: ^((([a-z]|[A-Z]|[0-9]|\*|_|/|#|\(|\)){1}([a-z]|[A-Z]|[0-9]|_|-|\.|\*|/|#|\(|\))*))$ |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
product_name |
Yes |
String |
Cloud product that the resource belongs to. Generally, the value format is Service namespace,First-level dimension name of the service, for example, SYS.ECS,instance_id. |
namespace |
Yes |
String |
Namespace of a service. For details about the namespace of each service, see Namespace. Regex Pattern: ^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*\.([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*$ |
product_instances |
Yes |
Array of ProductInstance objects |
Product instance details. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
first_dimension_name |
Yes |
String |
First-level dimension of the resource. For example, the dimension of an ECS is instance_id. Regex Pattern: ^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$ |
first_dimension_value |
Yes |
String |
First-level dimension value of the resource, which is the resource ID, for example, 4270ff17-aba3-4138-89fa-820594c39755. Regex Pattern: ^([a-z]|[A-Z]|[0-9]|\*|_|/|#|\(|\)){1}([a-z]|[A-Z]|[0-9]|_|-|\.|/|#|\(|\))*$ |
resource_name |
Yes |
String |
Resource name. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
succeed_count |
Integer |
Number of resources that were added. Value range: 0-1000 |
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" : "instace_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