查询网关下VPN服务端

功能介绍

根据P2C VPN网关ID，查询VPN服务端。

调用方法

请参见如何调用API。

URI

GET /v5/{project_id}/p2c-vpn-gateways/{p2c_vgw_id}/vpn-servers

请求消息

• 请求参数

  无。

• 请求样例

  GET https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/{p2c_vgw_id}/vpn-servers

响应消息

• 响应参数

  返回状态码为 200: 查询成功。

  表2 响应Body参数列表

  名称	类型	描述
  vpn_servers	Array of ShowServerResponse objects	服务端列表。
  request_id	String	请求id。

  表3 ShowServerResponse

  名称	类型	描述
  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：口令认证（本地）。
  tunnel_protocol	String	功能说明：隧道协议类型。 取值范围 SSL：SSL协议。
  server_certificate	server_certificate object	服务端证书。
  client_ca_certificates	Array of QueryClientCaCertificateBody objects	客户端CA证书列表，用于对客户端证书进行认证。
  ssl_options	ssl_options object	SSL隧道协议的可选配置项。
  status	String	功能说明：服务端状态。 取值范围： PENDING_CREATE：创建中。 PENDING_UPDATE：更新中。 ACTIVE：正常。 FAULT：异常。 FROZEN：冻结。
  created_at	String	功能说明：创建时间。 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ。
  updated_at	String	功能说明：最后更新时间。 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ。

  表4 server_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:ssZ。
  signature_algorithm	String	功能说明：证书签名算法。 取值范围：1-64个字符。

  表5 QueryClientCaCertificateBody

  名称	类型	描述
  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:ssZ。
  signature_algorithm	String	功能说明：证书签名算法。 取值范围：1-64个字符。
  created_at	String	功能说明：创建时间。 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ。
  updated_at	String	功能说明：最后更新时间。 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ。

  表6 ssl_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

• 响应样例

  {
      "vpn_servers": [
          {
              "id": "2407a20d-0bf7-4530-ba9a-7ffa0cedfa3b",
              "p2c_vgw_id": "3b5b64e4-2927-4062-acf6-05b0b842bbfe",
              "client_cidr": "1.1.0.0/16",
              "local_subnets": [
                  "192.168.12.0/24",
                  "192.168.1.0/24"
              ],
              "client_auth_type": "LOCAL_PASSWORD",
              "tunnel_protocol": "SSL",
              "server_certificate": {
                  "id": "scs1716171403922",
                  "name": "lsh-newcert",
                  "issuer": "C=CN,ST=beijing,L=haidian,O=lesaas,OU=root,CN=www.***.com",
                  "subject": "C=CN,ST=beijing,L=haidian,O=server,OU=server,CN=www.***.com",
                  "serial_number": "310325804134830162280305057622726926320418980636",
                  "expiration_time": "2024-06-19T02:15:26Z",
                  "signature_algorithm": "SHA256WITHRSA"
              },
              "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-14T01:14:56.802Z",
              "updated_at": "2024-06-14T08:53:22.855Z"
          }
      ],
      "request_id": "3378c265585ffb8aac68ec39a2db67a1"
  }

状态码

请参见状态码。