Querying a Certificate

Description

This API is used to query the certificate status, including the certificate validity period, certificate alarms, and whether a CRL has been imported.

URL

GET https://ip:port/AIVAULT/v1/certStatus

Request Header

Table 1 Request header

Parameter

Type

Description

DomainID

UInt

Key domain ID, which indicates the domain of an organization, an application, or a model. The value ranges from 1 to 500.

  1. Parameters in this request header are set by users.
  2. Domain IDs are used to differentiate applications or models. A maximum of 500 domains are supported.

Request Parameters

None

Request Example

https://ip:port/AIVAULT/v1/certStatus

Response Description

Table 2 Responses

Level-1 Parameter

Level-2 Parameter

Type

Description

status

\

String

Error code

msg

\

String

Error message

data

\

Object

Returned packet

\

CertType

Enum

Certificate type, which is related to the service plane.

\

CertValidDate

String

Certificate validity period

\

CertAlarm

String

Certificate alarm, including an expiration warning and an alarm indicating whether the certificate has expired.

\

CrlStatus

String

Status of the CRL certificate, including whether the CRL certificate has been imported.

Response Example

{
    "status": "00000000",
    "msg": "ok",
    "data": [
        {
            "CertType": "MGMT",
            "CertValidDate": "2022/6/8-2023/6/8",
            "CertAlarm": "",
            "CrlStatus": "No CRL certificate has been imported."
        },
        {
            "CertType": "SVC",
            "CertValidDate": "-",
            "CertAlarm": "No certificate",
            "CrlStatus": "No CRL certificate has been imported."
        }
    ]
}

For details about the error codes, see Error Codes.

For details about the status codes, see Status Codes.