Help Center/ Cloud Connect/ API Reference/ API/ Central Network Capabilities/ Querying Central Network Capabilities
Updated on 2024-11-25 GMT+08:00

Querying Central Network Capabilities

Function

This API is used to query central network capabilities.

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/capabilities

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Account ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

capability

No

Array of arrays

Capabilities. Multiple capabilities can be queried.

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.

capabilities

Array of CentralNetworkCapability objects

List of central network capabilities.

Table 5 CentralNetworkCapability

Parameter

Type

Description

id

String

Instance ID.

domain_id

String

ID of the account that the instance belongs to.

capability

String

Central network capabilities.

  • central-network.is-support: central networks

  • central-network.is-support-enterprise-project: enterprise projects for central networks

  • central-network.is-support-tag: central network tags

  • central-network.is-support-custom-er-table: custom route tables on central networks

  • connection-bandwidth.size-range: bandwidth range for a cross-site connection

  • connection-bandwidth.charge-mode: billing mode of the global connection bandwidth for assigning cross-site connection bandwidths

  • connection-bandwidth.free-line: free lines for cross-site connections

  • er-instance.support-regions: list of the regions where Enterprise Router is available

  • er-instance.support-ipv6-regions: list of the regions where Enterprise Router supports IPv6

  • er-instance.support-dscp-regions: list of the regions that support global connection bandwidth classes for enterprise routers

  • er-instance.support-sts5-regions: list of the regions where sts5 can make API calls to Enterprise Router

  • er-instance.support-sites: list of the sites where Enterprise Router is available

  • custom-connections.is-support: custom connections

  • custom-connections.support-regions: list of the regions where custom connections can be created

  • gdgw-instance.support-dscp-regions: list of the regions where the bandwidth for global DC gateways has different classes

  • gdgw-instance.support-freeze-regions: list of the regions where global connection bandwidths used by global DC gateways can be frozen

  • gdgw-attachment.is-support: global DC gateways as attachments

  • gdgw-attachment.support-regions: list of the regions where global DC gateways can be used as attachments

  • gdgw-attachment.support-sites: list of the sites where global DC gateways can be used as attachments

  • er-route-table-attachment.is-support: enterprise router route tables as attachments

  • er-route-table-attachment.support-regions: list of the regions where enterprise router route tables can be used as attachments

  • er-route-table-attachment.support-sites: list of the sites where enterprise router route tables can be used as attachments

  • cloud-alliance.support-regions: list of the regions that support Cloud Alliance

Example Requests

Querying central network capabilities

GET https://{cc_endpoint}/v3/gcn/capabilities

Example Responses

Status code: 200

Central network capabilities have been queried.

{
  "request_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
  "capabilities" : [ {
    "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "domain_id" : "XXX",
    "capability" : "central-network.is-support",
    "specifications" : {
      "is_support" : true
    }
  } ]
}

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

    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();
        ListCentralNetworkCapabilitiesRequest request = new ListCentralNetworkCapabilitiesRequest();
        try {
            ListCentralNetworkCapabilitiesResponse response = client.listCentralNetworkCapabilities(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
# 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 = ListCentralNetworkCapabilitiesRequest()
        response = client.list_central_network_capabilities(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
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.ListCentralNetworkCapabilitiesRequest{}
	response, err := client.ListCentralNetworkCapabilities(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

Central network capabilities have been queried.

Error Codes

See Error Codes.