文档

DescribePackageState - 查询已经购买的DV证书总数和使用情况

更新时间:

查询已经购买的DV证书总数和使用情况。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-cert:DescribePackageStateRead
  • 全部资源
    acs:yundun-cert:*:{#accountId}:*

请求参数

名称类型必填描述示例值
ProductCodestring

要查询的证书资源包的规格(即证书规格)。取值:

  • digicert-free-1-free(默认):表示 DigiCert DV 单域名证书(3 个月免费试用)。

  • symantec-free-1-free:表示 DigiCert DV 单域名证书(1 年免费试用)。

  • symantec-dv-1-starter:表示 DigiCert DV 通配符域名证书。

  • symantec-ov-1-personal:表示 DigiCert OV 单域名证书。

  • symantec-ov-w-personal:表示 DigiCert OV 通配符域名证书。

  • geotrust-dv-1-starter:表示 GeoTrust DV 单域名证书。

  • geotrust-dv-w-starter:表示 GeoTrust DV 通配符域名证书。

  • geotrust-ov-1-personal:表示 GeoTrust OV 单域名证书。

  • geotrust-ov-w-personal:表示 GeoTrust OV 通配符域名证书。

  • globalsign-dv-1-personal:表示 GlobalSign DV 单域名证书。

  • globalsign-dv-w-advanced:表示 GlobalSign DV 通配符域名证书。

  • globalsign-ov-1-personal:表示 GlobalSign OV 单域名证书。

  • globalsign-ov-w-advanced:表示 GlobalSign OV 通配符域名证书。

  • cfca-ov-1-personal:表示 CFCA OV 单域名证书。

  • cfca-ev-w-advanced:表示 CFCA OV 通配符域名证书。

digicert-free-1-free

调用 API 时,除了本文中该 API 的请求参数,还需加入阿里云 API 公共请求参数。

调用 API 的请求格式,请参见本文示例中的请求示例。

返回参数

名称类型描述示例值
object

对象。

IssuedCountlong

已经成功签发该规格证书的数量。

1
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

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

已购买该规格证书资源包的总数量。

20
ProductCodestring

证书资源包的规格(即证书规格)。取值:

  • digicert-free-1-free:表示 DigiCert DV 单域名证书(3 个月免费试用)。

  • symantec-free-1-free:表示 DigiCert DV 单域名证书(1 年免费试用)。

  • symantec-dv-1-starter:表示 DigiCert DV 通配符域名证书。

  • symantec-ov-1-personal:表示 DigiCert OV 单域名证书。

  • symantec-ov-w-personal:表示 DigiCert OV 通配符域名证书。

  • geotrust-dv-1-starter:表示 GeoTrust DV 单域名证书。

  • geotrust-dv-w-starter:表示 GeoTrust DV 通配符域名证书。

  • geotrust-ov-1-personal:表示 GeoTrust OV 单域名证书。

  • geotrust-ov-w-personal:表示 GeoTrust OV 通配符域名证书。

  • globalsign-dv-1-personal:表示 GlobalSign DV 单域名证书。

  • globalsign-dv-w-advanced:表示 GlobalSign DV 通配符域名证书。

  • globalsign-ov-1-personal:表示 GlobalSign OV 单域名证书。

  • globalsign-ov-w-advanced:表示 GlobalSign OV 通配符域名证书。

  • cfca-ov-1-personal:表示 CFCA OV 单域名证书。

  • cfca-ev-w-advanced:表示 CFCA OV 通配符域名证书。

digicert-free-1-free
UsedCountlong

已经提交该规格证书申请的次数。

说明 您只要成功调用一次 CreateCertificateForPackageRequestCreateCertificateRequestCreateCertificateWithCsrRequest 接口,就表示提交了一次证书申请(不论证书是否成功签发)。
2

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