
# 查询云服务器可挂载网卡 - ShowServerAttachableNicNum
#### 功能介绍
查询云服务器可挂载网卡。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ECS/doc?api=ShowServerAttachableNicNum)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ecs/ecs_06_0000.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
 
| 授权项                         | 访问级别 | 资源类型（\*为必须）                                                | 条件键                                                                                                                                                                                                        | 别名                   | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| ecs:cloudServers:showServer | read | instance \*  | - g:ResourceTag/\<tag-key\>  - g:EnterpriseProjectId   | ecs:cloudServers:get | -      |
   
#### URI
GET /v1/{project_id}/cloudservers/{server_id}/os-interface_extension
参数说明请参见[表1]。
 表1参数说明 
| 参数         | 是否必选 | 描述                                                                                                                                                                                                                                                                                                                                                                             |
|:---|:---|:---|
| project_id | 是    | **参数解释：** 项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-ecs/ecs_01_0016.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
| server_id  | 是    | **参数解释：** 云服务器ID。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                |
   
#### 请求消息
无
#### 响应消息
响应参数如[表2]所示。
 表2响应参数 
| 参数                   | 参数类型             | 描述                                                                                                                                                                                      |
|:---|:---|:---|
| attachableQuantity   | Object           | **参数解释：** 云服务器可挂载网卡数量。详见[表3]。 **取值范围：** 不涉及 |
| interfaceAttachments | Array of objects | **参数解释：** 云服务器网卡信息列表。详见[表4]。 **取值范围：** 不涉及                             |
   
 表3attachableQuantity参数信息 
| 参数           | 参数类型    | 描述                                                                                                                                      |
|:---|:---|:---|
| free_efi_nic | Integer | **参数解释：** 云服务器剩余可挂载efi网卡数量。 **取值范围：** 不涉及     |
| free_scsi    | Integer | **参数解释：** 可挂载scsi类型磁盘数量。 **取值范围：** 不涉及           |
| free_blk     | Integer | **参数解释：** 可挂载virtio_blk类型磁盘数量。 **取值范围：** 不涉及 |
| free_disk    | Integer | **参数解释：** 可挂载磁盘总数。 **取值范围：** 不涉及  |
| free_nic     | Integer | **参数解释：** 可挂载网卡总数。 **取值范围：** 不涉及                |
   
 表4interfaceAttachments字段数据结构说明 
| 参数                    | 参数类型             | 描述                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|
| 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号。 说明： 网卡不支持时，返回为空。 **取值范围：** 不涉及                                                                                                                      |
| preserve_on_delete    | Boolean          | **参数解释：** 删除时是否保留。 **取值范围：** - true: 保留  - false: 不保留                          |
   
 表5fixed_ips字段数据结构说明 
| 参数         | 参数类型   | 描述                                                                                                                              |
|:---|:---|:---|
| subnet_id  | String | **参数解释：** 网卡私网IP对应子网信息。 **取值范围：** 不涉及 |
| ip_address | String | **参数解释：** 网卡私网IP信息。 **取值范围：** 不涉及      |
   
#### 请求示例
查询云服务器可挂载网卡。
```
GET https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/os-interface_extension
```
#### 响应示例
```
{
    "attachableQuantity": {
        "free_nic": 2,
        "free_efi_nic": 0
    },
    "interfaceAttachments": [
        {
            "port_state": "ACTIVE",
            "fixed_ips": [
                {
                    "subnet_id": "7710f8b5-749b-4e39-b3b3-fbbd32ba8aa5",
                    "ip_address": "192.168.0.33"
                }
            ],
            "net_id": "b804395a-6d92-4b8a-8060-11c615751d77",
            "port_id": "87a84a24-7905-40c0-b2f7-4f402566e97c",
            "mac_addr": "fa:16:3e:02:b0:ba",
            "delete_on_termination": false,
            "driver_mode": null,
            "min_rate": 900,
            "multiqueue_num": 2,
            "pci_address": null
        }
    ]
}
```
#### 返回值
请参考[通用请求返回值](https://support.huaweicloud.com/api-ecs/ecs_07_0001.html)。
#### 错误码
请参考[错误码](https://support.huaweicloud.com/api-ecs/ecs_07_0002.html)。
