Help Center/Direct Connect/API Reference/API/Global DC Gateways/Querying Details About a Global DC Gateway
Updated on 2025-10-27 GMT+08:00
View PDF

Querying Details About a Global DC Gateway

Function

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

Calling Method

For details, see Calling APIs.

URI

GET /v3/{project_id}/dcaas/global-dc-gateways/{global_dc_gateway_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.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Specifies the number of records returned on each page.

Value range: 1 to 2000

Minimum: 1

Maximum: 2000

Default: 2000

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

enterprise_project_id

No

Array of strings

Specifies the enterprise project ID for querying instances.

Array Length: 1 - 10

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

global_dc_gateway

GlobalDcGatewayEntry object

Specifies the global DC gateway.

request_id

String

Specifies the request ID.

Minimum: 0

Maximum: 36

Table 5 GlobalDcGatewayEntry

Parameter

Type

Description

id

String

Specifies the global DC gateway ID.

Minimum: 0

Maximum: 36

tenant_id

String

Specifies the project ID.

Minimum: 0

Maximum: 255

name

String

Specifies the name of the global DC gateway.

Minimum: 0

Maximum: 64

description

String

Provides supplementary information about the global DC gateway.

Minimum: 0

Maximum: 128

reason

String

Specifies the cause of the failure to create the global DC gateway.

Minimum: 0

Maximum: 255

enterprise_project_id

String

Specifies the ID of the enterprise project that the global DC gateway belongs to.

Minimum: 0

Maximum: 36

global_center_network_id

String

Specifies the ID of the central network that the global DC gateway is added to.

Minimum: 0

Maximum: 36

bgp_asn

Long

Specifies the BGP ASN of the global DC gateway.

Minimum: 0

Maximum: 65535

region_id

String

Specifies the region of the global DC gateway.

Minimum: 0

Maximum: 36

location_name

String

Specifies the location where the underlying device of the global DC gateway is deployed.

Minimum: 0

Maximum: 36

locales

LocalesBody object

Specifies the locale.

current_peer_link_count

Integer

Specifies the number of peer links allowed on a global DC gateway, indicating the number of enterprise routers that the global DC gateway can be attached to.

available_peer_link_count

Integer

Specifies the number of peer links that can be created for a global DC gateway.

tags

Array of Tag objects

Specifies the tag added to the global DC gateway.

Array Length: 0 - 10

admin_state_up

Boolean

Specifies the administrative status of the global DC gateway.

  • true: The global DC gateway is available.

  • false: The global DC gateway is frozen.

status

String

Specifies the status of the global DC gateway.- DOWN: The global DC gateway is faulty.- PENDING_UPDATE: The global DC gateway is being updated.- ACTIVE: The global DC gateway is available.- ERROR: An error occurred.

created_time

String

Specifies the time when the global DC gateway was created.

updated_time

String

Specifies the time when the global DC gateway was updated.

address_family

String

Specifies the IP address family of the global DC gateway.

  • ipv4: Only IPv4 is supported.

  • dual: Both IPv4 and IPv6 are supported.

Table 6 LocalesBody

Parameter

Type

Description

en_us

String

Specifies the region name in English.

Minimum: 0

Maximum: 255

zh_cn

String

Specifies the region name in Chinese.

Minimum: 0

Maximum: 255

Table 7 Tag

Parameter

Type

Description

key

String

Specifies the tag key. The key can contain a maximum of 36 Unicode characters, including letters, digits, hyphens (-), and underscores (_).

Minimum: 0

Maximum: 36

value

String

Specifies the tag value. The value can contain a maximum of 43 Unicode characters, including letters, digits, hyphens (-), underscores (_), and periods (.).

Minimum: 0

Maximum: 43

Example Requests

Querying details about a global DC gateway

GET https://{dc_endpoint}/v3/b197c48159d44a66b32c538c3f8da89a/dcaas/global-dc-gateways/71f6ac9b-2745-4fb8-96c8-9d97d969c4b5

Example Responses

Status code: 200

OK

  • Global DC gateway details that have been queried

    {
  "global_dc_gateway" : {
    "enterprise_project_id" : "0",
    "name" : "dgw-2c18",
    "id" : "71f6ac9b-2745-4fb8-96c8-9d97d969c4b5",
    "tenant_id" : "b197c48159d44a66b32c538c3f8da89a",
    "description" : "",
    "tags" : [ ],
    "status" : "DOWN",
    "reason" : null,
    "admin_state_up" : true,
    "created_time" : "2024-12-12T07:33:19.000Z",
    "updated_time" : "2024-12-12T07:33:19.000Z",
    "bgp_asn" : 64512,
    "global_center_network_id" : null,
    "current_peer_link_count" : 0,
    "available_peer_link_count" : 3,
    "location_name" : null,
    "locales" : null,
    "region_id" : null,
    "address_family" : "ipv4"
  }
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent Topic: Global DC Gateways