EIP相关接口

申请EIP

  • 申请一个EIP,可用于绑定到任意BLB实例或BCC实例。
  • 创建EIP需要实名认证,若未通过实名认证可以前往百度智能云官网控制台中的安全认证下的实名认证中进行认证。

请求结构

POST /v{version}/eip?clientToken={clientToken} HTTP/1.1
    Host: eip.bj.baidubce.com
    Authorization: authorization string

    {
        "name": name,
        "bandwidthInMbps": bandwidthInMbps,
        "billing":{
            "paymentTiming": paymentTiming,
            "billingMethod": billingMethod,
            "reservation":{
                "reservationLength": reservationLength,
                "reservationTimeUnit": reservationTimeUnit
            }
        }
    }

请求头域

除公共头域外,无其他特殊头域

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值1。
clientToken String Query参数 幂等性Token,详见幂等性
bandwidthInMbps int RequestBody参数 公网带宽,单位为Mbps。对于prepay以及bandwidth类型的EIP,限制为为1~200之间的整数,对于traffic类型的EIP,限制为1~1000之前的整数。
billing Billing RequestBody参数 订单信息。
name String RequestBody参数 长度1~65个字节,字母开头,可包含字母数字-_/.字符。若不传该参数,服务会自动生成name。

返回状态码

成功返回200,失败返回见错误码

返回头域

除公共头域外,无其他特殊头域

返回参数

参数名称 类型 描述
eip string 分配的EIP地址

请求示例,后付费按流量计费

POST /v1/eip?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST eip.bj.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

{
    "name":"eip-for-test",
    "bandwidthInMbps": 1,
    "billing":{
        "paymentTiming":"Postpaid",
        "billingMethod":"ByTraffic"
    }
}

请求示例,预付费

POST /v1/eip?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST eip.bj.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

{
    "name":"eip-for-test",
    "bandwidthInMbps": 1,
    "billing":{
        "paymentTiming":"Prepaid",
        "reservation":{
            "reservationLength":1,
            "reservationTimeUnit":"Month"
        }
    }
}

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "eip":"180.181.3.133"
}

EIP带宽扩缩容

指定EIP的带宽扩缩容大小,通过查询EIP列表查看EIP扩缩容状态是否完成。

请求结构

PUT /v{version}/eip/{eip}?{action}&clientToken={clientToken} HTTP/1.1
Host: eip.bj.baidubce.com
Authorization: authorization string

{
    "newBandwidthInMbps": newBandwidthInMbps
}

请求头域

除公共头域外,无其他特殊头域

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值1
eip String URL参数 被更新的EIP,点分十进制表示
action String Query参数 对EIP实例执行的动作,本接口中取值resize
clientToken String Query参数 详见幂等性Token
newBandwidthInMbps int RequestBody参数 公网带宽,单位为Mbps。对于预付费(prepay)以及按带宽(bandwidth)类型的EIP,限制为1~200之间的整数,对于按流量(traffic)类型的EIP,限制为1~1000之间的整数。

返回状态码

成功返回200,失败返回见错误码

返回头域

除公共头域外,无其他特殊头域

返回参数

无特殊返回参数

请求示例

PUT /v1/eip/180.76.122.3?resize&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST eip.bj.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

{
    "newBandwidthInMbps": 10
}

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

绑定EIP

  • 可用于绑定EIP到任意BLB实例或BCC实例。
  • 只有available状态的EIP支持绑定操作。
  • 被绑定的实例不能存在任何已有EIP绑定关系。
  • 被绑定的实例不能处于欠费状态。

请求结构

PUT /v{version}/eip/{eip}?{action}&clientToken={clientToken} HTTP/1.1
Host: eip.bj.baidubce.com
Authorization: authorization string

{
    "instanceType": instanceType,
    "instanceId": instanceId
}

请求头域

除公共头域外,无其他特殊头域

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值1
eip String URL参数 被绑定的EIP,点分十进制表示
action String Query参数 对EIP实例执行的动作,本接口中取值bind
clientToken String Query参数 幂等性Token,详见幂等性
instanceType instanceType RequestBody参数 被绑定的实例类型
instanceId String RequestBody参数 被绑定的实例ID

返回状态码

成功返回200,失败返回见错误码

返回头域

除公共头域外,无其他特殊头域。

返回参数

无特殊返回参数。

请求示例

请求示例,绑定EIP到BCC。

PUT /v1/eip/180.76.122.3?bind&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST eip.bj.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

{
    "instanceType": "BCC",
    "instanceId": "i-Tkjq337f"
}

请求示例,绑定EIP到BLB。

PUT /v1/eip/180.76.122.3?bind&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST eip.bj.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-06-21T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

{
"instanceType": "BLB",
"instanceId": "lb-3ytqlktb"
}

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

解绑EIP

  • 解除指定EIP的绑定关系。
  • 被解绑的EIP必须已经绑定到某个实例。

请求结构

PUT /v{version}/eip/{eip}?{action}&clientToken={clientToken} HTTP/1.1
Host: eip.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外,无其他特殊头域

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值1
eip String URL参数 被解绑的EIP,点分十进制表示
action String Query参数 对EIP实例执行的动作,本接口中取值unbind
clientToken String Query参数 幂等性Token,详见幂等性

