DescribeCertificateState - 查询DV证书的申请状态

查询指定的证书申请订单的状态。

接口说明

如果您在提交证书申请后还没有完成域名所有权验证,则调用本接口可以获取完成域名验证所需要的信息;您可以根据返回的域名验证信息,在域名的 DNS 管理平台(DNS 验证方式)或者域名服务器(文件验证方式)上,完成域名验证。

只有当您完成域名验证后,证书申请才会进入 CA 中心审核环节。CA 中心审核通过您的证书申请后,将会为您签发证书。如果证书已经签发,调用本接口可以获取已签发的证书文件和私钥内容。

关于使用证书资源包 API 申请证书的完整流程,请参见使用 API 申请证书的流程

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-cert:DescribeCertificateState

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

OrderId

integer

要查询的证书申请订单的 ID。

说明

此 ID 可通过调用 ListUserCertificateOrder 获取。

123451222

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

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

返回参数

名称

类型

描述

示例值

object

对象。

Type

string

证书申请订单的状态。取值:

  • domain_verify待验证,表示证书申请提交后,您还没有完成域名验证。

    说明

    您在提交证书申请后,必须手动完成域名所有权验证,证书申请才可以进入审核环节。如果您还没有完成域名验证,则可以参照本接口的返回数据,完成域名验证。

  • process审核中,表示证书申请处于 CA 中心审核环节。

  • verify_fail审核失败,表示证书申请审核失败。

    说明

    审核失败可能是因为您提交的证书申请信息不正确,建议您调用 DeleteCertificateRequest 删除审核失败的订单(已删除订单不会消耗证书资源包个数),并重新提交证书申请。

  • certificate已签发,表示证书已经签发。

  • payed待申请,表示待申请证书。

  • unknow状态未知

domain_verify

Domain

string

使用文件验证方式进行域名验证时,待验证的域名。您需要连接该域名对应的服务器,并在服务器上创建指定的文件(即 Uri)。

说明

仅当 Type 取值为domain_verify(表示域名验证环节)且 ValidateType 取值为 FILE(表示验证方式为文件验证)时,才会返回该参数。

www.example.com

RecordType

string

使用 DNS 验证方式进行域名验证时,您需要添加的解析记录的类型。取值:

  • TXT:表示文本记录。

  • CNAME:表示别名记录。

说明

仅当 Type 取值为domain_verify(表示域名验证环节)且 ValidateType 取值为 DNS(表示验证方式为 DNS 验证)时,才会返回该参数。

TXT

CertId

string

证书 ID。

说明

当证书签发时返回。

111111

RequestId

string

本次请求的 ID。

082FAB35-6AB9-4FD5-8750-D36673548E76

RecordDomain

string

使用 DNS 验证方式进行域名验证时,您需要操作的主机记录。

说明

仅当 Type 取值为domain_verify(表示域名验证环节)且 ValidateType 取值为 DNS(表示验证方式为 DNS 验证)时,才会返回该参数。

_dnsauth

PrivateKey

string

证书私钥内容(PEM 格式)。关于 PEM 格式的更多介绍以及如何进行证书格式转换,请参见主流数字证书都有哪些格式?

说明

仅当 Type 取值为 certificate(表示证书已经签发)时,才会返回该参数。

-----BEGIN RSA PRIVATE KEY-----…… -----END RSA PRIVATE KEY-----

ValidateType

string

提交证书申请时选择的域名验证方式。取值:

  • DNS: 表示 DNS 验证。通过在域名的 DNS 管理平台为域名添加指定的 DNS 解析记录,验证域名的所有权。

  • FILE:表示文件验证。通过在域名服务器上创建指定的文件,验证域名的所有权。

说明

仅当 Type 取值为domain_verify(表示域名验证环节),才会返回该参数。

FILE

RecordValue

string

使用 DNS 验证方式进行域名验证时,您需要添加的解析记录的记录值。

说明

仅当 Type 取值为domain_verify(表示域名验证环节)且 ValidateType 取值为 DNS(表示验证方式为 DNS 验证)时,才会返回该参数。

20200420000000223erigacv46uhaubchcm0o7spxi7i2isvjq59mlx9lucnkqcy

Content

string

使用文件验证方式进行域名验证时,您需要在新创建文件中写入的内容。

说明

仅当 Type 取值为domain_verify(表示域名验证环节)且 ValidateType 取值为 FILE(表示验证方式为文件验证)时,才会返回该参数。

http://example.com/.well-known/pki-validation/fileauth.txt

Uri

string

使用文件验证方式进行域名验证时,您需要在域名服务器中创建的文件。Uri 包含文件路径及名称。

说明

仅当 Type 取值为domain_verify(表示域名验证环节)且 ValidateType 取值为 FILE(表示验证方式为文件验证)时,才会返回该参数。

/.well-known/pki-validation/fileauth.txt

Certificate

string

证书内容(PEM 格式)。关于 PEM 格式的更多介绍以及如何进行证书格式转换,请参见主流数字证书都有哪些格式?

说明

仅当 Type 取值为 certificate(表示证书已经签发)时,才会返回该参数。

-----BEGIN CERTIFICATE----- …… -----END CERTIFICATE-----

示例

正常返回示例

JSON格式

{
  "Type": "domain_verify",
  "Domain": "www.example.com",
  "RecordType": "TXT",
  "CertId": "111111",
  "RequestId": "082FAB35-6AB9-4FD5-8750-D36673548E76",
  "RecordDomain": "_dnsauth",
  "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----…… -----END RSA PRIVATE KEY-----",
  "ValidateType": "FILE",
  "RecordValue": "20200420000000223erigacv46uhaubchcm0o7spxi7i2isvjq59mlx9lucnkqcy",
  "Content": "http://example.com/.well-known/pki-validation/fileauth.txt",
  "Uri": "/.well-known/pki-validation/fileauth.txt",
  "Certificate": "-----BEGIN CERTIFICATE----- …… -----END CERTIFICATE-----"
}

错误码

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

变更历史

更多信息,参考变更详情