Adding a Peer Link

Function

This API is used to add a peer link between a global DC gateway and an enterprise router or another global DC gateway.

Calling Method

For details, see Calling APIs.

URI

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

**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.

Request Parameters

**Table 2** 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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
peer_link	Yes	peer_link object	Request body for creating a peer link

**Table 4** peer_link
Parameter	Mandatory	Type	Description
name	Yes	String	Specifies the name of the peer link. Minimum: 0 Maximum: 64
description	No	String	Provides supplementary information about the peer link. Minimum: 0 Maximum: 128
peer_site	Yes	peer_site object	Specifies the site of the peer link.

**Table 5** peer_site
Parameter	Mandatory	Type	Description
gateway_id	Yes	String	Specifies the ID of enterprise router that the global DC gateway is attached to. Minimum: 0 Maximum: 36
project_id	Yes	String	Specifies the project ID of the enterprise router that the global DC gateway is attached to. Minimum: 0 Maximum: 36
region_id	Yes	String	Specifies the region ID of the enterprise router that the global DC gateway is attached to. Minimum: 0 Maximum: 36

Response Parameters

Status code: 201

**Table 6** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID.
peer_link	ExternalCreatePeerLink object	Specifies the peer link.

**Table 7** ExternalCreatePeerLink
Parameter	Type	Description
id	String	Specifies the peer link ID.
instance_id	String	Specifies the peer link ID.
tenant_id	String	Specifies the tenant ID.
name	String	Specifies the peer link name.
description	String	Provides supplementary information about the peer link.
global_dc_gateway_id	String	Specifies the global DC gateway ID.
bandwidth_info	BandwidthInfoExternal object	Provides bandwidth information.
peer_site	PeerSiteExternal object	Specifies the site to be connected.
status	String	Specifies the status of the peer link. ACTIVE: The peer link is normal. ERROR: The peer link is abnormal.
reason	String	Specifies the cause of the failure to add the peer link.
created_time	String	Specifies the time when the peer link was added.
updated_time	String	Specifies the time when the peer link was updated.

**Table 8** BandwidthInfoExternal
Parameter	Type	Description
bandwidth_size	Long	Specifies the bandwidth.
gcb_id	String	Specifies the global connection bandwidth ID.

**Table 9** PeerSiteExternal
Parameter	Type	Description
gateway_id	String	Specifies the global DC gateway ID.
link_id	String	Specifies the peer link ID.
region_id	String	Specifies the site ID.
project_id	String	Specifies the project ID.
site_code	String	Specifies the site code.
type	String	Specifies the peer link type.

Example Requests

Adding a peer link

POST https://{dc_endpoint}/v3/b197c48159d44a66b32c538c3f8da89a/dcaas/global-dc-gateways/1c6edc27-5fdb-4dae-ac77-72d47c70ed83/peer-links

{
  "peer_link" : {
    "name" : "dgw-peer-link-94dc",
    "peer_site" : {
      "gateway_id" : "70e29908-12f8-4d5d-9adf-4da5465b91b2",
      "project_id" : "b197c48159d44a66b32c538c3f8da89a",
      "region_id" : "xxxxxx"
    }
  }
}

Example Responses

Status code: 201

Created

Peer link that has been created

{
  "peer_link" : {
    "name" : "dgw-peer-link-94dc",
    "id" : "d6ea4641-9575-4675-ac4f-906884e37f28",
    "tenant_id" : "b197c48159d44a66b32c538c3f8da89a",
    "description" : null,
    "status" : "PENDING_CREATE",
    "reason" : null,
    "created_time" : "2024-12-12T00:16:40.000Z",
    "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"
    },
    "instance_id" : null
  },
  "request_id" : "196ab00b7bbf03be9187606853d80cee"
}