Call ListUserCertificateOrder to query certificates and orders - Certificate Management Service - Alibaba Cloud - Certificate Management Service

Queries the list of user certificates or orders.

Operation description

This operation is used to query the list of user certificates or orders. If OrderType is set to CERT or UPLOAD, the certificate list is queried. If OrderType is set to CPACK or BUY, the order list is queried.

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If this limit is exceeded, the API call is throttled, which may affect your business. Call this operation appropriately.

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	The keyword for fuzzy search. Matches the domain name or the corresponding resource ID.	cert-instanceId
Status	string	No	The order status. Valid values: PAYED: Pending application. Valid when OrderType is set to CPACK or BUY. CHECKING: Under review. Valid when OrderType is set to CPACK or BUY. CHECKED_FAIL: Review failed. Valid when OrderType is set to CPACK or BUY. ISSUED: Issued. WILLEXPIRED: About to expire. EXPIRED: Expired. NOTACTIVATED: Not activated. Valid when OrderType is set to CPACK or BUY. REVOKED: Revoked. Valid when OrderType is set to CPACK or BUY. If OrderType is set to CERT or UPLOAD and Status is empty, valid certificates are returned by default, including issued and about-to-expire certificates. If OrderType is set to CPACK or BUY and Status is empty, all orders are returned by default.	ISSUED
OrderType	string	No	The resource type. Default value: CPACK. Valid values: CPACK: resource virtual order. Only orders generated from quotas are returned. BUY: purchase order. Only orders generated from purchases are returned. You can ignore this type in most cases. UPLOAD: uploaded certificate. Only uploaded certificates are returned. CERT: certificate. Both issued certificates and uploaded certificates are returned.	CPACK
CurrentPage	integer	No	The page number of the current page in a paginated query.	1
ShowSize	integer	No	The number of entries per page in a paginated query. Default value: 50.	10
ResourceGroupId	string	No	The resource group ID. You can obtain this ID by calling the ListResources operation.	rg-ae******4wia

Response elements

Element	Type	Description	Example
	object	The response for the certificate and order list query.
ShowSize	integer	The number of entries per page.	10
CurrentPage	integer	The number of entries per page.	1
TotalCount	integer	The total number of entries returned.	1
CertificateOrderList	array<object>	The certificate and order list.	{"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 certificate and order information.
Algorithm	string	The algorithm. Returned when OrderType is set to CPACK or BUY.	RSA
AliyunOrderId	integer	The Alibaba Cloud order ID. Returned when OrderType is set to CPACK or BUY.	234567
BuyDate	integer	The purchase time. Unit: milliseconds. Returned when OrderType is set to CPACK or BUY.	1634283958000
CertEndTime	integer	The certificate expiration time. Unit: milliseconds. Returned when OrderType is set to CPACK or BUY.	1665819958000
CertStartTime	integer	The certificate start time. Unit: milliseconds. Returned when OrderType is set to CPACK or BUY.	1665819958000
CertType	string	The certificate type. Returned when OrderType is set to CPACK or BUY. Valid values: DV: DV certificate. EV: EV certificate. OV: OV certificate. FREE: personal test certificate (supported only on the China site).	FREE
Domain	string	The domain name. Returned when OrderType is set to CPACK or BUY.	aliyundoc.com
DomainCount	integer	The total number of purchased domain names. Returned when OrderType is set to CPACK or BUY.	1
DomainType	string	The domain name type. Returned when 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 names.	ONE
InstanceId	string	The resource ID.	cas-instanceId
OrderId	integer	The order ID. Returned when OrderType is set to CPACK or BUY.	2345687
PartnerOrderId	string	The third-party CA order ID. Returned when OrderType is set to CPACK or BUY.	ca-123456
ProductCode	string	The order specification ID. Returned when OrderType is set to CPACK or BUY.	bykj123456
ProductName	string	The order specification name. Returned when OrderType is set to CPACK or BUY.	CFCA
RootBrand	string	The brand (such as WoSign, CFCA, DigiCert, and vTrus). Returned when OrderType is set to CPACK or BUY.	CFCA
SourceType	string	The order type. Returned when OrderType is set to CPACK or BUY. Valid values: cpack: resource virtual order. buy: purchase order.	buy
Status	string	The order or certificate status. Returned when OrderType is set to CPACK or BUY. Valid values: PAYED: Pending application. CHECKING: Under review. CHECKED_FAIL: Review failed. ISSUED: Issued. WILLEXPIRED: About to expire. EXPIRED: Expired. NOTACTIVATED: Not activated. REVOKED: Revoked.	PAYED
TrusteeStatus	string	The hosting status. Returned when OrderType is set to CPACK or BUY. Valid values: unTrustee: Not hosted. trustee: Hosted.	unTrustee
WildDomainCount	integer	The number of purchased wildcard domain names. Returned when OrderType is set to CPACK or BUY.	0
CertificateId	integer	The certificate ID. Returned when OrderType is set to CERT or UPLOAD.	896521
Name	string	The certificate name. Returned when OrderType is set to CERT or UPLOAD.	cert-name
CommonName	string	The common name of the certificate. Returned when OrderType is set to CERT or UPLOAD.	aliyun.com
Fingerprint	string	The certificate fingerprint. Returned when OrderType is set to CERT or UPLOAD.	CC6B3696E7C7CA715BD26E28E45FF3E3DF435C03
Sha2	string	The SHA-2 value of the certificate. Returned when OrderType is set to CERT or UPLOAD.	56B4DED2243A81DD909D7C39824FFE4DDBD87F91BFA46CD333FF212FE0E7CB11
SerialNo	string	The certificate serial number. Returned when OrderType is set to CERT or UPLOAD.	040a6e493cffdda6d744acf99b6576cf
Issuer	string	The certificate issuer. Returned when OrderType is set to CERT or UPLOAD.	MyIssuer
OrgName	string	The organization name of the certificate. Returned when OrderType is set to CERT or UPLOAD.	阿里云
Province	string	The province or autonomous region. Returned when OrderType is set to CERT or UPLOAD.	浙江省
City	string	The city. Returned when OrderType is set to CERT or UPLOAD.	杭州市
Country	string	The country code. Returned when OrderType is set to CERT or UPLOAD.	CN
Sans	string	All domain names bound to the certificate. Multiple domain names are separated by commas (,). Returned when OrderType is set to CERT or UPLOAD.	aliyun.com
Expired	boolean	Indicates whether the certificate has expired. Returned when OrderType is set to CERT or UPLOAD.	true
Upload	boolean	Indicates whether the certificate is an uploaded certificate. Returned when OrderType is set to CERT or UPLOAD.	false
StartDate	string	The certificate start date. Returned when OrderType is set to CERT or UPLOAD. The date is in the YYYY-MM-DD format.	2021-11-16
EndDate	string	The certificate end date. Returned when OrderType is set to CERT or UPLOAD. The date is in the YYYY-MM-DD format.	2022-11-17
ResourceGroupId	string	The resource group ID. Returned when OrderType is set to CERT or UPLOAD.	rg-ae******4wia
RequestId	string	The request ID. Alibaba Cloud generates a unique identifier for 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.