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

Key Management Service:機能別操作一覧

最終更新日:Feb 12, 2025

次の表に、Key Management Service (KMS) で使用できるAPI操作の一覧を示します。

主なサービス操作

  • CMK管理

    顧客マスターキー (CMK) 管理操作は、CMKの作成と変更、およびライフサイクルの管理に使用されます。

    操作

    説明

    CreateKey

    CMK を作成します。 KMSで作成したキーマテリアルを使用するか、外部キーマテリアルをCMKにインポートできます。 外部キーマテリアルのインポートは、Bring Your Own Key (BYOK) と呼ばれます。 この操作はBYOKの最初のステップです。

    GetParametersForImport

    インポートするキーマテリアルを照会します。この操作はBYOKの2番目のステップです。

    ImportKeyMaterial

    キーマテリアルをCMKにインポートします。 この操作はBYOKの最終ステップです。

    EnableKey

    CMKのステータスを有効に変更します。

    DisableKey

    CMKのステータスを無効に変更します。

    SetDeletionProtection

    CMKの削除保護を有効または無効にします。

    ScheduleKeyDeletion

    CMKの削除をスケジュールします。 この操作を呼び出すと、CMKは [削除保留中] 状態になります。 CMKは、指定された待機期間が経過すると自動的に削除されます。

    CancelKeyDeletion

    CMK のスケジュールされた削除をキャンセルします。 指定された待機期間が経過する前に、CMKのスケジュールされた削除をキャンセルできます。 スケジュールされた削除がキャンセルされると、CMKは再び有効状態になります。

    DeleteKeyMaterial

    CMKのキーマテリアルを削除します。 外部ソースからインポートされたキーマテリアルを直接削除できます。 CMKのキーマテリアルが削除されると、CMKはPending Import状態になります。

    DescribeKey

    CMKに関する情報を照会します。

    ListKeys

    現在のリージョンの現在のAlibaba CloudアカウントのすべてのCMKを照会します。

    UpdateKeyDescription

    CMK の説明を更新します。

  • キーのバージョン管理

    キーバージョン管理の操作は、CMKの回転に使用されます。

    操作

    説明

    DescribeKeyVersion

    キーバージョンに関する情報を照会します。

    ListKeyVersions

    CMKのすべてのキーバージョンを照会します。

    UpdateRotationPolicy

    対称CMKのローテーションポリシーを更新します。 自動ローテーションが有効になっている場合、KMSは定期的にキーバージョンを自動的に生成します。

    CreateKeyVersion

    CMKのキーバージョンを作成します。 この操作は、非対称CMKでのみ使用できます。

  • 暗号化操作

    データの暗号化や復号化など、データに対して暗号化操作を実行できます。 次の表の操作は、暗号操作を実行するために使用されます。

    操作

    説明

    Encrypt

    特定のCMKを使用してデータを暗号化します。 この操作は、オンラインで6 KB以下のデータを暗号化するために使用されます。

    GenerateDataKey

    乱数を生成し、特定のCMKで乱数を暗号化します。 乱数の暗号文と平文が返されます。 乱数は、大量のローカルデータを暗号化または復号化するためのデータ鍵として使用することができる。

    GenerateDataKeyWithoutPlaintext

    乱数を生成し、特定のCMKで乱数を暗号化します。 乱数の暗号文のみが返されます。 乱数は、大量のローカルデータを暗号化または復号化するためのデータ鍵として使用することができる。

    ExportDataKey

    特定の公開キーを使用してデータキーを暗号化し、データキーをエクスポートします。

    GenerateAndExportDataKey

    ランダムなデータキーを生成し、特定のCMKと公開キーを使用してデータキーを暗号化し、CMKを使用して生成された暗号文と公開キーを使用して生成された暗号文を返します。

    Decrypt

    EncryptまたはGenerateDataKey操作を呼び出して生成された暗号文を復号します。 復号化のためにCMKを指定する必要はありません。

    ReEncrypt

    暗号文を再暗号化します。 この操作を呼び出すと、KMSは最初に指定された暗号文を復号し、次に別のCMKを使用して生成された平文またはデータキーを暗号化します。 暗号文が返されます。

    非対称性サイン

    非対称CMKの秘密鍵を使用してデジタル署名を生成します。

    非対称性検証

    非対称CMKの公開鍵を使用して、秘密鍵を使用して生成されたデジタル署名を検証します。

    非対称性Decrypt

    非対称CMKの秘密鍵を使用して、公開鍵を使用して暗号化されたデータを復号化します。

    非対称性暗号化

    非対称CMKの公開鍵を使用してデータを暗号化します。

    GetPublicKey

    非対称CMKの公開キーを照会します。 公開鍵を使用して、データを暗号化したり、デジタル署名をオフラインで検証したりできます。

  • エイリアス管理

    エイリアスはKMSでは独立したオブジェクトです。 エイリアスは一意のCMKにバインドする必要があります。 特定の操作でKeyIdパラメーターをエイリアスに設定して、CMKを指定できます。

    操作

    説明

    CreateAlias

    エイリアスを作成し、CMK にバインドします。

    UpdateAlias

    既存のエイリアスを別のCMK IDにバインドします。

    DeleteAlias

    エイリアスを削除します。

    ListAliases

    現在のリージョンの現在のAlibaba Cloudアカウントのすべてのエイリアスを照会します。

    ListAliasesByKeyId

    特定のCMKにバインドされているすべてのエイリアスを照会します。

