# 查询VPC连接列表 - ListVpcAttachments #### 功能介绍 查询企业路由器实例下的VPC连接列表。 #### 接口约束 - 支持过滤查询，过滤条件有id，state，enterprise_project_id，vpc_id，过滤条件可以重复和组合。 - 支持分页查询，limit和marker组合实现分页查询。 - 支持单字段排序功能，排序字段有\[id,name,description,created_at,updated_at\]，不支持多字段排序。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-er/er_02_0008.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-er/er_02_0015.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | er:instances:listVpcAttachments | List | instances \* | - | er:attachments:list | - | #### URI GET /v3/{project_id}/enterprise-router/{er_id}/vpc-attachments 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID | | er_id | 是 | String | 企业路由器实例ID | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | 每页返回的个数。 取值范围：1\~2000。 最小值：**1** 最大值：**2000** | | marker | 否 | String | 查询的页码id，为空时为查询第一页。 使用说明：必须与limit一起使用。 最小长度：**1** 最大长度：**128** | | state | 否 | Array of strings | - 参数解释：连接状态 - 取值范围： - pending：等待中 - available：可用 - modifying：修改中 - deleting：删除中 - deleted：已删除 - failed：失败 - pending_acceptance：等待接受 - rejected：拒绝 - initiating_request：初始化请求 - invalid：无效 | | id | 否 | Array of strings | 根据资源ID查询，可同时查询多个。 | | sort_key | 否 | Array of strings | - 参数解释：按关键字排序，默认按照id排序 - 取值范围: - id：资源标识 - name：资源名称 - state：资源状态 | | sort_dir | 否 | Array of strings | 返回结果按照升序或降序排列，默认为asc,降序为desc | | vpc_id | 否 | Array of strings | VPC id | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | vpc_attachments | Array of [VpcAttachmentDetails] objects | VPC连接列表 | | page_info | [PageInfo] object | 分页查询的信息 | | request_id | String | 请求ID | 表4VpcAttachmentDetails | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | VPC连接ID | | name | String | VPC连接名称 | | vpc_id | String | VPC id | | virsubnet_id | String | VPC子网id | | auto_create_vpc_routes | Boolean | 默认为false,当设置true时，会自动为VPC配置10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16三条路由，下一跳指向企业路由器。 缺省值：**false** | | state | String | - 参数解释：VPC连接状态 - 取值范围： - pending：等待中 - available：可用 - modifying：修改中 - deleting：删除中 - deleted：已删除 - failed：失败 - initiating_request：初始化请求 - rejected：拒绝 - pending_acceptance：等待接受 - freezed：冻结 - invalid：无效 | | created_at | String | 创建时间,格式:YYYY-MM-DDTHH:mm:ss.sssZ | | updated_at | String | 更新时间,格式:YYYY-MM-DDTHH:mm:ss.sssZ | | tags | Array of [Tag] objects | 标签信息 | | description | String | VPC连接描述信息 | | project_id | String | 项目ID | | vpc_project_id | String | vpc所属项目ID | 表5Tag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | 标签键，规则： - 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及字符：下划线"_"，点"."，冒号":"，等号"="，加号"+"，中划线"-"，"@"。 - _sys_开头属于系统标签，租户不能输入。 - 标签key不能为空（长度不能为0）。 - 长度在1-128之间。 最小长度：**1** 最大长度：**128** | | value | String | 标签值，规则： - 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及字符：下划线"_"，点"."，冒号":"，等号"="，加号"+"，中划线"-"，"@"。 - 资源标签值可以为空（empty or null）。 - 长度在0-255之间。 最小长度：**0** 最大长度：**255** | 表6PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | next_marker | String | 下一个marker标识，为空时表示最后一页 | | current_count | Integer | 当前列表中资源数量 | #### 请求示例 - 分页查询VPC连接信息 ``` GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/6e426a28-be00-4e8d-8a5a-2e3b6e4c1d5f/vpc-attachments?limit=10 ``` - 查询全量VPC连接信息 ``` GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/6e426a28-be00-4e8d-8a5a-2e3b6e4c1d5f/vpc-attachments ``` #### 响应示例 **状态码：200** OK ``` { "vpc_attachments" : [ { "id" : "6f83b848-8331-4271-ac0c-ef94b7686402", "name" : "vpc-attach-01", "vpc_id" : "b715e131-3371-4e17-a2de-4f669e24439a", "virsubnet_id" : "aacdc21d-90f9-45ef-ab48-80ec1bbe15b8", "project_id" : "08d5a9564a704afda6039ae2babbef3c", "state" : "available", "created_at" : "2020-03-11T15:13:31.000Z", "updated_at" : "2020-03-11T15:13:31.000Z" }, { "id" : "6f83b848-8331-4271-ac0c-ef94b7686402", "name" : "vpc-attach-01", "vpc_id" : "4b8567f6-358f-4a7f-8cd3-3cbb82c0b25f", "virsubnet_id" : "2b55f334-a15e-43a9-ab11-b34c2dbb6fac", "project_id" : "08d5a9564a704afda6039ae2babbef3c", "state" : "available", "created_at" : "2020-03-11T15:13:31.000Z", "updated_at" : "2020-03-11T15:13:31.000Z" } ], "page_info" : { "next_marker" : "1", "current_count" : 2 }, "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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.er.v3.region.ErRegion; import com.huaweicloud.sdk.er.v3.*; import com.huaweicloud.sdk.er.v3.model.*; public class ListVpcAttachmentsSolution { 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); ErClient client = ErClient.newBuilder() .withCredential(auth) .withRegion(ErRegion.valueOf("")) .build(); ListVpcAttachmentsRequest request = new ListVpcAttachmentsRequest(); request.withErId("{er_id}"); try { ListVpcAttachmentsResponse response = client.listVpcAttachments(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 BasicCredentials from huaweicloudsdker.v3.region.er_region import ErRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdker.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 = ErClient.new_builder() \ .with_credentials(credentials) \ .with_region(ErRegion.value_of("")) \ .build() try: request = ListVpcAttachmentsRequest() request.er_id = "{er_id}" response = client.list_vpc_attachments(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/basic" er "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/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 := er.ErClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := er.NewErClient(hcClient) request := &model.ListVpcAttachmentsRequest{} request.ErId = "{er_id}" response, err := client.ListVpcAttachments(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ER/sdk?api=ListVpcAttachments)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-er/ErrorCode.html)。