Scale OceanBase Cluster Nodes via API - ApsaraDB for OceanBase - Alibaba Cloud - ApsaraDB for OceanBase (Deprecated)

You can call this operation to modify the number of nodes in a cluster.

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:ModifyInstanceNodeNum

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the OceanBase cluster.	ob317v4uif****
NodeNum	string	Yes	The number of nodes in the cluster. If the cluster is deployed in n-n-n mode, the number of nodes in the cluster equals n × 3.	6
DryRun	boolean	No	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 number of nodes in the instance is not modified. If the dry run succeeds, DryRunResult=true is returned. If the dry run fails, an error code is returned. false: The actual request is sent and no dry run is performed. The number of nodes is changed if the requirements are met. By default, the DryRunResult parameter returns false if you set DryRun to false.	false

Response elements

Element	Type	Description	Example
	object	The return result of the request.
RequestId	string	The ID of the request.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
Data	object	The return result of the request.
OrderId	string	The ID of the order.	21329031xxxxxxxx
DryRunResult	boolean	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

Success response

JSON format

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "Data": {
    "OrderId": "21329031xxxxxxxx",
    "DryRunResult": false
  }
}

Error codes

HTTP status code	Error code	Error message
400	Instance.Order.CreateFailed	Instance.Order.CreateFailed
400	InstanceDataSize.Invalid	InstanceDataSize.Invalid
400	InstanceClassSpecification.Invalid	InstanceClassSpecification.Invalid
400	InstanceLogSize.Invalid	InstanceLogSize.Invalid
400	Instance.ExpandLogDisk.Unsupport	Instance.ExpandLogDisk.Unsupport
400	InstanceOrder.NotAvailable	InstanceOrder.NotAvailable
400	InstanceNodeNum.Invalid	InstanceNodeNum.Invalid
400	InstanceStatus.Invalid	InstanceStatus.Invalid
400	InstanceName.ModifyFailed	InstanceName.ModifyFailed
400	InstanceClass.InvalidValue	InstanceClass.InvalidValue
400	InstanceType.Unsupport	InstanceType.Unsupport
400	InstanceId.Invalid	InstanceId.Invalid
400	InstanceId.Missing	InstanceId.Missing
400	Instance.Name.Missing	Instance.Name.Missing
400	ListCluster.Fail	ListCluster.Fail
400	GetCluster.Fail	GetCluster.Fail
400	ListClusterGroup.Fail	ListClusterGroup.Fail
400	GetClusterGroup.Fail	GetClusterGroup.Fail
400	ListInstance.Fail	ListInstance.Fail
400	GetInstance.Fail	GetInstance.Fail
400	ListTenant.Fail	ListTenant.Fail
400	GetTenant.Fail	GetTenant.Fail
400	Instance.ListAliyunInstance.Fail	Instance.ListAliyunInstance.Fail
400	Instance.GetAliyunInstance.Fail	Instance.GetAliyunInstance.Fail
400	ListZone.Fail	ListZone.Fail
400	GetObServer.Fail	GetObServer.Fail
400	CreateInstanceParameters.Error	CreateInstanceParameters.Error
400	CreateInstance.Fail	CreateInstance.Fail
400	StandbyInstance.StillOnline	StandbyInstance.StillOnline
400	InstanceServiceName.Missing	InstanceServiceName.Missing
400	PrimaryInstanceStatus.Invalid	PrimaryInstanceStatus.Invalid
400	StandbyInstanceStatus.Invalid	StandbyInstanceStatus.Invalid
400	StandbyInstance.NotSupport	StandbyInstance.NotSupport
400	StandbyInstance.Disconnect.NotAllowed	StandbyInstance.Disconnect.NotAllowed
400	InstanceDiskSize.Invalid	InstanceDiskSize.Invalid
400	CreateInstance.Spec.NotSupport	CreateInstance.Spec.NotSupport
400	MissingParameterDiskSize	MissingParameterDiskSize
400	CreateInstance.ReplicaMode.InvalidValue	CreateInstance.ReplicaMode.InvalidValue
400	CreateInstance.DeployType.InvalidValue	CreateInstance.DeployType.InvalidValue
400	AliyunInstance.NotExists	AliyunInstance.NotExists
500	Instance.Order.CreateFailed	Instance.Order.CreateFailed

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.