ListUserCertificateOrder - Certificate Management Service

Queries the certificates or certificate orders of users.

Operation description

You can call the ListUserCertificateOrder operation to query the certificates or certificate orders of users. If you set OrderType to CERT or UPLOAD, certificates are returned. If you set OrderType to CPACK or BUY, certificate orders are returned.

Limits

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Keyword	string	No	The domain name that is bound or the ID of the resource. Fuzzy match is supported.	cert-instanceId
Status	string	No	The certificate status of the order. Valid values: PAYED: pending application. You can set Status to PAYED only if you set OrderType to CPACK or BUY. CHECKING: validating. You can set Status to CHECKING only if you set OrderType to CPACK or BUY. CHECKED_FAIL: validation failed. You can set Status to CHECKED_FAIL only if you set OrderType to CPACK or BUY. ISSUED: issued. WILLEXPIRED: about to expire. EXPIRED: expired. NOTACTIVATED: not activated. You can set Status to NOTACTIVATED only if you set OrderType to CPACK or BUY. REVOKED: revoked. You can set Status to REVOKED only if you set OrderType to CPACK or BUY. If you set OrderType to CERT or UPLOAD and Status is left empty, valid certificates are returned by default, including issued certificates and certificates that are about to expire. If you set OrderType to CPACK or BUY and Status is left empty, all orders are returned by default.	ISSUED
OrderType	string	No	The type of the order. Default value: CPACK. Valid values: CPACK: virtual resource order. If you set OrderType to CPACK, only the information about orders that are generated to consume the certificate quota is returned. BUY: purchase order. If you set OrderType to BUY, only the information about purchase orders is returned. In most cases, this type of order can be ignored. UPLOAD: uploaded certificate. If you set OrderType to UPLOAD, only uploaded certificates are returned. CERT: certificate. If you set OrderType to CERT, both issued certificates and uploaded certificates are returned.	CPACK
CurrentPage	long	No	The number of the page to return.	1
ShowSize	long	No	The number of entries to return on each page. Default value: 50.	10
ResourceGroupId	string	No	The ID of the resource group. You can call the ListResources operation to obtain the ID.	rg-ae******4wia

Response parameters

Parameter	Type	Description	Example
	object	The data returned.
ShowSize	long	The number of entries returned per page.	10
CurrentPage	long	The page number of the returned page.	1
TotalCount	long	The total number of entries returned.	1
CertificateOrderList	array<object>	The certificates and orders.
	object	The information about the certificate and order.
