批量创建弹性公网IP
更新时间:2024-12-30
接口描述
本接口用来批量创建弹性公网IP(EIP)。
请求结构
POST /v1/eip/batch/create{?clientToken} HTTP/1.1
Host: bec.baidubce.com
Authorization: authorization string
{
"deployInstances": [
{
"regionId": "regionId",
"ipv4Subnet": "ipv4Subnet",
"ipv4Num": 1,
"ipv6Subnet": "ipv6Subnet",
"ipv6Num": 1
}
],
"bandwidthInMbps": "bandwidthInMbps",
"tags": "tags",
"name": "name"
}
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
name | String | 否 | Request Body参数 | 弹性公网IP名称,支持大小写字母、数字、中文和“-_/.+“,长度1-64 |
bandwidthInMbps | Integer | 是 | Request Body参数 | eip带宽 |
deployInstances | List<EipDeployment> | 是 | Request Body参数 | 指定的节点请求信息 |
tags | List<TagModel> | 是 | Request Body参数 | 标签信息 |
clientToken | String | 否 | Query参数 | 幂等性Token,是一个长度不超过64位的ASCII字符串 |
返回头域
除公共头域,无其它特殊头域。
返回参数
参数名称 | 类型 | 描述 |
---|---|---|
result | Boolean | 操作是否成功,true表示成功;false表示失败 |
details | List<EipVo> | 返回EIP对象列表 |
请求示例
POST /v1/eip/batch/create{?clientToken} HTTP/1.1
Host: bec.baidubce.com
Authorization: authorization string
{
"deployInstances": [
{
"ipv4Num": 1,
"regionId": "cn-changzhou1-ix",
"ipv4Subnet": {
"purpose": "public",
"isp": "cm"
}
}
],
"bandwidthInMbps": 10,
"name": "test",
"tags": [
{
"tagKey": "默认项目",
"tagValue": ""
}
]
}
返回示例
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50
Date: Thu, 16 Mar 2022 06:29:48 GMT
Content Type: application/json;charset=UTF 8
Server: BWS
{
"result": true,
"details": [
{
"bandwidthInMbps": 10,
"city": "CHANGZHOU1",
"cityName": "常州1",
"createTime": "2024-12-30T08:11:56Z",
"eip": "223.110.179.170",
"eipId": "ip-a6aeqpaa",
"eipInstanceType": "normal",
"instanceId": "",
"ipVersion": 4,
"isp": "cm",
"mode": "nat",
"name": "test",
"paymentTiming": "Postpaid",
"purpose": "public",
"regionId": "cn-changzhou1-ix",
"shareGroupId": "",
"status": "available"
}
]
}
Modal对象定义
EipDeployment
参数名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
regionId | String | 是 | 节点ID,由“国家码-城市-运营商”的小写字母组成字符串。例如 cn-hangzhou-cm,其中国家码标准为ISO 3166-2,城市为拼音,运营商为中国移动cm/中国电信ct/中国联通un/三线ix/海外节点为bgp |
ipv4Subnet | SubnetModel | 是 | 指定的IPV4子网信息 |
ipv4Num | int | 是 | 申请IPV4 EIP数量 |
ipv6Subnet | SubnetModel | 是 | 指定的IPV6子网信息 |
ipv6Num | int | 是 | 申请IPV6 EIP数量 |
EipVo
参数名称 | 类型 | 描述 |
---|---|---|
eipId | String | 弹性公网IP的ID |
name | String | 弹性公网IP名称 |
shareGroupId | String | 共享带宽组ID,若为普通EIP,此项值为空 |
eipInstanceType | String | EIP实例类型, normal 普通EIP类型; shared 共享带宽中的EIP |
eip | String | 弹性公网IP |
instanceId | String | eip绑定资源的id |
instanceType | String | eip绑定资源的类型 |
status | String | eip状态 |
bandwidthInMbps | int | eip带宽 |
routeType | String | 线路类型 |
createTime | String | 创建时间 |
paymentTiming | String | 付款时间,后支付(Postpaid) |
tags | List<TagModel> | 资源标签 |
regionId | String | 所属regionId |
ipVersion | int | IP地址类型 |
mode | String | 网络类型 |
instanceName | String | eip绑定资源的name |
instanceIp | String | eip绑定资源的ip |
isp | String | eip运营商 |
region | String | 节点所在region |
regionName | String | 节点所在region名称 |
city | String | 节点所在city |
cityName | String | 节点所在city名称 |
serviceProvider | String | 节点所属运营商 |
serviceProviderName | String | 节点所属运营商名称 |
instanceStatus | String | eip绑定资源的状态 |
SubnetModel
参数名称 | 类型 | 描述 |
---|---|---|
subnetId | String | 子网ID |
isp | String | 运营商 |
regionId | String | 所属regionId |
TagModel
参数名称 | 类型 | 描述 |
---|---|---|
tagKey | String | 标签键 |
tagValue | String | 标签值 |