Querying Dedicated Resources
Function
This API is used to query dedicated resources. Before calling this API:
- Learn how to authorize and authenticate it.
- Obtain the required region and endpoint.
URI
GET /v3/{project_id}/dedicated-resource/{dedicated_resource_id}
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. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. If the following response body is returned for calling the API used to obtain a user token, the request is successful. After the request is processed, the value of X-Subject-Token in the message header is the token value. |
X-Language |
No |
String |
Request language type. The default value is en-us. Value:
|
Response Parameters
Status code: 200
Parameter |
Type |
Description |
|---|---|---|
id |
String |
ID of the dedicated resource pool. |
name |
String |
Name of the dedicated resource pool. |
engine_name |
String |
Database name. |
availability_zone_ids |
Array of strings |
AZ. |
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. |
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. |
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
Parameter |
Type |
Description |
|---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
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",
"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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
