Query Information of a Bandwidth Package List
Last Updated:2022-01-14
Description
- Query all bandwidth package information under the user account.
- Support query by bandwidth package id, name, and bindType.
- The return result is the intersection of multiple query conditions.
- The result supports marker paging. The default paging size is 1,000 and can be specified by the maxKeys parameter.
Request Structure
GET /v{version}/eipbp?marker={marker}&maxKeys={maxKeys}&id={id}&name={name}&bindType={bindType} HTTP/1.1
Host: eip.bj.baidubce.com
Authorization: authorization string
Request Header
There are no other special headers except the public headers.
Request Parameter
Type | Required? | Parameter Position | Description | |
---|---|---|---|---|
version | String | Yes | URL parameter | API version number (the current value is 1) |
marker | String | No | Query parameter | The starting location of query for the batch acquisition of lists and is one string generated by the system. |
maxKeys | int | No | Query parameter | Maximum number contained in each page, generally not exceeding 1000. The default value is 1000. |
id | String | No | Query parameter | Bandwidth package id to be queried. |
name | String | No | Query parameter | Bandwidth package name to be queried |
bindType | String | No | Query parameter | Type of resource bound to bandwidth package to be queried, "eip" (Elastic IP (EIP)) or "eipgroup" (shared bandwidth) |
type | String | No | Query parameter | Bandwidth package type, including BandwidthPackage (bandwidth package) and AccelerationPackage (cross-border acceleration package). By default, both options are selected. |
Return Status Code
200 is returned successfully. For the failed return, see Error code.
Return Header
There are no other special headers except the public headers.
Return Parameter
Type | Description | |
---|---|---|
bpList | List <BandwidthPackage> | List containing query results |
marker | String | Mark the starting position of the query. The item does not exist if the result list is empty |
isTruncated | boolean | True means there are additional data in the following pages. False means the current page is the last page. |
nextMarker | String | The marker value requiring to be passed in order to acquire the next page. The domain doesn't appear when isTruncated is false. |
maxKeys | int | Maximum number contained in each page. |
Request Example
GET /v1/eipbp?marker=bw-IyWRnII7&maxKeys=2 HTTP/1.1
Host: eip.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
Response Example
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Thu, 16 Mar 2017 06:29:48 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"nextMarker": "bw-IyWRn123",
"marker": "bw-IyWRnII7",
"maxKeys": 2,
"isTruncated": true,
"bpList": [
{
"name":"bp_1",
"id":"bw-IyWRnII7",
"bindType":"eip",
"bandwidthInMbps":"15",
"instanceId":"ip-xefrn257",
"eips":[
"10.23.54.23"
],
"createTime":"2019-08-03T20:38:43Z",
"autoReleaseTime":"2019-08-23T12:38:43Z"
},
{
"name":"bp_2",
"id":"bw-IyWRnIqw",
"bindType":"eipgroup",
"bandwidthInMbps":"30",
"instanceId":"eg-xsdqn76f",
"eips":[
"10.23.96.96",
"10.23.96.97",
"10.23.96.98",
"10.23.96.99"
],
"createTime":"2019-08-03T20:38:43Z",
"autoReleaseTime":"2019-09-23T12:38:43Z",
“type”:"BandwidthPackage",
"region":"bj" }
]
}
BandwidthPackage
Type | Description | |
---|---|---|
name | String | Name of bandwidth package |
id | String | Bandwidth package id |
bindType | String | Type of resource bound to bandwidth package, "eip" (Elastic IP (EIP)) or "eipgroup" (shared bandwidth) |
bandwidthInMbps | int | Bandwidth value of bandwidth package |
instanceId | String | id of the resource bound to bandwidth package |
eips | List < String> | If bindType is "eip", only one eip address is included; if bindType is "eipgroup", all eip addresses under shared bandwidth are included. |
createTime | String | Bandwidth package creation time |
autoReleaseTime | String | Automatic release time of bandwidth package, and if not set, it is consistent with the expiration time of the bound resource. |
type | String | Bandwidth pacakge type, BandwidthPackage (Bandwidth pacakge) or AccelerationPackage (cross-boarder acceleration package) |
region | String | Region to which the bandwidth pacakge belongs |