All Products
Search
Document Center

ApsaraDB for OceanBase:ModifyInstanceSpec

Last Updated:Feb 22, 2024

You can call this operation to modify the cluster specifications and storage space.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the OceanBase cluster.

ob3h8ytroxxxxx
InstanceClassstringNo

The specifications of the cluster. You can specify one of the following four plans:

  • 8C32GB: indicates 8 CPU cores and 32 GB of memory.
  • 14C70GB: indicates 14 CPU cores and 70 GB of memory. This is the default value.
  • 30C180GB: indicates 30 CPU cores and 180 GB of memory.
  • 62C400GB: indicates 62 CPU cores and 400 GB of memory.
14C70GB
DiskSizelongNo

The size of the storage space, in GB. The required storage space varies based on the cluster specifications:

  • 8C32G: 100 GB to 10 TB.
  • 14C70G: 200 GB to 10 TB.
  • 30C180G: 400 GB to 10 TB.
  • 62C400G: 800 GB to 10 TB. The preceding minimum storage space sizes are the default storage space sizes of the corresponding cluster specification plans.
200
DryRunbooleanNo

Specifies whether to perform only a dry run for the request. Default value: false. Valid values:

  • true: Only a dry-run request is sent and the instance settings are not modified. If the dry run succeeds, DryRunResult=true is returned. If the dry run fails, an error code is returned.
  • false: If the DryRun parameter is set to false, no dry run is performed and the DryRunResult parameter returns false.
false
DiskTypestringNo

Disk type.

cloud_essd_pl1

Response parameters

ParameterTypeDescriptionExample
object

The return result of the request.

RequestIdstring

The ID of the request.

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

The return data of the request.

OrderIdstring

The ID of the order that you have placed.

213290*********
DryRunResultboolean

The result of the dry-run request.

  • If the DryRun parameter is set to true and the dry run succeeds, the DryRunResult parameter returns true. Otherwise, an error code is returned.
  • If the DryRun parameter is set to false, no dry run is performed and the DryRunResult parameter returns false.
false

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": {
    "OrderId": "213290*********",
    "DryRunResult": false
  }
}

Error codes

HTTP status codeError codeError message
400Instance.Order.CreateFailedInstance.Order.CreateFailed
400InstanceDataSize.InvalidInstanceDataSize.Invalid
400InstanceClassSpecification.InvalidInstanceClassSpecification.Invalid
400InstanceOrder.NotAvailableInstanceOrder.NotAvailable
400InstanceNodeNum.InvalidInstanceNodeNum.Invalid
400InstanceLogSize.InvalidInstanceLogSize.Invalid
400Instance.ExpandLogDisk.UnsupportInstance.ExpandLogDisk.Unsupport
400InstanceStatus.InvalidInstanceStatus.Invalid
400InstanceName.ModifyFailedInstanceName.ModifyFailed
400InstanceClass.InvalidValueInstanceClass.InvalidValue
400InstanceType.UnsupportInstanceType.Unsupport
400ZoneList.UnsupportZoneList.Unsupport
400InstanceId.InvalidInstanceId.Invalid
400InstanceId.MissingInstanceId.Missing
400Instance.Name.MissingInstance.Name.Missing
400ListCluster.FailListCluster.Fail
400GetCluster.FailGetCluster.Fail
400ListClusterGroup.FailListClusterGroup.Fail
400GetClusterGroup.FailGetClusterGroup.Fail
400ListInstance.FailListInstance.Fail
400GetInstance.FailGetInstance.Fail
400ListTenant.FailListTenant.Fail
400GetTenant.FailGetTenant.Fail
400Instance.ListAliyunInstance.FailInstance.ListAliyunInstance.Fail
400Instance.GetAliyunInstance.FailInstance.GetAliyunInstance.Fail
400ListZone.FailListZone.Fail
400GetObServer.FailGetObServer.Fail
400CreateInstanceParameters.ErrorCreateInstanceParameters.Error
400CreateInstance.FailCreateInstance.Fail
400StandbyInstance.StillOnlineStandbyInstance.StillOnline
400InstanceServiceName.MissingInstanceServiceName.Missing
400PrimaryInstanceStatus.InvalidPrimaryInstanceStatus.Invalid
400StandbyInstanceStatus.InvalidStandbyInstanceStatus.Invalid
400StandbyInstance.NotSupportStandbyInstance.NotSupport
400StandbyInstance.Disconnect.NotAllowedStandbyInstance.Disconnect.NotAllowed
400InstanceDiskSize.InvalidInstanceDiskSize.Invalid
400CreateInstance.Spec.NotSupportCreateInstance.Spec.NotSupport
400MissingParameterDiskSizeMissingParameterDiskSize
400CreateInstance.ReplicaMode.InvalidValueCreateInstance.ReplicaMode.InvalidValue
400CreateInstance.DeployType.InvalidValueCreateInstance.DeployType.InvalidValue
400AliyunInstance.NotExistsAliyunInstance.NotExists

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

Change history

Change timeSummary of changesOperation
2023-12-26The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 500
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: DiskType
2023-12-07The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 500
2023-10-30The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 500
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: DryRun
Output ParametersThe response structure of the API has changed.
2023-07-04The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    Added Error Codes: 500
2023-05-09The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
2023-03-20The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Added Error Codes: 400