ListUserCertificateOrder - Certificate Management Service

Queries a list of your certificates or orders.

Operation description

This operation queries a list of your certificates or orders. Set OrderType to CERT or UPLOAD to query certificates. Set OrderType to CPACK or BUY to query orders.

QPS limit

The queries per second (QPS) limit for a single user is 10 calls per second. If you exceed this limit, API calls are throttled, which may affect your business. Plan your calls accordingly.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Keyword	string	No	Performs a fuzzy query. The keyword can be a domain name or a resource ID.	cert-instanceId
Status	string	No	The status of the order. Valid values: PAYED: The certificate is pending application. This value is valid only when OrderType is set to CPACK or BUY. CHECKING: The certificate is under review. This value is valid only when OrderType is set to CPACK or BUY. CHECKED_FAIL: The review failed. This value is valid only when OrderType is set to CPACK or BUY. ISSUED: The certificate is issued. WILLEXPIRED: The certificate is about to expire. EXPIRED: The certificate has expired. NOTACTIVATED: The certificate is not activated. This value is valid only when OrderType is set to CPACK or BUY. REVOKED: The certificate is revoked. This value is valid only when OrderType is set to CPACK or BUY. If OrderType is CERT or UPLOAD and you leave this parameter empty, active certificates are returned by default. Active certificates are those in the ISSUED or WILLEXPIRED state. If OrderType is CPACK or BUY and you leave this parameter empty, all orders are returned by default.	ISSUED
OrderType	string	No	The resource type. Default value: CPACK. Valid values: CPACK: An order for a resource plan. Only orders created from a resource plan are returned. BUY: A direct purchase. Only orders created from direct purchases are returned. You can ignore this type in most cases. UPLOAD: An uploaded certificate. Only uploaded certificates are returned. CERT: A certificate. Both issued and uploaded certificates are returned.	CPACK
CurrentPage	integer	No	The page number.	1
ShowSize	integer	No	The number of entries to return on each page. Default value: 50.	10
ResourceGroupId	string	No	The ID of the resource group. For more information, see ListResources.	rg-ae******4wia

Response elements

Element	Type	Description	Example
	object	The list of certificates and orders.
ShowSize	integer	The number of entries on the current page.	10
CurrentPage	integer	The page number.	1
TotalCount	integer	The total number of entries.	1
CertificateOrderList	array<object>	The list of certificates and orders.	{"CertificateOrderList": [{"Status": "PAYED","ProductName": "专业版通配符 OV SSL","InstanceId": "cert-instanceId","ProductCode": "globalsign-xxxx","SourceType": "buy","WildDomainCount": 1,"CertType": "OV","PartnerOrderId": "","OrderId": 3451111,"Algorithm": "RSA","RootBrand": "GlobalSign","AliyunOrderId": 21xxxxxx40655,"DomainType": "WILDCARD","TrusteeStatus": "trustee","Domain": "","BuyDate": 1632649385000,"DomainCount": 1}]}
	object	The details of the certificate or order.
