Updated on 2025-08-15 GMT+08:00

Updating Cluster Routes

Function

This interface is used to update a cluster route.

Modifying the cluster route may cause service network exceptions and affect the network connection between the client and the cluster. Exercise caution when performing this operation.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/route

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

Constraints:

N/A

Value range:

Project ID of the account.

Default value:

N/A

cluster_id

Yes

String

Definition:

ID of the target cluster For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

Constraints:

N/A

Value range:

Cluster ID.

Default value:

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

configtype

Yes

String

Definition:

Operation type.

Constraints:

N/A

Value range:

  • add_ip: Add a cluster route.

  • del_ip: Delete a cluster route.

Default value:

N/A

configkey

Yes

String

Definition:

Route IP address, that is, the IP address of the server where the public network data source is located.

Constraints:

The value of this parameter cannot start with 0.

Value range:

N/A

Default value:

N/A

configvalue

Yes

String

Definition:

Subnet mask of a route. If the IP address contains 16 bits, set the subnet mask to 255.255.0.0. If the IP address contains 24 bits, set the subnet mask to 255.255.255.0.

Constraints:

The value of this parameter cannot start with 0.

Value range:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Update cluster routes.

POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/route

{
  "configtype" : "add_ip",
  "configkey" : "10.5.2.1",
  "configvalue" : "255.255.255.255"
}

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

400

Invalid request.

Modify the request instead of retrying.

409

The request cannot be processed due to a conflict.

This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.

412

The server does not meet one of the requirements that the requester puts on the request.

Error Codes

See Error Codes.