DescribeInstance - ApsaraDB for OceanBase - Alibaba Cloud Documentation Center

You can call this operation to query the detailed information of an OceanBase cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:DescribeInstance	Read	Instance acs:oceanbase:{#regionId}:{#accountId}:instance/{#InstanceId}/*	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The size of the data disk, in GB.	ob317v4uif****
PageSize	integer	No	The server with the highest disk usage.	10
PageNumber	integer	No	The information about the storage resources of the cluster.	1

Response parameters

Parameter	Type	Description	Example
	object	The number of resource units in the cluster.
RequestId	string	The total log disk space of the cluster, in GB.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
Instance	object	The log disk space of each replica node in the cluster. Unit: GB.
InstanceId	string	The information about the log disk space of the cluster.	ob317v4uif****
InstanceName	string	Indicates whether automatic upgrade of the OBServer version is enabled.	ob4test
InstanceClass	string	The detailed information of the OBServer version.	14C70G
Series	string	Indicates whether the OBServer version is the latest.	Indicates whether the OBServer version is the latest.
PayType	string	The list of zones.	PREPAY
CreateTime	string	Indicates whether the log disk specifications can be upgraded.	2021-10-19T07:13:41Z
ExpireTime	string	The information of the OceanBase cluster.	2021-10-17T16:00:00Z
Version	string	You can call this operation to query the detailed information of an OceanBase cluster.	2.2.77
DeployType	string	It is an online CLI tool that allows you to quickly retrieve and debug APIs. It can dynamically generate executable SDK code samples.	multiple
DeployMode	string	Alibaba Cloud CLI	1-1-1
DiskType	string	The total storage space of the cluster, in GB.	cloud_essd_pl1
MaintainTime	string	The time when the major compaction of cluster data is performed.	19:00Z-20:00Z
DataMergeTime	string	The total number of CPU cores of the cluster.	02:00
AutoRenewal	boolean	The operation that you want to perform. Set the value to DescribeInstance.	true
IsTrustEcs	boolean	The information about the CPU resources of the cluster.	true
Status	string	The information about cluster resources.	ONLINE
Resource	object	The size of used memory in the cluster, in GB.
Cpu	object	The information of the OceanBase cluster.
TotalCpu	long	The series of the OceanBase cluster. Valid values: NORMAL: the high availability edition. BASIC: the basic edition.	14
UsedCpu	long	Indicates whether automatic upgrade of the OBServer version is enabled.	10
UnitCpu	long	The type of the storage disk where the cluster is deployed. The default value is cloud_essd_pl1, which indicates an ESSD cloud disk.	10
Memory	object	The name of the OceanBase cluster.
TotalMemory	long	Indicates whether trusted ECS instances are used.	70
UsedMemory	long	The time in UTC when the cluster was created.	10
UnitMemory	long	The log disk space of each replica node in the cluster. Unit: GB.	10
DiskSize	object	The number of the page to return. Start value: 1 Default value: 1
TotalDiskSize	long	The data replica distribution mode of the cluster. Valid values: n: indicates the single-IDC mode. n-n: indicates the dual-IDC mode. n-n-n: indicates the multi-IDC mode. Note The integer n represents the number of OBServer nodes in each IDC.	200
UsedDiskSize	long	The specifications of the cluster. You can specify one of the following four plans: 8C32G: indicates 8 CPU cores and 32 GB of memory. 14C70G: indicates 14 CPU cores and 70 GB of memory. 30C180G: indicates 30 CPU cores and 180 GB of memory. 62C400G: indicates 62 CPU cores and 400 GB of memory.	100
UnitDiskSize	long	The list of zones.	200
DataUsedSize	double	The ID of the OceanBase cluster.	200
MaxDiskUsedPercent	double	The maximum disk usage, in percentage.	0.14
MaxDiskUsedObServer	array	The time in UTC when the cluster expires.
	string	Indicates whether the OBServer version is the latest.	i-bp1fhj23fs32dfbg4****
UnitCount	long	The number of CPU cores used in the cluster.	1
LogDiskSize	object	The server with the highest disk usage.
TotalDiskSize	long	The ID of the region.	400
UnitDiskSize	long	The request ID.	200
AutoUpgradeObVersion	boolean	Example 1	true
ObRpmVersion	string		2.2.77-20210526202046
IsLatestObVersion	boolean		true

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "Instance": {
    "InstanceId": "ob317v4uif****",
    "InstanceName": "ob4test",
    "InstanceClass": "14C70G",
    "Series": "Indicates whether the OBServer version is the latest. ",
    "PayType": "PREPAY",
    "CreateTime": "2021-10-19T07:13:41Z",
    "ExpireTime": "2021-10-17T16:00:00Z",
    "Version": "2.2.77",
    "DeployType": "multiple",
    "DeployMode": "1-1-1",
    "DiskType": "cloud_essd_pl1",
    "MaintainTime": "19:00Z-20:00Z",
    "DataMergeTime": "02:00",
    "AutoRenewal": true,
    "IsTrustEcs": true,
    "Status": "ONLINE",
    "Resource": {
      "Cpu": {
        "TotalCpu": 14,
        "UsedCpu": 10,
        "UnitCpu": 10
      },
      "Memory": {
        "TotalMemory": 70,
        "UsedMemory": 10,
        "UnitMemory": 10
      },
      "DiskSize": {
        "TotalDiskSize": 200,
        "UsedDiskSize": 100,
        "UnitDiskSize": 200,
        "DataUsedSize": 200,
        "MaxDiskUsedPercent": 0.14,
        "MaxDiskUsedObServer": [
          "i-bp1fhj23fs32dfbg4****"
        ]
      },
      "UnitCount": 1,
      "LogDiskSize": {
        "TotalDiskSize": 400,
        "UnitDiskSize": 200
      }
    },
    "AutoUpgradeObVersion": true,
    "ObRpmVersion": "2.2.77-20210526202046",
    "IsLatestObVersion": true,
    "AvailableZones": [
      "cn-hangzhou-i"
    ],
    "EnableUpgradeLogDisk": false,
    "Zones": [
      "cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j"
    ],
    "InstanceRole": "NORMAL",
    "NodeNum": "6",
    "Cgroup": false
  }
}

Error codes

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

Change history

Change time

Summary of changes

Operation

2024-04-15

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2024-02-02

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-12-26

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-12-07

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-11-20

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-10-30

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-08-21

The request parameters of the API has changed. The response structure of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: PageNumber
Output Parameters	The response structure of the API has changed.

2023-07-04

The request parameters of the API has changed. The response structure of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	delete Input Parameters: PageSize
	delete Input Parameters: PageNumber
Output Parameters	The response structure of the API has changed.

2023-05-17

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-03-21

The internal configuration of the API is changed, but the call is not affected

see changesets

Change item	Change content
	The internal configuration of the API is changed, but the call is not affected.

2022-08-15

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2021-08-19

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2021-08-19

Add Operation

see changesets

2021-08-19

API Description Update. The response structure of the API has changed

see changesets

Change item	Change content
API Description	API Description Update.
Output Parameters	The response structure of the API has changed.