文档首页/云数据库 GaussDB/API参考/API（推荐）/首页总览/实例状态统计 - CollectingInstanceStatusStatistics
更新时间：2025-11-13 GMT+08:00
查看PDF
分享

实例状态统计 - CollectingInstanceStatusStatistics

功能介绍

实例状态统计。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/instances-statistics

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

语言。

约束限制：

不涉及。

取值范围：

  • zh-cn
  • en-us

默认取值：

en-us

响应参数

表2 响应Body参数

参数

参数类型

描述

total_count

Integer

参数解释：

实例总数。

取值范围：

不涉及。

instances_statistics

Array of 表3 objects

参数解释：

实例统计信息。

表3 instances_statistics

参数

参数类型

描述

status

String

参数解释：

实例状态。

取值范围：

  • normal：实例状态正常。
  • abnormal：实例状态异常。
  • creating：实例创建中。
  • createfail：实例创建失败。
  • shutdown：实例已关机。
  • deleted：实例已删除。

count

Integer

参数解释：

实例数量。

取值范围：

不涉及。

请求示例

实例状态统计。

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/instances-statistics

响应示例

实例状态统计成功。

{ 
  "total_count" : "10", 
  "instances_statistics" : [ { 
    "status" : "normal", 
    "count" : 1 
  }, { 
    "status" : "abnormal", 
    "count" : 2 
  }, { 
    "status" : "creating", 
    "count" : 3 
  }, { 
    "status" : "createfail", 
    "count" : 4 
  } ] 
}

状态码

错误码

请参见错误码。

父主题：首页总览