Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Instance Management/ Deleting Coordinator Nodes
Updated on 2025-10-20 GMT+08:00
View PDF
Share

Deleting Coordinator Nodes

Function

This API is used to delete coordinator nodes (CNs). Before calling this API:

Constraints

  • Number of CNs to be deleted at a time: 1 to 10
  • At least one CN must be reserved.
  • All CNs must be available.
  • The instance must be available.
  • The first CN cannot be deleted. If you attempt to delete it, another CN will be randomly deleted instead.

Debugging

You can debug this API in API Explorer.

URI

DELETE /v3/{project_id}/instances/{instance_id}/coordinators

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value can contain 36 characters. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token.

You can obtain the token by calling the IAM API used to obtain a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Language.

Constraints

N/A

Range

  • zh-cn
  • en-us

Default Value

en-us
Table 3 Parameter description

Parameter

Mandatory

Type

Description

node_id_list

Yes

Array of String

Definition

IDs of nodes to be deleted.

Constraints

N/A

Response Parameters

Table 4 Response parameters

Parameter

Type

Description

job_id

String

Definition

ID of the job for changing an instance name.

Range

N/A

order_id

String

Definition

Order ID. This parameter is returned only when your instance is billed at a yearly/monthly basis. No information is returned when you unsubscribe from a yearly/monthly instance that has expired.

Range

N/A

Example Request

DELETE https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/coordinators
{
    "node_id_list":
    [
        "b26011bf0bd846f99dcede26ef11e329no14"
    ]
}

Example Response

 
{
	"job_id": "2b414788a6004883a02390e2eb0ea227"
        "order_id": "CS2309190334JSMCV"
}

Status Code

Error Codes

For details, see Error Codes.

Parent topic: Instance Management