Help Center/ Cloud Bastion Host/ API Reference/ API Description/ Network Management/ Changing the Security Group for a CBH Instance
Updated on 2026-11-05 GMT+08:00

Changing the Security Group for a CBH Instance

Function

This API is used to change the security group for a CBH instance.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{project_id}/cbs/instance/{server_id}/security-groups

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which uniquely identifies a project. 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

server_id

Yes

String

CBH instance ID, in UUID format.

For details about how to obtain the value, see "Viewing CBH Instance Details" in Cloud Bastion Host User Guide.

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 user token. For details, see Obtaining a User Token.

Constraints

N/A

Range

String type. The value can contain 1 to 28,000 characters.

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

security_groups

Yes

Array of strings

Security group information.

Response Parameters

Status code: 200

None

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_description

String

Incorrect request parameters.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_description

String

Token verification failed.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_description

String

Permissions required.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_description

String

Not CBH instances found.

Example Requests

{
  "security_groups" : [ "4967c8c3-xxxx-xxxx-xxxx-ee9638683471", "a78a0603-xxxx-xxxx-xxxx-e1313589137e" ]
}

Example Responses

None

Status Codes

Status Code

Description

200

Change Instance SecurityGroups Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.