Updated on 2023-05-29 GMT+08:00

Adding NICs to an ECS in a Batch

Function

This API is used to add one or multiple NICs to an ECS.

URI

POST /v1/{project_id}/cloudservers/{server_id}/nics

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 parameters

Parameter

Mandatory

Type

Description

nics

Yes

Array of objects

Specifies the NICs to be added. For details, see Table 3.

Table 3 nics field description

Parameter

Mandatory

Type

Description

subnet_id

Yes

String

Specifies the information about the NICs to be added to an ECS.

The value must be the ID of a created network in UUID format.

security_groups

No

Array of objects

Specifies the security groups for NICs. For details, see Table 4.

ip_address

No

String

Specifies the IP address. If this parameter is unavailable, the IP address is automatically assigned.

ipv6_enable

No

Boolean

Indicates whether to support IPv6 addresses.

If this parameter is set to true, the NIC supports IPv6 addresses.

ipv6_bandwidth

No

Object

Specifies the bound shared bandwidth. For details, see ipv6_bandwidth Field Description.

Table 4 security_groups field description

Parameter

Mandatory

Type

Description

id

Yes

String

Specifies the ID of the security group.

Response

See Responses (Task).

Example Request

POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/nics
{
    "nics": [
        {
            "subnet_id": "d32019d3-bc6e-4319-9c1d-6722fc136a23", 
            "security_groups": [
                {
                    "id": "f0ac4394-7e4a-4409-9701-ba8be283dbc3"
                }
            ]
        }
    ]
}

Example Response

{      
    "job_id": "70a599e0-31e7-49b7-b260-868f441e862b" 
} 

Error Codes

See Error Codes.