Help Center/ Cloud Connect/ API Reference/ API/ Central Network Attachments/ Querying the List of Central Network Attachments

Updated on 2024-11-25 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying the List of Central Network Attachments

Function

This API is used to query the list of central network attachments.

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.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Account ID.
central_network_id	Yes	String	Central network ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Number of records on each page. Value range: 1 to 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.
sort_key	No	String	Field for sorting.
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 of arrays	Resource ID. Multiple IDs can be queried.
name	No	Array of strings	Resource name. Multiple names can be queried.
attachment_instance_type	No	Array of arrays	Attachment type. Multiple attachment types can be queried.
state	No	Array of arrays	Central network connection status. Multiple statuses can be queried.
attachment_instance_id	No	Array of arrays	Attachment ID.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
request_id	String	Request ID.
page_info	PageInfo object	Pagination query information.
central_network_attachments	Array of CentralNetworkAttachment objects	List of connections on the central network.

**Table 5** PageInfo
Parameter	Type	Description
next_marker	String	Backward pagination identifier.
previous_marker	String	Forward pagination identifier.
current_count	Integer	Number of the resources in the current list.

**Table 6** CentralNetworkAttachment
Parameter	Type	Description
id	String	Instance ID.
name	String	Instance name.
description	String	Resource description. Angle brackets (<>) are not allowed.
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 connection bandwidth billed by fixed bandwidth is required, and cross-site connection bandwidths are assigned from the global connection bandwidth. TestBandwidth: The test bandwidth is free. Only the minimum bandwidth is used for testing cross-region connectivity.
bandwidth_size	Integer	Amount of bandwidth, 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 an enterprise router.
enterprise_router_attachment_id	String	Attachment ID of the enterprise router.
attachment_instance_type	String	Type of the resource that can be added to a central network as an attachment. The value can be GDGW (global DC gateway) or ER_ROUTE_TABLE (enterprise router route table).
attachment_instance_id	String	ID of the resource used as an attachment on the central network, for example, enterprise router route table ID or global DC gateway ID.
attachment_id	String	Attachment ID of the enterprise router or peer link ID of the global DC gateway.
attachment_instance_project_id	String	Project ID of the resource used as an attachment on the central network.
attachment_instance_region_id	String	Region ID of the resource used as an attachment on the central network.
attachment_instance_site_code	String	Site code of the resource used as an attachment on the central network.
enterprise_router_site_code	String	Site code of the enterprise router on a central network.
specification_value	CentralNetworkAttachmentSpecificationValueInfo object	Additional information about an attachment.

**Table 7** CentralNetworkAttachmentSpecificationValueInfo
Parameter	Type	Description
enterprise_router_table_id	String	ID of the enterprise router route table.
attachment_parent_instance_id	String	ID of the parent resource of an attachment. Here it is the ID of the enterprise router.
hosted_cloud	String	Huawei Cloud or partner cloud. HWCloud: Huawei Cloud Ireland: partner cloud in Ireland
approved_state	String	Approval status. APPROVING: Approving APPROVED: Approved UNAPPROVED: Approval failed
reason	String	Reason for rejecting attachment creation.

Example Requests

Querying the list of central network attachments

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

Example Responses

Status code: 200

The list of attachments 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_attachments" : [ {
    "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "name" : "name",
    "description" : "description",
    "domain_id" : "XXX",
    "state" : "AVAILABLE",
    "created_at" : "2023-10-09T10:13:57.962Z",
    "updated_at" : "2023-10-09T10:13:57.962Z",
    "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" : "region-abc",
    "enterprise_router_attachment_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "attachment_instance_type" : "GDGW",
    "attachment_instance_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "attachment_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "attachment_instance_project_id" : "XXX",
    "attachment_instance_region_id" : "region-abc",
    "attachment_instance_site_code" : "site-abc",
    "enterprise_router_site_code" : "site-abc",
    "specification_value" : {
      "enterprise_router_table_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
      "approved_state" : "APPROVING",
      "hosted_cloud" : "HWCloud",
      "reason" : "string"
    }
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

      
       
         
         
           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.*;


public class ListCentralNetworkAttachmentsSolution {

    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();
        ListCentralNetworkAttachmentsRequest request = new ListCentralNetworkAttachmentsRequest();
        request.withCentralNetworkId("{central_network_id}");
        try {
            ListCentralNetworkAttachmentsResponse response = client.listCentralNetworkAttachments(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());
        }
    }
}

          

        

      
     

      
       
         
         
           # coding: utf-8

import os
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 = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = GlobalCredentials(ak, sk)

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

    try:
        request = ListCentralNetworkAttachmentsRequest()
        request.central_network_id = "{central_network_id}"
        response = client.list_central_network_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)

          

        

      
     

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

          

        

      
     