Updated on 2024-10-22 GMT+08:00

Unbinding NICs from a BMS

Function

This API is used to unbind one or more NICs from a BMS.

The primary NIC of a BMS has routing rules configured and cannot be unbound.

URI

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

Table 1 lists the parameters.
Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

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

server_id

Yes

Specifies the BMS ID.

You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Discarded).

Request Parameters

Table 2 Request parameters

Parameter

Mandatory

Type

Description

nics

Yes

Array of objects

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

Table 3 nics field data structure description

Parameter

Mandatory

Type

Description

id

Yes

String

Specifies the port ID of the NIC.

Example Request

Unbinding a NIC (port ID: d32019d3-bc6e-4319-9c1d-6722fc136a23) from a BMS
{
    "nics": [
        {
            "id": "d32019d3-bc6e-4319-9c1d-6722fc136a23"
        }
    ]
}

Response Parameters

Table 4 Normal response

Parameter

Type

Description

job_id

String

Specifies the task ID returned after a task command is issued. The task ID can be used to query the execution status of the task.

For details about how to query the task execution status based on job_id, see Querying Task Statuses.

Table 5 Abnormal response

Parameter

Type

Description

error

Dictionary data structure

Specifies the error returned when a task submission encounters an exception. For details, see Table 6.

Table 6 error data structure

Parameter

Type

Description

message

String

Specifies the error message.

code

String

Specifies the error code.

Example Response

  • Normal response
    1
    2
    3
    { 
        "job_id": "70a599e0-31e7-49b7-b260-868f441e862b" 
    } 
    

Returned Values

Normal values

Returned Values

Description

200

The request has been successfully processed.

For details about other returned values, see Status Codes.

Error Codes

See Error Codes.