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
|
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. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
offset |
No |
Integer |
Index offset. If offset is set to N, the resource query starts from the N+1 piece of data. The value is 0 by default, indicating that the query starts from the first piece of data. The value cannot be a negative number. |
|
limit |
No |
Integer |
Number of records to be queried. The default value is 100. The value must be a positive integer. The minimum value is 1 and the maximum value is 100. |
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 |
|---|---|---|
|
resources |
Array of DedicatedResource objects |
Dedicated resource pool information. |
|
total_count |
Integer |
Number of dedicated resource pools. |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
ID of the dedicated resource pool. |
|
resource_name |
String |
Name of the dedicated resource pool. |
|
engine_name |
String |
DB engine. |
|
architecture |
String |
CPU architecture. |
|
status |
String |
Status of the dedicated resource pool. Value:
|
|
capacity |
DedicatedResourceCapacity object |
Capacity of the dedicated resource pool. |
|
availability_zone |
Array of strings |
AZ where the dedicated resource pool is deployed. |
|
Parameter |
Type |
Description |
|---|---|---|
|
ram |
Integer |
Memory size in GB. |
|
volume |
Long |
Disk capacity in GB. |
|
vcpus |
Integer |
Number of vCPUs. |
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 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" ]
} ]
}
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.
