Help Center/ Direct Connect/ API Reference/ API/ Global DC Gateways/ Querying the Global DC Gateway List

Updated on 2025-09-01 GMT+08:00

View PDF

Querying the Global DC Gateway List

Function

This API is used to query the global DC gateway list. Pagination query is recommended. The marker and limit parameters are used for pagination query. The two parameters take effect only when they are used together.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{project_id}/dcaas/global-dc-gateways

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID. Minimum: 0 Maximum: 36

**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
marker	No	String	Specifies the ID of the last resource record on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit. Minimum: 0 Maximum: 36
sort_key	No	String	Specifies the sorting field. Default: id Minimum: 0 Maximum: 36
sort_dir	No	Array of strings	Specifies the sorting order of returned results. There are two options: asc (default) and desc.
id	No	Array of strings	Specifies the resource ID for querying instances. Array Length: 1 - 5
name	No	Array of strings	Specifies the resource name for querying instances. You can specify multiple names. Array Length: 1 - 5
enterprise_project_id	No	Array of strings	Specifies the enterprise project ID for querying instances. Array Length: 1 - 10
site_network_id	No	Array of strings	Specifies the site network ID.
cloud_connection_id	No	Array of strings	Specifies the cloud connection ID.
status	No	Array of strings	Specifies the status by which instances are queried. Array Length: 1 - 5
global_center_network_id	No	Array of strings	Specifies the central network ID.

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_gateways	Array of GlobalDcGatewayEntry objects	Lists the global DC gateways. Array Length: 0 - 2000
page_info	PageInfo object	Specifies the pagination query information.
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.
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** PageInfo
Parameter	Type	Description
previous_marker	String	Specifies the marker of the previous page. The value is the resource UUID. Minimum: 0 Maximum: 36
current_count	Integer	Specifies the number of resources in the current list. Minimum: 0 Maximum: 2000
next_marker	String	Specifies the marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page. Minimum: 0 Maximum: 36

Example Requests

Querying the global DC gateway list

GET https://{dc_endpoint}/v3/b197c48159d44a66b32c538c3f8da89a/dcaas/global-dc-gateways

Example Responses

Status code: 200

Global DC gateway list that has been queried

{
  "request_id" : "f7fdbf6618bc3b3e8750340cb37d1761",
  "global_dc_gateways" : [ {
    "enterprise_project_id" : "0",
    "name" : "zss-ipv6-test",
    "id" : "0790b22c-42db-4051-b974-b80c5cd61a7b",
    "tenant_id" : "b197c48159d44a66b32c538c3f8da89a",
    "description" : "",
    "tags" : [ ],
    "status" : "ACTIVE",
    "reason" : null,
    "admin_state_up" : true,
    "created_time" : "2024-06-06T01:33:21.000Z",
    "updated_time" : "2024-09-12T08:32:49.831Z",
    "bgp_asn" : 64511,
    "global_center_network_id" : null,
    "current_peer_link_count" : 0,
    "available_peer_link_count" : 3,
    "location_name" : "Beijing4",
    "locales" : {
      "en_us" : "xxx",
      "zh_cn" : "xxx"
    },
    "region_id" : "xxxxxx",
    "address_family" : "ipv4"
  } ]
}