Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Database Proxy/ Deleting Proxy Nodes
Updated on 2024-09-11 GMT+08:00
View PDF
Share

Deleting Proxy Nodes

Function

This API is used to delete proxy nodes. Before calling this API: Proxy instances are unavailable for DB instances in a DeC.

URI

PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/reduce

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID, which is compliant with the UUID format.

proxy_id

Yes

String

Proxy instance ID, which is compliant with the UUID format.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained 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.

X-Language

No

String

Request language type. The default value is en-us.

Values:

  • en-us
  • zh-cn
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

node_num

Yes

Integer

Number of proxy nodes to be deleted.

The value is an integer from 1 to 14.

Restrictions: The total number of proxy nodes of the instance ranges from 2 to 16.

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Task ID.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Deleting proxy nodes

PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/151c14381ac14ecfb9703a745b992677po01/reduce
{ 
  "node_num" : 1
  
}

Example Response

Status code: 201

Success.

{ 
  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890" 
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Database Proxy