Batch Adding Resources to a Resource Group
Function
This API is used to batch add resources to a resource group whose type is Manual.
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 |
Project 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 |
Definition Namespace of a service. For details about the namespace of each service, see Namespaces. Constraints N/A Range The value is in the service.item format. The values of service and item must be a string, starting with a letter and containing only digits (0–9), letters (case-insensitive), and underscores (_). The value must contain 3 to 32 characters. Default Value N/A |
|
dimensions |
Yes |
Array of ResourceDimension objects |
Definition Resource dimension information. Constraints A maximum of four dimensions are allowed. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
name |
Yes |
String |
Definition 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 Dimensions. Constraints N/A Range The value starts with a letter and allows 1 to 32 characters. It can contain 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 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. Constraints N/A Range 0 to 128 characters Default Value N/A |
|
namespace |
Yes |
String |
Definition Namespace of a service. For details about the namespace of each service, see Namespaces. Constraints N/A Range The value is in the service.item format. The values of service and item must be a string, starting with a letter and containing only digits (0–9), letters (case-insensitive), and underscores (_). It must 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 the resource. For example, the dimension of an ECS is instance_id. Constraints N/A Range Resource dimension. The value must start with a letter and allows a maximum of 32 characters. It can only contain digits, letters, 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 |
Number of resources that were added. |
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.