查询云服务器网卡信息

功能介绍

查询云服务器网卡信息。

URI

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

参数说明请参见表1。

表1 参数说明
参数	是否必选	描述
project_id	是	项目ID。获取方法请参见获取项目ID。
server_id	是	云服务器ID。

请求消息

无

响应消息

响应参数如表2所示。

表2 响应参数
参数	参数类型	描述
interfaceAttachments	Array of objects	参数解释：云服务器网卡信息列表，详情请参见表3。取值范围：不涉及
attachableQuantity	Object	参数解释：云服务器可挂载网卡数，详情请参见表4。取值范围：不涉及

表3 interfaceAttachments字段数据结构说明
参数	参数类型	描述
port_state	String	参数解释：网卡端口状态。取值范围：不涉及
fixed_ips	Array of objects	参数解释：网卡私网IP信息列表，详情请参见表5。取值范围：不涉及
net_id	String	参数解释：网卡端口所属网络ID（network_id）。取值范围：不涉及
port_id	String	参数解释：网卡端口ID。取值范围：不涉及
mac_addr	String	参数解释：网卡Mac地址信息。取值范围：不涉及
delete_on_termination	Boolean	参数解释：卸载网卡时，是否删除网卡。取值范围： true: 删除 false: 不删除
driver_mode	String	参数解释：网卡的驱动类型，预留字段，默认取值为virtio。取值范围：不涉及
min_rate	Integer	参数解释：网卡带宽下限。取值范围：不涉及
multiqueue_num	Integer	参数解释：队列个数。取值范围： 1-64
pci_address	String	参数解释：弹性网卡在Linux GuestOS里的BDF号。说明：网卡不支持时，返回为空。取值范围：不涉及

表4 attachableQuantity字段数据结构说明
参数	参数类型	描述
free_nic	Integer	参数解释：云服务器剩余可挂载网卡数量。取值范围：不涉及

表5 fixed_ips字段数据结构说明
参数	参数类型	描述
subnet_id	String	参数解释：网卡私网IP对应子网信息。取值范围：不涉及
ip_address	String	参数解释：网卡私网IP信息。取值范围：不涉及

请求示例

查询云服务器网卡信息。

GET https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/os-interface

响应示例

{
    "interfaceAttachments": [
        {
            "port_state": "ACTIVE",
            "fixed_ips": [
                {
                    "subnet_id": "ba31e1f5-fa76-4530-862c-5176fad033cf",
                    "ip_address": "192.168.0.33"
                }
            ],
            "net_id": "610a4af2-1d90-4d2b-8057-dc238b26febf",
            "port_id": "04819c0a-6a07-44b6-945e-fb932071888e",
            "mac_addr": "fa:16:3e:45:65:c4"
        }
    ]
}