文档首页/ 云专线 DC/ API参考/ API/ 全域接入网关/ 查询专线全域接入网关列表
更新时间:2025-01-03 GMT+08:00

查询专线全域接入网关列表

功能介绍

查询专线全域接入网关列表,建议使用分页查询 分页查询使用的参数为marker、limit。marker和limit一起使用时才会生效,单独使用无效

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目ID

最小长度:0

最大长度:36

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每页返回的个数。

取值范围:1~2000。

最小值:1

最大值:2000

缺省值:2000

fields

Array of strings

显示字段列表

数组长度:1 - 5

marker

String

上一页最后一条资源记录的ID,为空时为查询第一页。

使用说明:必须与limit一起使用。

最小长度:0

最大长度:36

sort_key

String

排序字段。

缺省值:id

最小长度:0

最大长度:36

sort_dir

Array of strings

返回结果按照升序(asc)或降序(desc)排列,默认为asc

id

Array of strings

根据资源ID过滤实例

数组长度:1 - 5

name

Array of strings

根据名字过滤查询,可查询多个名字。

数组长度:1 - 5

enterprise_project_id

Array of strings

根据企业项目ID过滤资源实例

数组长度:1 - 10

site_network_id

Array of strings

站点网络ID

cloud_connection_id

Array of strings

云连接ID

status

Array of strings

根椐资源状态过滤实例

数组长度:1 - 5

global_center_network_id

Array of strings

全球中心网络ID

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 获取Token,请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

最小长度:0

最大长度:10240

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

global_dc_gateways

Array of GlobalDcGatewayEntry objects

全域接入网关列表。

数组长度:0 - 2000

page_info

PageInfo object

分页查询页的信息

request_id

String

请求ID。

最小长度:0

最大长度:36

表5 GlobalDcGatewayEntry

参数

参数类型

描述

id

String

专线全域接入网关(global-dc-gateway)ID

最小长度:0

最大长度:36

tenant_id

String

项目ID。

最小长度:0

最大长度:255

name

String

global-dc-gateway名字。

最小长度:0

最大长度:64

description

String

描述信息

最小长度:0

最大长度:128

reason

String

失败原因

最小长度:0

最大长度:255

enterprise_project_id

String

global-dc-gateway所属的企业项目ID。

最小长度:0

最大长度:36

global_center_network_id

String

DGW加载的全球中心网络实例的ID

最小长度:0

最大长度:36

bgp_asn

Long

DGW对应BGP的ASN编号

最小值:0

最大值:65535

region_id

String

DGW所属Region

最小长度:0

最大长度:36

location_name

String

DGW创建网关设备归属的位置

最小长度:0

最大长度:36

locales

LocalesBody object

Locale地址描述信息。

current_peer_link_count

Integer

全域接入网关(GDGW)上关联连接的数量,表示DGW挂载ER的数量

available_peer_link_count

Integer

该全域接入网关上GDGW允许创建关联连接(PeerLink)的数量

tags

Array of Tag objects

global-dc-gateway关联TAG。

数组长度:0 - 10

admin_state_up

Boolean

该GDGW的管理状态,true为激活状态、false为冻结状态

status

String

GDGW资源状态,DOWN (未连接状态), PENDING_UPDATE(连接状态更新中),ACTIVE (已连接状态), ERROR (出错)。

created_time

String

创建时间。

updated_time

String

更新时间。

address_family

String

网关的地址簇,IPv4或者ipv6和IPv4双栈

  • ipv4
  • dual
表6 LocalesBody

参数

参数类型

描述

en_us

String

区域英文名称。

最小长度:0

最大长度:255

zh_cn

String

区域中文名称。

最小长度:0

最大长度:255

表7 Tag

参数

参数类型

描述

key

String

标签键,最大长度36个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,中文。

最小长度:0

最大长度:36

value

String

标签值,最大长度43个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,点“.”,中文。

最小长度:0

最大长度:43

表8 PageInfo

参数

参数类型

描述

previous_marker

String

上一页的marker,值为资源的uuid

最小长度:0

最大长度:36

current_count

Integer

当前列表中资源数量

最小值:0

最大值:2000

next_marker

String

下一页的marker,值为资源的uuid,为空时表示最后一页

最小长度:0

最大长度:36

请求示例

查询全域接入网关列表

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

响应示例

状态码: 200

OK

  • 全域接入网关列表查询结果
    {
      "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" : "Beijing-4",
          "zh_cn" : "北京-4"
        },
        "region_id" : "cn-southwest-242",
        "address_family" : "ipv4"
      } ]
    }

SDK代码示例

SDK代码示例如下。

 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
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.ListGlobalDcGatewaysRequest{}
	response, err := client.ListGlobalDcGateways(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

错误码

请参见错误码