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

Key Management Service:GenerateDataKey

最終更新日:Oct 20, 2026

ローカルデータ暗号化用のランダムなデータキー (DK) を生成します。

操作説明

  • Resource Access Management (RAM) ユーザーまたは RAM ロールがこの API オペレーションの呼び出しを行うために必須となるアクセスポリシーの詳細については、「アクセスコントロール」を参照してください。

  • この API オペレーションは、共有ゲートウェイまたは専用ゲートウェイを通じて呼び出しできます。詳細については、「Alibaba Cloud SDK」を参照してください。

    • 共有ゲートウェイ: インターネットまたは VPC エンドポイント経由で KMS にアクセスします。このメソッドでは、パブリックネットワークアクセスを有効にする必要があります。詳細については、「インターネット経由での KMS インスタンスのアクセスキー」を参照してください。

    • 専用ゲートウェイ: KMS プライベートエンドポイント (<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com) 経由で KMS にアクセスします。

QPS 制限

  • 共有ゲートウェイ: この API オペレーションのユーザーごとの QPS 制限は、1 秒あたり 1,000 回の呼び出しです。制限を超えると、API の呼び出しがスロットリングされ、ビジネスに影響を与える可能性があります。API の呼び出しは適切な周波数で行ってください。

  • 専用ゲートウェイ: この API オペレーションのユーザーごとの QPS 制限は、KMS インスタンスのコンピューティングパフォーマンスのスペックによって異なります。詳細については、「パフォーマンスデータ」を参照してください。

説明

ランダムに生成されたデータキー (DK) は、指定されたカスタマーマスターキー (CMK) を使用して暗号化され、DK の暗号文とプレーンテキストが返されます。返された DK のプレーンテキストを使用して、KMS 外のローカルでデータを暗号化できます。暗号化されたデータを保存するときは、DK の暗号文も一緒に保存する必要があります。DK のプレーンテキストは応答の Plaintext フィールドから取得でき、DK の暗号文は CiphertextBlob フィールドから取得できます。

リクエストで指定された CMK は、DK の暗号化にのみ使用され、DK の生成には関与しません。KMS は、ランダムに生成された DK を Record または保存しません。DK の暗号文の永続化はユーザーの責任です。

ローカルでデータを暗号化するには、次のメソッドを使用することを推奨します。

  1. GenerateDataKey 操作を呼び出して、データ暗号化用のキーを取得します。

  2. 応答の Plaintext フィールドで返された DK のプレーンテキストを使用して、ローカルでオフラインデータ暗号化を完了し、その後メモリから DK のプレーンテキストを消去します。

  3. 応答の CiphertextBlob フィールドで返された DK の暗号文を、ローカルで暗号化されたデータと一緒に保存します。

ローカルでデータを復号するには:

  • Decrypt 操作を呼び出して、ローカルストレージ内の DK の暗号文を復号します。この操作は、DK のプレーンテキストを返します。

  • DK のプレーンテキストを使用して、ローカルでオフラインデータの復号を完了し、その後メモリから DK のプレーンテキストを消去します。

この Topic では、ID が key-hzz630494463ejqjx**** のキーに対してランダムな DK を生成する例を示します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

kms:GenerateDataKey

get

*Key。

