DeleteDBNodes
Deletes a read-only node from a PolarDB cluster.
Operation description
Deletes a read-only node from a PolarDB cluster. Before you call this operation, the cluster must be in the Running state. You can call the DescribeDBClusters operation to query the DBClusterStatus parameter and check the cluster state. If the cluster is in a transitional state such as DBNodeCreating or DBNodeDeleting, wait until the cluster returns to the Running state before you call this operation.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
polardb:DeleteDBNodes |
delete |
*dbcluster
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| DBClusterId |
string |
Yes |
The ID of the cluster. |
pc-************** |
| ClientToken |
string |
No |
The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token is case-sensitive and can be up to 64 ASCII characters in length. |
6000170000591aed949d0f54a343f1a42*********** |
| DBNodeType |
string |
No |
The type of the node. Valid values:
Valid values:
|
RO |
| DBNodeId |
array |
Yes |
The ID of the node in the cluster. Note
You can call the DescribeDBClusters operation to query the details of all clusters under your account, including the node IDs. |
pi-************ |
|
string |
No |
The ID of the node in the cluster. N is a positive integer starting from 1. The maximum value of N is the current number of nodes minus 2, which means that at least one primary node and one read-only node must be retained. Note
Currently, only PolarDB for MySQL clusters support deleting multiple read-only nodes at a time. |
pi-**************** |
|
| CloudProvider |
string |
No |
The service provider of the node. |
ENS |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The ID of the request. |
6566B2E6-3157-4B57-A693-AFB751****** |
| DBClusterId |
string |
The ID of the database cluster. |
pc-************** |
| OrderId |
string |
The ID of the order. |
2035638******* |
Examples
Success response
JSON format
{
"RequestId": "6566B2E6-3157-4B57-A693-AFB751******",
"DBClusterId": "pc-**************",
"OrderId": "2035638*******"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidDBNodeNum.Malformed | The number of parameter DBNode.N is not valid. | The specified number of database nodes is invalid. |
| 400 | OperationDenied.DeleteDBNodesWithStrictConsistencyOn | 3AZ cluster does not allow delete db nodes. | Nodes cannot be deleted for multi-zone clusters. |
| 400 | InvalidDBNode.Malformed | The specified parameter DBNode.N is not valid. | The specified DBNode.N parameter is invalid. |
| 403 | OperationDenied.DBNodeRole | The operation is not permitted due to the role of node. | This operation is not supported by the node role. |
| 404 | InvalidDBClusterId.NotFound | The DBClusterId provided does not exist in our records. | The specified DBClusterId parameter does not exist in the current record. |
| 404 | InvalidDBClusterId.Malformed | The specified parameter DBClusterId is not valid. | The specified DBClusterId parameter is invalid. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.