ListRevokeCertificate - Certificate Management Service - Alibaba Cloud Documentation Center

Queries the details of all revoked client and server-side certificates.

Operation description

Performs a paged query to retrieve the details of all revoked client and server-side certificates, such as the unique identifier, serial number, and revocation date.

QPS limit

The queries per second (QPS) limit for this API is 10 for each user. If you exceed this limit, API calls are throttled, which may affect your business. We recommend that you call this API at a reasonable rate.

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:ListRevokeCertificate

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CurrentPage	integer	No	The page number of the results to return. Default value: 1.	1
ShowSize	integer	No	The number of revoked certificates to return on each page. Default value: 20.	20

When you call this API operation, you must include the common request parameters. For more information about the request format, see the request example in the Examples section of this topic.

For an example of the request format, see the Examples section of this topic.

Response elements

Element	Type	Description	Example
	object	A ListCertificateResponse2 object that contains a list of RevokedCertificateDTO objects.
CertificateList	array<object>	The details of the revoked client or server-side certificates.
	object	An object that represents a certificate.
RevokeDate	string	The date when the certificate was revoked. The format is `yyyy-MM-ddT00:00Z`. For example, `2021-09-01T00:00Z` indicates September 1, 2021.	2021-09-01T00:00Z
Identifier	string	The unique identifier of the certificate.	05e148d8d3ecc9976d9ecd2b2f25****
SerialNumber	string	The serial number of the certificate.	168b12c42e62339f8d2340ff530f9365****
SubjectDN	string	The Distinguished Name (DN) of the certificate. The DN indicates the user of the certificate and contains the following information: C: The country. O: The organization. OU: The department. CN: The common name. ST: The province or state. CN: The common name.	C=CN,O=阿里云计算有限公司,OU=Security,L=ZheJiang,ST=HangZhou,CN=aliyundoc.com
CommonName	string	The common name of the certificate.	aliyundoc.com
OrganizationUnit	string	The name of the department of the organization that is associated with the subordinate CA certificate that issued the certificate.	Security
Organization	string	The name of the organization that is associated with the subordinate CA certificate that issued the certificate.	阿里云计算有限公司
Locality	string	The name of the city where the organization of the subordinate CA certificate that issued the certificate is located.	Hangzhou
State	string	The name of the province or state of the organization that is associated with the subordinate CA certificate that issued the certificate.	Zhejiang
CountryCode	string	The country code of the organization that is associated with the subordinate CA certificate that issued the certificate. For more information about country codes, see the "Country codes" section in Manage company information.	CN
Sans	string	The Subject Alternative Name (SAN) extension of the certificate. This parameter is a string that is converted from a JSON array. Each element in the JSON array is a struct that corresponds to a SAN extension. Each SAN extension struct contains the following parameters: Type: The type of the extension. This parameter is of the integer type. Valid values: 1: an email address. 2: a domain name. 6: a Uniform Resource Identifier (URI). 7: an 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.	ISSUE
BeforeDate	string	The date when the certificate was issued. The format is `yyyy-MM-ddT00:00Z`. For example, `2021-01-01T00:00Z` indicates January 1, 2021.	2021-01-01T00:00Z
AfterDate	string	The expiration date of the certificate. The format is `yyyy-MM-ddT00:00Z`. For example, `2021-12-31T00:00Z` indicates December 31, 2021.	2021-12-31T00:00Z
Algorithm	string	The type of the encryption algorithm of the certificate. Valid values: RSA: the RSA algorithm. ECC: the ECC algorithm. SM2: the 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.	SERVER
ParentIdentifier	string	The identifier of the parent certificate.	160ae6bb538d538c70c01f81dcf2****
Sha2	string	The SHA-256 fingerprint of the certificate.	b60eff7e04323ff662f9ab5e6986f849f626a9c7bf2c59dcc752fa23779a****
Md5	string	The MD5 fingerprint of the certificate.	05e148d8d3ecc9976d9ecd2b2f25****
CustomIdentifier	string	The custom identifier. This is a unique key.
CurrentPage	integer	The page number of the current page.	1
PageCount	integer	The total number of pages returned.	1
ShowSize	integer	The number of revoked certificates on each page.	20
TotalCount	integer	The total number of revoked client and server-side certificates.	1
RequestId	string	The ID of the request.	15C66C7B-671A-4297-9187-2C4477247A74

Examples

Success response

JSON format

{
  "CertificateList": [
    {
      "RevokeDate": "2021-09-01T00:00Z",
      "Identifier": "05e148d8d3ecc9976d9ecd2b2f25****",
      "SerialNumber": "168b12c42e62339f8d2340ff530f9365****",
      "SubjectDN": "C=CN,O=阿里云计算有限公司,OU=Security,L=ZheJiang,ST=HangZhou,CN=aliyundoc.com",
      "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": "2021-01-01T00:00Z",
      "AfterDate": "2021-12-31T00:00Z",
      "Algorithm": "RSA",
      "KeySize": 4096,
      "SignAlgorithm": "SHA256WITHRSA",
      "CertificateType": "SERVER",
      "ParentIdentifier": "160ae6bb538d538c70c01f81dcf2****",
      "Sha2": "b60eff7e04323ff662f9ab5e6986f849f626a9c7bf2c59dcc752fa23779a****",
      "Md5": "05e148d8d3ecc9976d9ecd2b2f25****",
      "CustomIdentifier": ""
    }
  ],
  "CurrentPage": 1,
  "PageCount": 1,
  "ShowSize": 20,
  "TotalCount": 1,
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.