Algorithm	string	The algorithm. This parameter is returned when OrderType is set to CPACK or BUY.	RSA
AliyunOrderId	integer	The ID of the Alibaba Cloud order. This parameter is returned when OrderType is set to CPACK or BUY.	234567
BuyDate	integer	The purchase time. The value is a UNIX timestamp. Unit: milliseconds. This parameter is returned when OrderType is set to CPACK or BUY.	1634283958000
CertEndTime	integer	The expiration time of the certificate. The value is a UNIX timestamp. Unit: milliseconds. This parameter is returned when OrderType is set to CPACK or BUY.	1665819958000
CertStartTime	integer	The start time of the certificate. The value is a UNIX timestamp. Unit: milliseconds. This parameter is returned when OrderType is set to CPACK or BUY.	1665819958000
CertType	string	The certificate type. This parameter is returned when OrderType is set to CPACK or BUY. Valid values: DV: A DV certificate. EV: An EV certificate. OV: An OV certificate. FREE: A free certificate for personal trial. This value is supported only on the Alibaba Cloud China website (www.aliyun.com).	FREE
Domain	string	The domain name. This parameter is returned when OrderType is set to CPACK or BUY.	aliyundoc.com
DomainCount	integer	The number of domain names that you purchased. This parameter is returned when OrderType is set to CPACK or BUY.	1
DomainType	string	The domain name type. This parameter is returned when OrderType is set to CPACK or BUY. Valid values: ONE: A single domain name. MULTIPLE: Multiple domain names. WILDCARD: A single wildcard domain name. M_WILDCARD: Multiple wildcard domain names. MIX: A hybrid domain name.	ONE
InstanceId	string	The resource ID.	cas-instanceId
OrderId	integer	The order ID. This parameter is returned when OrderType is set to CPACK or BUY.	2345687
PartnerOrderId	string	The ID of the third-party certificate authority (CA) order. This parameter is returned when OrderType is set to CPACK or BUY.	ca-123456
ProductCode	string	The code for the product specifications. This parameter is returned when OrderType is set to CPACK or BUY.	bykj123456
ProductName	string	The name of the product specifications. This parameter is returned when OrderType is set to CPACK or BUY.	CFCA
RootBrand	string	The brand, such as WoSign, CFCA, DigiCert, and vTrus. This parameter is returned when OrderType is set to CPACK or BUY.	CFCA
SourceType	string	The order type. This parameter is returned when OrderType is set to CPACK or BUY. cpack: An order for a resource plan. buy: A direct purchase.	buy
Status	string	The status of the order or certificate. This parameter is returned when OrderType is set to CPACK or BUY. PAYED: The certificate is pending application. CHECKING: The certificate is under review. CHECKED_FAIL: The review failed. ISSUED: The certificate is issued. WILLEXPIRED: The certificate is about to expire. EXPIRED: The certificate has expired. NOTACTIVATED: The certificate is not activated. REVOKED: The certificate is revoked.	PAYED
TrusteeStatus	string	The hosting status. This parameter is returned when OrderType is set to CPACK or BUY. unTrustee: Not hosted. trustee: Hosted.	unTrustee
WildDomainCount	integer	The number of wildcard domain names that you purchased. This parameter is returned when OrderType is set to CPACK or BUY.	0
CertificateId	integer	The certificate ID. This parameter is returned when OrderType is set to CERT or UPLOAD.	896521
Name	string	The certificate name. This parameter is returned when OrderType is set to CERT or UPLOAD.	cert-name
CommonName	string	The primary domain name of the certificate. This parameter is returned when OrderType is set to CERT or UPLOAD.	aliyun.com
Fingerprint	string	The certificate fingerprint. This parameter is returned when OrderType is set to CERT or UPLOAD.	CC6B3696E7C7CA715BD26E28E45FF3E3DF435C03
Sha2	string	The SHA-2 value of the certificate. This parameter is returned when OrderType is set to CERT or UPLOAD.	56B4DED2243A81DD909D7C39824FFE4DDBD87F91BFA46CD333FF212FE0E7CB11
SerialNo	string	The certificate serial number. This parameter is returned when OrderType is set to CERT or UPLOAD.	040a6e493cffdda6d744acf99b6576cf
Issuer	string	The issuer of the certificate. This parameter is returned when OrderType is set to CERT or UPLOAD.	MyIssuer
OrgName	string	The name of the organization that is associated with the certificate. This parameter is returned when OrderType is set to CERT or UPLOAD.	阿里云
Province	string	The province or autonomous region. This parameter is returned when OrderType is set to CERT or UPLOAD.	浙江省
City	string	The city. This parameter is returned when OrderType is set to CERT or UPLOAD.	杭州市
Country	string	The country code. This parameter is returned when OrderType is set to CERT or UPLOAD.	CN
Sans	string	The domain names that are bound to the certificate. Multiple domain names are separated by commas (,). This parameter is returned when OrderType is set to CERT or UPLOAD.	aliyun.com
Expired	boolean	Indicates whether the certificate has expired. This parameter is returned when OrderType is set to CERT or UPLOAD.	true
Upload	boolean	Indicates whether the certificate is an uploaded certificate. This parameter is returned when OrderType is set to CERT or UPLOAD.	false
StartDate	string	The start date of the certificate. This parameter is returned when OrderType is set to CERT or UPLOAD.	2021-11-16
EndDate	string	The end date of the certificate. This parameter is returned when OrderType is set to CERT or UPLOAD.	2022-11-17
ResourceGroupId	string	The ID of the resource group. This parameter is returned when OrderType is set to CERT or UPLOAD.	rg-ae******4wia
RequestId	string	The request ID. This ID is unique to each request. You can use this ID to troubleshoot issues.	15C66C7B-671A-4297-9187-2C4477247A74

Examples

Success response

JSON format

{
  "ShowSize": 10,
  "CurrentPage": 1,
  "TotalCount": 1,
  "CertificateOrderList": [
    {
      "Algorithm": "RSA",
      "AliyunOrderId": 234567,
      "BuyDate": 1634283958000,
      "CertEndTime": 1665819958000,
      "CertStartTime": 1665819958000,
      "CertType": "FREE",
      "Domain": "aliyundoc.com",
      "DomainCount": 1,
      "DomainType": "ONE",
      "InstanceId": "cas-instanceId",
      "OrderId": 2345687,
      "PartnerOrderId": "ca-123456",
      "ProductCode": "bykj123456",
      "ProductName": "CFCA",
      "RootBrand": "CFCA",
      "SourceType": "buy",
      "Status": "PAYED",
      "TrusteeStatus": "unTrustee",
      "WildDomainCount": 0,
      "CertificateId": 896521,
      "Name": "cert-name",
      "CommonName": "aliyun.com",
      "Fingerprint": "CC6B3696E7C7CA715BD26E28E45FF3E3DF435C03",
      "Sha2": "56B4DED2243A81DD909D7C39824FFE4DDBD87F91BFA46CD333FF212FE0E7CB11",
      "SerialNo": "040a6e493cffdda6d744acf99b6576cf",
      "Issuer": "MyIssuer",
      "OrgName": "阿里云",
      "Province": "浙江省",
      "City": "杭州市",
      "Country": "CN",
      "Sans": "aliyun.com",
      "Expired": true,
      "Upload": false,
      "StartDate": "2021-11-16",
      "EndDate": "2022-11-17",
      "ResourceGroupId": "rg-ae******4wia"
    }
  ],
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.