KMS で使用可能な API 操作については、下表をご参照ください。 詳細は、OpenAPI Explorer をご参照ください。
Alibaba Cloud は、API の学習およびコマンドラインの自動化を目的としたコマンドラインツールも提供しています。 コマンドラインツールのインストールおよび使用方法に関する詳細については、「」「Alibaba Cloud CLI」「」をご参照ください。
キー管理
キー管理の API 操作は、キーの作成と変更、およびライフサイクルの管理に使用されます。
| 操作 | 説明 |
|---|---|
| CreateKey | CMK を作成します。 KMS でキーマテリアルを生成するか、または独自のキーマテリアルをアップロードすることもできます。 Bring Your Own Key (BYOK) を作成する最初のステップは CreateKey です。 |
| GetParametersForImport | BYOK を作成する 2 番目のステップである、キーマテリアルの取得をします。 |
| ImportKeyMaterial | BYOK を作成する最終ステップである、 CMK へのキーマテリアルのインポートをします。 |
| EnableKey | キーのステータスを [有効] に変更します。 |
| DisableKey | キーのステータスを [無効] に変更します。 |
| ScheduleKeyDeletion | キーの削除をスケジュールします。 キーのステータスが [削除待ち] に変わります。 [削除待ち] 状態の CMK は、スケジュールされた期間が終了すると削除されます。 |
| CancelKeyDeletion | CMK のスケジュールされた削除をキャンセルします。 スケジュールされた削除リクエストは、送信後でも、スケジュールされた期間の終了前はキャンセルできます。 スケジュールされた削除がキャンセルされた後、CMK は [有効] 状態に戻ります。 |
| DeleteKeyMaterial | CMK のキーマテリアルを削除します。 BYOK のキーマテリアルを直接削除できます。 キーマテリアルの削除後、BYOK は [インポート待ち] 状態になります。 |
| DescribeKey | 指定された CMK の詳細情報を照会します。 |
| ListKeys | 現在の Alibaba Cloud アカウントに属する現在のリージョン内のすべての CMK を一覧表示します。 |
| UpdateKeyDescription | CMK の説明を更新します。 |
キーバージョン管理
キーバージョン管理の API 操作は、CMK ローテーションに使用されます。
| 操作 | 説明 |
|---|---|
| DescribeKeyVersion | キーバージョンを照会します。 |
| ListKeyVersions | 指定された CMK のすべてのキーバージョンを一覧表示します。 |
| UpdateRotationPolicy | CMK ローテーションポリシーを更新します。 自動ローテーションが有効になっている場合、KMS は定期的に新しいキーバージョンを自動生成します。 |
キー操作
キー操作の API 操作は、暗号化や復号化などのキーを含むデータ操作を実行するために使用されます。
| 操作 | 説明 |
|---|---|
| Encrypt | 指定された CMK を使用してデータを暗号化します。 この操作は、6 KB 以下のデータのオンライン暗号化に使用されます。 |
| GenerateDataKey | 乱数を生成します。 指定された CMK で乱数が暗号化された後、その暗号化テキストとプレーンテキストが返されます。 この乱数は、ローカルで大量のデータを暗号化または復号化するためのデータキーとして使用できます。 |
| GenerateDataKeyWithoutPlaintext | 乱数を生成します。 指定された CMK で乱数が暗号化された後、その暗号テキストが返されます。 この乱数は、ローカルで大量のデータを暗号化または復号化するためのデータキーとして使用できます。 |
| Decrypt | Encrypt または GenerateDataKey API 操作で生成された暗号テキストを複合化します。 復号化のために CMK を指定する必要はありません。 |
エイリアス管理
エイリアスとは、一意の CMK にバインドされる必要のある、独立したオブジェクトを指します。 これを使用して CMK の KeyId を置き換えることができます。
| 操作 | 説明 |
|---|---|
| CreateAlias | エイリアスを作成し、CMK にバインドします。 |
| UpdateAlias | 指定したエイリアスを新しい CMK にバインドします。 |
| DeleteAlias | 指定のエイリアスを削除します。 |
| ListAliases | 現在のリージョンの Alibaba Cloud アカウントのすべてのエイリアスを一覧表示します。 |
| ListAliasesByKeyId | 指定された CMK にバインドされているすべてのエイリアスを一覧表示します。 |
タグの管理
CMK はタグをサポートしています。 複数のタグを CMK に追加できます。 タグは、 TagKey と TagValue のペアで定義されます。
| 操作 | 説明 |
|---|---|
| TagResource | CMK のタグを追加または変更します。 |
| UntagResource | CMK の指定されたタグを削除します。 |
| ListResourceTags | CMK のすべてのタグを一覧表示します。 |