查询分支网络列表 - ListSiteNetworks
功能介绍
查询分支网络列表。
分页查询使用的参数为marker、limit。limit默认值为0,没有指定marker时返回第一条数据。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
cc:siteNetwork:list
List
siteNetwork *
-
-
-
URI
GET /v3/{domain_id}/dcaas/site-networks
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| domain_id | 是 | String | 用户的账号ID,即租户ID,用于标识资源所属的华为云账号。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | |
| marker | 否 | String | |
| sort_dir | 否 | Object | |
| id | 否 | Array of strings | 根据ID查询,可查询多个ID。 |
| name | 否 | Array of strings | 根据名称查询,可查询多个名称。 |
| state | 否 | Array of strings | 根据状态查询,有效值: |
| enterprise_project_id | 否 | Array of strings | 根据企业项目ID过滤列表。 |
| global_dc_gateway_id | 否 | Array of strings | 根据GDW实例ID过滤列表。 |
| global_connection_bandwidth_id | 否 | Array of strings | 根据带宽包ID过滤。 |
| connection_id | 否 | Array of strings | 分支连接的ID。 |
| sort_key | 否 | String | 排序字段,有效值: |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 否 | String | 用户Token,即用户的认证令牌,用于验证用户身份和权限。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| request_id | String | 请求ID。 |
| page_info | PageInfo object | 分页查询页的信息。 |
| site_networks | Array of SiteNetworkEntry objects | 分支网络列表。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| next_marker | String | 向后分页标识符。 |
| previous_marker | String | 向前分页标识符。 |
| current_count | Integer | 当前列表中资源数量。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | |
| name | String | |
| description | String | |
| created_at | String | |
| updated_at | String | |
| domain_id | String | 实例所属账号ID。 |
| state | String | 分支网络状态,有效值: |
| enterprise_project_id | String | |
| apply_policy_id | String | 应用策略ID。 |
| tags | Array of Tag objects | 实例标签。 |
| topology | String | 拓扑结构类型,有效值 |
| connections | Array of SiteConnection objects | 分支连接列表。 |
| sites | Array of SiteInformation objects | 点对点拓扑或者网状拓扑中的节点。 |
| hub_site | SiteInformation object | 分支信息。 |
| spoke_sites | Array of SiteInformation objects | 分支列表。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | |
| site_network_id | String | 分支网络ID。 |
| state | String | 分支网络连接状态,有效值: |
| created_at | String | |
| updated_at | String | |
| edge_pair | Array of DirectedEdge objects | 分支网络连接的两个端点定义,长度固定为2的数组。 |
| cross_region_type | String | 跨地域类型,有效值: |
| global_connection_bandwidth_id | String | 全域互联带宽ID。 |
| bandwidth_size | Integer | 带宽值,单位Mbps。 |
| is_frozen | Boolean | 是否冻结。 |
| frozen_effect | String | 冻结效果,有效值: |
| is_bind_bandwidth | Boolean | 是否绑定带宽包。 |
请求示例
查询分支网络列表。
GET /v3/{domain_id}/dcaas/site-networks 响应示例
状态码:200
查询分支网络列表成功。
{
"request_id" : "0050ea65af7e190d9a791d9e69f28e63",
"page_info" : {
"current_count" : 1
},
"site_networks" : [ {
"id" : "eb350a5c-06c1-4b12-9ae4-3820f31faaa0",
"name" : "er-connection",
"domain_id" : "XXX",
"created_at" : "2023-10-09T10:15:32.134Z",
"updated_at" : "2023-10-09T10:15:32.134Z",
"enterprise_project_id" : "0",
"apply_policy_id" : "43ad756e-2780-463e-a8ed-27a5bd77b7a7",
"topology" : "p2p",
"state" : "AVAILABLE",
"sites" : [ {
"gateway_id" : "1c233723-234c-4b50-8fba-7072b4c6aa1a",
"project_id" : "XXX",
"region_id" : "region-abc",
"site_code" : "region-abc",
"gateway_type" : "GDGW"
}, {
"gateway_id" : "8641d7f0-bd0c-49fe-8b70-3649cd7dd9b1",
"project_id" : "XXX",
"region_id" : "region-abc",
"site_code" : "region-abc",
"gateway_type" : "GDGW"
} ],
"connections" : [ {
"id" : "1c233723-234c-4b50-8fba-7072b4c6aa1a",
"state" : "AVAILABLE",
"cross_region_type" : "inter-region",
"global_connection_bandwidth_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
"bandwidth_size" : 20,
"is_frozen" : false,
"is_bind_bandwidth" : false,
"edge_pair" : [ {
"id" : "1c233723-234c-4b50-8fba-7072b4c6aa1a",
"gateway_id" : "8641d7f0-bd0c-49fe-8b70-3649cd7dd9b1",
"project_id" : "XXX",
"region_id" : "region-abc",
"site_code" : "region-abc",
"gateway_type" : "GDGW"
}, {
"id" : "1c233723-234c-4b50-8fba-7072b4c6aa11",
"gateway_id" : "8641d7f0-bd0c-49fe-8b70-3649cd7dd9b1",
"project_id" : "XXX",
"region_id" : "region-abc",
"site_code" : "region-abc",
"gateway_type" : "GDGW"
} ]
} ]
} ]
} 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 ListSiteNetworksSolution { 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(); ListSiteNetworksRequest request = new ListSiteNetworksRequest(); try { ListSiteNetworksResponse response = client.listSiteNetworks(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 = ListSiteNetworksRequest() response = client.list_site_networks(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 36 37 38 39 40 41 42 43 44 45 46 47 | 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("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cc.NewCcClient(hcClient) request := &model.ListSiteNetworksRequest{} response, err := client.ListSiteNetworks(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询分支网络列表成功。 |
错误码
请参见错误码。