更新时间:2024-11-26 GMT+08:00

查询实例状态

功能介绍

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

URI

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

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

参数

类型

必选

说明

project_id

String

项目ID。获取方式,参考获取项目ID

include_failure

String

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

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

请求消息

请求参数

无。

请求示例

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

响应消息

响应参数

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

参数

类型

说明

redis

StatusStatistic object

Redis实例数量统计信息。

creating_count

Integer

正在创建的实例数。

deleting_count

Integer

正在删除的实例数。

running_count

Integer

正在运行的实例数。

error_count

Integer

异常的实例数。

restarting_count

Integer

正在重启的实例数。

createfailed_count

Integer

创建失败的实例数。

extending_count

Integer

扩容中的实例数。

upgrading_count

Integer

升级中的实例数。

paying_count

Integer

支付中的实例数。

migrating_count

Integer

迁移中的实例数。

flushing_count

Integer

清空中的实例数。

closed_count

Integer

已关闭的实例数。

starting_count

Integer

启动中的实例数。

closing_count

Integer

关闭中的实例数。

restoring_count

Integer

恢复中的实例数。

表3 StatusStatistic

参数

参数类型

描述

paying_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

异常的实例数。

createfailed_count

Integer

创建失败的实例数。

restarting_count

Integer

正在重启的实例数。

状态码: 400

表4 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

最大长度:1024

error_code

String

错误码

最大长度:9

error_ext_msg

String

扩展错误信息(暂未使用,赋值为null)

最大长度:1024

状态码: 500

表5 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

最大长度:1024

error_code

String

错误码

最大长度:9

error_ext_msg

String

扩展错误信息(暂未使用,赋值为null)

最大长度:1024

响应示例

{
"paying_count":0,
"migrating_count":0,
"error_count":0,
"restarting_count":0,
"createfailed_count":0,
"flushing_count":0,
"redis":{
   "paying_count":0,
   "migrating_count":0,
   "error_count":0,
   "restarting_count":0,
   "createfailed_count":0,
   "flushing_count":0,
   "closed_count":0,
   "extending_count":2,
   "creating_count":0,
   "starting_count":0,
   "closing_count":0,
   "running_count":1,
   "upgrading_count":0,
   "restoring_count":0
   },
"closed_count":0,
"extending_count":2,
"creating_count":0,
"starting_count":0,
"closing_count":0,
"running_count":1,
"upgrading_count":0,
"restoring_count":0} 
}

状态码

操作成功的状态码如表6所示,其他响应见表1

表6 状态码

状态码

描述

200

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

400

非法请求。

500

内部服务错误。