doc-exports/docs/ecs/api-ref/en-us_topic_0020212666.html
Zaoxu, Li 4edaa4a4cc ECS API 20231016 version
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com>
Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>
2024-04-29 11:04:13 +00:00

6.5 KiB

Deleting a NIC from an ECS

Function

This API is used to delete a NIC from an ECS based on the port ID.

Constraints

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

When an ECS NIC is detached, all NICs attached to the ECS through the OpenStack Nova API will be deleted.

URI

DELETE /v2.1/{project_id}/servers/{server_id}/os-interface/{port_id}{?reserve_port}

DELETE /v2/{project_id}/servers/{server_id}/os-interface/{port_id}{?reserve_port}

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

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

server_id

Yes

Specifies the ECS ID.

port_id

Yes

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.

reserve_port

No

Indicates whether to retain the NIC port after the NIC is unbound.

True: indicates that the port is reserved.

False: indicates that the port is deleted. This is the default value.

Request

None

Response

None

Example Request

Delete a NIC from an ECS based on the specified port ID.

DELETE https://{endpoint}/v2/{project_id}/servers/{server_id}/os-interface/{port_id}
DELETE https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-interface/{port_id}

Example Response

None