文档首页/分布式缓存服务 DCS/API参考 (联盟区域) /API V2（推荐）/实例管理/查询实例状态
更新时间：2025-12-29 GMT+08:00
查看PDF
分享

查询实例状态

功能介绍

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

URI

GET /v2/{project_id}/instances/status

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

include_failure

否

String

参数解释：

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

约束限制：

不涉及。

取值范围：

  • true：返回的统计包括创建失败的实例数。

  • false：返回的统计不包括创建失败的实例数。

默认取值：

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

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

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

取值范围：

不涉及。

状态码：500

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

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

取值范围：

不涉及。

请求示例

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

内部服务错误。

错误码

请参见错误码。

父主题：实例管理