ListClientCertificate

Updated at:

Queries the details of all client certificates and server certificates.

Operation description

This operation performs a paged query to retrieve the details of all client certificates and server certificates that you have created, such as the unique identifier, serial number, subject information, content, and status of the certificates.

QPS limit

The queries per second (QPS) limit per user is 10. If the limit is exceeded, API calls are throttled, which may affect your services. Call the API at a reasonable frequency.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-cert:ListClientCertificate

list

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

CurrentPage

integer

No

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

1

ShowSize

integer

No

The number of certificates to display on each page. Default value: 20.

20

Identifier

string

No

The unique identifier of the client certificate or server certificate that you want to query.

Note

You can call the ListClientCertificate operation to query the unique identifiers of all client certificates and server certificates.

160ae6bb538d538c70c01f81dcf2****

ResourceGroupId

string

No

The ID of the resource group. You can call the ListResources operation to obtain the ID.

rg-ae******4wia

When you call this operation, you must include the common request parameters of Alibaba Cloud APIs in addition to the operation-specific request parameters.

For more information about the request format, see the request example in the Examples section.

Response elements

Element

Type

Description

Example

object

ListCertificateResponse2

CertificateList

array<object>

The list of details about client certificates or server certificates.

object

The object.

X509Certificate

string

The content of the certificate.

-----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE-----

Identifier

string

The unique identifier of the certificate.

d3b95700998e47afc4d95f886579****

SerialNumber

string

The serial number of the certificate.

62b2b943a32d96883a6650e672ea0276****

SubjectDN

string

The distinguished name (DN) attribute of the certificate, which indicates the subject of the certificate. The attribute includes the following information:

  • C: the country.

  • O: the organization.

  • OU: the organizational unit.

  • L: the locality.

  • ST: the province, municipality, or autonomous region.

  • CN: the common name.

C=CN,O=Alibaba Cloud Computing Co., Ltd.,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun

CommonName

string

The common name of the certificate.

aliyundoc.com

OrganizationUnit

string

The name of the department under the organization associated with the intermediate CA certificate that issued the certificate.

Security

Organization

string

The name of the organization associated with the intermediate CA certificate that issued the certificate.

Alibaba Cloud Computing Co., Ltd

Locality

string

The name of the city where the organization associated with the intermediate CA certificate that issued the certificate is located.

Hangzhou

State

string

The name of the province, municipality, or autonomous region where the organization associated with the intermediate CA certificate that issued the certificate is located.

Zhejiang

CountryCode

string

The country code of the organization associated with the intermediate CA certificate that issued the certificate.

For more information about country codes, see the Country code section in Manage company information.

CN

Sans

string

The Subject Alternative Name (SAN) extension attribute of the certificate, which indicates other domain names and IP addresses associated with the certificate.

This parameter is represented as a string converted from a JSON array. Each element in the JSON array is a struct that corresponds to a SAN extension. Each SAN extension struct includes the following parameters:

  • Type: the type of the extension. This parameter is of the INTEGER type. Valid values:
    • 1: email address

    • 2: domain name

    • 6: Uniform Resource Identifier (URI)

    • 7: IP address

  • Value: the content of the extension. This parameter is of the STRING type.

[ {"Type": 7, "Value": "192.0.XX.XX"}, {"Type": 2, "Value": "www.aliyundoc.com"}, ]

Status

string

The status of the certificate. Valid values:

  • ISSUE: The certificate is issued.

  • REVOKE: The certificate is revoked.

ISSUE

BeforeDate

integer

The issuance date of the certificate. The value is a timestamp in milliseconds.

1634283958000

AfterDate

integer

The expiration date of the certificate. The value is a timestamp in milliseconds.

1665819958000

Algorithm

string

The type of the encryption algorithm used for the certificate. Valid values:

  • RSA: RSA algorithm

  • ECC: ECC algorithm

  • SM2: SM2 algorithm

RSA

KeySize

integer

The key length of the certificate.

4096

SignAlgorithm

string

The signature algorithm of the certificate.

SHA256WITHRSA

CertificateType

string

The type of the certificate. Valid values:

  • CLIENT: client certificate

  • SERVER: server certificate

SERVER

ParentIdentifier

string

The unique identifier of the intermediate CA certificate that issued the certificate.

160ae6bb538d538c70c01f81dcf2****

Sha2

string

The SHA-256 fingerprint of the certificate.

14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****

Md5

string

The MD5 fingerprint of the certificate.

d3b95700998e47afc4d95f886579****

Days

integer

The validity period of the certificate. Unit: days.

365

ResourceGroupId

string

The ID of the resource group to which the certificate belongs.

rg-acfmyxa2uv6cu5a

CustomIdentifier

string

The custom identifier, which is a unique key.

****48d8d3ecc9976d9ecd2b2f25****

Id

integer

The primary key ID of the certificate.

12321

AliasName

string

The name set for the issued certificate.

Production training 10.153.13.177

CurrentPage

integer

The page number of the current page.

1

PageCount

integer

The total number of pages.

1

ShowSize

integer

The number of certificates returned per page.

20

TotalCount

integer

The total number of client certificates and server certificates queried.

1

RequestId

string

The ID of the request.

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

MaxResults

integer

The maximum number of results returned for a paginated query.

20

Examples

Success response

JSON format

{
  "CertificateList": [
    {
      "X509Certificate": "-----BEGIN CERTIFICATE-----  ...... -----END CERTIFICATE-----",
      "Identifier": "d3b95700998e47afc4d95f886579****",
      "SerialNumber": "62b2b943a32d96883a6650e672ea0276****",
      "SubjectDN": "C=CN,O=阿里云计算有限公司,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun",
      "CommonName": "aliyundoc.com",
      "OrganizationUnit": "Security",
      "Organization": "阿里云计算有限公司",
      "Locality": "Hangzhou",
      "State": "Zhejiang",
      "CountryCode": "CN",
      "Sans": "[ {\"Type\": 7, \"Value\": \"192.0.XX.XX\"}, {\"Type\": 2, \"Value\": \"www.aliyundoc.com\"}, ]",
      "Status": "ISSUE",
      "BeforeDate": 1634283958000,
      "AfterDate": 1665819958000,
      "Algorithm": "RSA",
      "KeySize": 4096,
      "SignAlgorithm": "SHA256WITHRSA",
      "CertificateType": "SERVER",
      "ParentIdentifier": "160ae6bb538d538c70c01f81dcf2****",
      "Sha2": "14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****",
      "Md5": "d3b95700998e47afc4d95f886579****",
      "Days": 365,
      "ResourceGroupId": "rg-acfmyxa2uv6cu5a",
      "CustomIdentifier": "****48d8d3ecc9976d9ecd2b2f25****",
      "Id": 12321,
      "AliasName": "生产培训10.153.13.177"
    }
  ],
  "CurrentPage": 1,
  "PageCount": 1,
  "ShowSize": 20,
  "TotalCount": 1,
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74",
  "MaxResults": 20
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.