All Products
Search
Document Center

PolarDB:DeleteDBNodes

Last Updated:Oct 15, 2024

Deletes a read-only node from a PolarDB 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
polardb:DeleteDBNodesdelete
  • dbcluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the cluster.

pc-**************
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. The token is case-sensitive.

6000170000591aed949d0f54a343f1a42***********
DBNodeTypestringNo

The type of the node. Valid values:

  • RO
  • STANDBY
Enumeration Value:
  • DLNode: ai node.
  • STANDBY: standby node.
  • RO: read-only node.
RO
DBNodeIdarrayYes

The IDs of the nodes.

Note You can call the DescribeDBClusters operation to query the details of all clusters that belong to your Alibaba Cloud account, such as the cluster ID.
stringYes

The ID of the node. N is a positive integer that starts from 1. The maximum value of N is the number of current nodes minus 2. Each cluster must contain at least one primary node and one read-only node.

Note You can delete multiple read-only nodes at the same time only in PolarDB for MySQL clusters
pi-****************

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

6566B2E6-3157-4B57-A693-AFB751******
DBClusterIdstring

The ID of the cluster.

pc-**************
OrderIdstring

The ID of the order.

2035638*******

Examples

Sample success responses

JSONformat

{
  "RequestId": "6566B2E6-3157-4B57-A693-AFB751******",
  "DBClusterId": "pc-**************",
  "OrderId": "2035638*******"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidDBNodeNum.MalformedThe number of parameter DBNode.N is not valid.The specified number of database nodes is invalid.
400OperationDenied.DeleteDBNodesWithStrictConsistencyOn3AZ cluster does not allow delete db nodes.Nodes cannot be deleted for multi-zone clusters.
400InvalidDBNode.MalformedThe specified parameter DBNode.N is not valid.The specified DBNode.N parameter is invalid.
403OperationDenied.DBNodeRoleThe operation is not permitted due to the role of node.This operation is not supported by the node role.
404InvalidDBClusterId.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.
404InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.The specified DBClusterId parameter is invalid.

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

Change history

Change timeSummary of changesOperation
2023-09-12The Error code has changedView Change Details
2023-06-20The Error code has changed. The request parameters of the API has changedView Change Details