Query Shared Bandwidth List

Last Updated：2020-07-20

List of shared bandwidth can be queried based on multiple conditions.
If you do not provide the query conditions, all EIPs are overwritten by default.
The returned result is the query result of intersection of multiple conditions, i.e. when multiple conditions are provided, shared bandwidth meeting all conditions simultaneously is returned.
The query result above supports marker paging, with paging size of 1,000 by default, which can be specified via maxKeys parameter.

Request structure

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

Request header

There are no other special headers except the public headers.

Request parameter

Parameter name	Type	Required or not	Parameter position	Description
version	String	Yes	URL parameter	API version number (the current value is 1)
id	String	No	Query parameter	ID of shared bandwidth to be queried
name	String	No	Query parameter	Name of shared bandwidth to be queried
status	String	No	Query parameter	State of shared bandwidth to be queried
marker	String	No	Query parameter	The starting location of query for 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.

Return status code

200 is returned successfully, for the failed return, please see Error Code.

Return header

There are no other special headers except the public headers.

Return parameter

Parameter name	Type	Description
eipgroups	List<EipGroupModel>	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 and 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/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

Response example

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
}

Update Shared Bandwidth

Query Details of a Shared Bandwidth

百度智能云

Elastic IP

Query Shared Bandwidth List