Help Center> Cloud Connect> API Reference> API> Central Network Attachments> Querying the List of Global DC Gateways on a Central Network
Updated on 2024-05-13 GMT+08:00

Querying the List of Global DC Gateways on a Central Network

Function

This API is used to query the list of global DC gateways on a central network.

Parameters marker and limit are used for pagination query. The default value of limit is 0. If marker is not specified, the first data record is returned.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{domain_id}/gcn/central-network/{central_network_id}/gdgw-attachments

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Account ID.

Minimum: 10

Maximum: 32

central_network_id

Yes

String

Central network ID.

Minimum: 36

Maximum: 36

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Number of records on each page.

Value range: 1 to 1000

Minimum: 1

Maximum: 1000

Default: 1000

marker

No

String

Pagination query information. You can obtain the marker values from the response of the last API call. You can enter the marker value of the previous page or the next page. If you enter the marker value of the previous page, the previous page will be queried. If you enter the marker value of the next page, the next page will be queried. During pagination query, the query criteria, including the filters, sorting criteria, and the limit value, cannot be modified.

Minimum: 1

Maximum: 4096

sort_key

No

String

Field for sorting.

Default: updated_at

Minimum: 1

Maximum: 36

sort_dir

No

Object

Whether the resources are sorted in ascending or descending order. asc indicates the ascending order and desc indicates the descending order.

id

No

Array

Resource ID. Multiple IDs can be queried.

Array Length: 1 - 20

name

No

Array

Resource name. Multiple names can be queried.

Array Length: 1 - 20

state

No

Array

Central network connection status. Multiple statuses can be queried.

Array Length: 1 - 20

global_dc_gateway_id

No

Array

Global DC gateway IDs.

Array Length: 1 - 10

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

Minimum: 0

Maximum: 2000000

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

request_id

String

Resource ID.

Minimum: 32

Maximum: 36

page_info

PageInfo object

Pagination query information.

central_network_gdgw_attachments

Array of CentralNetworkGdgwAttachment objects

List of the global DC gateways on the central network.

Array Length: 0 - 2000

Table 5 PageInfo

Parameter

Type

Description

next_marker

String

Backward pagination identifier.

Minimum: 1

Maximum: 4096

previous_marker

String

Forward pagination identifier.

Minimum: 1

Maximum: 4096

current_count

Integer

Number of the resources in the current list.

Minimum: 0

Maximum: 2000

Table 6 CentralNetworkGdgwAttachment

Parameter

Type

Description

id

String

Resource ID.

name

String

Resource name.

description

String

Resource description. Angle brackets (<>) are not allowed.

Minimum: 0

Maximum: 255

domain_id

String

ID of the account that the instance belongs to.

state

String

Central network connection status.

  • AVAILABLE: The connection is available.

  • CREATING: The connection is being created.

  • UPDATING: The connection is being updated.

  • DELETING: The connection is being deleted.

  • FREEZING: The connection is being frozen.

  • UNFREEZING: The connection is being unfrozen.

  • RECOVERING: The connection is being recovered.

  • FAILED: The operation on the connection failed.

  • DELETED: The connection is deleted.

  • APPROVING: The connection is being approved.

  • APPROVED: The connection is approved.

  • UNAPPROVED: The approval failed.

created_at

String

Time when the resource was created. The time is in the yyyy-MM-ddTHH:mm:ss format.

updated_at

String

Time when the resource was updated. The time must be in the yyyy-MM-ddTHH:mm:ss format.

central_network_id

String

Central network ID.

central_network_plane_id

String

ID of the central network plane.

global_connection_bandwidth_id

String

Global connection bandwidth ID.

bandwidth_type

String

Bandwidth type. The bandwidth types are as follows:

  • BandwidthPackage: A global private bandwidth billed by fixed bandwidth is required, and cross-site connection bandwidths are assigned from the global private bandwidth.

  • TestBandwidth: The test bandwidth is free. Only the minimum bandwidth is used for testing cross-region connectivity.

