Help Center/ Direct Connect/ API Reference/ API/ Global DC Gateways/ Querying the Global DC Gateway List
Updated on 2026-11-11 GMT+08:00

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.

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:list

    List

    gdgw *

    -

    -

    cc:centralNetwork:list

    -

    g:EnterpriseProjectId

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Specifies the project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Definition

Specifies the number of records returned on each page.

Constraints

N/A

Range

1 to 2000

Default Value

2000

fields

No

Array of strings

Definition

Specifies the list of fields to be displayed.

Constraints

The array length ranges from 1 to 5.

marker

No

String

Definition

Specifies the ID of the last resource record on the previous page. If this parameter is left blank, the first page is queried.

Constraints

This parameter must be used together with limit.

Range

The value can contain a maximum of 36 characters.

Default Value

N/A

sort_key

No

String

Definition

Specifies the sorting key.

Constraints

N/A

Range

The value can contain a maximum of 36 characters.

Default Value

id

sort_dir

No

Array of strings

Definition

Specifies the sorting order of returned results, which can be asc (ascending order) or desc (descending order). The default value is asc.

Constraints

N/A

id

No

Array of strings

Definition

Specifies the resource ID by which instances are queried.

Constraints

The array length ranges from 1 to 5.

name

No

Array of strings

Definition

Specifies the resource name by which instances are filtered. You can specify multiple names.

Constraints

The array length ranges from 1 to 5.

enterprise_project_id

No

Array of strings

Definition

Specifies the enterprise project ID by which resource instances are queried.

Constraints

The array length ranges from 1 to 10.

site_network_id

No

Array of strings

Definition

Specifies the site network ID.

Constraints

N/A

cloud_connection_id

No

Array of strings

Definition

Specifies the cloud connection ID.

Constraints

N/A

status

No

Array of strings

Definition

Specifies the status by which instances are queried.

Constraints

The array length ranges from 1 to 5.

global_center_network_id

No

Array of strings

Definition

Specifies the central network ID.

Constraints

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. After the request is processed, the value of X-Subject-Token in the header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

global_dc_gateways

Array of GlobalDcGatewayEntry objects

Definition

Specifies the global DC gateways.

page_info

PageInfo object

Definition

Specifies the pagination query information.

request_id

String

Definition

Specifies the request ID.

Range

The value can contain a maximum of 36 characters.

Table 5 GlobalDcGatewayEntry

Parameter

Type

Description

id

String

Definition

Specifies the global DC gateway ID.

Range

The value can contain a maximum of 36 characters.

tenant_id

String

Definition

Specifies the project ID.

Range

N/A

name

String

Definition

Specifies the name of the global DC gateway.

Range

The value can contain a maximum of 64 characters.

description

String

Definition

Specifies the description.

Range

The value can contain a maximum of 128 characters.

reason

String

Definition

Specifies the failure cause.

Range

The value can contain a maximum of 255 characters.

enterprise_project_id

String

Definition

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

Range

The value can contain a maximum of 36 characters.

global_center_network_id

String

Definition

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

Range

The value can contain a maximum of 36 characters.

bgp_asn

Long

Definition

Specifies the BGP ASN of the global DC gateway.

Range

0 to 65535

region_id

String

Definition

Specifies the region of the global DC gateway.

Range

N/A

location_name

String

Definition

Specifies the location of the global DC gateway.

Range

The value can contain a maximum of 36 characters.

locales

LocalesBody object

Definition

Specifies the locale.

current_peer_link_count

Integer

Definition

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.

Range

N/A

available_peer_link_count

Integer

Definition

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

Range

N/A

tags

Array of Tag objects

Definition

Specifies the tags added to the global DC gateway.

admin_state_up

Boolean

Definition

Specifies the administrative status of the global DC gateway. true indicates that the global DC gateway is available, and false indicates that the global DC gateway is frozen.

Range

  • true

  • false

status

String

Definition

Specifies the status of the global DC gateway. The value can be DOWN (the global DC gateway becomes faulty), PENDING_UPDATE (the global DC gateway is being updated), ACTIVE (the global DC gateway is available), or ERROR (an error occurred).

Range

  • DOWN

  • PENDING_UPDATE

  • ACTIVE

  • ERROR

created_time

String

Definition

Specifies the creation time.

updated_time

String

Definition

Specifies the update time.

address_family

String

Definition

Specifies the address family of the global DC gateway.

  • ipv4

  • dual

Range

  • ipv4

  • dual

Table 6 LocalesBody

Parameter

Type

Description

en_us

String

Definition

Specifies the region name in English.

Range

The value can contain a maximum of 255 characters. Angle brackets (< and >) are not allowed.

zh_cn

String

Definition

Specifies the region name in Chinese.

Range

The value can contain a maximum of 255 characters. Angle brackets (< and >) are not allowed.

Table 7 Tag

Parameter

Type

Description

key

String

Definition

Specifies the tag key. Each key cannot start or end with a space, or start with _sys_. Only letters, digits, spaces, and the following special characters are allowed: _.:=+-@

Range

1 to 128 characters

value

String

Definition

Specifies the tag value. The value can contain letters, digits, spaces, and the following special characters: _.:/=+-@

Range

The value can contain a maximum of 255 characters.

Table 8 PageInfo

Parameter

Type

Description

previous_marker

String

Definition

Specifies the marker of the previous page. The value is the resource UUID.

Range

The value can contain a maximum of 36 characters.

current_count

Integer

Definition

Specifies the number of resources in the current list.

Range

0 to 2000

next_marker

String

Definition

Specifies the marker of the next page. The value is the resource UUID. This parameter does not exist if the page is the last one.

Range

The value can contain a maximum of 36 characters.

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" : "xxx",
    "locales" : {
      "en_us" : "xxx",
      "zh_cn" : "xxx"
    },
    "region_id" : "xxxxxx",
    "address_family" : "ipv4"
  } ],
  "page_info" : {
    "previous_marker" : "0790b22c-42db-4051-b974-b80c5cd61a7b",
    "current_count" : 1
  }
}

SDK Sample Code

The SDK sample code is as follows.

 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
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 ListGlobalDcGatewaysSolution {

    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();
        ListGlobalDcGatewaysRequest request = new ListGlobalDcGatewaysRequest();
        try {
            ListGlobalDcGatewaysResponse response = client.listGlobalDcGateways(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());
        }
    }
}
 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
# 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 = ListGlobalDcGatewaysRequest()
        response = client.list_global_dc_gateways(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := dc.DcClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := dc.NewDcClient(hcClient)

    request := &model.ListGlobalDcGatewaysRequest{}
	response, err := client.ListGlobalDcGateways(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

200

OK

Error Codes

See Error Codes.