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

Updating a Peer Link

Function

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

Calling Method

For details, see Calling APIs.

URI

PUT /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.

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

No

peer_link object

Request body for updating a peer link

Table 4 peer_link

Parameter

Mandatory

Type

Description

name

No

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

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID.

peer_link

ExternalUpdatePeerLink object

Request body for updating a peer link

Table 6 ExternalUpdatePeerLink

Parameter

Type

Description

id

String

Specifies the peer link ID.

tenant_id

String

Specifies the tenant ID of the peer link.

name

String

Specifies the name of the peer link.

description

String

Provides supplementary information about the peer link.

global_dc_gateway_id

String

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

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.

Table 7 BandwidthInfoExternal

Parameter

Type

Description

bandwidth_size

Long

Specifies the bandwidth.

gcb_id

String

Specifies the global connection bandwidth ID.

Table 8 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

Updating a peer link

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

{
  "peer_link" : {
    "name" : "dgw-peer-link-test",
    "description" : "test"
  }
}

Example Responses

Status code: 200

OK

  • Peer link that has been updated

    {
  "peer_link" : {
    "name" : "dgw-peer-link-test",
    "id" : "d6ea4641-9575-4675-ac4f-906884e37f28",
    "tenant_id" : "b197c48159d44a66b32c538c3f8da89a",
    "description" : "test",
    "status" : "ACTIVE",
    "reason" : null,
    "created_time" : "2024-12-12T08:16:40.000Z",
    "updated_time" : "2024-12-12T08:22:21.910Z",
    "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"
    }
  },
  "request_id" : "e5406bdd85ca945d6a574e1a297abd1d"
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent Topic: Peer Links