共享带宽相关接口

创建共享带宽

  • 创建一个共享带宽。
  • 创建共享带宽需要实名认证,若未通过实名认证可以前往百度开放云官网控制台中的安全认证下的实名认证中进行认证。
  • 目前仅支持预付费共享带宽的创建。

请求结构

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

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

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值1
clientToken String Query参数 幂等性Token,详见clientToken
eipCount int RequestBody参数 共享带宽中EIP的个数。公网IP数量最少为2个,最多可以包括n个(n*5Mbps小于共享带宽包总量)
bandwidthInMbps int RequestBody参数 公网带宽,单位为Mbps。对于prepay类型的EIP Group,限制为为10~200之间的整数
billing Billing RequestBody参数 订单信息
name String RequestBody参数 长度1~65个字节,字母开头,可包含字母数字-_/.字符。若不传该参数,服务会自动生成name

返回状态码

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

返回头域

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

返回参数

参数名称 类型 描述
id String 分配的实例ID

请求示例,预付费

POST /v1/eipgroup?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":"eipgroup-for-test",
    "eipCount": 5,
    "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

{
    "id":"eg-b2511000"
}

共享带宽的带宽扩容

  • 指定共享带宽的带宽扩容

请求结构

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

{
    "bandwidthInMbps": bandwidthInMbps
}

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值1
id String URL参数 共享带宽的id
action String Query参数 对共享带宽实例执行的动作,本接口中取值resize
clientToken String Query参数 幂等性Token,详见clientToken
bandwidthInMbps int RequestBody参数 公网带宽,单位为Mbps。对于prepay类型的EIP Group,限制为为10~200之间的整数

返回状态码

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

返回头域

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

返回参数

无特殊返回参数

请求示例

PUT /v1/eipgroup/eg-b2511000?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

{
    "bandwidthInMbps": 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

共享带宽IP数量升级

  • 用于指定共享带宽IP数量升级

请求结构

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

{
    "eipAddCount": eipAddCount
}

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值1
id String URL参数 共享带宽的id
action String Query参数 对共享带宽实例执行的动作,本接口中取值resize
clientToken String Query参数 幂等性Token,详见clientToken
eipAddCount int RequestBody参数 共享带宽包新增EIP的数量。该值大于0,公网IP数量最多可以包括n个(n*5Mbps小于共享带宽包总量)。

返回状态码

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

返回头域

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

返回参数

无特殊返回参数

请求示例

PUT /v1/eipgroup/eg-b2511000?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

{
    "eipAddCount": 3
}

响应示例

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

共享带宽更新

  • 共享带宽更新

请求结构

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

{
    "name": name
}

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值1
id String URL参数 共享带宽的id
action String Query参数 对共享带宽实例执行的动作,本接口中取值update
clientToken String Query参数 幂等性Token,详见clientToken
name String RequestBody参数 共享带宽名称

返回状态码

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

返回头域

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

返回参数

无特殊返回参数

请求示例

PUT /v1/eipgroup/eg-b2511000?update&clientToken=be31b98c-5e41-4838-9831-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": "eipgroup"
}

响应示例

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。
  • 返回结果为多重条件交集的查询结果,即提供多重条件的情况下,返回同时满足所有条件的共享带宽。
  • 以上查询结果支持marker分页,分页大小默认为1000,可通过maxKeys参数指定。

请求结构

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

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值1
id String Query参数 要查询的共享带宽的ID
name String Query参数 要查询的共享带宽的名称
status String Query参数 要查询的共享带宽的状态
marker String Query参数 批量获取列表的查询的起始位置,是一个由系统生成的字符串
maxKeys int Query参数 每页包含的最大数量,最大数量不超过1000。缺省值为1000

返回状态码

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

返回头域

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

返回参数

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

请求示例

GET /v1/eipgroup?maxKeys=1 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

{
    "eipgroups": [
        {
            "id":"eg-DCB50385",
            "name":"eipgroup-for-test",
            "eips": [
                {
                    "name":"eip-xrllt5M-1",
                    "eip": "180.181.3.133",
                    "status":"binded",
                    "instanceType": "BCC",
                    "instanceId": "i-IyWRtII7",
                    "shareGroupId": "eg-DCB50385",
                    "eipInstanceType": "shared",
                    "bandwidthInMbps": 5,
                    "paymentTiming":"Prepaid",
                    "billingMethod":null,
                    "createTime":"2016-03-08T08:13:09Z",
                    "expireTime":"2016-04-08T08:13:09Z"
                },
            ],
            "status":"binded",
            "bandwidthInMbps": 5,
            "paymentTiming":"Prepaid",
            "createTime":"2016-03-08T08:13:09Z",
            "expireTime":"2016-04-08T08:13:09Z"
        }
    ],
    "marker":"eg-DCB50385",
    "isTruncated": true,
    "nextMarker": "eg-DCB50387",
    "maxKeys": 2
}

查询共享带宽详情

  • 查询共享带宽详情。

请求结构

GET /v{version}/eipgroup/{id} HTTP/1.1
Host: eip.bj.baidubce.com
Authorization: authorization string

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值1
id String URL参数 要查询的共享带宽的ID

返回状态码

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

返回头域

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

返回参数

参数名称 类型 描述
id String 共享带宽的ID
name String 共享带宽的名字
eips List<EipModel> EIP实例列表
status EipGroupStatus 共享带宽状态
bandwidthInMbps int 公网带宽,单位为Mbps
paymentTiming String 付款时间,预支付(Prepaid)
createTime String 创建时间
expireTime String 过期时间,只有预付费产品此参数才有值

请求示例

GET /v1/eipgroup/eg-DCB50385 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

{
      "id":"eg-DCB50385",
        "name":"eipgroup-for-test",
        "eips": [
            {
                "name":"eip-xrllt5M-1",
                "eip": "180.181.3.133",
                "status":"binded",
                "instanceType": "BCC",
                "instanceId": "i-IyWRtII7",
                "shareGroupId": "eg-DCB50385",
                "eipInstanceType": "shared",
                "bandwidthInMbps": 5,
                "paymentTiming":"Prepaid",
                "billingMethod":null,
                "createTime":"2016-03-08T08:13:09Z",
                "expireTime":"2016-04-08T08:13:09Z"
            },
         ],
         "status":"binded",
         "bandwidthInMbps": 5,
         "paymentTiming":"Prepaid",
         "createTime":"2016-03-08T08:13:09Z",
         "expireTime":"2016-04-08T08:13:09Z"
}

共享带宽续费

针对指定共享带宽的续费操作,延长过期时长

  • 共享带宽扩缩容期间不能进行续费操作。

请求结构

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

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

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号
id String URL参数 共享带宽的ID
action String Query参数 本接口中该参数取值purchaseReserved
clientToken String Query参数 幂等性Token,是一个长度不超过64位的ASCII字符串,详见链接
billing Billing RequestBody参数 订单信息

返回头域

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

返回参数

无特殊返回参数

请求示例

PUT /v1/eipgroup/eg-b2511000?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