Encrypt - - Alibaba Cloud ドキュメントセンター

操作説明

注意事項

RAM ユーザーまたは RAM ロールがこの API 操作を呼び出すために必要なアクセスポリシーについては、「リソースアクセス管理」をご参照ください。
この操作は、共有ゲートウェイまたは専用ゲートウェイを使用して呼び出すことができます。詳細については、「Alibaba Cloud SDK」をご参照ください。
- 共有ゲートウェイ: インターネットまたは VPC 経由で KMS にアクセスできます。この方法を使用するには、インターネットアクセスを有効にする必要があります。詳細については、「インターネット経由での KMS インスタンスのアクセスキー」をご参照ください。
- 専用ゲートウェイ: KMS のプライベートエンドポイント (<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com) を使用して KMS にアクセスできます。

QPS 制限

共有ゲートウェイを使用してこの操作を呼び出す場合、1 ユーザーあたりのクエリ/秒 (QPS) 制限は 1,000 です。制限を超えると、API 呼び出しはスロットルされます。これはビジネスに影響を与える可能性があります。スロットルを回避するために、適切なレートでこの操作を呼び出すことをお勧めします。
専用ゲートウェイを使用してこの操作を呼び出す場合、1 ユーザーあたりの QPS 制限は、KMS インスタンスのコンピューティングパフォーマンス仕様によって異なります。詳細については、「パフォーマンスメトリック」をご参照ください。

説明

KMS は、指定されたキーのプライマリバージョンを使用して、指定されたデータを暗号化します。
RSA キー、データベースパスワード、その他の機密情報など、最大 6 KB のデータを暗号化できます。
暗号化されたデータをあるリージョンから別のリージョンに移行する場合、ターゲットリージョンで Encrypt 操作を呼び出して、ソースリージョンからのプレーンテキストデータキーを再暗号化できます。これにより、新しい暗号化データキーが生成されます。次に、復号化操作を呼び出して、ターゲットリージョンでこの新しいキーを復号化できます。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	タイプ	必須 / 任意	説明	例
KeyId	string	必須	キーの ID。キーのエイリアスまたは Amazon リソースネーム (ARN) を指定することもできます。エイリアスの詳細については、「エイリアスの管理」をご参照ください。説明別の Alibaba Cloud アカウントのキーにアクセスする場合は、キーの ARN を指定する必要があります。キーの ARN は `acs:kms:${region}:${account}:key/${keyid}` 形式です。	1234abcd-12ab-34cd-56ef-12345678****
Plaintext	string	必須	暗号化するプレーンテキスト。プレーンテキストは Base64 でエンコードする必要があります。	SGVsbG8gd29y****
EncryptionContext	object	任意	キーと値のペアで構成される JSON 文字列。このパラメーターを指定する場合は、Decrypt 操作を呼び出すときに同じパラメーターを指定する必要があります。詳細については、「EncryptionContext」をご参照ください。	{"Example":"Example"}
DryRun	string	任意	ドライラン機能を有効にするかどうかを指定します。 true: ドライラン機能を有効にします。 false (デフォルト): ドライラン機能を無効にします。ドライラン機能は、API 呼び出しをテストし、所有しているリソースに対する権限とリクエストパラメーターの有効性を検証するために使用されます。レスポンスで確認結果を確認できます。 DryRunOperationError: 権限とパラメーターは有効です。 DryRun パラメーターを指定しない場合、リクエストは成功します。 ValidationError: リクエストのパラメーターが無効です。 AccessDeniedError: KMS リソースに対してこの操作を実行する権限がありません。	false

レスポンスパラメーター

パラメーター	タイプ	説明	例
	object
KeyVersionId	string	プレーンテキストの暗号化に使用されるキーバージョンの ID。これは、指定されたキーのプライマリバージョンです。	86a9efd9-3d16-4894-bd4f-1fc43f3f****
KeyId	string	キーの ID。リクエストでキーのエイリアスまたは ARN を使用した場合、キーの ID が返されます。	1234abcd-12ab-34cd-56ef-12345678****
CiphertextBlob	string	指定されたキーのプライマリバージョンを使用して暗号化されたデータの暗号文。	DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK****
RequestId	string	リクエストの ID。これは、Alibaba Cloud によってリクエストに対して生成された一意の識別子です。この ID を使用して問題のトラブルシューティングを行うことができます。	475f1620-b9d3-4d35-b5c6-3fbdd941423d

例

成功レスポンス

JSONJSON

{
  "KeyVersionId": "86a9efd9-3d16-4894-bd4f-1fc43f3f****",
  "KeyId": "1234abcd-12ab-34cd-56ef-12345678****",
  "CiphertextBlob": "DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK****",
  "RequestId": "475f1620-b9d3-4d35-b5c6-3fbdd941423d"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameter	The specified parameter is invalid.
404	Forbidden.KeyNotFound	The specified Key is not found.	アクセスキーが有効になっていません。
404	Forbidden.AliasNotFound	The specified Alias is not found.
404	InvalidAccessKeyId.NotFound	The Access Key ID provided does not exist in our records.

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

変更履歴

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