Use ListCsr to query Certificate Signing Requests - Certificate Management Service

Queries the certificate signing requests (CSRs) in your account.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
KeyWord	string	No	The keyword for fuzzy search. For example, you can specify a domain name.	test_name
Algorithm	string	No	The algorithm. Valid values: RSA, ECC, and SM2. Valid values: RSA : RSA ECC : ECC SM2 : SM2	RSA
CurrentPage	integer	No	The page number. Default value: 1.	1
ShowSize	integer	No	The number of entries per page. Default value: 50.	10

Response elements

Element	Type	Description	Example
	object	The object.
ShowSize	integer	The number of entries per page. Default value: 50.	10
CurrentPage	integer	The page number.	1
TotalCount	integer	The total number of entries returned.	10
CsrList	array<object>	The CSRs.
	object
CsrId	integer	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

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.