acs:kms:{#regionId}:{#accountId}:key/{#KeyId}

  • kms:tag
なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

KeyId

string

必須

キーの ID。キーのエイリアスまたは Amazon リソースネーム (ARN) を指定することもできます。エイリアスの詳細については、「キーエイリアスの管理」を参照してください。

説明

別の Alibaba Cloud アカウントに属するキーにアクセスする場合は、キーの ARN を入力する必要があります。キーの ARN は acs:kms:${region}:${account}:key/${keyid} フォーマットです。

key-hzz630494463ejqjx****

KeySpec

string

任意

生成される DK の長さを指定します。有効な値:

  • AES_256: 256 ビットの対称キー。

  • AES_128: 128 ビットの対称キー。

説明

DK の長さを指定するには、KeySpec または NumberOfBytes を使用します。どちらのパラメーターも指定されていない場合、KMS は 256 ビットの DK を生成します。両方のパラメーターが指定されている場合、KMS は KeySpec パラメーターを無視します。

AES_256

NumberOfBytes

integer

任意

生成される DK の長さをバイト単位で指定します。

有効な値: 1~1024。

デフォルト値:

  • KeySpec が AES_256 に設定されている場合、NumberOfBytes のデフォルト値は 32 です。

  • KeySpec が AES_128 に設定されている場合、NumberOfBytes のデフォルト値は 16 です。

256

EncryptionContext

object

任意

キーと値のペアの JSON 文字列。

このパラメーターを指定した場合、 Decrypt 操作の呼び出し時に同じパラメーターを指定する必要があります。詳細については、「 EncryptionContext 」を参照してください。

{"Example":"Example"}

DryRun

string

任意

ドライランモードを有効にするかどうかを指定します。有効な値:

  • true: 有効。

  • false: 無効。

デフォルト値: false。

ドライランモードは、API の呼び出しをテストし、リソースに対する必須の権限があるかどうかを確認し、リクエストパラメーターが正しく設定されているかどうかをチェックするために使用されます。ドライランモードが有効な場合、KMS は常に失敗を返し、失敗の原因を提供します。原因には次のものがあります。

  • DryRunOperationError: DryRun パラメーターが指定されていない場合、リクエストは成功します。

  • ValidationError: リクエストで指定されたパラメーターが無効です。

  • AccessDeniedError: KMS リソースに対してこの操作を実行するために必須の権限がありません。

false

Recipient

string

任意

信頼できる環境の認証情報。

  • AttestationDocument // 環境の測定値、署名、証明書などの情報を含む、Base64 エンコーディングされた信頼できる環境の証明ドキュメント。

  • KeyEncryptionAlgorithm // 暗号化アルゴリズム。RSAES_OAEP_SHA_256 のみがサポートされています。

AttestationDocument の構造:

  • quoted

  • extendUserData // Base64 エンコーディングされたユーザー拡張データ。デコードされた構造は次のとおりです。
    • aud // 固定値 "kms"。

    • iat // 発行時間。秒単位の UNIX タイムスタンプ。

    • exp // 有効期限。秒単位の UNIX タイムスタンプ。

    • pubKey // Base64 エンコーディングされた SPKI フォーマットの RSA2048 公開鍵。

    • digestAlg // ダイジェストアルゴリズム。"sha256" のみがサポートされています。

    • ver // プロトコルバージョン。"v1" のみがサポートされています。

    • signature // quoted と extendUserData の整合性を検証するために使用されるレポート署名。

  • pcrInfo:
    • pcrValues // プラットフォーム構成レジスタ (PCR) の測定値。

    • pcrSelectionOut // PCR 選択情報。

    • pcrUpdateCounter // PCR 更新回数。

  • cert // 署名の有効性を検証するために使用されるプラットフォーム証明証明書。
    重要 このパラメーターは、専用ゲートウェイを通じて API オペレーションの呼び出しを行う場合にのみ効果があります。

{ "AttestationDocument":"base64-encoded-attestion-document", "KeyEncryptionAlgorithm":"RSAES_OAEP_SHA_256" }

共通リクエストパラメーターの詳細については、「共通パラメーター」を参照してください。

レスポンスフィールド

フィールド

型

説明

例

object

KeyVersionId

string

キーバージョンの ID。プライマリキーバージョンのグローバル一意識別子です。

2ab1a983-7072-4bbc-a582-584b5bd8****

KeyId

string

キーの ID。リクエストの KeyId パラメーターがキーのエイリアスまたは Amazon リソースネーム (ARN) にセットされている場合、キー ID も応答で返されます。

key-hzz630494463ejqjx****

CiphertextBlob

string

指定されたキーのプライマリバージョンを使用して暗号化する、DK の暗号文。

ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****

RequestId

string

リクエストの ID。Alibaba Cloud によってリクエストに対して生成される一意の識別子であり、問題のトラブルシューティングと特定に使用できます。

7021b6ec-4be7-4d3c-8a68-1e85d4d515a0

Plaintext

string

Base64 エンコードされた DK のプレーンテキスト。

QmFzZTY0IGVuY29kZWQgcGxhaW50****

CiphertextForRecipient

string

Recipient パラメーターが渡された場合、プレーンテキストの DK は Recipient の extendUserData 内の公開鍵を使用して暗号化する処理が行われ、結果は Base64 エンコードされます。

重要 このパラメーターは、専用ゲートウェイを通じて API オペレーションの呼び出しを行う場合にのみ効果があります。

NIahY6pgjK4ZMP2R0EmsmBqntrv0AI2rcDyU7Su6uOT9Le7EOvlCpjHJfr9z3M0vkfulQoyuETmKSpYDfixE3auE4MwxloT6D9Gfsk6hm5FV2iAxL//Ms2kLv6K4z6yGi7lKm2yjX4***==

例

成功レスポンス

JSONJSON

{
  "KeyVersionId": "2ab1a983-7072-4bbc-a582-584b5bd8****",
  "KeyId": "key-hzz630494463ejqjx****",
  "CiphertextBlob": "ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****",
  "RequestId": "7021b6ec-4be7-4d3c-8a68-1e85d4d515a0",
  "Plaintext": "QmFzZTY0IGVuY29kZWQgcGxhaW50****",
  "CiphertextForRecipient": "NIahY6pgjK4ZMP2R0EmsmBqntrv0AI2rcDyU7Su6uOT9Le7EOvlCpjHJfr9z3M0vkfulQoyuETmKSpYDfixE3auE4MwxloT6D9Gfsk6hm5FV2iAxL//Ms2kLv6K4z6yGi7lKm2yjX4***=="
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 UnsupportedOperation This action is not supported.
404 Forbidden.AliasNotFound The specified Alias is not found.
404 Forbidden.KeyNotFound The specified Key is not found.
409 Rejected.Disabled The request was rejected because the key state is Disabled.
409 Rejected.PendingDeletion The request was rejected because the key state is PendingDeletion.
409 Rejected.Unavailable The request was rejected because the key state is Unavailable.

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

変更履歴

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