响应参数
4.5 网卡管理
} ] }
返回值
请参考通用请求返回值。
错误码
请参考错误码。
4.5 网卡管理
4.5.1 批量添加云服务器网卡
功能介绍
给云服务器添加一张或多张网卡。
URI
POST /v1/{project_id}/cloudservers/{server_id}/nics 参数说明请参见表4-100。
表4-100 参数说明
参数 是否必选 描述
project_id 是 项目ID。
获取方法请参见获取项目ID。
server_id 是 云服务器ID。
请求消息
请求参数如表4-101所示。
表4-101 请求参数
参数 是否必选 参数类型 描述
nics 是 Array of objects 需要添加的网卡参数列表，详 情请参见表4-102。
表4-102 nics 字段数据结构说明
参数 是否必选 参数类型 描述
subnet_id 是 String 云服务器添加网卡的信息。
security_group
s 否 Array of objects 添加网卡的安全组信息，详情 请参见表4-103。
ip_address 否 String IP地址，无该参数表示自动分 配IP地址。
ipv6_enable 否 Boolean 是否支持ipv6。
取值为true时，标识此网卡支 持ipv6。
ipv6_bandwidt
h 否 Object 绑定的共享带宽信息，详情请
参见ipv6_bandwidth字段数据 结构说明。
表4-103 security_groups 字段数据结构说明
参数 是否必选 参数类型 描述
id 是 String 安全组ID。
响应消息
请参考响应（任务类）。
请求示例
POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/nics { "nics": [
{
"subnet_id": "d32019d3-bc6e-4319-9c1d-6722fc136a23", "security_groups": [
{
"id": "f0ac4394-7e4a-4409-9701-ba8be283dbc3"
} ] } ] }
响应示例
无
返回值
请参考通用请求返回值。
错误码
请参考错误码。
4.5.2 批量删除云服务器网卡
功能介绍
卸载并删除云服务器中的一张或多张网卡。
接口约束
主网卡是弹性云服务器上配置了路由规则的网卡，不可删除。
URI
POST /v1/{project_id}/cloudservers/{server_id}/nics/delete 参数说明请参见表4-104。
表4-104 参数说明
参数 是否必选 描述
project_id 是 项目ID。
获取方法请参见获取项目ID。
server_id 是 云服务器ID。
请求消息
请求参数如表4-105所示。
表4-105 请求参数
参数 是否必选 参数类型 描述
nics 是 Array of objects 需要删除的网卡列表信息，详 情请参见表4-106。
表4-106 nics 字段数据结构说明
参数 是否必选 参数类型 描述
id 是 String 网卡Port ID。
说明当该ID为弹性云服务器主网卡 ID，将返回403。
响应消息
请参考响应（任务类）。
请求示例
POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/nics/delete { "nics": [
{
"id": "d32019d3-bc6e-4319-9c1d-6722fc136a23"
} ] }
响应示例
无
返回值
请参考通用请求返回值。
错误码
请参考错误码。
4.5.3 云服务器网卡配置虚拟 IP 地址
功能介绍
虚拟IP地址用于为网卡提供第二个IP地址，同时支持与多个弹性云服务器的网卡绑定，
从而实现多个弹性云服务器之间的高可用性。
该接口用于给云服务器网卡配置虚拟IP地址：
● 当指定的IP地址是一个不存在的虚拟IP地址时，系统会创建该虚拟IP，并绑定至对 应网卡。
● 当指定的IP地址是一个已经创建好的虚拟IP时，系统会将指定的网卡和虚拟IP绑 定。如果该IP的device_owner为空，则仅支持VPC内二三层通信；如果该IP的 device_owner为neutron:VIP_PORT，则支持VPC内二三层通信、VPC之间对等连 接访问，以及弹性公网IP、VPN、云专线等Internet接入。
了解更多请参考虚拟IP简介。
URI
PUT /v1/{project_id}/cloudservers/nics/{nic_id}
参数说明请参见表4-107。
表4-107 参数说明
参数 是否必选 描述
project_id 是 项目ID。
获取方法请参见获取项目ID。
nic_id 是 云服务器网卡ID。
请求消息
请求参数如表4-108所示。
表4-108 请求参数
参数 是否必选 参数类型 描述
nic 是 Object 需要配置私有IP的网卡参数列表。
更多信息请参见表4-109。
表4-109 nic 字段数据结构说明
参数 是否必选 参数类型 描述
subnet_id 是 String 云服务器添加网卡的信息。
需要指定云服务器所属虚拟私有云 下已创建的网络（network）的 ID，UUID格式。
ip_address 是 String 网卡即将配置的虚拟IP的地址。
reverse_bindi
ng 否 Boolean 虚拟IP的allowed_address_pairs属 性是否添加网卡的IP/Mac对。
响应消息
响应参数如表4-110所示。
表4-110 响应参数
参数 参数类型 描述
port_id String 云服务器网卡ID。
请求示例
PUT https://{endpoint}/v1/{project_id}/cloudservers/nics/{nic_id}
{ "nic": {
"subnet_id": "d32019d3-bc6e-4319-9c1d-6722fc136a23", "ip_address": "192.168.0.7",
"reverse_binding": true }
}
响应示例
{ "port_id": "d32019d3-bc6e-4319-9c1d-6722fc136a23"
}
返回值
请参考通用请求返回值。
错误码
请参考错误码。
4.5.4 云服务器网卡解绑虚拟 IP 地址
功能介绍
虚拟IP地址用于为网卡提供第二个IP地址，同时支持与多个弹性云服务器的网卡绑定，
从而实现多个弹性云服务器之间的高可用性。
该接口用于解绑定弹性云服务器网卡的虚拟IP地址。解绑后，网卡不会被删除，如需 删除云服务器网卡，请参见批量删除云服务器网卡。
URI
PUT /v1/{project_id}/cloudservers/nics/{nic_id}
参数说明请参见表4-111。
表4-111 参数说明
参数 是否必选 描述
project_id 是 项目ID。
获取方法请参见获取项目ID。
nic_id 是 云服务器网卡ID。
请求消息
请求参数如表4-112所示。
表4-112 请求参数
参数 是否必选 参数类型 描述
nic 是 Object 需要解绑虚拟IP的网卡参数
列表。更多信息请参见表 4-113。
表4-113 nic 字段数据结构说明
参数 是否必选 参数类型 描述
subnet_id 是 String 云服务器添加网卡的信息。
约束：解绑虚拟IP时，
subnet_id为空字符串
ip_address 是 String 网卡即将配置的虚拟IP的地址。
约束：解绑虚拟IP时，
ip_address为空字符串 reverse_bindi
ng 否 Boolean 虚拟IP的allowed_address_pairs 属性是否添加网卡的IP/Mac对。
响应消息
响应参数如表4-114所示。
表4-114 响应参数
参数 参数类型 描述
port_id String 云服务器网卡ID。
请求示例
PUT https://{endpoint}/v1/{project_id}/cloudservers/nics/{nic_id}
{ "nic": {
"subnet_id": "", "ip_address": "", "reverse_binding": false }
}
响应示例
{ "port_id": "d32019d3-bc6e-4319-9c1d-6722fc136a23"
}
返回值
请参考通用请求返回值。
错误码
请参考错误码。
4.5.5 查询云服务器网卡信息
功能介绍
查询云服务器网卡信息。
URI
GET /v1/{project_id}/cloudservers/{server_id}/os-interface 参数说明请参见表4-115。
表4-115 参数说明
参数 是否必选 描述
project_id 是 项目ID。
获取方法请参见获取项目ID。
server_id 是 云服务器ID。
请求消息
无
响应消息
响应参数如表4-116所示。
表4-116 响应参数
参数 参数类型 描述
interfaceAttachments Array of objects 云服务器网卡信息列表，详情 请参见表4-117。
attachableQuantity Object 云服务器可挂载网卡数，详情 请参见表4-118
表4-117 interfaceAttachments 字段数据结构说明
参数 参数类型 描述
port_state String 网卡端口状态。
fixed_ips Array of objects 网卡私网IP信息列表，详情请参见 表4-119。
net_id String 网卡端口所属网络ID
（network_id）。
port_id String 网卡端口ID。
mac_addr String 网卡Mac地址信息。
delete_on_termina
tion Boolean 卸载网卡时，是否删除网卡。
true: 删除； false: 不删除
driver_mode String 从guest os中，网卡的驱动类型。
可选值为virtio和hinic，默认为 virtio。
min_rate Integer 网卡带宽下限。
multiqueue_num Integer 队列个数。
取值范围为 1, 2, 4, 8, 16，28。
pci_address String 弹性网卡在Linux GuestOS里的BDF 号。
说明
网卡不支持时，返回为空。
表4-118 attachableQuantity 字段数据结构说明
参数 参数类型 描述
free_nic Integer 云服务器剩余可挂载网卡数量
表4-119 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"
} ] }
返回值
请参考通用请求返回值。