DocsICP FilingConsole
官方文档
首页

DescribeInstances

更新时间：
复制 MD 格式
产品详情
我的收藏

Retrieves a list of OceanBase clusters.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

oceanbase:DescribeInstances

list

*All Resource

*

 None None

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 omit this parameter, the API returns instances from all resource groups.

group1
PageSize

integer

No

The number of entries to return on each page.

  • Maximum value: 100.

  • Default value: 10.

10
PageNumber

integer

No

The page number.

  • Starts from 1.

  • Default value: 1.

1
InstanceName

string

No

The name of the OceanBase cluster. The name must be 1 to 20 characters long and can contain English or Chinese characters. If this parameter is not specified, the default value is the instance ID of the cluster.

ob4prod
SearchKey

string

No

The keyword for a fuzzy search on the instance ID, instance name, tenant ID, and tenant name.

pay
WithOBCloudInstances

boolean

No

Response elements

Element

Type

Description

Example

object

The returned data.

Instances

array<object>

Details of the OceanBase clusters.

array<object>

The details of a single OceanBase cluster.

VpcId

string

The ID of the VPC.

vpc-8vb8qjrixzovjpy******
CommodityCode

string

The product code of the OceanBase cluster.

  • oceanbase_oceanbasepre_public_cn: indicates a subscription OceanBase cluster on the China site.

  • oceanbase_oceanbasepost_public_cn: indicates a pay-as-you-go OceanBase cluster on the China site.

  • oceanbase_obpre_public_intl: indicates a subscription OceanBase cluster on the international site.

  • oceanbase_obpost_public_intl: indicates a pay-as-you-go OceanBase cluster on the international site.

oceanbase_oceanbasepost_public_cn
ExpireTime

string

The expiration time of the cluster, in UTC.

Note

This parameter is returned only for subscription instances.

2021-10-17T16:00:00Z
State

string

The cluster status.

  • ONLINE: Running.

  • PENDING_CREATE: Creating.

  • ARREARS_CLOSED: The pay-as-you-go cluster is shut down due to an overdue payment.

  • PREPAID_EXPIRE_CLOSED: The subscription cluster is shut down after it expires.

  • WHITE_LIST_MODIFYING: The IP whitelist is being modified.

  • SSL_MODIFYING: The SSL configuration is being changed.

  • PARAMETER_MODIFYING: Parameters are being modified.

  • TENANT_CREATING: A tenant is being created.

  • TENANT_SPEC_MODIFYING: The instance type of a tenant is being modified.

  • EXPANDING: Nodes are being scaled out.

  • REDUCING: Nodes are being scaled in.

  • ZONE_CHANGING: Availability zones are being changed.

  • SPEC_UPGRADING: The instance type is being scaled up.

  • SPEC_DOWNGRADING: The instance type is being scaled down.

  • DISK_UPGRADING: The storage space is being scaled up.

  • UPGRADING: The cluster is being upgraded.

  • PENDING_DELETE: The cluster is being deleted.

  • DELETED: The cluster is deleted.

  • ABNORMAL: The cluster is in an abnormal state.

  • OFFLINE: The cluster is offline.

  • STANDBY_CREATING: A standby cluster is being created.

  • STANDBY_DELETING: A standby cluster is being deleted.

  • SWITCHOVER_SWITCHING: A primary/standby switchover is in progress.

  • STANDBY_DISCONNECTING: A standby cluster is being detached.

  • LOG_DISK_UPGRADING: The log disk is being scaled up.

  • ISOLATION_OPTIMIZATION_MODIFYING: The isolation optimization settings are being changed.

  • DISKTYPE_MODIFYING: The data disk type is being changed.

  • PROXY_SERVICE_CREATING: The proxy service is being enabled.

  • PROXY_SERVICE_DELETING: The proxy service is being disabled.

  • PROXY_SERVICE_SPEC_MODIFYING: The proxy service specifications are being modified.

  • READONLY_ADD_NODE: A read-only node is being added.

  • READONLY_REDUCE_NODE: A read-only node is being removed.

  • READONLY_REDUCE_ZONE: The availability zone for the read-only replica is being removed.

  • READONLY_ADD_ZONE: The availability zone for the read-only replica is being added.

  • READONLY_UPGRADE_SPEC: The instance type of the read-only replica is being scaled up.

  • READONLY_UPGRADE_DISK: The storage space of the read-only replica is being scaled up.

  • READONLY_DOWNGRADE_SPEC: The instance type of the read-only replica is being scaled down.

  • READONLY_DOWNGRADE_DISK: The storage space of the read-only replica is being scaled down.

  • CREATING_TENANT_READONLY_REPLICA: A read-only replica is being created for the tenant.

  • DELETING_TENANT_READONLY_REPLICA: The read-only replica of the tenant is being deleted.

  • DISK_DOWNGRADING: The storage space is being scaled down.

  • DEPLOY_MODE_MODIFYING: The deployment mode is being changed.

