DescribeInstanceSummary - 获取实例概览信息 - 云数据库 OceanBase

获取 OceanBase 实例概览信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
oceanbase:DescribeInstanceSummary	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
PageSize	integer	否	分页查询时设置的每页行数。最大值：100 默认值：10	10
PageNumber	integer	否	分页查询的页码。起始值：1 默认值：1	1

返回参数

名称	类型	描述	示例值
	object	请求的返回结果
RequestId	string	请求 ID。	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
InstanceSummary	object	实例概览信息。
TotalInstancesCount	long	实例总数。	3
OverLoadInstancesCount	long	超载实例数量（个）。	1
ImmediatelyExpiredInstancesCount	long	过期待释放实例总数。	1
RunningInstancesCount	long	运行中的实例数量。	1
InsufficientDiskInstancesCount	long	具有容量风险的集群总数。	2
ExpiredInstancesCount	long	已过期的实例数量。	1
AlarmSummaryCount	long	在查询时间范围内每条记录的条数。	1
AnomalySQLCount	long	anomalysql 总数量。	1
ClusterInstancesCount	long	集群实例数量	1
TenantInstancesCount	long	租户实例数量	1
TotalOmsInstancesCount	long	数据传输实例数。	1
RegionalInstanceSummaryList	array<object>	地域实例概要列表。
RegionalInstanceSummaryLis	object
Region	string	地域 ID。	cn-shanghai
TotalInstancesCount	long	实例总数。	3
ImmediatelyExpiredInstancesCount	long	即将过期实例数。	1
RunningInstancesCount	long	运行中实例总数。	1
ExpiredInstancesCount	long	已过期实例数。	1
RecentCreatedInstancesCount	long	近期创建实例数。	1

示例

正常返回示例

JSON格式

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "InstanceSummary": {
    "TotalInstancesCount": 3,
    "OverLoadInstancesCount": 1,
    "ImmediatelyExpiredInstancesCount": 1,
    "RunningInstancesCount": 1,
    "InsufficientDiskInstancesCount": 2,
    "ExpiredInstancesCount": 1,
    "AlarmSummaryCount": 1,
    "AnomalySQLCount": 1,
    "ClusterInstancesCount": 1,
    "TenantInstancesCount": 1,
    "TotalOmsInstancesCount": 1,
    "RegionalInstanceSummaryList": [
      {
        "Region": "cn-shanghai",
        "TotalInstancesCount": 3,
        "ImmediatelyExpiredInstancesCount": 1,
        "RunningInstancesCount": 1,
        "ExpiredInstancesCount": 1,
        "RecentCreatedInstancesCount": 1
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。