DescribeInstances - ApsaraDB for OceanBase - Alibaba Cloud Documentation Center

You can call this operation to obtain the list of OceanBase clusters.

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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The ID of the OceanBase cluster.	ob317v4uif****
ResourceGroupId	string	No	The ID of the resource group. If you do not specify this parameter, all resources are returned.	group1
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. Pages start from page 1. Default value: 1.	1
InstanceName	string	No	The name of the OceanBase cluster. It must be 1 to 20 characters in length. If this parameter is not specified, the value is the instance ID of the cluster by default.	ob4prod
SearchKey	string	No	The keyword for fuzzy search, which can be an instance ID, instance name, tenant ID, or tenant name.	pay

Response parameters

Parameter	Type	Description	Example
	object	The return result of the request.
Instances	array<object>	The information of the OceanBase cluster.
Data	object	The information of the OceanBase cluster.
VpcId	string	vpcId	vpc-8vb8qjrixzovjpy******
CommodityCode	string	The product code of the OceanBase cluster. oceanbase_oceanbasepre_public_cn: indicates an OceanBase cluster that is billed based on the subscription plan and that is deployed in a China site. oceanbase_oceanbasepost_public_cn: indicates an OceanBase cluster that is billed based on the pay-as-you-go plan and that is deployed in a China site. oceanbase_obpre_public_intl: indicates an OceanBase cluster that is billed based on the subscription plan and that is deployed in an international site.	oceanbase_oceanbasepost_public_cn
ExpireTime	string	The time in UTC when the cluster expires. Note This parameter is valid only for subscription instances.	2021-10-17T16:00:00Z
State	string	The status of the cluster. Valid values: ONLINE: The cluster is running. PENDING_CREATE: The cluster is being created. ARREARS_CLOSED("arrears_closed"): The cluster is suspended due to insufficient balance. PREPAID_EXPIRE_CLOSED("prepaid_expire_closed"): The cluster is suspended because the subscription has expired. WHITE_LIST_MODIFYING("white_list_modifying"): The allowlist of the cluster is being modified. SSL_MODIFYING("ssl_modifying"): The Secure Sockets Layer (SSL) settings of the cluster are being modified. PARAMETER_MODIFYING("parameter_modifying"): Parameters of the cluster are being modified. TENANT_CREATING("tenant_creating"): A tenant is being created in the cluster. TENANT_SPEC_MODIFYING("tenant_spec_modifying"): The specifications of a tenant in the cluster are being modified. EXPANDING("expanding"): Nodes are being added to the cluster. REDUCING("reducing"): Nodes are being removed from the cluster. ZONE_CHANGING("zone_changing"): Zones of the cluster are being modified. SPEC_UPGRADING: The service plan is being upgraded. SPEC_DOWNGRADING("spec_downgrading"): The plan specification is being downgraded. DISK_UPGRADING: The storage space is being expanded. UPGRADING("upgrading"): The version of the cluster is being upgraded. PENDING_DELETE("pending_delete"): The cluster is being deleted. DELETED("deleted"): The cluster has been deleted. ABNORMAL("abnormal"): The cluster is abnormal. OFFLINE("offline"): The cluster is offline. STANDBY_CREATING("standby_creating"): A standby cluster is being created for the cluster. STANDBY_DELETING("standby_deleting"): A standby cluster of the cluster is being deleted. SWITCHOVER_SWITCHING("switchover_switching"): The cluster is undergoing a primary/standby switchover. STANDBY_DISCONNECTING("standby_disconnecting"): The cluster is being decoupled from its standby cluster. LOG_DISK_UPGRADING("log_disk_upgrading"): The log disk of the cluster is being scaled out. ISOLATION_OPTIMIZATION_MODIFYING("isolation_optimization_modifying"): The isolation optimization settings of the cluster are being modified. DISKTYPE_MODIFYING("disktype_modifying"): The data disk type of the cluster is being modified. PROXY_SERVICE_CREATING("proxy_service_creating"): The proxy service is being enabled for the cluster. PROXY_SERVICE_DELETING("proxy_service_deleting"): The proxy service is being disabled for the cluster. PROXY_SERVICE_SPEC_MODIFYING("proxy_service_spec_modifying"): The proxy service specification is being modified for the cluster. READONLY_ADD_NODE("readonly_add_node"): A read-only node is being added to the cluster. READONLY_REDUCE_NODE("readonly_reduce_node"): A read-only node is being removed from the cluster. READONLY_REDUCE_ZONE("readonly_reduce_zone"): A read-only zone is being removed from the cluster. READONLY_ADD_ZONE("readonly_add_zone"): A read-only zone is being added to the cluster. READONLY_UPGRADE_SPEC("readonly_upgrade_spec"): The specification of read-only replicas is being upgraded. READONLY_UPGRADE_DISK("readonly_upgrade_disk"): The disk space of read-only replicas is being scaled out. READONLY_DOWNGRADE_SPEC("readonly_downgrade_spec"): The specification of read-only replicas is being downgraded. READONLY_DOWNGRADE_DISK("readonly_downgrade_disk"): The disk space of read-only replicas is being scaled in. CREATING_TENANT_READONLY_REPLICA("creating_tenant_readonly_replica"): A read-only replica is being created for a tenant in the cluster. DELETING_TENANT_READONLY_REPLICA("deleting_tenant_readonly_replica"): A read-only replica is being deleted for a tenant in the cluster. DISK_DOWNGRADING("disk_downgrading"): The disk space of the cluster is being scaled in. DEPLOY_MODE_MODIFYING("deploy_mode_modifying"): The deployment mode of the cluster is being modified. Note Generally, the cluster is in the ONLINE state.	ONLINE
InstanceClass	string	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.	14C70G
CreateTime	string	The time in UTC when the cluster was created.	2021-10-19T07:13:41Z
DeployMode	string	The data replica distribution mode of the cluster. The value is in the n-n-n format, where n is the number of OBServer nodes in each IDC.	1-1-1
CpuArchitecture	string	The CPU architecture of the cluster.	X86_64, AARCH64
MaintainTime	string	The time period in UTC for the daily routine maintenance of the cluster.	2021-10-19T07:13:41Z
DeployType	string	The deployment type of the cluster. Valid values: multiple: multi-IDC deployment single: single-IDC deployment dual: dual-IDC deployment	multiple
PayType	string	The billing method for the OceanBase cluster. Valid values: PREPAY: the subscription billing method. POSTPAY: the pay-as-you-go billing method.	PREPAY
DiskSize	string	The size of the storage space, in GB.	200
DiskType	string	The type of the storage disk where the cluster is deployed. The default value is cloud_essd_pl1, which indicates an ESSD cloud disk.	cloud_essd_pl1
InstanceId	string	The ID of the OceanBase cluster.	ob317v4uif****
ExpireSeconds	integer	The time elapsed since the expiration of the cluster, in seconds. Note In subscription mode, if the cluster has not expired, this parameter indicates the remaining validity period of the cluster. If the cluster has expired, this parameter indicates the time elapsed since the expiration.	2606682
Mem	long	The memory size of the instance, in GB.	70
EnableUpgradeNodes	boolean	Indicates whether new nodes can be added.	true
Cpu	integer	The number of CPU cores of the cluster.	14
AvailableZones	array	The information about the zone in which the cluster is deployed.
AvailableZones	string	The information about the zone in which the cluster is deployed.	cn-hangzhou-i
Version	string	The OBServer version.	2.2.77
InstanceName	string	The name of the OceanBase cluster.	ob4test
Series	string	The series of the OceanBase cluster. Valid values: NORMAL: the high availability edition. BASIC: the basic edition.	NORMAL
UsedDiskSize	long	The size of used storage space of the cluster, in GB.	20
ResourceGroupId	string	The ID of the resource group.	group1
Resource	object	The information about cluster resources.
Cpu	object	The information about the CPU resources of the cluster.
TotalCpu	long	The total number of CPU cores of the cluster.	14
UsedCpu	long	The number of CPU cores used in the cluster.	10
UnitCpu	long	The number of CPU cores of each replica node in the cluster.	10
OriginalTotalCpu	long	The number of original CPU cores in the cluster.	14
Memory	object	The information about the memory resources of the cluster.
TotalMemory	long	The total memory size of the cluster, in GB.	70
UsedMemory	long	The size of used memory in the cluster, in GB.	10
UnitMemory	long	The memory size of each replica node in the cluster, in GB.	10
OriginalTotalMemory	long	The original memory size of the cluster, in GB.	72
DiskSize	object	The information about the storage resources of the cluster.
TotalDiskSize	long	The total storage space of the cluster, in GB.	200
UsedDiskSize	long	The size of used storage space of the cluster, in GB.	100
UnitDiskSize	long	The storage space of each replica node in the cluster, in GB.	200
OriginalTotalDiskSize	long	The original size of the disk.	200
UnitCount	long	The number of resource units in the cluster.	1
CapacityUnit	object	The information about capacity units.
MaxCapacityUnit	integer	The maximum number of capacity units.	4
MinCapacityUnit	integer	The minimum number of capacity units.	1
UsedCapacityUnit	integer	The number of used capacity units.	2
InstanceType	string	The instance type. cluster: indicates a cluster instance. mtenant: indicates a tenant instance in MySQL mode. mtenant_serverless: indicates a serverless instance in MySQL mode.	CLUSTER
InstanceRole	string	The role of the instance.	NORMAL
InTempCapacityStatus	boolean	Specifies whether to indicate the temporary status of the capacity.	false
DataDiskAutoScaleConfig	object	Specifies parameters for the automatic scaling of the data disk.
AutoScale	boolean	Specifies whether to enable the automatic scaling of the data disk.	true
Upperbound	long	The maximum space, in GB, to which the data disk can be scaled.	16
UpperThreshold	long	The maximum usage of the data disk, in percentage, that triggers the scaling of the data disk for daily use.	80
UpperMergeThreshold	long	The maximum usage of the data disk, in percentage, that triggers the scaling of the data disk for major compactions.	90
MaxDiskSize	long	The maximum size of the disk, in GB.	80000
ScaleStepInNormal	long	The size of scaling step during daily use.	50
ScaleStepInMerge	long	The size of scaling step during a major compaction.	100
UpperScaleStrategy	string	The scale-out strategy. Valid values: RAW and PERCENTAGE.	RAW
EnableReadOnlyReplicaManagement	boolean	Indicates whether the cluster supports read-only replicas.	yes
TotalCount	integer	The number of OceanBase clusters queried.	2
RequestId	string	The request ID.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C

