DescribeInstanceSummary - ApsaraDB for OceanBase - Alibaba Cloud Documentation Center

Obtains the overview information about OceanBase instances.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
oceanbase:DescribeInstanceSummary	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The number of rows to return on each page. Maximum value: 100. Default value: 10.	10
PageNumber	integer	No	The number of the page to return. Start value: 1 Default value: 1	1

Response parameters

Parameter	Type	Description	Example
	object	The return result of the request.
RequestId	string	The request ID.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
InstanceSummary	object	The overview information about OceanBase instances.
TotalInstancesCount	long	The total number of instances.	3
OverLoadInstancesCount	long	The number of overloaded instances.	1
ImmediatelyExpiredInstancesCount	long	The total number of expired instances to be released.	1
RunningInstancesCount	long	The number of running instances.	1
InsufficientDiskInstancesCount	long	The total number of clusters with capacity risks.	2
ExpiredInstancesCount	long	The number of expired instances.	1
AlarmSummaryCount	long	The total number of alerts during the query period.	1
AnomalySQLCount	long	The total number of abnormal SQL statements.	1
ClusterInstancesCount	long	The number of cluster instances.	1
TenantInstancesCount	long	The number of tenant instances.	1
TotalOmsInstancesCount	long	The number of data transmission instances.	1
RegionalInstanceSummaryList	array<object>	A list of regional instances.
RegionalInstanceSummaryLis	object
Region	string	The ID of the region.	cn-shanghai
TotalInstancesCount	string	The total number of instances.	3
ImmediatelyExpiredInstancesCount	string	The number of instances about to expire.	1
RunningInstancesCount	string	The total number of running instances.	1
ExpiredInstancesCount	string	The number of expired instances.	1
RecentCreatedInstancesCount	string	The number of recently created instances.	1

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-10-29	The response structure of the API has changed	View Change Details