返回状态码

成功返回200,失败返回见错误码

返回头域

除公共头域外,无其他特殊头域

返回参数

无特殊返回参数

请求示例

PUT /v1/eip/180.76.122.3?unbind&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST eip.bj.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

释放EIP

  • 释放指定EIP,被释放的EIP无法找回
  • 如果EIP被绑定到任意实例,需要先解绑才能释放
  • 预付费购买的EIP如需提前释放,请通过工单进行

请求结构

DELETE /v{version}/eip/{eip}?clientToken={clientToken} HTTP/1.1
Host: eip.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外,无其他特殊头域

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值1
eip String URL参数 被释放的EIP,点分十进制表示
clientToken String Query参数 幂等性Token,详见幂等性

返回状态码

成功返回200,失败返回见错误码

返回头域

除公共头域外,无其他特殊头域

返回参数

无特殊返回参数

请求示例

DELETE /v1/eip/180.76.122.3?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST eip.bj.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

查询EIP列表

  • 可根据多重条件查询EIP列表。
  • 如只需查询单个EIP的详情,只需提供eip参数即可。
  • 如只需查询绑定到指定类型实例上的EIP,提供instanceType参数即可。
  • 如只需查询指定实例上绑定的EIP的详情,提供instanceType及instanceId参数即可。
  • 若不提供查询条件,则默认查询覆盖所有EIP。
  • 返回结果为多重条件交集的查询结果,即提供多重条件的情况下,返回同时满足所有条件的EIP。
  • 以上查询结果支持marker分页,分页大小默认为1000,可通过maxKeys参数指定。

请求结构

GET /v{version}/eip?eip={eip}&instanceType={instanceType}&instanceId={instanceId}&status={status}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
Host: eip.bj.baidubce.com
Authorization: authorization string

除公共头域外,无其他特殊头域

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值1
eip String Query参数 要查询的EIP,点分十进制表示
instanceType instanceType Query参数 绑定实例类型
instanceId String Query参数 实例短ID,若指定了此参数,需同时提供instanceType参数
marker String Query参数 批量获取列表的查询的起始位置,是一个由系统生成的字符串
maxKeys int Query参数 每页包含的最大数量,最大数量不超过1000。缺省值为1000
status String Query参数 实例状态,仅支持AVAILABLE, BINDED, PAUSED三种状态的查询

返回状态码

成功返回200,失败返回见错误码

返回头域

除公共头域外,无其他特殊头域

返回参数

参数名称 类型 描述
eipList List<EipModel> 包含查询结果的列表
marker string 标记查询的起始位置,若结果列表为空,此项不存在
isTruncated boolean true表示后面还有数据,false表示已经是最后一页
nextMarker String 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现
maxKeys int 每页包含的最大数量

请求示例

GET /v1/eip?instanceType=BCC&maxKeys=2 HTTP/1.1
HOST eip.bj.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "eipList": [
        {
            "name":"eip-xrllt5M-1",
            "eip": "180.181.3.133",
            "status":"binded",
            "instanceType": "BCC",
            "instanceId": "i-IyWRtII7",
            "shareGroupId": "eg-0c31c93a",
            "eipInstanceType": "shared",
            "bandwidthInMbps": 5,
            "paymentTiming":"Prepaid",
            "billingMethod":null,
            "createTime":"2016-03-08T08:13:09Z",
            "expireTime":"2016-04-08T08:13:09Z"
        },
        {
            "name":"eip-scewa1M-1",
            "eip": "180.181.3.134",
            "status":"binded",
            "instanceType": "BCC",
            "instanceId": "i-KjdgweC4",
            "shareGroupId": null,
            "eipInstanceType": "normal",
            "bandwidthInMbps": 1,
            "paymentTiming":"Postpaid",
            "billingMethod":"ByTraffic",
            "createTime":"2016-03-08T08:13:09Z",
            "expireTime":null
        },
    ],
    "marker":"eip-DCB50385",
    "isTruncated": true,
    "nextMarker": "eip-DCB50387",
    "maxKeys": 2
}

EIP续费

指定EIP的续费操作,延长过期时长。

EIP扩缩容期间不能进行续费操作。

请求结构

PUT /v{version}/eip/{eip}?{action}&clientToken={clientToken} HTTP/1.1
Host: eip.bj.baidubce.com
Authorization: authorization string

{
    "billing":{
        "reservation":{
            "reservationLength": reservationLength,
            "reservationTimeUnit": reservationTimeUnit
        }
    }
}

请求头域

除公共头域外,无其它特殊头域。

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号
eip String URL参数 被绑定的EIP,点分十进制表示
action String Query参数 本接口中该参数取值purchaseReserved
clientToken String Query参数 幂等性Token,是一个长度不超过64位的ASCII字符串,详见幂等性
billing Billing RequestBody参数 订单信息

返回头域

除公共头域,无其它特殊头域。

返回参数

无特殊返回参数

请求示例

PUT /v1/eip/180.76.122.3?purchaseReserved&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST eip.bj.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

{
    "billing":{
        "reservation":{
            "reservationLength":1,
            "reservationTimeUnit":"Month"
        }
    }
}

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS