Creating an Elastic Resource Pool¶

Function¶

This API is used to create elastic resource pools.

URI¶

URI format
POST /v3/{project_id}/elastic-resource-pools
Parameter description
Table 1 URI parameter¶
Parameter
Mandatory
Type
Description
project_id
Yes
String
Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

**Table 1** URI parameter¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

Request¶

**Table 2** Request parameters¶
Parameter	Mandatory	Type	Description
elastic_resource_pool_name	Yes	String	Name of a new elastic resource pool. Only digits, letters, and underscores (_) are allowed, but the value cannot contain only digits or start with an underscore (_). The value can contain 1 to 128 characters. Note If the name contains uppercase letters, the system automatically converts them to lowercase letters.
description	No	String	Description. The value can contain a maximum of 256 characters.
cidr_in_vpc	No	String	VPC CIDR associated with the virtual cluster. If it is not specified, the default value 172.16.0.0/12 is used.
max_cu	Yes	Integer	Maximum number of CUs. The value of this parameter must be greater than or equal to the sum of maximum CUs allowed for any queue in the resource pool, and greater than min_cu. The minimum value is 64.
min_cu	Yes	Integer	Minimum number of CUs. The value of this parameter must be greater than or equal to the sum of the minimum CUs allowed for each queue in the resource pool. The minimum value is 64.
charging_mode	No	Integer	Billing mode. The default value is 1, which indicates the pay-per-use billing mode.
enterprise_project_id	No	String	Enterprise ID. If this parameter is left blank, the default value 0 is used.
tags	No	Array of objects	Queue tags for identifying cloud resources. A tag consists of a key and a value. For details, see Table 3.

**Table 3** tags parameters¶
Parameter	Mandatory	Type	Description
key	Yes	String	Tag key Note A tag key can contain a maximum of 128 characters. Only letters, digits, spaces, and special characters `(_.:=+-@)` are allowed, but the key cannot start or end with a space or start with _sys_.
value	Yes	String	Tag value Note A tag value can contain a maximum of 255 characters. Only letters, digits, spaces, and special characters `(_.:=+-@)` are allowed. The value cannot start or end with a space.

Response¶

**Table 4** Response parameters¶
Parameter	Mandatory	Type	Description
is_success	No	Boolean	Whether the request is successfully executed. Value true indicates that the request is successfully executed.
message	No	String	Message content, for example, Success to get tsdb list.
elastic_resource_pool_name	No	String	Elastic resource pool name, for example, elastic_pool_0623_02".

Example Request¶

Create an elastic resource pool with maximum CUs of 684 and minimum CUs of 684.

{
  "elastic_resource_pool_name" : "elastic_pool_0623_02",
  "description" : "test",
  "cidr_in_vpc" : "172.16.0.0/14",
  "charging_mode" : "1",
  "max_cu" : 684,
  "min_cu" : 684
}

Example Response¶

{
  "is_success" : true,
  "message" : "Success to get tsdb list",
  "elastic_resource_pool_name" : "elastic_pool_0623_02"
}

Status Codes¶

Status Code	Description
200	OK
400	Incorrect parameters. For example, creating an existing elastic resource pool.
403	Forbidden

Error Codes¶

If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Codes.

last updated: 2024-11-20 15:34 UTC - commit: c856450509a511f9057fb9577287974ed6fce406