Querying Dedicated Resource Pools

Function

This API is used to obtain information about all dedicated resource pools you created. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

GET /v3/{project_id}/dedicated-resources

**Table 1** URI parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition Index offset. The query starts from the next piece of data indexed by this parameter. Constraints The value cannot be a negative number. Range ≥ 0 Default Value 0
limit	No	Integer	Definition Number of records to be queried. Constraints The value cannot be a negative number. Range 1–100 Default Value 100

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
resources	Array of DedicatedResource objects	Definition Dedicated resource pool information.
total_count	Integer	Definition Number of dedicated resource pools. Range N/A

**Table 5** DedicatedResource
Parameter	Type	Description
id	String	Definition ID of the dedicated resource pool. Range N/A
resource_name	String	Definition Name of the dedicated resource pool. Range N/A
engine_name	String	Definition DB engine. Range N/A
architecture	String	Definition CPU architecture. Range N/A
status	String	Definition Status of the dedicated resource pool. Range NORMAL: The dedicated resource pool is normal. BUILDING: The dedicated resource pool is being built. EXTENDING: The dedicated resource pool is being scaled out. DELETED: The dedicated resource pool has been deleted.
capacity	DedicatedResourceCapacity object	Definition Capacity of the dedicated resource pool.
availability_zone	Array of strings	Definition AZ where the dedicated resource pool is deployed. Range N/A

**Table 6** DedicatedResourceCapacity
Parameter	Type	Description
ram	Integer	Definition Memory size, in GB. Range N/A
volume	Long	Definition Storage space, in GB. Range N/A
vcpus	Integer	Definition Number of vCPUs. Range N/A

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Querying dedicated resource pools

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/dedicated-resources

Example Response

Status code: 200

Success.

{
  "resources" : [ {
    "id" : "1d07f7ba-f140-46a7-b002-58ba22ee6ff3",
    "resource_name" : "testdcc",
    "engine_name" : "gaussdb-mysql",
    "architecture" : "ARM",
    "status" : "NORMAL",
    "capacity" : {
      "ram" : 256,
      "volume" : 10000000,
      "vcpus" : 64
    },
    "availability_zone" : [ "az1xahz" ]
  } ]
}