doc-exports/docs/ces/api-ref/BatchCreateResources.html

Batch Adding Associated Resources to a Custom Resource Group

Function

This API is used to batch add associated resources to a custom resource group whose type is Manual.

URI

POST /v2/{project_id}/resource-groups/{group_id}/resources/batch-create

Table 1 Path parameters

Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. Minimum: 1 Maximum: 64 Regular expression matching: ^[a-zA-Z0-9-]{1,64}$
group_id	Yes	String	Resource group ID. The value starts with rg and is followed by 22 characters of letters, digits, or a combination of both. Minimum: 24 Maximum: 24

Request Parameters

Table 2 Request header parameters

Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token. Minimum: 1 Maximum: 16384

Table 3 Request body parameters

Parameter	Mandatory	Type	Description
resources	Yes	Array of Resource objects	Resource information. Array length: 1 to 1000

Table 4 Resource

Parameter	Mandatory	Type	Description
namespace	Yes	String	Namespace of a service. For details about the namespace of each service, see Service Namespaces. The namespace must be in the service.item format and contain 3 to 32 characters. service and item must start with a letter and can contain only letters, digits, and underscores (_). Minimum: 3 Maximum: 32
dimensions	Yes	Array of Dimension objects	Resource dimension information. Array length: 1 to 4

Table 5 Dimension

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 Dimensions. Regular expression matching: ^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$
value	Yes	String	Resource dimension value, which is an instance ID, for example, 4270ff17-aba3-4138-89fa-820594c39755. Regular expression matching: ^((([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-|\.)*)|\*){1,256}$

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter	Type	Description
succeed_count	Integer	Number of resources that were added. Minimum: 0 Maximum: 1000

Status code: 400

Table 7 Response body parameters

Parameter	Type	Description
error_code	String	Status code customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Request error message. Minimum: 0 Maximum: 256
request_id	String	Request ID. Minimum: 0 Maximum: 256

Status code: 404

Table 8 Response body parameters

Parameter	Type	Description
error_code	String	Status code customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Request error message. Minimum: 0 Maximum: 256
request_id	String	Request ID. Minimum: 0 Maximum: 256

Status code: 500

Table 9 Response body parameters

Parameter	Type	Description
error_code	String	Status code customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Request error message. Minimum: 0 Maximum: 256
request_id	String	Request ID. Minimum: 0 Maximum: 256

Example Requests

Batch adding associated 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" : 1
}

Status Codes

Status Code	Description
200	Resources added.
400	Parameter verification failed.
404	Resources not found.
500	Failed to complete the request because of an internal server error.

Error Codes

See Error Codes.

Parent topic: Resources in a Resource Group