Note

Typically, a cluster is in the Running (ONLINE) state.

ONLINE
InstanceClass

string

The instance type of the cluster. Supported types include:

  • 4C16GB: 4 cores, 16 GB of memory.

  • 8C32GB: 8 cores, 32 GB of memory.

  • 14C70GB: 14 cores, 70 GB of memory.

  • 24C120GB: 24 cores, 120 GB of memory.

  • 30C180GB: 30 cores, 180 GB of memory.

  • 62C400GB: 62 cores, 400 GB of memory.

  • 104C600GB: 104 cores, 600 GB of memory.

  • 16C70GB: 16 cores, 70 GB of memory.

  • 32C160GB: 32 cores, 160 GB of memory.

  • 64C380GB: 64 cores, 380 GB of memory.

  • 20C32GB: 20 cores, 32 GB of memory.

  • 40C64GB: 40 cores, 64 GB of memory.

  • 16C32GB: 16 cores, 32 GB of memory.

  • 32C70GB: 32 cores, 70 GB of memory.

  • 64C180GB: 64 cores, 180 GB of memory.

  • 32C180GB: 32 cores, 180 GB of memory.

  • 64C400GB: 64 cores, 400 GB of memory.

14C70G
CreateTime

string

The time when the cluster was created, in UTC.

2021-10-19T07:13:41Z
DeployMode

string

The distribution mode of data replicas, formatted as n-n-n. Each n represents the number of OBServer nodes in a data center.

1-1-1
CpuArchitecture

string

The CPU architecture of the cluster.

X86_64、 AARCH64
MaintainTime

string

The daily maintenance window of the cluster, in UTC.

19:00Z-20:00Z
DeployType

string

The deployment type of the cluster.

  • multiple: multiple data centers.

  • single: a single data center.

  • dual: dual data centers.

multiple
PayType

string

The billing method of the OceanBase cluster:

  • PREPAY: subscription.

  • POSTPAY: pay-as-you-go.

PREPAY
DiskSize

integer

The storage space, in GB.

200
DiskType

string

The storage type of the cluster.

cloud_essd_pl1
InstanceId

string

The ID of the OceanBase cluster.

ob317v4uif****
ExpireSeconds

integer

The remaining validity period of the cluster, in seconds.

Note

For subscription clusters, if the cluster has not expired, this parameter indicates the remaining validity period. If the cluster has expired, this parameter indicates the duration since expiration.

2606682
Mem

integer

The memory size, in GB.

70
EnableUpgradeNodes

boolean

Indicates whether you can add new nodes.

true
Cpu

integer

The number of CPU cores.

14
AvailableZones

array

The availability zones where the cluster is deployed.

string

An availability zone where the cluster is deployed.

cn-hangzhou-i
Version

string

The OBServer version.

2.2.77
InstanceName

string

The name of the OceanBase cluster. The name must be 1 to 20 characters in length and can contain letters or Chinese characters. If this parameter is not specified, the value of InstanceId is used by default.

ob4test
Series

string

The series of the OceanBase instance.

  • normal (default): Standard Cluster Edition (cloud disk).

  • normal_ssd: Standard Cluster Edition (local disk).

  • history: History Database Cluster Edition.

  • normal_kv: OBKV cluster.

  • normal_hg: a trusted computing cluster.

