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

查询分支网络的能力列表

功能介绍

查询分支网络的能力列表。

调试

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

URI

GET /v3/{domain_id}/dcaas/site-network/capabilities

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

账号ID。

表2 Query参数

参数

是否必选

参数类型

描述

specification

Array of arrays

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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求ID。

capabilities

Array of SiteNetworkCapabilityEntry objects

分支网络租户能力列表。

表5 SiteNetworkCapabilityEntry

参数

参数类型

描述

id

String

实例ID。

domain_id

String

实例所属账号ID。

specification

String

分支网络的规格类型定义:

  • site-network.is-support: 支持分支网络。

  • site-network.is-support-enterprise-project: 支持分支网络的企业项目。

  • site-network.is-support-tag: 支持分支网络的标签能力。

  • site-network.is-support-intra-region: 支持同region创建分支网络。

  • site-network.support-topologies: 支持分支网络拓扑。

  • site-network.support-regions: 支持分支接入的Region列表。

  • site-network.support-dscp-regions: 支持分支接入的Region列表

  • site-network.support-freeze-regions: 支持分支网络冻结的Region列表

  • site-network.support-locations: 支持分支接入点列表。

  • site-connection-bandwidth.size-range: 分支连接带宽大小的范围。

  • site-connection-bandwidth.charge-mode: 分支连接带宽计费类型。

  • site-connection-bandwidth.free-line: 分支连接带宽免费线路。

is_support

Boolean

是否支持分支网络。

is_support_enterprise_project

Boolean

是否支持分支网络企业项目。

is_support_tag

Boolean

是否支持分支网络标签。

is_support_intra_region

Boolean

是否支持创建同region分支网络。

support_topologies

Array of strings

分支网络的拓扑列表。

support_regions

Array of strings

list类型

support_dscp_regions

Array of strings

list类型

support_freeze_regions

Array of strings

list类型

support_locations

Array of strings

list类型

size_range

ConnectionBandwidthSizeRange object

json类型

charge_mode

Array of strings

list类型

表6 ConnectionBandwidthSizeRange

参数

参数类型

描述

min

Long

最小值

max

Long

最大值

请求示例

查询分支网络租户能力

GET https://{cc_endpoint}/v3/{domain_id}/dcaas/site-network/capabilities

响应示例

状态码: 200

查询分支网络能力列表成功。

{
  "request_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
  "capabilities" : [ {
    "id" : "1b7de9bb-e222-45b0-a3c2-65210349e578",
    "specification" : "site-network.is-support",
    "domain_id" : "77c0f00509d542629d032230098950c7",
    "is_support" : true
  }, {
    "id" : "bd231847-18a6-4ae3-adc0-0b0c1d706634",
    "specification" : "site-network.is-support-enterprise-project",
    "domain_id" : "77c0f00509d542629d032230098950c7",
    "is_support_enterprise_project" : true
  }, {
    "id" : "af56b862-ad14-4b8b-8919-1eef0bc08913",
    "specification" : "site-network.is-support-tag",
    "domain_id" : "77c0f00509d542629d032230098950c7",
    "is_support_tag" : true
  }, {
    "id" : "d4ed18c8-8ec8-4022-98b7-8fbb5ca487a5",
    "specification" : "site-network.is-support-intra-region",
    "domain_id" : "77c0f00509d542629d032230098950c7",
    "is_support_intra_region" : false
  }, {
    "id" : "de73beea-9104-43e6-888e-2513883091af",
    "specification" : "site-network.support-topologies",
    "domain_id" : "77c0f00509d542629d032230098950c7",
    "support_topologies" : [ "P2P" ]
  }, {
    "id" : "892a448c-62bd-46c9-aca0-44f1a7bb3eda",
    "specification" : "site-network.support-regions",
    "domain_id" : "77c0f00509d542629d032230098950c7",
    "support_regions" : [ "region-abc", "region-def" ]
  }, {
    "id" : "8f6adfa5-517a-4a52-b04e-6b2e90836b01",
    "specification" : "site-network.support-locations",
    "domain_id" : "77c0f00509d542629d032230098950c7",
    "support_locations" : [ "接入点" ]
  }, {
    "id" : "57b48e0b-16c7-4f32-9092-81e0816d7e74",
    "specification" : "site-connection-bandwidth.size-range",
    "domain_id" : "77c0f00509d542629d032230098950c7",
    "size_range" : {
      "max" : 100,
      "min" : 10
    }
  }, {
    "id" : "fc04670b-d8c9-4551-b128-ef65693ec3ef",
    "specification" : "site-connection-bandwidth.charge-mode",
    "domain_id" : "77c0f00509d542629d032230098950c7",
    "charge_mode" : [ "bwd" ]
  } ]
}

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

    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();
        ListSiteNetworkCapabilitiesRequest request = new ListSiteNetworkCapabilitiesRequest();
        try {
            ListSiteNetworkCapabilitiesResponse response = client.listSiteNetworkCapabilities(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 = ListSiteNetworkCapabilitiesRequest()
        response = client.list_site_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.ListSiteNetworkCapabilitiesRequest{}
	response, err := client.ListSiteNetworkCapabilities(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

查询分支网络能力列表成功。

错误码

请参见错误码

相关文档