ListCsr - Certificate Management Service - Alibaba Cloud Documentation Center

Queries certificate signing requests (CSRs).

Debugging

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

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-cert:ListCsr	list	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
KeyWord	string	No	The keyword.	test_name
Algorithm	string	No	The algorithm. Valid values: RSA, ECC, and SM2.	RSA
CurrentPage	long	No	The page number.	1
ShowSize	long	No	The number of entries per page. Default value: 50.	10

Response parameters

Parameter	Type	Description	Example
	object	The object.
ShowSize	long	The number of entries per page. Default value: 50.	10
CurrentPage	long	The page number.	1
TotalCount	long	The total number of entries returned.	10
CsrList	array<object>	The CSRs.
	object
CsrId	long	The ID of the CSR.	3454
Algorithm	string	The algorithm. Valid values: RSA, SM2, and ECC.	RSA
KeySize	integer	The key length that is used by the algorithm. The key length for RSA algorithms can be 2,048, 3,072, and 4,096 bits. The key length for ECC and SM2 algorithms can be 256 bits.	2048
KeySha2	string	The public key that is calculated by using the SHA256 algorithm.	1234
CommonName	string	The primary domain name, which is a common name.	example.com
Sans	string	The secondary domain names. Separate multiple domain names with commas (,).	www.example.com,www.aliyundoc.com
CountryCode	string	The code of the country or region in which the organization is located. For example, you can use CN to indicate China and use US to indicate the United States. The default value is the code of the country or region in which the organization is located. The organization is associated with the intermediate CA certificate from which the certificate is issued. For more information about country codes, see the "Country codes" section of the Manage company profiles topic.	CN
Province	string	The province or location.	Beijing
Locality	string	The city where the company is located.	Beijing
CorpName	string	The name of the company.	corp_name
Department	string	The department that uses the certificate.	IT
HasPrivateKey	boolean	Indicates whether the certificate contains a private key.	true
Name	string	The name of the CSR.	name
RequestId	string	The request ID.	E865F6AD-0294-4A24-A58B-DAC6BE2BDD20

Examples

Sample success responses

JSONformat

{
  "ShowSize": 10,
  "CurrentPage": 1,
  "TotalCount": 10,
  "CsrList": [
    {
      "CsrId": 3454,
      "Algorithm": "RSA",
      "KeySize": 2048,
      "KeySha2": "1234",
      "CommonName": "example.com",
      "Sans": "www.example.com,www.aliyundoc.com",
      "CountryCode": "CN",
      "Province": "Beijing",
      "Locality": "Beijing",
      "CorpName": "corp_name",
      "Department": "IT",
      "HasPrivateKey": true,
      "Name": "name"
    }
  ],
  "RequestId": "E865F6AD-0294-4A24-A58B-DAC6BE2BDD20"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-09-20	API Description Update	View Change Details