Querying DCS Instance Statuses
Function
This API is used to query the number of instances in different states.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/instances/status
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Parameter description: Project ID. For details, see Obtaining a Project ID. Constraints: N/A. Value range: N/A. Default value: N/A. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
include_failure |
No |
String |
Parameter description: Whether to return the number of instances that fail to be created. Constraints: N/A. Value range:
Default value: false |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
redis |
StatusStatistic object |
Parameter description: Redis instance quantity statistics. Value range: N/A. |
memcached |
StatusStatistic object |
Parameter description: Memcached instance quantity statistics. Value range: N/A. |
paying_count |
Integer |
Parameter description: Number of instances for which payment is in progress. Value range: N/A. |
freezing_count |
Integer |
Parameter description: Number of instances that are being frozen. Value range: N/A. |
migrating_count |
Integer |
Parameter description: Number of instances on which data migration is in progress. Value range: N/A. |
flushing_count |
Integer |
Parameter description: Number of instances whose data is being cleared. Value range: N/A. |
upgrading_count |
Integer |
Parameter description: Number of instances that are being upgraded. Value range: N/A. |
restoring_count |
Integer |
Parameter description: Number of instances for which data restoration is in progress. Value range: N/A. |
extending_count |
Integer |
Parameter description: Number of instances that are being scaled up. Value range: N/A. |
creating_count |
Integer |
Parameter description: Number of instances that are being created. Value range: N/A. |
running_count |
Integer |
Parameter description: Number of running instances. Value range: N/A. |
error_count |
Integer |
Parameter description: Number of abnormal instances. Value range: N/A. |
frozen_count |
Integer |
Parameter description: Number of frozen instances. Value range: N/A. |
createfailed_count |
Integer |
Parameter description: Number of instances that fail to be created. Value range: N/A. |
restarting_count |
Integer |
Parameter description: Number of instances that are being restarted. Value range: N/A. |
Parameter |
Type |
Description |
---|---|---|
paying_count |
Integer |
Parameter description: Number of instances for which payment is in progress. Value range: N/A. |
freezing_count |
Integer |
Parameter description: Number of instances that are being frozen. Value range: N/A. |
migrating_count |
Integer |
Parameter description: Number of instances on which data migration is in progress. Value range: N/A. |
flushing_count |
Integer |
Parameter description: Number of instances whose data is being cleared. Value range: N/A. |
upgrading_count |
Integer |
Parameter description: Number of instances that are being upgraded. Value range: N/A. |
restoring_count |
Integer |
Parameter description: Number of instances for which data restoration is in progress. Value range: N/A. |
extending_count |
Integer |
Parameter description: Number of instances that are being scaled up. Value range: N/A. |
creating_count |
Integer |
Parameter description: Number of instances that are being created. Value range: N/A. |
running_count |
Integer |
Parameter description: Number of running instances. Value range: N/A. |
error_count |
Integer |
Parameter description: Number of abnormal instances. Value range: N/A. |
frozen_count |
Integer |
Parameter description: Number of instances that have been frozen. Value range: N/A. |
createfailed_count |
Integer |
Parameter description: Number of instances that fail to be created. Value range: N/A. |
restarting_count |
Integer |
Parameter description: Number of instances that are being restarted. Value range: N/A. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Parameter description: Error message. Value range: N/A. |
error_code |
String |
Parameter description: Error code. Value range: For details, see Error Codes. |
error_ext_msg |
String |
Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Parameter description: Error message. Value range: N/A. |
error_code |
String |
Parameter description: Error code. Value range: For details, see Error Codes. |
error_ext_msg |
String |
Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A. |
Example Requests
GET https://{dcs_endpoint}/v2/{project_id}/instances/status?include_failure=true
Example Responses
Status code: 200
DCS instance quantity queried successfully.
{ "extending_count" : 0, "creating_count" : 0, "running_count" : 16, "error_count" : 0, "frozen_count" : 0, "createfailed_count" : 44, "restarting_count" : 0, "paying_count" : 0, "freezing_count" : 0, "migrating_count" : 0, "flushing_count" : 0, "upgrading_count" : 0, "redis" : { "extending_count" : 0, "creating_count" : 0, "running_count" : 8, "error_count" : 0, "frozen_count" : 0, "createfailed_count" : 22, "restarting_count" : 0, "paying_count" : 0, "freezing_count" : 0, "migrating_count" : 0, "flushing_count" : 0, "upgrading_count" : 0 }, "memcached" : { "extending_count" : 0, "creating_count" : 0, "running_count" : 8, "error_count" : 0, "frozen_count" : 0, "createfailed_count" : 22, "restarting_count" : 0, "paying_count" : 0, "freezing_count" : 0, "migrating_count" : 0, "flushing_count" : 0, "upgrading_count" : 0 } }
Status Codes
Status Code |
Description |
---|---|
200 |
DCS instance quantity queried successfully. |
400 |
Invalid request. |
500 |
Internal service error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.