文档首页> 分布式缓存服务 DCS> API参考（巴黎区域）> API V2（推荐）> 实例管理> 查询实例状态
更新时间：2023-12-13 GMT+08:00
查看PDF

查询实例状态

功能介绍

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

URI

GET /v2/{project_id}/instances/status

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参见获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

include_failure

否

String

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

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

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

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

redis

StatusStatistic object

Redis实例数量统计信息。

memcached

StatusStatistic object

Memcached实例数量统计信息。

paying_count

Integer

支付中的实例数。

freezing_count

Integer

冻结中的实例数。

migrating_count

Integer

迁移中的实例数。

flushing_count

Integer

清空中的实例数。

upgrading_count

Integer

升级中的实例数。

restoring_count

Integer

恢复中的实例数。

extending_count

Integer

扩容中的实例数。

creating_count

Integer

正在创建的实例数。

running_count

Integer

正在运行的实例数。

error_count

Integer

异常的实例数。

frozen_count

Integer

已冻结的实例数。

createfailed_count

Integer

创建失败的实例数。

restarting_count

Integer

正在重启的实例数。
表4 StatusStatistic

参数

参数类型

描述

paying_count

Integer

支付中的实例数。

freezing_count

Integer

冻结中的实例数。

migrating_count

Integer

迁移中的实例数。

flushing_count

Integer

清空中的实例数。

upgrading_count

Integer

升级中的实例数。

restoring_count

Integer

恢复中的实例数。

extending_count

Integer

扩容中的实例数。

creating_count

Integer

正在创建的实例数。

running_count

Integer

正在运行的实例数。

error_count

Integer

异常的实例数。

frozen_count

Integer

已冻结的实例数。

createfailed_count

Integer

创建失败的实例数。

restarting_count

Integer

正在重启的实例数。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

最大长度：1024

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

最大长度：1024

请求示例

GET https://{dcs_endpoint}/v2/{project_id}/instances/status?include_failure=true

响应示例

状态码： 200

查询实例数量统计信息成功。

{
  "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
  }
}

状态码

状态码

描述

200

查询实例数量统计信息成功。

400

非法请求。

500

内部服务错误。

错误码

请参见错误码。

父主题： 实例管理