Help Center/ Cloud Search Service/ API Reference/ API V1/ Cluster Management/ Changing the Subnet of a Cluster
Updated on 2025-11-28 GMT+08:00
View PDF

Changing the Subnet of a Cluster

Function

This API is used to bind a new subnet to newly added nodes after cluster creation, or in the case of a cluster subnet change.

By default, subnets with the same VPC are connected. Ensure that the new subnet can reach your service system. Note that a cluster with automatic IPv6 address creation enabled can only be switched to a new subnet that uses IPv6 addresses.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/subnet/change

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 cluster whose subnet is to be changed. 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

subnet_id

Yes

String

Definition:

Subnet ID.

Constraints:

The value must be standard UUID format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.

Value range:

The value must be standard UUID format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.

Default value:

N/A

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Modify the subnet of a cluster.

POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/subnet/change

{
  "subnet_id" : "b1234567-1f77-4ae9-b64d-9af56e123456"
}

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

400

Invalid request.

Modify the request and then retry.

403

Request rejected.

The server has received the request and understood it, but refuses to respond to it. The client should not repeat the request without modifications.

Error Codes

See Error Codes.

Parent topic: Cluster Management