Adding NICs to an ECS in a Batch¶

Function¶

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

This API is an asynchronous API. After the NIC addition request is successfully delivered, a job ID is returned. This does not mean the NIC addition is complete. You need to call the API by referring to Querying Task Execution Status to query the job status. The SUCCESS status indicates that the NIC addition is successful.

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.

**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¶

Add the NIC whose ID is d32019d3-bc6e-4319-9c1d-6722fc136a23 and security group ID is f0ac4394-7e4a-4409-9701-ba8be283dbc3 to an ECS.

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": "ff80808288d41e1b018990260955686a"
}

Returned Values¶

See Returned Values for General Requests.

Error Codes¶

See Error Codes.

last updated: 2024-11-08 14:21 UTC - commit: c986e0f7c0392c4cd98c9cb56ea7f6b22cacb972