All Products
Search

This Product

    ApsaraDB RDS:CreateDBNodes

    Document Center

    ApsaraDB RDS:CreateDBNodes

    Last Updated:Apr 28, 2024

    Adds a read-only node to an ApsaraDB RDS for MySQL 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

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

    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:CreateDBNodesWrite
    • 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****
    DBNodeobject []Yes

    The details of the node.

    classCodestringYes

    The specification information of the node.

    		mysql.n2.medium.xc
    zoneIdstringYes

    The zone ID of the node.

    		cn-zhangjiakou-a
    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.
    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.

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

    Change history

    Change timeSummary of changesOperation
    2024-04-23The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
    2024-03-22The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
    2023-11-23The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 403 change
      delete Error Codes: 400
    2023-11-07The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
    2023-10-20The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
    2023-10-20The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
    2023-09-08The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
    2023-07-24The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
    2023-06-27The 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: 403
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: ResourceGroupId
    2023-03-22The Error code 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: 403
    Output ParametersThe response structure of the API has changed.