Updated on 2026-03-16 GMT+08:00

Querying Dedicated Resources

Function

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

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

URI

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

**Table 1** URI parameters
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
dedicated_resource_id	Yes	String	Definition ID of the dedicated resource pool. To obtain this value, see Querying Dedicated Resource Pools. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** 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 3** Response body parameters
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 name. Range N/A
availability_zone_ids	Array of strings	Definition AZs.
architecture	String	Definition CPU architecture. Range N/A
status	String	Definition Status of the dedicated resource pool. Range NORMAL BUILDING DELETED
dedicated_compute_info	DedicatedComputeInfo object	Definition Compute resource information.
dedicated_storage_info	DedicatedStorageInfo object	Definition Storage resource information.

**Table 4** DedicatedComputeInfo
Parameter	Type	Description
vcpus_total	Integer	Definition Total vCPUs in the dedicated resource pool. Range N/A
vcpus_used	Integer	Definition Used vCPUs in the dedicated resource pool. Range N/A
ram_total	Integer	Definition Total memory size of the dedicated resource pool, in GB. Range N/A
ram_used	Integer	Definition Used memory size of the dedicated resource pool, in GB. Range N/A
spec_code	String	Definition Compute resource specification code of the dedicated resource pool. Range N/A
host_num	Integer	Definition Number of compute hosts in the dedicated resource pool. Range N/A

**Table 5** DedicatedStorageInfo
Parameter	Type	Description
spec_code	String	Definition Storage resource specification code of the dedicated resource pool. Range N/A
host_num	Integer	Definition Number of storage hosts in the dedicated resource pool. Range N/A

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.

Parent topic: Instance Management