Examples

Sample success responses

JSONformat

{
  "Instances": [
    {
      "VpcId": "vpc-8vb8qjrixzovjpy******",
      "CommodityCode": "oceanbase_oceanbasepost_public_cn",
      "ExpireTime": "2021-10-17T16:00:00Z",
      "State": "ONLINE",
      "InstanceClass": "14C70G",
      "CreateTime": "2021-10-19T07:13:41Z",
      "DeployMode": "1-1-1",
      "CpuArchitecture": "X86_64, AARCH64",
      "MaintainTime": "2021-10-19T07:13:41Z",
      "DeployType": "multiple",
      "PayType": "PREPAY",
      "DiskSize": "200",
      "DiskType": "cloud_essd_pl1",
      "InstanceId": "ob317v4uif****",
      "ExpireSeconds": 2606682,
      "Mem": 70,
      "EnableUpgradeNodes": true,
      "Cpu": 14,
      "AvailableZones": [
        "cn-hangzhou-i"
      ],
      "Version": "2.2.77",
      "InstanceName": "ob4test",
      "Series": "NORMAL",
      "UsedDiskSize": 20,
      "ResourceGroupId": "group1",
      "Resource": {
        "Cpu": {
          "TotalCpu": 14,
          "UsedCpu": 10,
          "UnitCpu": 10,
          "OriginalTotalCpu": 14
        },
        "Memory": {
          "TotalMemory": 70,
          "UsedMemory": 10,
          "UnitMemory": 10,
          "OriginalTotalMemory": 72
        },
        "DiskSize": {
          "TotalDiskSize": 200,
          "UsedDiskSize": 100,
          "UnitDiskSize": 200,
          "OriginalTotalDiskSize": 200
        },
        "UnitCount": 1,
        "CapacityUnit": {
          "MaxCapacityUnit": 4,
          "MinCapacityUnit": 1,
          "UsedCapacityUnit": 2
        }
      },
      "InstanceType": "CLUSTER",
      "InstanceRole": "NORMAL",
      "InTempCapacityStatus": false,
      "DataDiskAutoScaleConfig": {
        "AutoScale": true,
        "Upperbound": 16,
        "UpperThreshold": 80,
        "UpperMergeThreshold": 90,
        "MaxDiskSize": 80000,
        "ScaleStepInNormal": 50,
        "ScaleStepInMerge": 100,
        "UpperScaleStrategy": "RAW"
      },
      "EnableReadOnlyReplicaManagement": true
    }
  ],
  "TotalCount": 2,
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-08-19	The response structure of the API has changed	View Change Details
2024-06-06	The response structure of the API has changed	View Change Details
2024-04-15	The response structure of the API has changed	View Change Details
2024-02-02	The response structure of the API has changed	View Change Details
2023-12-26	The response structure of the API has changed	View Change Details
2023-12-07	The response structure of the API has changed	View Change Details
2023-11-20	The response structure of the API has changed	View Change Details
2023-10-30	The response structure of the API has changed	View Change Details
2023-08-21	The response structure of the API has changed	View Change Details
2023-07-04	The response structure of the API has changed	View Change Details
2022-01-17	The response structure of the API has changed	View Change Details