All Products
Search
Document Center

Certificate Management Service:DescribePackageState

Last Updated:Feb 27, 2025

Queries the quota for domain validated (DV) certificates that you purchase and the quota usage.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-cert:DescribePackageStateget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProductCodestringNo

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 parameters

ParameterTypeDescriptionExample
object

The response parameters.

IssuedCountlong

The number of issued certificates of the specified specifications.

1
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

10CFA380-1C58-45C7-8075-06215F3DB681
TotalCountlong

The total number of purchased certificate resource plans of the specified specifications.

20
ProductCodestring

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
UsedCountlong

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

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
2024-09-20API Description UpdateView Change Details