文档首页/ 分布式缓存服务 DCS/ API参考/ 历史API/ 实例管理/ 查询实例状态
更新时间：2023-12-12 GMT+08:00
查看PDF
分享

查询实例状态

功能介绍

查询该租户在当前区域下不同状态的实例数。

URI

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

参数说明见表1。
表1 参数说明

参数

类型

必选

说明

project_id

String

是

项目ID。

includeFailure

String

否

是否返回创建失败的实例数。

  • 当参数值为“true”时，返回的统计包括创建失败的实例数。
  • 参数值为“false”或者其他值，返回的统计不包括创建失败的实例数。

请求消息

请求参数

无。

请求示例

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

响应消息

响应参数

参数说明见表2。
表2 参数说明

参数

类型

说明

creating_count

Integer

正在创建的实例数。

frozen_count

Integer

已冻结的实例数。

deleting_count

Integer

正在删除的实例数。

running_count

Integer

正在运行的实例数。

error_count

Integer

异常的实例数。

restarting_count

Integer

正在重启的实例数。

createfailed_count

Integer

创建失败的实例数。

extending_count

Integer

扩容中的实例数。

响应示例

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

状态码

操作成功的状态码如表3所示，其他响应见表1。

表3 状态码

状态码

描述

200

查询实例数量统计信息成功。
父主题： 实例管理