接口功能介绍
创建弹性网卡
接口约束
无
URI
POST /v4/ports/create
请求参数
请求体Body参数
参数 | 参数类型 | 是否必填 | 说明 | 示例 |
---|---|---|---|---|
clientToken | String | 是 | 客户端存根,用于保证订单幂等性, 长度 1 - 64 | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 |
regionID | String | 是 | 资源池ID | |
subnetID | String | 是 | 子网ID | |
primaryPrivateIp | String | 否 | 弹性网卡的主私有IP地址 | |
ipv6Addresses | Array of String | 否 | 为弹性网卡指定一个或多个IPv6地址 | |
securityGroupIds | Array of String | 否 | 加入一个或多个安全组。安全组和弹性网卡必须在同一个专有网络VPC中,最多同时支持 10 个 | |
secondaryPrivateIpCount | Integer | 否 | 指定私有IP地址数量,让ECS为您自动创建IP地址 | |
secondaryPrivateIps | Array of String | 否 | 指定私有IP地址,不能和secondaryPrivateIpCount同时指定 | |
name | String | 否 | 支持拉丁字母、中文、数字,下划线,连字符,中文 / 英文字母开头,不能以 http: / https: 开头,长度 2 - 32 | acl11 |
description | String | 否 | 支持拉丁字母、中文、数字, 特殊字符:!@#$%^& *()_-+= <>?:"{},./;'[]·~ !@#¥%……&* () —— -+={} | 《》?:“”【】、;‘',。、,不能以 http: / https: 开头,长度 0 - 128 |
响应参数
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 |
message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success |
description | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 |
errorCode | String | statusCode为900时为业务细分错误码,三段式:product.module.code; statusCode为800时为SUCCESS | SUCCESS |
returnObj | Object | 返回结果 | 见下表 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
vpcID | String | vpc的id | |
subnetID | String | 子网id | |
networkInterfaceID | String | 网卡id | |
networkInterfaceName | String | 网卡名称 | |
macAddress | String | mac地址 | |
description | String | 网卡描述 | |
ipv6Address | Array of String | IPv6地址列表 | |
securityGroupIds | Array of String | 安全组ID列表 | |
secondaryPrivateIps | Array of String | 二级IP地址列表 | |
privateIpAddress | String | 弹性网卡的主私有IP | |
instanceOwnerID | String | 绑定的实例的所有者ID | |
instanceType | String | 设备类型 VM, BM, Other | |
instanceID | String | 绑定的实例ID |
请求示例
请求体body
{
"clientToken": "xxxxxxxxx" ,
"regionID": "100054c0416811e9a6690242ac110002",
"subnetID": "xxxxxx"
"primaryPrivateIp": "192.168.1.3",
"ipv6Addresses": ["xxxxxxxxxxxxx"],
"securityGroupIds": ["sg-id"],
"secondaryPrivateIpCount": 2,
"secondaryPrivateIps": [],
"name": "port-name",
"description": "The description of port."
}
响应示例
{
"statusCode":800,
"errorCode":"SUCCESS",
"message":"success",
"descritption": "成功",
"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": "deviece owner id",
"instanceType": "VM",
"instanceID": "instance-id"
}
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
请参考 错误码说明。