查询虚拟网关列表 - ListVirtualGateways
功能介绍
查询虚拟网关列表。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
dcaas:vgw:list
List
vgw *
-
-
-
-
g:EnterpriseProjectId
URI
GET /v3/{project_id}/dcaas/virtual-gateways
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 租户项目ID。获取方法请参见《统一身份认证服务API参考》的『获取账号项目ID』章节,或通过查询项目列表接口获取 约束限制: 不涉及 取值范围: 32 位十六进制字符(0-9, a-f, A-F) 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 每页返回的个数。 约束限制: 不涉及 取值范围: 1~2000。 默认取值: 2000 |
| marker | 否 | String | 参数解释: 上一页最后一条资源记录的ID,为空时为查询第一页。 约束限制: 必须与limit一起使用。 取值范围: 长度不超过36个字符 默认取值: 不涉及 |
| fields | 否 | Array of strings | 参数解释: 显示字段列表,数组中每个字符串为虚拟接口对象的字段名(如 id、name、admin_state_up、bandwidth、status 等) 约束限制: 数组长度为1~5 取值范围: 不涉及 默认取值: 不涉及 |
| sort_dir | 否 | Array of strings | 参数解释: 返回结果按照升序(asc)或降序(desc)排列,默认为asc 约束限制: 不涉及 |
| sort_key | 否 | String | 参数解释: 排序字段。 约束限制: 不涉及 取值范围: 只能由字母、数字及连字符组成,长度不超过36个字符 默认取值: id |
| id | 否 | Array of strings | 参数解释: 根据资源ID过滤实例。获取方式:可通过查询虚拟接口列表(ListVirtualInterfaces)接口获取 约束限制: 数组长度为1~5 |
| enterprise_project_id | 否 | Array of strings | 参数解释: 根据企业项目ID过滤资源实例。获取方式:可通过企业项目管理服务查询获取 约束限制: 数组长度为1~10 |
| vpc_id | 否 | Array of strings | 通过VPC-ID过滤虚拟网关实例 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 获取Token,请参考《统一身份认证服务API参考》的「获取用户Token」章节。请求响应成功后在响应消息头中包含的「X-Subject-Token」的值即为Token值。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| request_id | String | 参数解释: 操作请求ID 取值范围: 不涉及 |
| virtual_gateways | Array of VirtualGateway objects | 参数解释: 虚拟网关对象列表 |
| page_info | PageInfo object | 参数解释: 分页查询页的信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 虚拟网关的ID 取值范围: 不涉及 |
| vpc_id | String | 参数解释: 虚拟网关接入的VPC的ID 取值范围: UUID 格式,以连字符(-)连接 |
| tenant_id | String | 参数解释: 实例所属项目ID。 取值范围: 不涉及 |
| name | String | 参数解释: 虚拟网关的名称 取值范围: 长度不超过64个字符 |
| description | String | 参数解释: 虚拟网关的描述 取值范围: 长度不超过128个字符 |
| type | String | 参数解释: 虚拟网关类型:default 取值范围: 不涉及 |
| local_ep_group | Array of strings | 参数解释: 虚拟网关到访问云上服务IPv4子网列表,通常是vpc的cidrs |
| local_ep_group_ipv6 | Array of strings | 参数解释: 预留字段用于虚拟网关到访问云上服务IPv6子网列表,通常是vpc的cidrs |
| admin_state_up | Boolean | 参数解释: 管理状态 取值范围: true、false |
| status | String | 参数解释: 操作状态。 取值范围: |
| bgp_asn | Integer | 参数解释: 虚拟网关本地的BGP自治域号(asn) 取值范围: 1~4294967295 |
| enterprise_project_id | String | 参数解释: 实例所属企业项目ID。 取值范围: 最大长度36字节,带"-"连字符的UUID格式,或者是字符串"0","0"表示默认企业项目。 |
| device_id | String | 参数解释: 归属的设备ID 取值范围: 不涉及 |
| redundant_device_id | String | 参数解释: 归属的冗余设备ID 取值范围: 不涉及 |
| public_border_group | String | 参数解释: 归属的可用区对应的边界组(public border group),标识是否homezone局点。 取值范围: 不涉及 |
| tags | Array of Tag objects | 参数解释: 标签信息 |
请求示例
查询虚拟网关列表
GET https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-gateways 响应示例
状态码:200
-
{ "virtual_gateways" : [ { "id" : "20082c1b-3c99-48d8-8e8c-116af5d7e9f0", "name" : "vgw-c7b22", "description" : "", "tenant_id" : "0605768a3300d5762f82c01180692873", "vpc_id" : "6592c28e-95d7-4b0a-9f61-004fdf03420c", "device_id" : "26.151.63.100", "redundant_device_id" : "26.152.128.20", "type" : "default", "status" : "ACTIVE", "admin_state_up" : true, "bgp_asn" : 64512, "local_ep_group" : [ "192.168.1.0/24" ], "enterprise_project_id" : "0", "public_border_group" : "center", "local_ep_group_ipv6" : null, "tags" : [ ] } ], "request_id" : "765f7aaf8f2edd0e719de564ef72e2de", "page_info" : { "previous_marker" : "20082c1b-3c99-48d8-8e8c-116af5d7e9f0", "current_count" : 1 } }
SDK代码示例
SDK代码示例如下。
Java
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 com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; 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.dc.v3.region.DcRegion; import com.huaweicloud.sdk.dc.v3.*; import com.huaweicloud.sdk.dc.v3.model.*; public class ListVirtualGatewaysSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DcClient client = DcClient.newBuilder() .withCredential(auth) .withRegion(DcRegion.valueOf("<YOUR REGION>")) .build(); ListVirtualGatewaysRequest request = new ListVirtualGatewaysRequest(); try { ListVirtualGatewaysResponse response = client.listVirtualGateways(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
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 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdc.v3.region.dc_region import DcRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdc.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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DcClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListVirtualGatewaysRequest() response = client.list_virtual_gateways(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
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 48 49 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/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") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dc.DcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dc.NewDcClient(hcClient) request := &model.ListVirtualGatewaysRequest{} response, err := client.ListVirtualGateways(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
错误码
请参见错误码。