DeleteDBNodes

Updated at:

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

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardb:DeleteDBNodes

delete

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

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:

  • RO

  • STANDBY

  • DLNode

Valid values:

  • DLNode :

    AI node.

  • STANDBY :

    Standby node.

  • RO :

    Read-only node.

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.