非対称キーを使用してデータを暗号化します。
操作説明
注意事項
-
この操作を呼び出すために必要な権限については、「リソースアクセス管理」をご参照ください。
-
この操作は、共有ゲートウェイまたは専用ゲートウェイを使用して呼び出すことができます。 詳細については、「Alibaba Cloud SDK」をご参照ください。
共有ゲートウェイ: インターネット経由または VPC ドメイン名を使用して KMS にアクセスできます。 インターネット経由で KMS にアクセスするには、インターネットアクセスを有効にする必要があります。 詳細については、「インターネット経由で KMS インスタンスのキーにアクセスする」をご参照ください。
専用ゲートウェイ: KMS のプライベートエンドポイント (
<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com) を使用して KMS にアクセスできます。
QPS 制限
共有ゲートウェイを使用する場合: シングルユーザーの 1 秒あたりのクエリ数 (QPS) は 200 に制限されています。制限を超えると、API 呼び出しがスロットルされます。これはビジネスに影響を与える可能性があります。 この制限を超えないように API 呼び出しを計画することをお勧めします。
専用ゲートウェイを使用する場合: シングルユーザーの QPS 制限は、KMS インスタンスのコンピューティングパフォーマンス仕様によって異なります。 詳細については、「パフォーマンスメトリック」をご参照ください。
説明
この操作は、使用パラメーターが ENCRYPT/DECRYPT に設定されている非対称キーのみをサポートします。 次の表は、サポートされている暗号化アルゴリズムを示しています。
KeySpec | アルゴリズム | 説明 | 暗号化できる最大バイト数 |
RSA_2048 | RSAES_OAEP_SHA_256 | SHA-256 および SHA-256 を使用した MGF1 を使用する RSAES-OAEP | 190 |
RSA_2048 | RSAES_OAEP_SHA_1 | SHA1 および SHA1 を使用した MGF1 を使用する RSAES-OAEP | 214 |
RSA_3072 | RSAES_OAEP_SHA_256 | SHA-256 および SHA-256 を使用した MGF1 を使用する RSAES-OAEP | 318 |
RSA_3072 | RSAES_OAEP_SHA_1 | SHA1 および SHA1 を使用した MGF1 を使用する RSAES-OAEP | 342 |
EC_SM2 | SM2PKE | SM2 楕円曲線公開鍵暗号化アルゴリズム | 6047 |
この例では、プレーンテキスト SGVsbG8gd29ybGQ= は、キー ID key-hzz630494463ejqjx****、キーバージョン ID 2ab1a983-7072-4bbc-a582-584b5bd8****、および RSAES_OAEP_SHA_1 暗号化アルゴリズムを持つ非対称キーを使用して暗号化されます。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
タイプ |
必須 / 任意 |
説明 |
例 |
| Plaintext |
string |
必須 |
暗号化するプレーンテキスト。 値は Base64 でエンコードする必要があります。 |
SGVsbG8gd29ybGQ= |
| KeyId |
string |
必須 |
キーの ID。 キーのエイリアスまたは Amazon リソースネーム (ARN) を指定することもできます。 エイリアスの詳細については、「エイリアスを管理する」をご参照ください。 説明
別の Alibaba Cloud アカウントのキーにアクセスするには、キーの ARN を指定する必要があります。 キー ARN の形式は |
5c438b18-05be-40ad-b6c2-3be6752c**** |
| KeyVersionId |
string |
必須 |
キーバージョンの ID。 ID はグローバルに一意の識別子である必要があります。 説明
ListKeyVersions 操作を呼び出して、キーバージョン ID を取得できます。 |
2ab1a983-7072-4bbc-a582-584b5bd8**** |
| Algorithm |
string |
必須 |
暗号化アルゴリズム。 |
RSAES_OAEP_SHA_1 |
| DryRun |
string |
任意 |
ドライラン機能を有効にするかどうかを指定します。
ドライラン機能は、API 呼び出しをテストし、指定されたリソースに対する権限とリクエストパラメーターの有効性を検証するために使用されます。 ドライラン機能を有効にすると、KMS は常に失敗した結果と失敗の理由を返します。 失敗の理由には、次のものがあります。
|
false |
レスポンスパラメーター
|
パラメーター |
タイプ |
説明 |
例 |
|
object |
|||
| KeyVersionId |
string |
プレーンテキストの暗号化に使用されるマスターキーのバージョン番号。 |
2ab1a983-7072-4bbc-a582-584b5bd8**** |
| KeyId |
string |
キーの ID。 リクエストでキーのエイリアスまたは ARN を指定した場合、キーの ID が返されます。 |
5c438b18-05be-40ad-b6c2-3be6752c**** |
| CiphertextBlob |
string |
暗号化されたデータの暗号文。 値は Base64 でエンコードされます。 |
BQKP+1zK6+ZEMxTP5qaVzcsgXtWplYBKm0NXdSnB5FzliFxE1bSiu4dnEIlca2JpeH7yz1/S6fed630H+hIH6DoM25fTLNcKj+mFB0Xnh9m2+HN59Mn4qyTfcUeadnfCXSWcGBouhXFwcdd2rJ3n337bzTf4jm659gZu3L0i6PLuxM9p7mqdwO0cKJPfGVfhnfMz+f4alMg79WB/NNyE2lyX7/qxvV49ObNrrJbKSFiz8Djocaf0IESNLMbfYI5bXjWkJlX92DQbKhibtQW8ZOJ//ZC6t0AWcUoKL6QDm/dg5koQalcleRinpB+QadFm894sLbVZ9+N4GVsv1Wbjwg== |
| RequestId |
string |
リクエストの ID。リクエストに対して Alibaba Cloud によって生成された一意の識別子です。 リクエスト ID を使用して問題のトラブルシューティングを行うことができます。 |
475f1620-b9d3-4d35-b5c6-3fbdd941423d |
例
成功レスポンス
JSONJSON
{
"KeyVersionId": "2ab1a983-7072-4bbc-a582-584b5bd8****",
"KeyId": "5c438b18-05be-40ad-b6c2-3be6752c****",
"CiphertextBlob": "BQKP+1zK6+ZEMxTP5qaVzcsgXtWplYBKm0NXdSnB5FzliFxE1bSiu4dnEIlca2JpeH7yz1/S6fed630H+hIH6DoM25fTLNcKj+mFB0Xnh9m2+HN59Mn4qyTfcUeadnfCXSWcGBouhXFwcdd2rJ3n337bzTf4jm659gZu3L0i6PLuxM9p7mqdwO0cKJPfGVfhnfMz+f4alMg79WB/NNyE2lyX7/qxvV49ObNrrJbKSFiz8Djocaf0IESNLMbfYI5bXjWkJlX92DQbKhibtQW8ZOJ//ZC6t0AWcUoKL6QDm/dg5koQalcleRinpB+QadFm894sLbVZ9+N4GVsv1Wbjwg==",
"RequestId": "475f1620-b9d3-4d35-b5c6-3fbdd941423d"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | Rejected.UnsupportedOperation | Unsupported operation. | |
| 404 | Forbidden.AliasNotFound | The specified Alias is not found. | |
| 404 | Forbidden.KeyNotFound | The specified Key is not found. | アクセスキーが有効になっていません。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。