すべてのプロダクト
Search
ドキュメントセンター

Certificate Management Service:DescribeCertificateState

最終更新日:Jun 10, 2026

証明書アプリケーション注文のステータス(ドメイン検証の進捗状況など)を照会します。

操作説明

If you have not completed domain ownership validation after submitting a certificate request, you can call this operation to obtain the information required to complete domain validation. Using the returned domain validation information, you can complete domain validation on the DNS management platform (DNS validation method) or on the domain server (file validation method).

Your certificate request will enter the CA center review stage only after you complete domain validation. After the CA center approves your certificate request, a certificate will be issued to you. If the certificate has been issued, you can call this operation to obtain the issued certificate file and private key content.

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

yundun-cert:DescribeCertificateState

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

OrderId

integer

必須

クエリする証明書リクエスト注文の ID。

説明

ListUserCertificateOrder を呼び出してこの ID を取得できます。

123451222

API 操作を呼び出す際には、その操作に固有のリクエストパラメーターに加えて、Alibaba Cloud 共通リクエストパラメーターも含める必要があります。

API 操作の呼び出し時のリクエストフォーマットについては、本トピックの「」セクションのリクエスト例を参照してください。

レスポンスフィールド

フィールド

説明

object

The object.

Type

string

The status of the certificate request order. Valid values:

  • domain_verify: Pending validation, which indicates that you have not completed domain validation after submitting the certificate request.

    説明

    After you submit a certificate request, you must manually complete domain ownership validation before the certificate request can enter the review stage. If you have not completed domain validation, you can refer to the response parameters of this operation to complete domain validation.

  • process: Under review, which indicates that the certificate request is being reviewed by the CA center.

  • verify_fail: Review failed, which indicates that the certificate request failed the review.

    説明

    The review may fail because the certificate request information you submitted is incorrect. We recommend that you call DeleteCertificateRequest to delete the order that failed the review (deleted orders do not consume certificate resource plan quota) and submit a new certificate request.

  • certificate: Issued, which indicates that the certificate has been issued.

  • payed: Pending request, which indicates that the certificate is pending request.

  • unknow: Unknown status.

domain_verify

Domain

string

The domain name to be validated when you use the file validation method for domain validation. You need to connect to the server corresponding to this domain name and create the specified file (i.e., Uri) on the server.

説明

This parameter is returned only when Type is set to domain_verify (indicating the domain validation stage) and ValidateType is set to FILE (indicating the file validation method).

www.example.com

RecordType

string

The type of DNS record that you need to add when you use the DNS validation method for domain validation. Valid values:

  • TXT: text record.

  • CNAME: alias record.

説明

This parameter is returned only when Type is set to domain_verify (indicating the domain validation stage) and ValidateType is set to DNS (indicating the DNS validation method).

TXT

CertId

string

The certificate ID.

説明

This parameter is returned when the certificate is issued.

111111

RequestId

string

The ID of the request.

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

RecordDomain

string

The host record that you need to operate when you use the DNS validation method for domain validation.

説明

This parameter is returned only when Type is set to domain_verify (indicating the domain validation stage) and ValidateType is set to DNS (indicating the DNS validation method).

_dnsauth

PrivateKey

string

The content of the certificate private key (in PEM format). For more information about the PEM format and how to convert the format of a certificate, see What are the formats of mainstream digital certificates?.

説明

This parameter is returned only when Type is set to certificate (indicating that the certificate has been issued).

——BEGIN RSA PRIVATE KEY—— …… ——END RSA PRIVATE KEY——

ValidateType

string

The domain validation method selected when submitting the certificate request. Valid values:

  • DNS: DNS validation. This method validates domain ownership by adding the specified DNS record to the domain on the DNS management platform.

  • FILE: file validation. This method validates domain ownership by creating the specified file on the domain server.

説明

This parameter is returned only when Type is set to domain_verify (indicating the domain validation stage).

FILE

RecordValue

string

The record value that you need to add when you use the DNS validation method for domain validation.

説明

This parameter is returned only when Type is set to domain_verify (indicating the domain validation stage) and ValidateType is set to DNS (indicating the DNS validation method).

20200420000000223erigacv46uhaubchcm0o7spxi7i2isvjq59mlx9lucnkqcy

Content

string

The content that you need to write to the newly created file when you use the file validation method for domain validation.

説明

This parameter is returned only when Type is set to domain_verify (indicating the domain validation stage) and ValidateType is set to FILE (indicating the file validation method).

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

Uri

string

The file that you need to create on the domain server when you use the file validation method for domain validation. Uri includes the file path and name.

説明

This parameter is returned only when Type is set to domain_verify (indicating the domain validation stage) and ValidateType is set to FILE (indicating the file validation method).

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

Certificate

string

The certificate content (in PEM format). For more information about the PEM format and how to convert the format of a certificate, see What are the formats of mainstream digital certificates?.

説明

This parameter is returned only when Type is set to certificate (indicating that the certificate has been issued).

——BEGIN CERTIFICATE—— …… ——END CERTIFICATE——

成功レスポンス

JSONJSON

{
  "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——"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。