All Products
Search
Document Center

ApsaraDB for OceanBase:DescribeAvailableSpec

Last Updated:Nov 14, 2025

You can call this operation to query the specifications available for an OceanBase cluster.

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.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
oceanbase:DescribeAvailableSpecnone
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the OceanBase cluster.

ob317v4uif****
UpgradeTypestringYes

The type of the specification change. Valid values:

  • upgradenodenum: Increases the number of nodes.
  • downgradespec: Downgrades the specification plan.
  • upgradespec: Upgrades the specification plan.
  • upgradedisk: Increases the disk size.
  • downgradenodenum: Reduces the number of nodes.
Enumeration Value:
  • downgradedisk: downgradedisk.
  • upgradenodenum: upgradenodenum.
  • downgradespec: downgradespec.
  • upgradespec: upgradespec.
  • upgradedisk: upgradedisk.
  • downgradenodenum: downgradenodenum.
upgradespec
SpecstringNo

The specifications of the node.

oceanbase.cluster.cd8.xlarge

Response parameters

ParameterTypeDescriptionExample
object

The return result of the request.

RequestIdstring

The ID of the request.

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
Dataobject

The returned data.

AvailableSpecificationsarray<object>

The specifications available for the cluster.

AvailableSpecificationsobject

The specifications available for the cluster.

Specstring

The specifications of the migration instance.

oceanbase.cluster.cd8.xlarge
InstanceClassstring

The specifications of the cluster.

4C16GB
NodeNumarray

The number of nodes.

NodeNuminteger

The number of nodes.

3
DiskSizeRangeobject

The storage size.

Steplong

The minimum adjustment step.

5
Maxlong

The maximum value of the parameter.

40000
Minlong

The minimum value of the parameter.

1000
LogDiskSizeRangeobject

The size of the log disk.

Steplong

The minimum adjustment step.

5
Maxlong

The maximum value of the parameter.

4000
Minlong

The minimum value of the parameter.

100
DiskTypesarray

存储类型列表信息。

DiskTypesstring

存储类型。

cloud_essd_pl1

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "Data": {
    "AvailableSpecifications": [
      {
        "Spec": "oceanbase.cluster.cd8.xlarge",
        "InstanceClass": "4C16GB",
        "NodeNum": [
          3
        ],
        "DiskSizeRange": {
          "Step": 5,
          "Max": 40000,
          "Min": 1000
        },
        "LogDiskSizeRange": {
          "Step": 5,
          "Max": 4000,
          "Min": 100
        },
        "DiskTypes": [
          "cloud_essd_pl1"
        ]
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-12-26The response structure of the API has changedView Change Details
2023-11-07The response structure of the API has changedView Change Details