Query certificate quota and usage with DescribePackageState - Certificate Management Service

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProductCode	string	No	The specifications of the certificate resource plan. Valid values: digicert-free-1-free (default): DigiCert single-domain domain validated (DV) certificate in a three-month free trial, available only on the China site (aliyun.com). symantec-free-1-free: DigiCert single-domain DV certificate in a one-year free trial, available only on the China site (aliyun.com). symantec-dv-1-starter: DigiCert wildcard DV certificate. symantec-ov-1-personal: DigiCert single-domain organization validated (OV) certificate. symantec-ov-w-personal: DigiCert wildcard OV certificate. geotrust-dv-1-starter: GeoTrust single-domain DV certificate. geotrust-dv-w-starter: GeoTrust wildcard DV certificate. geotrust-ov-1-personal: GeoTrust single-domain OV certificate. geotrust-ov-w-personal: GeoTrust wildcard OV certificate. globalsign-dv-1-personal: GlobalSign single-domain DV certificate. globalsign-dv-w-advanced: GlobalSign wildcard DV certificate. globalsign-ov-1-personal: GlobalSign single-domain OV certificate. globalsign-ov-w-advanced: GlobalSign wildcard OV certificate. cfca-ov-1-personal: China Financial Certification Authority (CFCA) single-domain OV certificate, available only on the China site (aliyun.com). cfca-ev-w-advanced: CFCA wildcard OV certificate, available only on the China site (aliyun.com).	symantec-free-1-free

Response elements

Element	Type	Description	Example
	object	The response parameters.
IssuedCount	integer	The number of issued certificates of the specified specifications.	1
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	10CFA380-1C58-45C7-8075-06215F3DB681
TotalCount	integer	The total number of purchased certificate resource plans of the specified specifications.	20
ProductCode	string	The specifications of the certificate resource plan. Valid values: digicert-free-1-free: DigiCert single-domain DV certificate in a three-month free trial, available only on the China site (aliyun.com). symantec-free-1-free: DigiCert single-domain DV certificate in a one-year free trial, available only on the China site (aliyun.com). symantec-dv-1-starter: DigiCert wildcard DV certificate. symantec-ov-1-personal: DigiCert single-domain OV certificate. symantec-ov-w-personal: DigiCert wildcard OV certificate. geotrust-dv-1-starter: GeoTrust single-domain DV certificate. geotrust-dv-w-starter: GeoTrust wildcard DV certificate. geotrust-ov-1-personal: GeoTrust single-domain OV certificate. geotrust-ov-w-personal: GeoTrust wildcard OV certificate. globalsign-dv-1-personal: GlobalSign single-domain DV certificate. globalsign-dv-w-advanced: GlobalSign wildcard DV certificate. globalsign-ov-1-personal: GlobalSign single-domain OV certificate. globalsign-ov-w-advanced: GlobalSign wildcard OV certificate. cfca-ov-1-personal: CFCA single-domain OV certificate, available only on the China site (aliyun.com). cfca-ev-w-advanced: CFCA wildcard OV certificate, available only on the China site (aliyun.com).	symantec-free-1-free
UsedCount	integer	The number of certificate applications that you submitted for certificates of the specified specifications. Note : A successful call of the CreateCertificateForPackageRequest, CreateCertificateRequest, or CreateCertificateWithCsrRequest operation is counted as one a certificate application, regardless of whether the certificate is issued.	2

Examples

Success response

JSON format

{
  "IssuedCount": 1,
  "RequestId": "10CFA380-1C58-45C7-8075-06215F3DB681",
  "TotalCount": 20,
  "ProductCode": "digicert-free-1-free",
  "UsedCount": 2
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.