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

功能介绍

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

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。

如果使用身份策略授权，需具备如下身份策略权限。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
bms:servers:showBaremetalServerInterfaceAttachments	read	instance*	g:EnterpriseProjectId g:ResourceTag/<tag-key>	bms:servers:get	-

URI

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

参数说明请参见表1。

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

请求参数

无

请求示例

查询ID为95bf2490-5428-432c-ad9b-5e3406f869dd的裸金属服务器的网卡信息。

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

响应参数

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

表2 interfaceAttachments字段数据结构说明
参数	参数类型	描述
port_state	String	网卡端口状态。取值为：ACTIVE、BUILD、DOWN
fixed_ips	Array of objects	网卡私网IP信息列表，详情请参见表3。
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"
        }
    ]
}
 