查询指定的证书申请订单的状态。
接口说明
如果您在提交证书申请后还没有完成域名所有权验证,则调用本接口可以获取完成域名验证所需要的信息;您可以根据返回的域名验证信息,在域名的DNS管理平台(DNS验证方式)或者域名服务器(文件验证方式)上,完成域名验证。
只有当您完成域名验证后,证书申请才会进入CA中心审核环节。CA中心审核通过您的证书申请后,将会为您签发证书。如果证书已经签发,调用本接口可以获取已签发的证书文件和私钥内容。
关于使用证书资源包API申请证书的完整流程,请参见使用API申请证书的流程。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
yundun-cert:DescribeCertificateState | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
OrderId | long | 是 | 要查询的证书申请订单的ID。 说明您在调用CreateCertificateForPackageRequest、CreateCertificateRequest、CreateCertificateWithCsrRequest接口提交证书申请后,可以从请求返回数据中获取对应的证书申请订单ID(即OrderId)。 | 123451222 |
调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。
调用API的请求格式,请参见本文示例中的请求示例。
返回参数
示例
正常返回示例
JSON
格式
{
"Type": "domain_verify",
"Domain": "www.example.com",
"RecordType": "TXT",
"Certificate": "-----BEGIN CERTIFICATE----- …… -----END CERTIFICATE-----",
"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"
}
错误码
访问错误中心查看更多错误码。