Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: guoyanyan <guoyanyan3@huawei.com>
Co-committed-by: guoyanyan <guoyanyan3@huawei.com>

2023-10-11 08:28:11 +00:00

16 KiB

Raw Permalink Blame History

Detaching NICs from a BMS

Function

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

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

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 (Native OpenStack API).

Request

Request parameters
Parameter

Mandatory

Type

Description

nics

Yes

Array of objects

Specifies the NICs to be detached. For details, see Table 2.

Table 2 nics field data structure description
Parameter

Mandatory

Type

Description

id

Yes

String

Specifies the port ID of the NIC.

Parameter	Mandatory	Type	Description
nics	Yes	Array of objects	Specifies the NICs to be detached. For details, see Table 2.

**Table 2** **nics** field data structure description
Parameter	Mandatory	Type	Description
id	Yes	String	Specifies the port ID of the NIC.

Example request

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

Response

Response parameters

**Table 3** 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 4** Abnormal response
Parameter	Type	Description
error	Dictionary data structure	Specifies the error returned when a task submission encounters an exception. For details, see Table 5.

**Table 5** **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.

Parent topic: BMS NIC Management

16 KiB Raw Permalink Blame History