# 查询租户下所有VPN服务端 - QueryVPNServers #### 功能介绍 查询租户下所有VPN服务端。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-vpn/vpn_api_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-vpn/vpn_api_0044.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | vpn:p2cVpnGateway:listAllServers | list | p2cVpnGateway | - | - | - | #### URI GET /v5/{project_id}/vpn-servers 表1参数说明 | 名称 | 类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | project_id | String | 是 | 项目ID，可以通过[获取项目ID](https://support.huaweicloud.com/api-vpn/vpn_api_0051.html)获取项目ID。 | 表2请求Query参数列表 | 名称 | 类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | limit | Integer | 否 | 分页查询时每页返回的记录数量。 | | marker | String | 否 | - 功能说明：查询本页的起始标记位，为空时为查询第一页。查询下一页的marker可以根据上一页响应的page_info对象中的next_marker填写。 - 约束：必须与limit一起使用。 | | enterprise_project_id | Array | 否 | 企业项目ID。 | #### 请求消息 - 请求参数 无。 - 请求样例 ``` GET https://{Endpoint}/v5/{project_id}/vpn-servers ``` #### 响应消息 - 响应参数 返回状态码为 200: 查询成功。 表3响应Body参数列表 | 名称 | 类型 | 描述 | |:---|:---|:---| | vpn_servers | Array of [ShowServerResponse] objects | 查询VPN服务端响应对象列表。 | | total_count | Integer | 当前租户下的VPN服务端总数。 | | page_info | [PageInfo] object | 分页查询页的信息。 | | request_id | String | 请求id。 | 表4ShowServerResponse | 名称 | 类型 | 描述 | |:---|:---|:---| | id | String | - 功能说明：VPN服务端 ID。 - 格式：36位UUID。 | | p2c_vgw_id | String | - 功能说明：P2C VPN网关ID。 - 格式：36位UUID。 | | client_cidr | String | - 功能说明：客户端网段。客户端建立连接时，会从该网段分配一个虚拟IP地址。 - 格式："点分十进制/掩码"格式，例如192.168.1.0/24。 | | local_subnets | Array of strings | - 功能说明：本端网段列表。 - 格式："点分十进制/掩码"格式，例如10.10.1.0/24。 | | client_auth_type | String | - 功能说明：客户端认证类型。 - 取值范围： CERT：证书认证。 LOCAL_PASSWORD：口令认证（本地）。 IAM：IAM认证。 FEDERATED：联邦认证。 | | tunnel_protocol | String | - 功能说明：隧道协议类型。 - 取值范围 SSL：SSL协议。 | | server_certificate | [server_certificate] object | 服务端证书。 | | client_ca_certificates | Array of [QueryClientCaCertificateBody] objects | 客户端CA证书列表，用于对客户端证书进行认证。 | | ssl_options | [ssl_options] object | SSL隧道协议的可选配置项。 | | dns_servers | Array of strings | - 功能说明：DNS服务端列表 - 格式："点分十进制"格式，例如172.16.1.1 | | idp_name | String | 身份提供商名称。 | | status | String | - 功能说明：服务端状态。 - 取值范围： PENDING_CREATE：创建中。 PENDING_UPDATE：更新中。 ACTIVE：正常。 FAULT：异常。 FROZEN：冻结。 | | created_at | String | - 功能说明：创建时间。 - UTC时间格式：*yyyy-MM-ddTHH:mm:ss.SSSZ*。 | | updated_at | String | - 功能说明：最后更新时间。 - UTC时间格式：*yyyy-MM-ddTHH:mm:ss.SSSZ*。 | 表5server_certificate | 名称 | 类型 | 描述 | |:---|:---|:---| | id | String | 证书ID，为CCM(云证书与管理服务)中已上传证书的证书ID。若证书在CCM中被删除后，该ID为空。 | | name | String | 证书名，为CCM(云证书与管理服务)中已上传证书的证书名称。 | | issuer | String | - 功能说明：证书颁发者。 - 取值范围：1-256个字符。 | | subject | String | - 功能说明：证书使用者。 - 取值范围：1-256个字符。 | | serial_number | String | - 功能说明：证书序列号。 - 取值范围：1-64个字符。 | | expiration_time | String | - 功能说明：到期时间。 - UTC时间格式：*yyyy-MM-ddTHH:mm:ss.SSSZ*。 | | signature_algorithm | String | - 功能说明：证书签名算法。 - 取值范围：1-64个字符。 | | source | String | - 功能说明：证书来源。 - 取值范围： - CCM - SERVICE_SIGN | 表6QueryClientCaCertificateBody | 名称 | 类型 | 描述 | |:---|:---|:---| | id | String | - 功能说明：证书ID。 - 格式：36位UUID。 | | name | String | - 功能说明：证书名称。 - 取值范围：1-64个字符、支持数字、英文字母、中文(\\u4e00 - \\u9fa5)、_(下划线)、-(中划线)。 | | issuer | String | - 功能说明：证书颁发者。 - 取值范围：1-256个字符。 | | subject | String | - 功能说明：证书使用者。 - 取值范围：1-256个字符。 | | serial_number | String | - 功能说明：CA证书序列号。 - 取值范围：1-64个字符。 | | expiration_time | String | - 功能说明：证书到期时间。 - UTC时间格式：*yyyy-MM-ddTHH:mm:ss.SSSZ*。 | | signature_algorithm | String | - 功能说明：证书签名算法。 - 取值范围：1-64个字符。 | | created_at | String | - 功能说明：创建时间。 - UTC时间格式：*yyyy-MM-ddTHH:mm:ss.SSSZ*。 | | updated_at | String | - 功能说明：最后更新时间。 - UTC时间格式：*yyyy-MM-ddTHH:mm:ss.SSSZ*。 | 表7ssl_options | 名称 | 类型 | 描述 | |:---|:---|:---| | protocol | string | - 功能说明：协议。 - 取值范围：TCP。 | | port | integer | - 功能说明：端口。 - 取值范围： - 443 - 1194 | | encryption_algorithm | string | - 功能说明：加密算法。 - 取值范围： - AES-128-GCM - AES-256-GCM | | authentication_algorithm | string | - 功能说明：认证算法。 - 取值范围： - SHA256 - SHA384 | | is_compressed | boolean | - 功能说明：是否压缩，默认否。 - 取值范围： - true - false | 表8PageInfo | 名称 | 类型 | 描述 | |:---|:---|:---| | next_marker | String | 下一页的marker,值为上一次查询响应中最后一个资源的创建时间。 | | current_count | Integer | 当前列表中资源数量 | - 响应示例 ``` { "vpn_servers": [ { "id": "3f7e48ca-cd3c-4ce2-a277-674382ce44ea", "p2c_vgw_id": "10d176c7-aed8-4766-9180-a47e536c64d0", "client_cidr": "173.16.1.0/24", "local_subnets": [ "172.16.0.0/24", "172.16.1.0/24" ], "client_auth_type": "CERT", "tunnel_protocol": "SSL", "server_certificate": { "id": "scs1698803781642", "name": "p2cvpn_test", "issuer": "CN=p2cvpn.test", "subject": "CN=p2cvpn.server", "serial_number": "109258411809374886820602321558250159914", "expiration_time": "2026-01-22T06:26:18Z", "signature_algorithm": "SHA256WITHRSA", "source": "CCM" }, "client_ca_certificates": [ { "id": "2f291995-9582-4ce8-a7f4-e1b7742e6e0c", "name": "client_ca_sdk_test_1", "issuer": "CN=p2cvpn.test", "subject": "CN=p2cvpn.test", "serial_number": "218730615113252363388323617489459159151767515623", "expiration_time": "2033-10-17T06:21:25Z", "signature_algorithm": "SHA256WITHRSA", "created_at": "2024-06-15T01:59:46.612Z", "updated_at": "2024-06-15T01:59:46.612Z" } ], "ssl_options": { "protocol": "TCP", "port": 443, "encryption_algorithm": "AES-128-GCM", "authentication_algorithm": "SHA256", "is_compressed": false }, "status": "ACTIVE", "created_at": "2024-06-15T01:59:46.612Z", "updated_at": "2024-06-15T02:01:16.606Z" }, { "id": "3840e9ea-84be-4ff9-ad26-817829ba16ed", "p2c_vgw_id": "30dfb9cd-eeb0-4937-a7a5-4bc08184090b", "client_cidr": "173.17.0.0/24", "local_subnets": [ "172.16.0.0/24", "172.16.1.0/24" ], "client_auth_type": "LOCAL_PASSWORD", "tunnel_protocol": "SSL", "server_certificate": { "id": "scs1698803781642", "name": "p2cvpn_test", "issuer": "CN=p2cvpn.test", "subject": "CN=p2cvpn.server", "serial_number": "109258411809374886820602321558250159914", "expiration_time": "2026-01-22T06:26:18Z", "signature_algorithm": "SHA256WITHRSA", "source": "CCM" }, "client_ca_certificates": [], "ssl_options": { "protocol": "TCP", "port": 443, "encryption_algorithm": "AES-128-GCM", "authentication_algorithm": "SHA256", "is_compressed": false }, "status": "ACTIVE", "created_at": "2024-06-15T02:01:19.87Z", "updated_at": "2024-06-15T02:01:19.87Z" } ], "total_count": 2, "page_info": { "current_count": 2 }, "request_id": "2b16014544fff455b50ef3f1e62bbe35" } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-vpn/vpn_api_0052.html)。