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.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
 - If you are using identity policy-based authorization, the following identity policy-based permissions are required. 
     
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
dcaas:gdgw:createPeerlink
Write
gdgw *
- 
            
g:EnterpriseProjectId
 - 
            
g:ResourceTag/<tag-key>
 
-
-
 - 
            
 
URI
POST /v3/{project_id}/dcaas/global-dc-gateways/{global_dc_gateway_id}/peer-links
| 
         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
| 
         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  | 
      
| 
         Parameter  | 
       
         Mandatory  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|---|
| 
         peer_link  | 
       
         Yes  | 
       
         peer_link object  | 
       
         Request body for creating a 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.  | 
      
| 
         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
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         request_id  | 
       
         String  | 
       
         Specifies the request ID.  | 
      
| 
         peer_link  | 
       
         ExternalCreatePeerLink object  | 
       
         Specifies the peer link.  | 
      
| 
         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. 
  | 
      
| 
         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.  | 
      
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         bandwidth_size  | 
       
         Long  | 
       
         Specifies the bandwidth.  | 
      
| 
         gcb_id  | 
       
         String  | 
       
         Specifies the global connection bandwidth ID.  | 
      
| 
         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" : "cn-southwest-242"
    }
  }
}
  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" : "cn-southwest-242",
      "site_code" : "cn-southwest-242",
      "project_id" : "b197c48159d44a66b32c538c3f8da89a",
      "type" : "ER"
    },
    "instance_id" : null
  },
  "request_id" : "196ab00b7bbf03be9187606853d80cee"
}
  SDK Sample Code
The SDK sample code is as follows.
Adding a peer link
          1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58  | 
         
          package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dc.v3.region.DcRegion; import com.huaweicloud.sdk.dc.v3.*; import com.huaweicloud.sdk.dc.v3.model.*; public class CreatePeerLinkSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DcClient client = DcClient.newBuilder() .withCredential(auth) .withRegion(DcRegion.valueOf("<YOUR REGION>")) .build(); CreatePeerLinkRequest request = new CreatePeerLinkRequest(); request.withGlobalDcGatewayId("{global_dc_gateway_id}"); CreateExternalPeerLinkRequestBody body = new CreateExternalPeerLinkRequestBody(); CreateExternalPeerLinkRequestBodyPeerLinkPeerSite peerSitePeerLink = new CreateExternalPeerLinkRequestBodyPeerLinkPeerSite(); peerSitePeerLink.withGatewayId("70e29908-12f8-4d5d-9adf-4da5465b91b2") .withProjectId("b197c48159d44a66b32c538c3f8da89a") .withRegionId("cn-southwest-242"); CreateExternalPeerLinkRequestBodyPeerLink peerLinkbody = new CreateExternalPeerLinkRequestBodyPeerLink(); peerLinkbody.withName("dgw-peer-link-94dc") .withPeerSite(peerSitePeerLink); body.withPeerLink(peerLinkbody); request.withBody(body); try { CreatePeerLinkResponse response = client.createPeerLink(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } }  | 
        
Adding a peer link
          1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44  | 
         
          # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdc.v3.region.dc_region import DcRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdc.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DcClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreatePeerLinkRequest() request.global_dc_gateway_id = "{global_dc_gateway_id}" peerSitePeerLink = CreateExternalPeerLinkRequestBodyPeerLinkPeerSite( gateway_id="70e29908-12f8-4d5d-9adf-4da5465b91b2", project_id="b197c48159d44a66b32c538c3f8da89a", region_id="cn-southwest-242" ) peerLinkbody = CreateExternalPeerLinkRequestBodyPeerLink( name="dgw-peer-link-94dc", peer_site=peerSitePeerLink ) request.body = CreateExternalPeerLinkRequestBody( peer_link=peerLinkbody ) response = client.create_peer_link(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg)  | 
        
Adding a peer link
          1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50  | 
         
          package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dc.NewDcClient( dc.DcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreatePeerLinkRequest{} request.GlobalDcGatewayId = "{global_dc_gateway_id}" peerSitePeerLink := &model.CreateExternalPeerLinkRequestBodyPeerLinkPeerSite{ GatewayId: "70e29908-12f8-4d5d-9adf-4da5465b91b2", ProjectId: "b197c48159d44a66b32c538c3f8da89a", RegionId: "cn-southwest-242", } peerLinkbody := &model.CreateExternalPeerLinkRequestBodyPeerLink{ Name: "dgw-peer-link-94dc", PeerSite: peerSitePeerLink, } request.Body = &model.CreateExternalPeerLinkRequestBody{ PeerLink: peerLinkbody, } response, err := client.CreatePeerLink(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } }  | 
        
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| 
         Status Code  | 
       
         Description  | 
      
|---|---|
| 
         201  | 
       
         Created  | 
      
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot