DescribeCertificateState -

查詢指定的憑證申請訂單的狀態。

介面說明

如果您在提交憑證申請後尚未完成網域所有權驗證，則呼叫本介面可以取得完成網域驗證所需要的資訊；您可以根據傳回的網域驗證資訊，在網域的 DNS 管理平台（DNS 驗證方式）或者網域伺服器（檔案驗證方式）上，完成網域驗證。

只有當您完成網域驗證後，憑證申請才會進入 CA 中心審核環節。CA 中心審核通過您的憑證申請後，將會為您簽發憑證。如果憑證已經簽發，呼叫本介面可以取得已簽發的憑證檔案和私密金鑰內容。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-cert:DescribeCertificateState

get

*All Resource

*

無

請求參數

名稱	類型	必填	描述	樣本值
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——"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。