All Products
Search
Document Center

Certificate Management Service:ListCert

Last Updated:Jul 31, 2024

Queries the certificates in a certificate repository.

Operation description

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
KeyWordstringNo

The keyword for the query. You can enter a name, domain name, or Subject Alternative Name (SAN) extension. Fuzzy match is supported.

test_name
WarehouseIdlongNo

The ID of the certificate repository. You can call the ListCertWarehouse API operation to query the IDs of certificate repositories.

12
StatusstringNo

The status of the certificate. Valid values:

  • ISSUE: issued
  • REVOKE: revoked
ISSUE
SourceTypestringNo

The source of the certificate. Valid values:

  • upload: uploaded certificate
  • aliyun: Alibaba Cloud certificate
aliyun
CurrentPagelongNo

The number of the page to return. Default value: 1.

1
ShowSizelongNo

The number of entries to return on each page. Default value: 50.

50

Response parameters

ParameterTypeDescriptionExample
object

The object.

ShowSizelong

The number of entries returned per page. Default value: 50.

50
CurrentPagelong

The page number of the returned page. Default value: 1.

1
TotalCountlong

The total number of entries returned.

10
CertListarray<object>

An array that consists of the certificates.

object

The information about the certificate.

WhIdlong

The ID of the certificate repository.

2
Identifierstring

The unique identifier of the certificate.

14dcc8afc7578e
WhInstanceIdstring

The instance ID of the certificate repository.

test_whInstanceId
Statusstring

The status of the certificate. Valid values:

  • ISSUE: issued
  • REVOKE: revoked
ISSUE
SourceTypestring

The source of the certificate. Valid values:

  • upload: uploaded certificate
  • aliyun: Alibaba Cloud certificate
aliyun
CommonNamestring

The domain name.

aliyun.alibaba.com
BeforeDatelong

The issuance time of the certificate. The value is a UNIX timestamp. Unit: milliseconds.

1665819958000
Issuerstring

The issuer of the certificate.

mySSL
AfterDatelong

The expiration time of the certificate. The value is a UNIX timestamp. Unit: milliseconds.

1634283958000
ExistPrivateKeyboolean

Indicates whether the certificate contains a private key. Valid values:

  • true
  • false
false
Sansstring

The domain names that are bound to the certificate. Multiple domain names are separated by commas.

*.alibaba.com,aliyun.alibaba.com
RequestIdstring

The ID of the request.

15C66C7B-671A-4297-9187-2C4477247A74

Examples

Sample success responses

JSONformat

{
  "ShowSize": 50,
  "CurrentPage": 1,
  "TotalCount": 10,
  "CertList": [
    {
      "WhId": 2,
      "Identifier": "14dcc8afc7578e",
      "WhInstanceId": "test_whInstanceId",
      "Status": "ISSUE",
      "SourceType": "aliyun",
      "CertType": "CERT",
      "CommonName": "aliyun.alibaba.com",
      "BeforeDate": 1665819958000,
      "Issuer": "mySSL",
      "AfterDate": 1634283958000,
      "ExistPrivateKey": false,
      "Sans": "*.alibaba.com,aliyun.alibaba.com"
    }
  ],
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-12-19The request parameters of the API has changed. The response structure of the API has changedView Change Details