文档首页/弹性云服务器 ECS/API参考/API/网卡管理/批量添加云服务器网卡 - BatchAddServerNics
更新时间：2026-03-19 GMT+08:00
查看PDF
分享

批量添加云服务器网卡 - BatchAddServerNics

功能介绍

给云服务器添加一张或多张网卡。

本接口为异步接口，当前批量添加云服务器网卡请求下发成功后会返回job_id，此时批量添加云服务器网卡并没有立即完成，需要通过调用查询任务的执行状态 - ShowJob查询job状态，当Job状态为 SUCCESS 时代表云服务器网卡批量添加成功。

接口约束

在网卡添加成功以前，禁止对添加中的网卡进行卸载、删除等操作。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

ecs:cloudServers:addNics

write

instance *

  • ecs:SubnetId
  • ecs:PortId

-

-

URI

POST /v1/{project_id}/cloudservers/{server_id}/nics

参数说明请参见表1。
表1 参数说明

参数

是否必选

描述

project_id

是

参数解释：

项目ID。

获取方法请参见获取项目ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

server_id

是

参数解释：

云服务器ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求消息

请求参数如表2所示。
表2 请求参数

参数

是否必选

参数类型

描述

nics

是

Array of objects

参数解释：

需要添加的网卡参数列表，详情请参见表3。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

表3 nics字段数据结构说明

参数

是否必选

参数类型

描述

subnet_id

否

String

参数解释：

云服务器添加网卡的信息。

需要指定已创建的网络（network）的ID，UUID格式。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

security_groups

否

Array of objects

参数解释：

添加网卡的安全组信息，详情请参见表4。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

ip_address

否

String

参数解释：

IP地址。

约束限制：

不涉及

取值范围：

当该字段为空时，表示自动分配IP地址。

默认取值：

不涉及

port_id

否

String

参数解释：

网卡ID，UUID格式。

网卡ID可以从虚拟私有云的“查询端口列表”章节查询到。

约束限制：

  • port_id和subnet_id不能同时为空。
  • 网卡状态必须为DOWN
  • 当port_id和subnet_id同时存在的时候，优先使用port_id。
  • 当选择port_id不为空时，代表此时使用的是弹性网卡，此时security_groups和ip_address等参数不生效。

取值范围：

当该字段不为空时，表示挂载指定的网卡。

默认取值：

不涉及

ipv6_enable

否

Boolean

参数解释：

是否支持ipv6。

约束限制：

不涉及

取值范围：

取值为true时，表示此网卡支持ipv6。

默认取值：

不涉及

ipv6_bandwidth

否

Object

参数解释：

绑定的共享带宽信息，详情请参见ipv6_bandwidth字段数据结构说明。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

表4 security_groups字段数据结构说明

参数

是否必选

参数类型

描述

id

是

String

参数解释：

安全组ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

响应消息

响应参数如表5所示。

表5 响应参数

参数

参数类型

描述

job_id

String

参数解释：

提交任务成功后返回的任务ID，用户可以使用该ID对任务执行情况进行查询。如何根据job_id来查询Job的执行状态，请参考查询Job状态。

取值范围：

不涉及

异常响应请参考响应（任务类），异常响应要素说明。

请求示例

添加网络ID为“d32019d3-bc6e-4319-9c1d-6722fc136a23”，安全组ID为“f0ac4394-7e4a-4409-9701-ba8be283dbc3”的网卡至云服务器。

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"
                }
            ]
        }
    ]
}

响应示例

{      
    "job_id": "ff80808288d41e1b018990260955686a" 
}

返回值

请参考通用请求返回值。

错误码

请参考错误码。

父主题：网卡管理