NORMAL
UsedDiskSize

integer

The used storage space, in GB.

20
ResourceGroupId

string

The ID of the resource group.

group1
Resource

object

The resource information of the cluster.

Cpu

object

The CPU resource information of the cluster.

TotalCpu

number

The total number of CPU cores.

14
UsedCpu

number

The number of used CPU cores.

10
UnitCpu

number

The number of CPU cores per replica node.

10
OriginalTotalCpu

number

The original total number of CPU cores.

14
Memory

object

The memory resource information of the cluster.

TotalMemory

number

The total memory size, in GB.

70
UsedMemory

integer

The amount of memory used, in GB.

10
UnitMemory

integer

The memory size of each replica node, in GB.

10
OriginalTotalMemory

number

The original total memory size.

72
DiskSize

object

The storage resource information of the cluster.

TotalDiskSize

number

The total storage space, in GB.

200
UsedDiskSize

integer

The used storage space, in GB.

100
UnitDiskSize

number

The storage space of each replica node, in GB.

200
OriginalTotalDiskSize

number

The original total disk size.

200
UnitCount

integer

The number of resource units in the cluster.

1
CapacityUnit

object

The capacity unit.

MaxCapacityUnit

integer

The maximum capacity unit.

4
MinCapacityUnit

integer

The minimum capacity unit.

1
UsedCapacityUnit

integer

The number of used capacity units.

2
InstanceType

string

The type of the instance.

  • cluster: cluster instance.

  • mtenant: tenant instance in MySQL mode.

  • mtenant_serverless: Serverless instance in MySQL mode.

CLUSTER
InstanceRole

string

The role of the instance.

NORMAL
InTempCapacityStatus

boolean

Indicates whether the cluster has temporary capacity.

false
DataDiskAutoScaleConfig

object

The auto-scaling configuration of the data disk.

AutoScale

boolean

Indicates whether auto-scaling is enabled.

true
Upperbound

number

The upper limit for scaling.

16
UpperThreshold

number

The threshold for routine scaling.

80
UpperMergeThreshold

number

The threshold for scaling out during major compactions.

90
MaxDiskSize

integer

The maximum disk size.

80000
ScaleStepInNormal

number

The step size for routine scaling.

50
ScaleStepInMerge

number

The step size for scaling during major compactions.

100
UpperScaleStrategy

string

The scaling strategy. Valid values: RAW and PERCENTAGE.

RAW
EnableReadOnlyReplicaManagement

boolean

Indicates whether read-only replicas can be purchased for the cluster.

yes
SpecType

string

The specification type.

dedicatedspec
ObRpmVersion

string

The RPM version of the cluster.

4.2.1.7-107030032024062709
ReplicaMode

string

The replica mode of the cluster.

3F、2F1A
Migratable

boolean

MigrationInfo

object

Information about migrating to Alibaba Cloud Marketplace.

Migratable

boolean

Indicates whether the instance can be migrated.

CheckResult

object

Provides the reason if migration is not supported.

Level

string

The level of the check result.

Code

string

The code of the check item.

CodeName

string

The description of the check item.

Module

string

The name of the module.

ModuleName

string

The display name of the module.

SubModule

string

The name of the submodule.

SubModuleName

string

The display name of the submodule.

Iops

integer

10000
TotalCount

integer

The total number of returned clusters.

2
RequestId

string

The request ID.

EE205C00-30E4-****-****-87E3A8A2AA0C

Examples

Success response

JSON format

{
  "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": "19:00Z-20:00Z",
      "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,
      "SpecType": "dedicatedspec",
      "ObRpmVersion": "4.2.1.7-107030032024062709",
      "ReplicaMode": "3F、2F1A",
      "Migratable": false,
      "MigrationInfo": {
        "Migratable": false,
        "CheckResult": {
          "Level": "",
          "Code": "",
          "CodeName": "",
          "Module": "",
          "ModuleName": "",
          "SubModule": "",
          "SubModuleName": ""
        }
      },
      "Iops": 10000
    }
  ],
  "TotalCount": 2,
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.