Secrets Managerの操作

Secrets Manager操作は、シークレットの管理、保護、配布、およびローテーションに使用されます。

操作

説明

CreateSecret

シークレットを作成し、初期バージョンでシークレット値を格納します。

ListSecrets

現在のリージョンの現在のAlibaba Cloudアカウントのすべてのシークレットを照会します。

DeleteSecret

シークレットを削除します。

DescribeSecret

シークレットのメタデータを照会します。

GetSecretValue

シークレット値を照会します。

PutSecretValue

新しいバージョンのシークレット値をシークレットに格納します。

UpdateSecret

シークレットのメタデータを更新します。

UpdateSecretVersionStage

シークレットバージョンをマークするステージラベルを更新します。

RestoreSecret

削除されたシークレットを復元します。

ListSecretVersionIds

シークレットのすべてのバージョンを照会します。

GetRandomPassword

ランダムなパスワード文字列を照会します。

証明書の操作

証明書操作は、証明書の作成、削除、更新、およびクエリに使用されます。 証明書操作は、証明書の署名を検証するためにも使用されます。

操作

説明

CreateCertificate

証明書を作成します。

UploadCertificate

認証局 (CA) によって発行された証明書と証明書チェーンをCertificates Managerにインポートします。

GetCertificate

Certificates Managerによって管理される証明書を照会します。

DescribeCertificate

証明書に関する情報を照会します。

UpdateCertificateStatus

証明書のステータスを更新します。

DeleteCertificate

証明書と、証明書の秘密鍵と証明書チェーンを削除します。

CertificatePrivateKeySign

特定の証明書を使用してデジタル署名を生成します。

CertificatePublicKeyVerify

特定の証明書を使用してデジタル署名を検証します。

CertificatePublicKeyEncrypt

特定の証明書を使用してデータを暗号化します。

CertificatePrivateKeyDecrypt

特定の証明書を使用してデータを復号します。

タグ管理操作

CMK はタグをサポートしています。 複数のタグを CMK に追加できます。 タグは、 TagKey TagValue のペアで定義されます。

操作

説明

TagResource

CMKまたはシークレットの既存のタグにタグを追加または変更します。

UntagResource

CMKまたはシークレットからタグを削除します。

ListResourceTags

CMKまたはシークレットのすべてのタグを照会します。

その他の操作

操作

説明

DescribeRegions

現在のAlibaba Cloudアカウントで利用可能なリージョンを照会します。

OpenKmsService

現在のAlibaba CloudアカウントのKMSを有効化します。

DescribeAccountKmsStatus

現在のAlibaba CloudアカウントのKMSのステータスを照会します。