All Products
Search

This Product

    ApsaraDB for OceanBase:ModifyInstanceNodeNum

    Document Center

    ApsaraDB for OceanBase:ModifyInstanceNodeNum

    Last Updated:Apr 29, 2024

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

    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.

    		ob317v4uif****
    NodeNumstringYes

    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
    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 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.
    		true

    Response parameters

    ParameterTypeDescriptionExample
    object

    The return result of the request.

    RequestIdstring

    The ID of the request.

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

    The return result of the request.

    OrderIdstring

    The ID of the order.

    		2132903*********
    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": "2132903*********",
    "DryRunResult": false
  }
}

    Error codes

    HTTP status codeError codeError message
    400Instance.Order.CreateFailedInstance.Order.CreateFailed
    400InstanceDataSize.InvalidInstanceDataSize.Invalid
    400InstanceClassSpecification.InvalidInstanceClassSpecification.Invalid
    400InstanceLogSize.InvalidInstanceLogSize.Invalid
    400Instance.ExpandLogDisk.UnsupportInstance.ExpandLogDisk.Unsupport
    400InstanceOrder.NotAvailableInstanceOrder.NotAvailable
    400InstanceNodeNum.InvalidInstanceNodeNum.Invalid
    400InstanceStatus.InvalidInstanceStatus.Invalid
    400InstanceName.ModifyFailedInstanceName.ModifyFailed
    400InstanceClass.InvalidValueInstanceClass.InvalidValue
    400InstanceType.UnsupportInstanceType.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-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