GetManagedDataKey - Key Management Service - Alibaba Cloud ドキュメントセンター

操作説明

この操作を呼び出すために RAM ユーザーまたは RAM ロールに付与する必要があるアクセスポリシーについては、アクセスの制御をご参照ください。

この操作は共有ゲートウェイ経由で呼び出すことができます。詳細については、Alibaba Cloud SDK をご参照ください。

共有ゲートウェイ: パブリックエンドポイントまたは VPC エンドポイント経由で KMS にアクセスします。

今すぐお試しください

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

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエスト構文

GET  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DataKeyName	string	任意	管理対象データキー (DK) の名前。このパラメーターは必須です。	example-data-key。
DataKeyVersionId	string	任意	管理対象データキー (DK) のバージョン番号。このパラメーターは任意です。このパラメーターに特定のバージョン番号を設定すると、指定したバージョンの管理対象データキー (DK) のプレーンテキストが返されます。	xH6OPUmz。
UseLatest	boolean	任意	バージョン番号が指定されていない場合に、管理対象データキー (DK) の最新バージョンを使用するかどうかを指定します。有効な値: true: 管理対象データキー (DK) の最新バージョンを返します。 false: 管理対象データキー (DK) の最初のバージョンを返します。デフォルト値: false。	true。

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
RequestId	string	リクエスト ID。Alibaba Cloud は各リクエストに対して一意の識別子を生成します。リクエスト ID を使用して問題のトラブルシューティングを行うことができます。	4bd560a1-729e-45f1-a3d9-b2a33d61046b
DataKeyName	string	管理対象データキー (DK) の名前。	example-data-key。
DataKeyVersionName	string	返された管理対象データキー (DK) バージョンのキーマテリアルを格納する認証情報の名前。	kms-datakeyversion!example-data-key!xH6OPUmz。
DataKeyVersionId	string	返された管理対象データキー (DK) のバージョン番号。	xH6OPUmz。
Plaintext	string	データキー (DK) の Base64 エンコーディングされたプレーンテキスト値。	CYueyVmZJ2MfA1VSZV2jCbFT8bO7StAvBnHacplr9aI=

例

成功レスポンス

JSONJSON

{
  "RequestId": "4bd560a1-729e-45f1-a3d9-b2a33d61046b",
  "DataKeyName": "example-data-key",
  "DataKeyVersionName": "kms-datakeyversion!example-data-key!xH6OPUmz",
  "DataKeyVersionId": "xH6OPUmz\n",
  "Plaintext": "CYueyVmZJ2MfA1VSZV2jCbFT8bO7StAvBnHacplr9aI="
}

エラーコード

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

変更履歴

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