Help Center> Distributed Cache Service> API Reference> Instance Management APIs> Querying DCS Instance Status
View PDF

Querying DCS Instance Status

Function

This API is used to query the number of instances in different states.

URI

GET /v1.0/{project_id}/instances/status?includeFailure={includeFailure}

Table 1 describes the parameters.
Table 1 Parameter description

Parameter

Type

Mandatory

Description

project_id

String

Yes

Project ID.

includeFailure

String

No

An indicator of whether the number of DCS instances that failed to be created will be returned to the API caller. Options:

  • true: The number of DCS instances that failed to be created will be returned to the API caller.
  • false or others: The number of DCS instances that failed to be created will not be returned to the API caller.

Request

Request parameters

None.

Example request

GET https://{dcs_endpoint}/v1.0/{project_id}/instances/status?includeFailure=true

Response

Response parameters

Table 2 describes the response parameters.
Table 2 Parameter description

Parameter

Type

Description

creating_count

Integer

Number of instances that are being created.

frozen_count

Integer

Number of instances that have been frozen.

deleting_count

Integer

Number of instances that are being deleted.

running_count

Integer

Number of running instances.

error_count

Integer

Number of abnormal instances.

restarting_count

Integer

Number of instances that are being restarted.

createfailed_count

Integer

Number of instances that fail to be created.

extending_count

Integer

Number of instances that are being scaled up.

Example response

{
    "extending_count": 0,
    "creating_count": 0,
    "deleting_count": 0, 
    "running_count": 16,
    "error_count": 0,
    "frozen_count": 0,
    "restarting_count": 0,
    "createfailed_count": 44
}

Status Code

Table 3 describes the status code of successful operations. For details about other status codes, see Table 1.

Table 3 Status code

Status Code

Description

200

Quantities of DCS instances in different statuses queried successfully.
Parent topic: Instance Management APIs