查詢指定的證書申請訂單的狀態。
接口說明
如果您在提交證書申請后還沒有完成域名所有權驗證,則調用本接口可以獲取完成域名驗證所需要的信息;您可以根據返回的域名驗證信息,在域名的 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 | long | 是 | 要查詢的證書申請訂單的 ID。 說明
此 ID 可通過調用 ListUserCertificateOrder 獲取。
| 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"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-11-22 | OpenAPI 描述信息更新 | 查看變更詳情 |