文档首页/ 云连接 CC/ API参考/ API/ 中心网络能力/ 查询中心网络能力列表
更新时间:2024-11-25 GMT+08:00

查询中心网络能力列表

功能介绍

查询中心网络能力列表。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v3/{domain_id}/gcn/capabilities

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

账号ID。

表2 Query参数

参数

是否必选

参数类型

描述

capability

Array of arrays

根据租户能力名查询,可查询多个类型。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求ID。

capabilities

Array of CentralNetworkCapability objects

租户能力列表

表5 CentralNetworkCapability

参数

参数类型

描述

id

String

实例ID。

domain_id

String

实例所属账号ID。

capability

String

能力类型定义:

  • central-network.is-support: 支持中心网络

  • central-network.is-support-enterprise-project: 支持中心网络的企业项目

  • central-network.is-support-tag: 支持中心网络的标签能力

  • central-network.is-support-custom-er-table: 支持中心网络的自定义路由表能力

  • connection-bandwidth.size-range: 跨地域连接带宽大小的范围

  • connection-bandwidth.charge-mode: 跨地域连接带宽计费类型

  • connection-bandwidth.free-line: 跨地域连接免费线路

  • er-instance.support-regions: 支持ER实例的Region列表

  • er-instance.support-ipv6-regions: 支持IPV6的ER实例Region列表

  • er-instance.support-dscp-regions:支持带宽包线路等级配置的region列表

  • er-instance.support-sts5-regions:支持sts5调用ER服务的region列表

  • er-instance.support-sites: 支持ER实例的站点列表

  • custom-connections.is-support: 是否支持自定义连接

  • custom-connections.support-regions: 支持创建自定义连接的region

  • gdgw-instance.support-dscp-regions:支持GDGW全域互联带宽线路等级配置的region列表

  • gdgw-instance.support-freeze-regions:支持GDGW全域互联带宽冻结的region列表

  • gdgw-attachment.is-support: 支持GDGW附件

  • gdgw-attachment.support-regions: 支持GDGW附件的Region列表

  • gdgw-attachment.support-sites: 支持GDGW附件的站点列表

  • er-route-table-attachment.is-support: 支持路由表附件

  • er-route-table-attachment.support-regions: 支持路由表附件的Region列表

  • er-route-table-attachment.support-sites: 支持路由表附件的站点列表

  • cloud-alliance.support-regions: 支持云联盟场景的Region列表

请求示例

查询租户能力

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

响应示例

状态码: 200

查询中心网络能力列表成功。

{
  "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代码示例

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
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)
    }
}

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

状态码

状态码

描述

200

查询中心网络能力列表成功。

错误码

请参见错误码