bandwidth_size

Integer

Bandwidth range, in Mbit/s.

is_frozen

Boolean

Whether the resource is frozen.

enterprise_router_id

String

Enterprise router ID.

enterprise_router_project_id

String

Project ID of the enterprise router.

enterprise_router_region_id

String

Region ID of the enterprise router.

enterprise_router_attachment_id

String

Attachment ID of the enterprise router.

global_dc_gateway_peer_link_id

String

Resource ID.

global_dc_gateway_id

String

Resource ID.

global_dc_gateway_project_id

String

Project ID.

global_dc_gateway_region_id

String

Region ID.

enterprise_router_site_code

String

Site code definition.

global_dc_gateway_site_code

String

Site code definition.

Example Requests

Querying the list of global DC gateways on a central network

GET /v3/{domain_id}/gcn/central-network/{central_network_id}/gdgw-attachments

Example Responses

Status code: 200

The list of global DC gateways on the central network has been queried.

{
  "request_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
  "page_info" : {
    "next_marker" : "8EDF12u71N...",
    "previous_marker" : "8EDF12u71N...",
    "current_count" : 1
  },
  "central_network_gdgw_attachments" : [ {
    "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "name" : "name",
    "description" : "description",
    "domain_id" : "XXX",
    "state" : "AVAILABLE",
    "created_at" : "2023-10-09T10:11:11.222Z",
    "updated_at" : "2023-10-09T10:11:11.222Z",
    "central_network_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "central_network_plane_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "global_connection_bandwidth_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "bandwidth_type" : "BandwidthPackage",
    "bandwidth_size" : 20,
    "is_frozen" : false,
    "enterprise_router_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "enterprise_router_project_id" : "XXX",
    "enterprise_router_region_id" : "cn-north-4",
    "enterprise_router_attachment_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "global_dc_gateway_peer_link_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "global_dc_gateway_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "global_dc_gateway_project_id" : "XXX",
    "global_dc_gateway_region_id" : "cn-north-4",
    "enterprise_router_site_code" : "cn-north-bj4",
    "global_dc_gateway_site_code" : "cn-north-bj4"
  } ]
}

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
48
49
50
51
52
53
54
55
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
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.cc.v3.region.CcRegion;
import com.huaweicloud.sdk.cc.v3.*;
import com.huaweicloud.sdk.cc.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class ListCentralNetworkGdgwAttachmentsSolution {

    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");

        ICredential auth = new GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        CcClient client = CcClient.newBuilder()
                .withCredential(auth)
                .withRegion(CcRegion.valueOf("<YOUR REGION>"))
                .build();
        ListCentralNetworkGdgwAttachmentsRequest request = new ListCentralNetworkGdgwAttachmentsRequest();
        request.withLimit(<limit>);
        request.withMarker("<marker>");
        request.withSortKey("<sort_key>");
        request.withSortDir();
        request.withId();
        request.withName();
        request.withState();
        request.withGlobalDcGatewayId();
        try {
            ListCentralNetworkGdgwAttachmentsResponse response = client.listCentralNetworkGdgwAttachments(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
32
33
34
35
36
37
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkcc.v3.region.cc_region import CcRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcc.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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = GlobalCredentials(ak, sk) \

    client = CcClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CcRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListCentralNetworkGdgwAttachmentsRequest()
        request.limit = <limit>
        request.marker = "<marker>"
        request.sort_key = "<sort_key>"
        request.sort_dir = 
        request.id = 
        request.name = 
        request.state = 
        request.global_dc_gateway_id = 
        response = client.list_central_network_gdgw_attachments(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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    cc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/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")

    auth := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := cc.NewCcClient(
        cc.CcClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListCentralNetworkGdgwAttachmentsRequest{}
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	sortKeyRequest:= "<sort_key>"
	request.SortKey = &sortKeyRequest
	response, err := client.ListCentralNetworkGdgwAttachments(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

The list of global DC gateways on the central network has been queried.

Error Codes

See Error Codes.