View Peer Connection Details
Last Updated:2020-07-20
Description
View the details of the specified peer connection.
Request Structure
GET /v{version}/peerconn/{peerConnId} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
Request Parameter
Parameter name | Type | Required or not | Parameter position | Description |
---|---|---|---|---|
version | String | Yes | URL parameter | API version number (the current value is 1) |
peerConnId | String | Yes | URL parameter | peer connection ID |
role | String | No | Query parameter | The "initiator" refers to the initiator, and the "acceptor" refers to the acceptor. The details of the peer connections in the same region can be queried based on this. If this parameter is not set, either the initiator or the acceptor information is returned for the same region. |
Return Header
There are no other special headers except the public headers.
Return Parameter
Parameter name | Type | Description |
---|---|---|
peerConnId | String | peer connection ID |
role | String | The "initiator" refers to the initiator, and the "acceptor" refers to the acceptor. |
status | PeerConnStatus | Status of peer connection |
bandwithInMbp | int | peer connection bandwidth |
description | String | peer connection comments |
localIfId | String | Local interface ID of peer connection |
localIfName | String | Local interface name of peer connection |
localVpcId | String | ID of local VPC of peer connection |
localRegion | String | Local region of peer connection |
peerVpcId | String | ID of opposite terminal VPC of peer connection |
peerRegion | String | Opposite terminal region of peer connection |
peerAccountId | String | Account ID of opposite terminal of peer connection |
createdTime | String | Creation time of peer connection |
expiredTime | String | After the peer connection expires, the value for post-payment is empty. |
dnsStatus | DnsStatus | Status of synchronous dns of peer connection |
paymentTiming | String | The billing types "Prepaid" and "Postpaid" of peer connection are respectively refer to prepayment and postpayment. |
Request Example
GET /v1/peerconn/peerconn-9td54fmx143e 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/38230e0d152186b4d4ec912c2b828d1f0d2623920d640589196f3f5be25534b7
Return Example
HTTP/1.1 200 OK
Date: Fri, 20 Jul 2018 11:37:16 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"peerConnId":"peerconn-cbp4xrtzk3fb",
"role":"initiator",
"status":"active",
"bandwithInMbp":1000,
"description":"mypeerconn",
"localIfId":"qpif-qz9a61ujsizt",
"localIfName":"dsds",
"localVpcId":"20fada00-f66e-40de-bed4-954af13dc0b2",
"localRegion":"bj",
"peerVpcId":"1aa1427d-92cf-45d0-bc31-ab4d9fe71425",
"peerRegion":"bj",
"peerAccountId":"75c14a239bb24b9e88b695e8e9e47952",
"createdTime": "2018-08-03 20:38:43"
"expiredTime":null,
"dnsStatus":"close",
"paymentTiming":"Postpaid"
}