Help Center/ API Gateway/ API Reference (Paris Region)/ Shared Gateway APIs/ Domain Name Management/ Querying Details of a Certificate Bound to a Domain Name
Updated on 2022-02-21 GMT+08:00

Querying Details of a Certificate Bound to a Domain Name

Function

This API is used to query the details of a specified certificate bound to a domain name.

URI

The following table lists the HTTP/HTTPS request method and URI of the API.

Table 1 HTTP/HTTPS request method and URI

Request Method

URI

GET

/v1.0/apigw/api-groups/{group_id}/domains/{domain_id}/certificate/{id}

The following table lists the parameters in the URI.

Table 2 Parameter description

Parameter

Mandatory

Type

Description

group_id

Yes

String

API group ID

domain_id

Yes

String

Domain ID

id

Yes

String

Certificate ID

Request

N/A

Response

Table 3 Parameter description

Parameter

Type

Description

common_name

String

Certificate domain name

san

Dictionary

Subject alternative name (SAN)

version

String

Certificate version

organization

Dictionary

Company or organization

organizational_unit

Dictionary

Department

locality

Dictionary

City

state

Dictionary

Province or state

country

Dictionary

Country or region

not_before

Timestamp

Start time of the certificate validity period

not_after

Timestamp

Expiration time of the certificate validity period

serial_number

String

SN

issuer

Dictionary

Certificate issuer

signature_algorithm

String

Signature algorithm

Example response:

{
    "san": [
        "xxx.xxx.xxx"
    ],
    "country": [
        "CN"
    ],
    "not_before": "2019-04-29T11:49:18Z",
    "locality": [
        "ShenZhen"
    ],
    "serial_number": "00000000000000000000000000",
    "version": 3,
    "issuer": [
        "XXX"
    ],
    "not_after": "2029-04-29T11:49:18Z",
    "organization": [
        "XXX"
    ],
    "signature_algorithm": "SHA256-RSA",
    "state": [
        "XXX"
    ],
    "common_name": "xxx.xxx.xxx",
    "organizational_unit": [
        "XXX"
    ]
}

Status Codes

Table 4 Status codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Internal Error