Updated on 2023-10-13 GMT+08:00

Adding an ECS to a Security Group

Function

This API is used to add an ECS to a security group.

You are suggested to add an ECS to a maximum of five security groups.

For security group details, see Security Group.

URI

POST /v2.1/{project_id}/servers/{server_id}/action

Table 1 describes the parameters in the URI.
Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

For details about how to obtain the ID, see Obtaining a Project ID.

server_id

Yes

Specifies the ECS ID.

Request

Table 2 describes the request parameters.

Table 2 Request parameter

Parameter

Mandatory

Type

Description

addSecurityGroup

Yes

Object

Specifies the security group where the ECS is added. For details, see Table 3.

Table 3 addSecurityGroup parameter description

Parameter

Mandatory

Type

Description

name

Yes

String

Specifies the UUID or name of the security group to which the ECS is added. The configuration takes effect for the NICs on the ECS.

Response

None

Example Request

Add a security group to a specified ECS.

POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action

{ 
    "addSecurityGroup": { 
        "name": "sg-test"
    }
}

Example Response

None