Help Center/ Elastic Cloud Server/ API Reference (Kuala Lumpur Region)/ APIs (Recommended)/ NIC Management/ Deleting NICs from an ECS in a Batch
Updated on 2024-04-18 GMT+08:00
View PDF
Share

Deleting NICs from an ECS in a Batch

Function

This API is used to uninstall and delete one or multiple NICs from an ECS.

This API is an asynchronous API. After the deletion request is successfully delivered, a job ID is returned. This does not mean the deletion 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 deletion is successful.

Constraints

The primary NIC of an ECS has routing rules configured and cannot be deleted.

URI

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

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 deleted. For details, see Table 3.
Table 3 nics field description

Parameter

Mandatory

Type

Description

id

Yes

String

Specifies the port ID of the NIC.

NOTE:

When the ID is the same as the ECS primary NIC ID, the system will return error code 403.

Response

See Responses (Task).

Example Request

Delete the NIC whose ID is d32019d3-bc6e-4319-9c1d-6722fc136a23 from an ECS.

POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/nics/delete

{
    "nics": [
         {
            "id": "d32019d3-bc6e-4319-9c1d-6722fc136a23"
        }
    ]
}

Example Response

{      
    "job_id": "ff80808288d41e1b018990260955686a" 
}

Returned Values

See Returned Values for General Requests.

Error Codes

See Error Codes.

Parent topic: NIC Management