# 查询VPC列表 - ListVpcs #### 功能介绍 查询虚拟私有云列表。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=VPC&api=ListVpcs&version=v2)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-vpc/vpc_permission_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | vpc:vpcs:list | List | vpc \* | - | - | - | | vpc:vpcs:list | List | - | [g:EnterpriseProjectId](https://support.huaweicloud.com/usermanual-iam5/iam_01_1287.html) | - | - | #### URI GET /v1/{project_id}/vpcs 样例： ``` GET https://{Endpoint}/v1/{project_id}/vpcs?limit=10&marker=13551d6b-755d-4757-b956-536f674975c0 ``` 参数说明请参见[表1]。 表1参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取项目ID请参见[获取项目ID](https://support.huaweicloud.com/api-vpc/vpc_api_0011.html)。 | | id | 否 | String | 按照VPC ID过滤查询。 | | marker | 否 | String | 分页查询的起始资源ID，表示从指定资源的下一条记录开始查询。 marker需要和limit配合使用： - 若不传入marker和limit参数，查询结果返回第一页全部资源记录。 - 若不传入marker参数，limit为10，查询结果返回第1\~10条资源记录。 - 若marker为第10条记录的资源ID，limit为10，查询结果返回第11\~20条资源记录。 - 若marker为第10条记录的资源ID，不传入limit参数，查询结果返回第11\~2000条（limit默认值2000）资源记录。 | | limit | 否 | Integer | 分页查询每页返回的记录个数，取值范围为0\~2000，默认值2000。 limit需要和marker配合使用，详细规则请见marker的参数说明。 | | enterprise_project_id | 否 | String | - 功能说明：按照企业项目ID过滤查询，可以使用该字段过滤某个企业项目下的虚拟私有云。 - 取值范围：最大长度36字节，带"-"连字符的UUID格式，或者是字符串"0"。"0"表示默认企业项目。若需要查询当前用户所有企业项目绑定的虚拟私有云，请传参**all_granted_eps**。 | #### 请求参数 无 #### 请求示例 ``` GET https://{Endpoint}/v1/{project_id}/vpcs ``` #### 响应参数 表2响应参数 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | vpcs | Array of [vpc] objects | [表3 vpc对象]列表。 | 表3vpc对象 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | id | String | uuid形式的一个资源标识。 | | name | String | - 功能说明：虚拟私有云名称。 - 取值范围：0-64个字符，支持数字、字母、中文字符、_(下划线)、-（中划线）、.（点）。 - 约束：如果名称不为空，则同一个租户下的名称不能重复。 | | description | String | - 功能说明：虚拟私有云描述。 - 取值范围：0-255个字符，不能包含"\<"和"\>"。 | | cidr | String | - 功能说明：虚拟私有云下可用子网的范围。 - 取值范围： 建议使用如下IP地址范围： - 10.0.0.0/8\~24 - 172.16.0.0/12\~24 - 192.168.0.0/16\~24 除上述地址外，还可以使用任何可公共路由的IP地址，但必须**排除**如下的系统预留地址和公网保留地址： 系统预留地址： - 100.64.0.0/10 - 214.0.0.0/7 - 198.18.0.0/15 - 169.254.0.0/16 公网保留地址： - 0.0.0.0/8 - 127.0.0.0/8 - 240.0.0.0/4 - 不指定cidr时，默认值为空。 - 约束：如果cidr不为空，必须是cidr格式，例如:192.168.0.0/16。 | | status | String | - 功能说明：虚拟私有云的状态。 - 取值范围： - CREATING：创建中。 - OK：创建成功。 | | block_service_endpoint_states | String | - 功能说明：默认情况下，VPC中的资源可以通过内网访问服务终结点。开启该项后，VPC将无法通过内网访问服务终结点，请谨慎操作。无法访问以下云服务：容器镜像服务SWR、云日志服务LTS、企业主机安全HSS、应用运维管理AOM、应用性能管理APM、对象存储服务OBS、API网关APIG。 - 取值范围： - off：代表禁用。 - on：代表开启。 | | enable_network_address_usage_metrics | Boolean | - 功能说明：是否开启VPC内所有子网的IPv4地址使用量指标监控。 - 取值范围： - true：开启 - false：不开启 | | enterprise_project_id | String | - 功能说明：企业项目ID。 - 取值范围：最大长度36字节，带"-"连字符的UUID格式，或者是字符串"0"。"0"表示默认企业项目。 说明： 关于企业项目ID的获取及企业项目特性的详细信息，请参见[《企业管理用户指南》](https://support.huaweicloud.com/usermanual-em/zh-cn_topic_0126101490.html)。 | | routes | Array of [route] objects | - 功能说明：路由信息列表。 - 约束：详情参见[表4]。 | | tenant_id | String | - 功能说明：项目ID。 | | created_at | String | - 功能说明：资源创建时间，UTC时间。 - 格式：yyyy-MM-ddTHH:mm:ss。 | | updated_at | String | - 功能说明：资源更新时间，UTC时间。 - 格式：yyyy-MM-ddTHH:mm:ss。 | 表4route对象 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | destination | String | - 功能说明：路由目的网段。 - 约束：必须是cidr格式，支持IPv4和IPv6 cidr格式。 | | nexthop | String | - 功能说明：路由下一跳地址。 - 约束：必须为IP地址格式，且必须属于本VPC下的子网范围内才能生效，支持IPv4和IPv6地址。 | #### 响应示例 ``` { "vpcs": [ { "id": "13551d6b-755d-4757-b956-536f674975c0", "name": "default", "description": "test", "cidr": "172.16.0.0/16", "status": "OK", "enterprise_project_id": "0", "routes": [], "block_service_endpoint_states": "off", "enable_network_address_usage_metrics": false, "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", "created_at": "2022-12-15T02:11:13", "updated_at": "2022-12-15T02:11:13" }, { "id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "name": "222", "description": "test", "cidr": "192.168.0.0/16", "status": "OK", "enterprise_project_id": "0", "routes": [], "block_service_endpoint_states": "off", "enable_network_address_usage_metrics": false, "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", "created_at": "2022-12-15T04:01:21", "updated_at": "2022-12-15T04:01:21" }, { "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3", "name": "vpc", "description": "test", "cidr": "192.168.0.0/16", "status": "OK", "enterprise_project_id": "0", "routes": [], "block_service_endpoint_states": "off", "enable_network_address_usage_metrics": false, "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", "created_at": "2022-12-15T05:36:29", "updated_at": "2022-12-15T05:36:29" } ] } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-vpc/vpc_api_0002.html)。 #### 错误码 请参考[错误码](https://support.huaweicloud.com/api-vpc/vpc_api_0003.html)。