# 查询分支网络的能力列表 - ListSiteNetworkCapabilities #### 功能介绍 查询分支网络的能力列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CC/doc?api=ListSiteNetworkCapabilities&version=v3)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-cc/cc_02_0002.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | cc:capability:list | List | - | - | - | - | #### URI GET /v3/{domain_id}/dcaas/site-network/capabilities 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | domain_id | 是 | String | 用户的账号ID，即租户ID，用于标识资源所属的华为云账号。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | specification | 否 | Array of strings | 根据分支网络租户能力名查询，可查询多个类型。 | | limit | 否 | Integer | - 参数解释：每页返回的个数，用于控制分页查询返回的记录数量。 - 约束限制：不涉及。 - 取值范围：1\~2000。 - 默认取值：2000。 | | marker | 否 | String | - 参数解释：翻页信息，从上次API调用返回的翻页数据中获取。可填写前一页marker或者后一页marker，填入前一页previous_marker就向前翻页，后一页next_marker就向后翻页。 - 约束限制：翻页过程中，查询条件不能修改，包括过滤条件、排序条件、limit。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | enterprise_project_id | 否 | Array of strings | 根据企业项目ID过滤列表。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | 用户Token，即用户的认证令牌，用于验证用户身份和权限。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | 请求ID。 | | page_info | [PageInfo] object | 分页查询页的信息。 | | capabilities | Array of [SiteNetworkCapabilityEntry] objects | 分支网络租户能力列表。 | 表5PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | next_marker | String | 向后分页标识符。 | | previous_marker | String | 向前分页标识符。 | | current_count | Integer | 当前列表中资源数量。 | 表6SiteNetworkCapabilityEntry | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | - 参数解释：实例ID，即资源的唯一标识符，采用标准UUID格式。 - 约束限制：长度为36个字符，符合标准UUID格式，包含4个连字符。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | 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类型 | 表7ConnectionBandwidthSizeRange | 参数 | 参数类型 | 描述 | |:---|:---|:---| | min | Long | 最小值 | | max | Long | 最大值 | #### 请求示例 查询分支网络租户能力 ``` GET https://{cc_endpoint}/v3/{domain_id}/dcaas/site-network/capabilities ``` #### 响应示例 **状态码：200** 查询分支网络能力列表成功。 ``` { "request_id" : "a3bad42033b84e269e9bbdf67aa8e72b", "page_info" : { "current_count" : 9 }, "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代码示例如下。 - [Java] ``` 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("")) .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()); } } } ``` - [Python] ``` # 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("")) \ .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) ``` - [Go] ``` 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, err := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := cc.CcClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cc.NewCcClient(hcClient) request := &model.ListSiteNetworkCapabilitiesRequest{} response, err := client.ListSiteNetworkCapabilities(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CC/sdk?api=ListSiteNetworkCapabilities&version=v3)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询分支网络能力列表成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cc/ErrorCode.html)。