Query Peer Connection List
Last Updated：2020-07-20
Description
Query the peer connection list.
Request Structure
GET /v{version}/peerconn?vpcId={vpcId}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization stringRequest Parameter
| Parameter name | Type | Required or not | Parameter position | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number (the current value is 1) |
| vpcId | String | No | URL parameter | vpc ID |
| 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 Header
There are no other special headers except the public headers.
Return Parameter
| Parameter name | Type | Description |
|---|---|---|
| peerConns | List<PeerConn> | 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/peerconn?vpcId=vpc-13vuxu016dew&maxKeys=1 HTTP/1.1
Host: bcc.bj.baidubce.com
authorization: bce-auth-v1/930192808c0c11e8b62ccf3a4a052967/2018-07-20T11:37:16Z/3600/host;x-bce-account;x-bce-client-ip;x-bce-date;x-bce-request-id;x-bce-security-token/38230e0d152186b4d4ec912c2b828d1f0d2623920d640589196f3f5be25534b7Return Example
HTTP/1.1 200 OK
Date: Fri, 20 Jul 2018 11:37:16 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"peerConns":[
{
"peerConnId":"peerconn-9td54fmx143e",
"role":"initiator",
"status":"active",
"bandwithInMbp":500,
"description":"peer_diff_account",
"localIfId":"qpif-ken2yc9j8x56",
"localIfName":"int-SpLVk25R",
"localVpcId":"vpc-13vuxu016dew",
"localRegion":"bj",
"peerVpcId":"vpc-jcvmhw9h1a35",
"peerRegion":"bj",
"peerAccountId":"75c14a239bb24b9e88b695e8e9e47952",
"dnsStatus":"close",
"paymentTiming":"Postpaid",
"createdTime" :"2018-08-07 19:46:55",
"expiredTime":expiredTime
}
]
}
"marker":"peerconn-9td54fmx143e",
"isTruncated": true,
"nextMarker": "peerconn-srbvvxmjn7ux",
"maxKeys": 1
}