Querying a VPN Server Based on a Specified Gateway ID

Function

This API is used to query a VPN server based on a specified P2C VPN gateway ID.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

• If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
• If you are using identity policy-based authorization, the following identity policy-based permissions are required.

URI

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

Request

• Request parameters

  None

• Example request

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

Response

• Response parameters

  Returned status code 200: successful query

  Table 2 Parameters in the response body

  Parameter	Type	Description
  vpn_servers	Array of ShowServerResponse objects	Specifies server list information.
  total_count	integer	Specifies the total number of records.
  page_info	PageInfo object	Specifies pagination query information.
  request_id	String	Specifies a request ID.

  Table 3 ShowServerResponse

  Parameter	Type	Description
  id	String	Specifies the ID of a VPN server. The value is a UUID containing 36 characters.
  p2c_vgw_id	String	Specifies the ID of a P2C VPN gateway. The value is a UUID containing 36 characters.
  client_cidr	String	Specifies a client CIDR block. A virtual IP address on this CIDR block will be assigned to a client for establishing a connection. The value is in the format of dotted decimal notation/mask, for example, 192.168.1.0/24.
  local_subnets	Array of strings	Specifies the list of local CIDR blocks. The value is in the format of dotted decimal notation/mask, for example, 10.10.1.0/24.
  client_auth_type	String	Specifies the client authentication mode. Value range: CERT: certificate authentication LOCAL_PASSWORD: password authentication (local) IAM: IAM authentication FEDERATED: federated authentication
  tunnel_protocol	String	Specifies a tunnel protocol. Value range: SSL
  server_certificate	server_certificate object	Specifies server certificate information.
  client_ca_certificates	Array of QueryClientCaCertificateBody objects	Specifies the list of client CA certificates, which are used to authenticate client certificates.
  ssl_options	ssl_options object	Specifies SSL options.
  dns_servers	Array of strings	Specifies the DNS server list. The value is in dotted decimal notation, for example, 172.16.1.1.
  idp_name	String	Specifies an identity provider name.
  status	String	Specifies the server status. Value range: PENDING_CREATE: creating PENDING_UPDATE: updating ACTIVE: normal FAULT: abnormal FROZEN: frozen
  created_at	String	Specifies the creation time. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.
  updated_at	String	Specifies the last update time. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.

  Table 4 server_certificate

  Parameter	Type	Description
  id	String	Specifies a certificate ID, which is the ID of a certificated uploaded in the CCM. This parameter is left empty if the certificate is deleted from the CCM.
  name	String	Specifies a certificate name, which is the name of a certificated uploaded in the CCM.
  issuer	String	Specifies the issuer of a certificate. The value is a string of 1 to 256 characters.
  subject	String	Specifies the subject of a certificate. The value is a string of 1 to 256 characters.
  serial_number	String	Specifies the serial number of a certificate. The value is a string of 1 to 64 characters.
  expiration_time	String	Specifies the expiration time. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.
  signature_algorithm	String	Specifies the signature algorithm of a certificate. The value is a string of 1 to 64 characters.
  source	String	Specifies the certificate source. Value range: CCM SERVICE_SIGN

  Table 5 QueryClientCaCertificateBody

  Parameter	Type	Description
  id	String	Specifies a certificate ID. The value is a UUID containing 36 characters.
  name	String	Specifies a certificate name. The value is a string of 1 to 64 characters, which can contain digits, letters, underscores (_), and hyphens (-).
  issuer	String	Specifies the issuer of a certificate. The value is a string of 1 to 256 characters.
  subject	String	Specifies the subject of a certificate. The value is a string of 1 to 256 characters.
  serial_number	String	Specifies the serial number of a CA certificate. The value is a string of 1 to 64 characters.
  expiration_time	String	Specifies the expiration time of a certificate. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.
  signature_algorithm	String	Specifies the signature algorithm of a certificate. The value is a string of 1 to 64 characters.
  created_at	String	Specifies the creation time. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.
  updated_at	String	Specifies the last update time. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.

  Table 6 ssl_options

  Parameter	Type	Description
  protocol	string	Specifies a protocol. Value range: TCP
  port	integer	Specifies a port number. Value range: 443 1194
  encryption_algorithm	string	Specifies an encryption algorithm. Value range: AES-128-GCM AES-256-GCM
  authentication_algorithm	string	Specifies an authentication algorithm. Value range: SHA256 SHA384
  is_compressed	boolean	Specifies whether to compress data. By default, data is not compressed. Value range: true false

  Table 7 PageInfo

  Parameter	Type	Description
  next_marker	String	Specifies the marker of the next page. The value is the time when the last resource in the last query response was created.
  current_count	integer	Specifies the number of resources in the current list.

• Example response

  {
      "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",
                  "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-14T01:14:56.802Z",
              "updated_at": "2024-06-14T08:53:22.855Z"
          }
      ],
      "request_id": "3378c265585ffb8aac68ec39a2db67a1"
  }

Status Codes

For details, see Status Codes.