Algorithm	string	The algorithm. This parameter is returned only if OrderType is set to CPACK or BUY.	RSA
AliyunOrderId	long	The ID of the Alibaba Cloud order. This parameter is returned only if OrderType is set to CPACK or BUY.	234567
BuyDate	long	The time at which the order was placed. Unit: milliseconds. This parameter is returned only if OrderType is set to CPACK or BUY.	1634283958000
CertEndTime	long	The time at which the certificate expires. Unit: milliseconds. This parameter is returned only if OrderType is set to CPACK or BUY.	1665819958000
CertStartTime	long	The time at which the certificate starts to take effect. Unit: milliseconds. This parameter is returned only if OrderType is set to CPACK or BUY.	1665819958000
CertType	string	The type of the certificate. This parameter is returned only if OrderType is set to CPACK or BUY. Valid values: DV: domain validated (DV) certificate EV: extended validation (EV) certificate OV: organization validated (OV) certificate FREE: free certificate, available only on the China site (aliyun.com)	FREE
Domain	string	The domain name. This parameter is returned only if OrderType is set to CPACK or BUY.	aliyundoc.com
DomainCount	long	The total number of domain names that can be bound to the certificate. This parameter is returned only if OrderType is set to CPACK or BUY.	1
DomainType	string	The type of the domain name. This parameter is returned only if OrderType is set to CPACK or BUY. Valid values: ONE: single domain name MULTIPLE: multiple domain names WILDCARD: single wildcard domain name M_WILDCARD: multiple wildcard domain names MIX: hybrid domain name	ONE
InstanceId	string	The ID of the resource.	cas-instanceId
OrderId	long	The order ID. This parameter is returned only if OrderType is set to CPACK or BUY.	2345687
PartnerOrderId	string	The ID of the third-party certificate authority (CA) order. This parameter is returned only if OrderType is set to CPACK or BUY.	ca-123456
ProductCode	string	The specification ID of the order. This parameter is returned only if OrderType is set to CPACK or BUY.	bykj123456
ProductName	string	The specification name of the order. This parameter is returned only if OrderType is set to CPACK or BUY.	CFCA
RootBrand	string	The brand of the certificate. Valid values: WoSign, CFCA, DigiCert, and vTrus. This parameter is returned only if OrderType is set to CPACK or BUY.	CFCA
SourceType	string	The type of the order. This parameter is returned only if OrderType is set to CPACK or BUY. Valid values: cpack: virtual resource order buy: purchase order	buy
Status	string	The certificate status of the order. This parameter is returned only if OrderType is set to CPACK or BUY. Valid values: PAYED: pending application CHECKING: reviewing CHECKED_FAIL: review failed ISSUED: issued WILLEXPIRED: about to expire EXPIRED: expired NOTACTIVATED: not activated REVOKED: revoked	PAYED
TrusteeStatus	string	The hosting status of the certificate. This parameter is returned only if OrderType is set to CPACK or BUY. Valid values: unTrustee: not hosted trustee: hosted	unTrustee
WildDomainCount	long	The number of wildcard domain names that can be bound to the certificate. This parameter is returned only if OrderType is set to CPACK or BUY.	0
CertificateId	long	The ID of the certificate. This parameter is returned only if OrderType is set to CERT or UPLOAD.	896521
Name	string	The name of the certificate. This parameter is returned only if OrderType is set to CERT or UPLOAD.	cert-name
CommonName	string	The parent domain name of the certificate. This parameter is returned only if OrderType is set to CERT or UPLOAD.	aliyun.com
Fingerprint	string	The fingerprint of the certificate. This parameter is returned only if OrderType is set to CERT or UPLOAD.	CC6B3696E7C7CA715BD26E28E45FF3E3DF435C03
Sha2	string	The SHA-2 value of the certificate. This parameter is returned only if OrderType is set to CERT or UPLOAD.	56B4DED2243A81DD909D7C39824FFE4DDBD87F91BFA46CD333FF212FE0E7CB11
SerialNo	string	The serial number of the certificate. This parameter is returned only if OrderType is set to CERT or UPLOAD.	040a6e493cffdda6d744acf99b6576cf
Issuer	string	The issuer of the certificate. This parameter is returned only if 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 only if OrderType is set to CERT or UPLOAD.	Alibaba Cloud
Province	string	The province or autonomous region in which the organization is located. This parameter is returned only if OrderType is set to CERT or UPLOAD.	Zhejiang
City	string	The city in which the organization is located. This parameter is returned only if OrderType is set to CERT or UPLOAD.	Hangzhou
Country	string	The code of the country in which the organization is located. This parameter is returned only if OrderType is set to CERT or UPLOAD.	CN
Sans	string	All domain names that are bound to the certificate. Multiple domain names are separated by commas (,). This parameter is returned only if OrderType is set to CERT or UPLOAD.	aliyun.com
Expired	boolean	Indicates whether the certificate expires. This parameter is returned only if OrderType is set to CERT or UPLOAD.	true
Upload	boolean	Indicates whether the certificate is an uploaded certificate. This parameter is returned only if OrderType is set to CERT or UPLOAD.	false
StartDate	string	The time at which the certificate starts to take effect. This parameter is returned only if OrderType is set to CERT or UPLOAD.	2021-11-16
EndDate	string	The time at which the certificate expires. This parameter is returned only if OrderType is set to CERT or UPLOAD.	2022-11-17
ResourceGroupId	string	The ID of the resource group. This parameter is returned only if OrderType is set to CERT or UPLOAD.	rg-ae******4wia
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	15C66C7B-671A-4297-9187-2C4477247A74

Examples

Sample success responses

JSONformat

{
  "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": "Alibaba Cloud\n",
      "Province": "Zhejiang\n",
      "City": "Hangzhou\n",
      "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

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

Change history

Change time	Summary of changes	Operation

No change history