查询裸金属服务器网卡信息.md

查询裸金属服务器网卡信息

功能介绍

查询裸金属服务器的网卡信息，比如网卡的IP地址、MAC地址。

调试

您可以在API Explorer中调试该接口。

URI

GET /v1/{project_id}/baremetalservers/{server_id}/os-interface

参数说明请参见表1。

表 1 参数说明

参数	是否必选	描述
project_id	是	项目ID。获取方式请参见获取项目ID。
server_id	是	裸金属服务器ID。可以从裸金属服务器控制台查询，或者通过调用查询裸金属服务器列表（OpenStack原生）API获取。

请求消息

• 请求参数

  无

• 请求样例

  GET https://{BMS Endpoint}/v1/c685484a8cc2416b97260938705deb65/baremetalservers/95bf2490-5428-432c-ad9b-5e3406f869dd/os-interface
  

响应消息

• 响应参数

参数	参数类型	描述
interfaceAttachments	Array of objects	裸金属服务器网卡信息列表，详情请参见表2 interfaceAttachments字段数据结构说明。

**表 2**  interfaceAttachments字段数据结构说明

参数	参数类型	描述
port_state	String	网卡端口状态。取值为：ACTIVE、BUILD、DOWN
fixed_ips	Array of objects	网卡私网IP信息列表，详情请参见表3 fixed_ips字段数据结构说明。
net_id	String	网卡端口所属子网的网络ID（network_id）。
port_id	String	网卡端口ID。
mac_addr	String	网卡MAC地址信息。
driver_mode	String	从guest os中，网卡的驱动类型。可选值为virtio和hinic，默认为virtio。
pci_address	String	弹性网卡在Linux GuestOS里的BDF号。

**表 3**  fixed\_ips字段数据结构说明

参数	参数类型	描述
subnet_id	String	网卡私网IP对应子网的子网ID（subnet_id）。
ip_address	String	网卡私网IP信息。

• 响应样例

  {
      "interfaceAttachments": [
          {
              "port_state": "ACTIVE",
              "fixed_ips": [
                  {
                      "subnet_id": "a5052101-11e1-4f3d-a5fa-f6ba6791219c",
                      "ip_address": "192.168.1.147"
                  }
              ],
              "net_id": "ad0fadbf-4bc1-472c-a030-5310e53b3818",
              "port_id": "bb585b04-f2a2-4528-9064-fd0aeb4e15a9",
              "mac_addr": "fa:16:3e:3b:58:fc"
          }
      ]
  }
  

返回值

正常返回值：

返回值	说明
200	服务器已成功处理了请求。

其他返回值请参考状态码。

错误码

请参考错误码。