All Products
Search
Document Center

ApsaraDB RDS:CreateDBNodes

Last Updated:Dec 05, 2024

Adds a node to an ApsaraDB RDS for MySQL or ApsaraDB RDS for PostgreSQL instance that runs RDS Cluster Edition. An RDS instance that runs RDS Cluster Edition is referred to as an RDS cluster.

Operation description

Supported database engines

MySQL

References

Note Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.

Add a node to an ApsaraDB RDS for MySQL 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:
    • The required resource types are displayed in bold characters.
    • 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
rds:CreateDBNodescreate
*DBInstance
acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests.

The token can contain only ASCII characters and cannot exceed 64 characters in length.

ETnLKlblzczshOTUbOCz****
DBInstanceIdstringYes

The instance ID You can call the DescribeDBInstances operation to query the instance ID.

rm-2ze450g4ctg6t****
DBNodearray<object>Yes

The details of the node.

objectYes

The details of the node.

classCodestringYes

The specification information of the node.

mysql.n2.medium.xc
zoneIdstringYes

The ID of the zone in which the node is deployed.

cn-zhangjiakou-a
vswitchIdstringNo

The vSwitch ID of the node.

vsw-bp1sxxsodv28ey5dl****
ResourceGroupIdstringNo

The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID.

rg-acfmy*****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

7A41C147-C8D0-4DAE-A1A2-17EBCD60DFA1
DBInstanceIdstring

The ID of the instance.

rm-2ze450g4ctg6t****
OrderIdlong

The ID of the order.

2133400000*****
NodeIdsstring

The ID of the created node. The value is a string. Multiple values are separated by commas (,).

rn-abcd2*****

Examples

Sample success responses

JSONformat

{
  "RequestId": "7A41C147-C8D0-4DAE-A1A2-17EBCD60DFA1",
  "DBInstanceId": "rm-2ze450g4ctg6t****",
  "OrderId": 0,
  "NodeIds": "rn-abcd2*****"
}

Error codes

HTTP status codeError codeError messageDescription
400DBNodeFormatFaultThe specified parameter DBNode is malformedThe specified dbNode parameter is invalid.
400DBNodeParameterRequiredThe specified parameter DBNode is required.You must specify the dbNode parameter.
400DBNodeParameterTooManyItemsThe specified parameter DBNode has too many items.An excessive number of nodes are added for dbNode.
400DBNodeParameter.InvalidClassCodeThe ClassCode of the item of the specified parameter DBNode is inconsistent.The ClassCode configuration is invalid for the DBNode parameter.
400DBNodeParameter.InvalidValueThe specific param DBNode is not valid.-
400DBNodeParameter.NotFoundThe specified parameter DBNode is not valid.-
400InvalidMultiTenantMulti tenants cannot exist in a same instance.-
400InvalidClassCodeThe specification code in the parameter is invalid.The specification code in the parameter is invalid.
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.A package instance is not allowed to operate independently.
400Price.PricingPlanResultNotFoundPricing plan price result not found.Pricing plan price result not found.
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.Your account available limit is less than 0, please recharge before trying to purchase.
400CommodityServiceCalling.ExceptionFailed to call commodity service.Failed to call commodity service return.
400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.The module you purchased is not legal, please buy it again.
400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.Hello customer, this area has been abolished.
400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.Hello customer, this area has been abolished.
400Price.CommoditySysCommodity system call exception.Commodity system call exception.
400Pay.InsufficientBalanceInsufficient available balance.Insufficient available balance.
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.There is a problem with the period you selected, please choose again.
400pay.noCreditCardAccount not bound to credit card.-
400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.-
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.Your basic information is not complete, please complete your basic information before operation.
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.Your account is abnormal, please contact customer service for details.
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.-
400System.SaleValidateFailedSales expression validation system error.A system error occurs when the sales expression is verified.
400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
403GroupReplicationNotSupport.InvalidEngineVersionGroup Replication requires the instance engine version to be 8.0.-
403GroupReplicationNotSupport.InvalidNodeClassCodeGroup Replication requires the ClassCode of each node to be consistent.-
403GroupReplicationNotSupport.InvalidNodeNumGroup Replication is not supported, the number of nodes must be an odd number greater than or equal to 3.-
403GroupReplicationNotSupport.InvalidXengineGroup Replication is not supported because the instance has xengine tables.-
403GroupReplicationNotSupport.MemoryTooSmallGroup Replication is not supported because the memory is too small.-
403OperationDenied.DBTypeThe operation is not permitted due to type of the database.The operation is not supported for the database engine of the RDS instance.
403OrderStatus.UnPaidThe specified db instance has unpaid order.The instance has an unpaid order. Please pay first and try again.

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

Change history

Change timeSummary of changesOperation
2024-04-23The Error code has changedView Change Details
2024-03-22The Error code has changedView Change Details
2023-11-23The Error code has changedView Change Details
2023-11-07The Error code has changedView Change Details
2023-10-20The Error code has changedView Change Details
2023-10-20The Error code has changedView Change Details
2023-09-08The Error code has changedView Change Details
2023-07-24The Error code has changedView Change Details
2023-06-27The Error code has changed. The request parameters of the API has changedView Change Details
2023-03-22The Error code has changed. The response structure of the API has changedView Change Details