接口功能介绍
创建弹性网卡
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
接口约束
1.使用限制，本接口只支持在华东1、上海32、上海33、上海36、南宁23、南昌19、青岛20、青岛21、武汉41资源池进行公测
2.当前网卡最多支持配置 10 个私网IPv4地址，其中 1 个为主私网IP，9个为辅助私网IP。
URI
POST /v4/ecs/ports/create
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 是 | String | 客户端存根，用于保证订单幂等性。长度为1-64字符，要求单个云平台账户内唯一，使用同一个ClientToken值，则代表为同一个请求。保留时间为24小时 | ports_create07231529 | |
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| subnetID | 是 | String | 子网ID，您可以查看产品定义-子网来了解子网 获取： 查 查询子网列表 创 创建子网 |
subnet-y8cofge5uj | |
| primaryPrivateIp | 否 | String | 弹性网卡的主私网IPv4地址 | 172.16.0.141 | |
| ipv6Addresses | 否 | Array of Strings | 弹性网卡的主私网IPv6地址 | ['240e:978:497c:ec00:cd74:fd9d:c45d:4131'] | |
| securityGroupIds | 否 | Array of Strings | 加入一个或多个安全组。安全组和弹性网卡必须在同一个专有网络VPC中。您可以查看安全组概述来了解安全组 获取： 查 查询用户安全组列表 创 创建安全组 |
['sg-n7nu88xfbq'] | |
| secondaryPrivateIpCount | 否 | Integer | 辅助私网IP地址数量，让ECS为您自动创建IP地址 | 1 | |
| secondaryPrivateIps | 否 | Array of Strings | 辅助私网IP地址，不能和secondaryPrivateIpCount同时指定 | ['172.16.0.210'] | |
| name | 否 | String | 网卡名称，满足以下规则：支持拉丁字母、中文、数字，下划线，连字符，中文/英文字母开头，不能以http:/https:开头，长度2-32 | nic-test01 | |
| description | 否 | String | 网卡的描述，满足以下规则：支持拉丁字母、中文、数字, 特殊字符：~!@#$%^&*()_-+= <>?:"{},./;'[]·！@#￥%……&*（） —— -+={}\｜《》？：“”【】、；‘'，。、，不能以 http: / https: 开头，长度 0 - 128 | new-Description | create_nic_test |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| message | String | 失败时的错误信息 | success | |
| description | String | 失败时的错误描述 | 成功 | |
| returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| vpcID | String | vpc的ID | vpc-euu7edo58k | |
| subnetID | String | 子网ID | subnet-y8cofge5uj | |
| networkInterfaceID | String | 网卡ID | port-vibsmse8pl | |
| networkInterfaceName | String | 网卡名称 | nic-test01 | |
| macAddress | String | mac地址 | fa:16:3e:c3:xx:xx | |
| description | String | 网卡描述 | create_nic_test | |
| ipv6Address | Array of Strings | IPv6地址列表 | ['240e:978:497c:ec00:cd74:fd9d:c45d:4131'] | |
| securityGroupIds | Array of Strings | 安全组ID列表 | ['sg-n7nu88xfbq'] | |
| secondaryPrivateIps | Array of Strings | 二级IP地址列表 | ['172.16.0.210'] | |
| privateIpAddress | String | 弹性网卡的主私有IP | 172.16.0.141 | |
| instanceOwnerID | String | 绑定的实例的所有者ID | ||
| instanceType | String | 绑定的实例类型 | VM | |
| instanceID | String | 绑定的实例ID | a628a7d9-ef97-3b16-8a0a-4a794fcdxxxx |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例：创建一个弹性网卡，名称为port-name，处于子网subnet-y8cofge5uj下，加入安全组securityGroupIds中，
主私网IPv4的地址为"192.168.1.3"，主私网IPv6的地址为"240e:978:497c:ec00:cd74:fd9d:c45d:4131"，
辅助私网IP采用自动分配的方式，数量为2。
{
"clientToken": "create-port-test" ,
"regionID": "bb9fdb42056f11eda1610242ac110002",
"subnetID": "subnet-y8cofge5uj",
"primaryPrivateIp": "192.168.1.3",
"ipv6Addresses": ["240e:978:497c:ec00:cd74:fd9d:c45d:4131"],
"securityGroupIds": ["sg-n7nu88xfbq"],
"secondaryPrivateIpCount": 2,
"name": "port-name",
"description": "The description of port."
}
响应示例
{
"statusCode":800,
"errorCode":"SUCCESS",
"message":"success",
"description": "成功",
"returnObj": {
"vpcID": "vpc-xxxx",
"subnetID": "subnet-xxxx",
"networkInterfaceName": "port-name",
"macAddress": "mac-address",
"networkInterfaceID": "port-id",
"description": "The description of interface",
"ipv6Address": ["xxxxx", "xxxxx"],
"securityGroupIds": ["sg-id"],
"secondaryPrivateIps": ["192.168.x.x"],
"privateIpAddress": "192.168.x.x",
"instanceOwnerID": "",
"instanceType": "VM",
"instanceID": "a628a7d9-ef97-3b16-8a0a-4a794fcdxxxx"
}
}
状态码
请参考 状态码
错误码
请参考 错误码
