Help Center/ Virtual Private Network/ API Reference/ API/ P2C VPN APIs/ Server/ Querying a Client CA Certificate

Updated on 2024-12-03 GMT+08:00

View PDF

Querying a Client CA Certificate

Function

This API is used to query a client CA certificate with a specified ID.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/client-ca-certificates/{client_ca_certificate_id}

**Table 1** Parameter description
Parameter	Type	Mandatory	Description
project_id	String	Yes	Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID.
vpn_server_id	String	Yes	Specifies the ID of a VPN server.
client_ca_certificate_id	String	Yes	Specifies the ID of a client CA certificate.

Request

Request parameters
None

Example request

GET https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/client-ca-certificates/{client_ca_certificate_id}

Response

Response parameters

Returned status code 200: successful query

**Table 2** Parameters in the response body
Parameter	Type	Description
client_ca_certificate	QueryClientCaCertificateBody object	Specifies the client CA certificate object.
request_id	string	Specifies a request ID.

**Table 3** 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:ssZ.
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:ssZ.
updated_at	String	Specifies the last update time. The UTC time format is yyyy-MM-ddTHH:mm:ssZ.

Example response

{
    "client_ca_certificate": {
        "id": "ab80b8f6-6d67-4bdb-ba39-e8dd9419e64e",
        "name": "ca-cert-55f7",
        "issuer": "CN=xxx",
        "subject": "CN=xxx",
        "serial_number": "218730615113252363388323617489459159151767515623",
        "expiration_time": "2033-10-17T06:21:25Z",
        "signature_algorithm": "SHA256WITHRSA",
        "created_at": "2024-06-17T02:46:22.327Z",
        "updated_at": "2024-06-17T02:46:22.327Z"
    },
    "request_id": "29d83bb1-5349-4af5-9fa6-672af3daf4d1"
}