DescribeCertificatePrivateKey

更新日時
Copy as MD

単一のクライアント証明書またはサーバー証明書の暗号化された秘密鍵を取得します。

操作説明

この API は、システムで生成された証明書署名要求 (CSR) から発行された証明書にのみ適用されます。この API を使用して、クライアント証明書またはサーバー証明書の暗号化された秘密鍵を取得できます。この API を呼び出す前に、次のいずれかの API を呼び出して、クライアント証明書またはサーバー証明書を発行しておく必要があります。

転送中の秘密鍵の安全性を確保するため、この API は、設定したパスワードを使用して秘密鍵を暗号化します。その後、API は暗号化された秘密鍵を返します。暗号化された秘密鍵を取得した後、次のいずれかの方法で復号化できます。

  • 証明書が RSA 暗号化アルゴリズムを使用している場合は、openssl rsa -in <encrypted_private_key_file> -passin pass:<private_key_password> -out <decrypted_private_key_file> コマンドを実行して秘密鍵を復号化します。このコマンドは、OpenSSL または BabaSSL がインストールされているコンピューターで実行する必要があります。

  • 証明書が ECC 暗号化アルゴリズムを使用している場合は、openssl ec -in <encrypted_private_key_file> -passin pass:<private_key_password> -out <decrypted_private_key_file> コマンドを実行して秘密鍵を復号化します。このコマンドは、OpenSSL または BabaSSL がインストールされているコンピューターで実行する必要があります。

  • 証明書が SM2 暗号化アルゴリズムを使用している場合は、openssl ec -in <encrypted_private_key_file> -passin pass:<private_key_password> -out <decrypted_private_key_file> コマンドを実行して秘密鍵を復号化します。このコマンドは、BabaSSL がインストールされているコンピューターで実行する必要があります。

説明

DescribeClientCertificate を呼び出して、クライアント証明書またはサーバー証明書の暗号化アルゴリズムをクエリできます。

QPS 制限

この API は、ユーザーごとに 1 秒あたりのクエリ数 (QPS) が 10 に制限されています。この制限を超えると、API 呼び出しはスロットリングされます。スロットリングはビジネスに影響を与える可能性があります。それに応じて呼び出しを計画してください。

今すぐお試しください

この 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:DescribeCertificatePrivateKey

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

Identifier

string

必須

秘密鍵を取得するクライアント証明書またはサーバー証明書の一意の識別子。

説明

ListClientCertificate を呼び出して、すべてのクライアント証明書とサーバー証明書の一意の識別子をクエリします。

bc37133bb7ed68c7938d928fd26d****

EncryptedCode

string

必須

秘密鍵を暗号化するためのパスワード。パスワードには、大文字、小文字、数字、および ,.+-_# などの特殊文字を含めることができます。最大長は 32 バイトです。

警告 設定したパスワードを覚えておいてください。暗号化された秘密鍵を復号化するには、このパスワードが必要です。パスワードを忘れた場合、この API 呼び出しから取得した秘密鍵を復号化することはできません。この API を再度呼び出して、新しい暗号化キーを取得する必要があります。

!Demo@WS3ed

ResourceGroupId

string

任意

証明書が属するリソースグループの ID。

test

このトピックの API 固有のリクエストパラメーターに加えて、API 呼び出しを行う際には共通リクエストパラメーターを指定する必要があります。

リクエストフォーマットについては、セクションのリクエスト例をご参照ください。

レスポンスフィールド

フィールド

説明

object

GetCertificatePrivateKeyResponse。

EncryptedData

string

秘密鍵の暗号化された内容。

-----BEGIN ENCRYPTED PRIVATE KEY----- …… -----END ENCRYPTED PRIVATE KEY-----

RequestId

string

リクエストの ID。

09470F19-CEE8-5C63-BF2C-02B5E3F07A17

成功レスポンス

JSONJSON

{
  "EncryptedData": "-----BEGIN ENCRYPTED PRIVATE KEY----- …… -----END ENCRYPTED PRIVATE KEY-----",
  "RequestId": "09470F19-CEE8-5C63-BF2C-02B5E3F07A17"
}

エラーコード

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

変更履歴

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