Updated on 2024-09-11 GMT+08:00

Querying Dedicated Resources

Function

This API is used to query dedicated resources. Before calling this API:

URI

GET /v3/{project_id}/dedicated-resource/{dedicated_resource_id}

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

dedicated_resource_id

Yes

String

ID of the dedicated resource pool. To obtain this value, see Querying Dedicated Resource Pools.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token.

The value of X-Subject-Token in the response header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Values:

  • en-us
  • zh-cn

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

ID of the dedicated resource pool.

resource_name

String

Name of the dedicated resource pool.

engine_name

String

Database name.

availability_zone_ids

Array of strings

AZs.

architecture

String

CPU architecture.

status

String

Status of the dedicated resource pool.

dedicated_compute_info

DedicatedComputeInfo object

Compute resource information.

dedicated_storage_info

DedicatedStorageInfo object

Storage resource information.

Table 4 DedicatedComputeInfo

Parameter

Type

Description

vcpus_total

Integer

Total vCPUs in the dedicated resource pool.

vcpus_used

Integer

Used vCPUs in the dedicated resource pool.

ram_total

Integer

Total memory size of the dedicated resource pool, in GB.

ram_used

Integer

Used memory size of the dedicated resource pool, in GB.

spec_code

String

Compute resource specification code of the dedicated resource pool.

host_num

Integer

Number of compute hosts in the dedicated resource pool.

Table 5 DedicatedStorageInfo

Parameter

Type

Description

spec_code

String

Storage resource specification code of the dedicated resource pool.

host_num

Integer

Number of storage hosts in the dedicated resource pool.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Querying dedicated resources

GET https://{endpoint}/v3/058497e1c100d3eb2f3cc01160616934/dedicated-resource/6e097c33-d6b9-4ca5-83cb-6cc79dcf4f06

Example Response

Status code: 200

Success.

{
  "id" : "e097c33-d6b9-4ca5-83cb-6cc79dcf4f06",
  "resource_name" : "test_dcc",
  "engine_name" : "taurus",
  "availability_zone_ids" : [ "az1xahz", "az2xahz" ],
  "architecture" : "ARM",
  "status" : "normal",
  "dedicated_compute_info" : {
    "vcpus_total" : 128,
    "vcpus_used" : 64,
    "ram_total" : 512,
    "ram_used" : 256,
    "spec_code" : "gaussdb.mysql.c6.host",
    "host_num" : 1
  },
  "dedicated_storage_info" : {
    "spec_code" : "gaussdb.mysql.dfvpool.30tb.host",
    "host_num" : 1
  }
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.