Querying SSL Certificates¶

Function¶

This API is used to query the SSL certificates.

Calling Method¶

For details, see Calling APIs.

URI¶

GET /v2/{project_id}/apigw/certificates

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain it, see Obtaining a Project ID.

**Table 2** Query Parameters¶
Parameter	Mandatory	Type	Description
offset	No	Long	Offset from which the query starts. If the value is less than 0, it is automatically converted to 0. Default: 0
limit	No	Integer	Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500. Minimum: 1 Maximum: 500 Default: 20
name	No	String	Certificate name.
common_name	No	String	Certificate domain name.
signature_algorithm	No	String	Certificate signature algorithm.
type	No	String	Certificate scope. Enumeration values: instance global
instance_id	Yes	String	ID of the gateway to which the certificate belongs.

Request Parameters¶

**Table 3** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

Response Parameters¶

Status code: 200

**Table 4** Response body parameters¶
Parameter	Type	Description
size	Integer	Length of the returned resource list.
total	Long	Number of resources that match the query conditions.
certs	Array of CertBase objects	Certificate basic content.

**Table 5** CertBase¶
Parameter	Type	Description
id	String	Certificate ID.
name	String	Certificate name.
type	String	Certificate type. global: Global certificate. instance: Gateway certificate. Enumeration values: global instance
instance_id	String	Gateway ID. If type is set to global, the default value is common. If type is set to instance, a gateway ID is displayed.
project_id	String	Project ID.
common_name	String	Domain name.
san	Array of strings	SAN domain name.
not_after	String	Expiration time.
signature_algorithm	String	Signature algorithm.
create_time	String	Creation time.
update_time	String	Update time.
is_has_trusted_root_ca	Boolean	Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate. Default: false

Status code: 400

**Table 6** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 401

**Table 7** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 8** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 9** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests¶

None

Example Responses¶

Status code: 200

{
  "total" : 1,
  "size" : 1,
  "certs" : [ {
    "id" : "a27be832f2e9441c8127fe48e3b5ac67",
    "name" : "cert_demo",
    "type" : "instance",
    "project_id" : "73d69ae0cfcf460190522d06b60f05ad",
    "instance_id" : "f0fa1789-3b76-433b-a787-9892951c620e",
    "common_name" : "apigtest.example.com",
    "san" : [ "apigtest.example.com", "*.san.com" ],
    "not_after" : "2021-04-26T09:03:30Z",
    "signature_algorithm" : "SHA256-RSA",
    "create_time" : "2021-08-26T07:27:06.304004Z",
    "update_time" : "2021-08-26T07:27:06.304004Z"
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:dict_name. Please refer to the support documentation"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Status code: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Status Codes¶

Status Code	Description
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
500	Internal Server Error

Error Codes¶

See Error Codes.

last updated: 2024-11-13 13:54 UTC - commit: 0a62e5dc1182b13184917e7aa490e164e6eb655a