Help Center/Direct Connect/API Reference/API/Peer Links/Querying Details About a Peer Link
Updated on 2025-10-27 GMT+08:00
View PDF

Querying Details About a Peer Link

Function

This API is used to query details about a peer link of a global DC gateway.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{project_id}/dcaas/global-dc-gateways/{global_dc_gateway_id}/peer-links/{peer_link_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

Minimum: 0

Maximum: 36

global_dc_gateway_id

Yes

String

Specifies the global DC gateway ID.

peer_link_id

Yes

String

Specifies the peer link of the global DC gateway.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

fields

No

Array of strings

Specifies the list of fields to be displayed.

Array Length: 1 - 5

ext_fields

No

Array of strings

show response ext-fields

Array Length: 0 - 5

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

Minimum: 0

Maximum: 10240

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

peer_link

PeerLinkEntry object

Specifies the details about the peer link.

request_id

String

Specifies the request ID.

Minimum: 0

Maximum: 36

Table 5 PeerLinkEntry

Parameter

Type

Description

id

String

Specifies the peer link ID.

Minimum: 0

Maximum: 36

tenant_id

String

Specifies the tenant ID.

Minimum: 0

Maximum: 255

name

String

Specifies the name of the peer link.

Minimum: 0

Maximum: 64

description

String

Provides supplementary information about the peer link.

Minimum: 0

Maximum: 255

reason

String

Specifies the cause of the failure to add the peer link.

Minimum: 0

Maximum: 255

global_dc_gateway_id

String

Specifies the ID of the global DC gateway that the peer link is added for.

Minimum: 0

Maximum: 64

bandwidth_info

BandWidthInfo object

Provides bandwidth information.

peer_site

PeerSite object

Describes the peer site.

status

String

Specifies the status of the peer link.- PENDING_CREATE: The peer link is being created.- PENDING_UPDATE: The peer link is being updated.- ACTIVE: The peer link is available.- ERROR: An error occurred.

created_time

String

Specifies the time when the peer link was added.

updated_time

String

Specifies the time when the peer link was updated.

create_owner

String

Specifies the cloud service where the peer link is used.

  • cc: Cloud Connect

  • dc: Direct Connect

instance_id

String

Specifies the ID of the instance associated with the peer link.

Table 6 BandWidthInfo

Parameter

Type

Description

bandwidth_size

Integer

Specifies the bandwidth.

Minimum: 0

Maximum: 268435455

gcb_id

String

Specifies the global connection bandwidth ID.

Minimum: 0

Maximum: 36

Table 7 PeerSite

Parameter

Type

Description

gateway_id

String

Specifies the peer gateway ID.

Minimum: 0

Maximum: 36

link_id

String

Specifies the connection ID of the peer gateway at the peer site. For example, if the peer gateway is an enterprise router, this parameter is set to the attachment ID. If the peer gateway is a global DC gateway, this parameter is set to the peer link ID.

Minimum: 0

Maximum: 64

region_id

String

Specifies the region ID of the peer site.

Minimum: 0

Maximum: 36

site_code

String

Specifies the site information of the global DC gateway.

Minimum: 0

Maximum: 64

project_id

String

Specifies the project ID of the peer site.

Minimum: 0

Maximum: 36

type

String

Specifies the type of the peer gateway.

  • er: enterprise router

  • GDGW: global DC gateway

Minimum: 0

Maximum: 64

Example Requests

Querying details about a peer link

GET https://{dc_endpoint}/v3/b197c48159d44a66b32c538c3f8da89a/dcaas/global-dc-gateways/335cb548-0ea0-4aff-80f5-502a2dab5325/peer-links/d6ea4641-9575-4675-ac4f-906884e37f28

Example Responses

Status code: 200

OK

  • Peer link details that have been queried

    {
  "peer_link" : {
    "name" : "dgw-peer-link-94dc",
    "id" : "d6ea4641-9575-4675-ac4f-906884e37f28",
    "tenant_id" : "b197c48159d44a66b32c538c3f8da89a",
    "description" : null,
    "status" : "ACTIVE",
    "reason" : null,
    "created_time" : "2024-12-12T08:16:40.000Z",
    "updated_time" : "2024-12-12T08:17:10.796Z",
    "global_dc_gateway_id" : "335cb548-0ea0-4aff-80f5-502a2dab5325",
    "bandwidth_info" : {
      "bandwidth_size" : 0,
      "gcb_id" : null
    },
    "peer_site" : {
      "gateway_id" : "70e29908-12f8-4d5d-9adf-4da5465b91b2",
      "link_id" : null,
      "region_id" : "xxxxxx",
      "site_code" : "xxxxxx",
      "project_id" : "b197c48159d44a66b32c538c3f8da89a",
      "type" : "ER"
    },
    "create_owner" : "dc",
    "instance_id" : null
  },
  "request_id" : "d4b6270f377d1cfcb90edd12fc737b1f"
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent Topic: Peer Links