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

:API概要

最終更新日:Feb 07, 2025

このトピックでは、Key Management Service (KMS) のすべてのOpenAPI操作を一覧表示します。

サービス管理

API

説明

DescribeRegions

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

OpenKmsService

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

DescribeAccountKmsStatus

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

インスタンス管理

API

説明

ConnectKmsInstance

KMSインスタンスを有効にします。

GetKmsInstance

KMSインスタンスの詳細を照会します。

ListKmsInstances

KMSインスタンスのリストを照会します。

UpdateKmsInstanceBindVpc

KMSインスタンスに関連付けられた仮想プライベートクラウド (VPC) を更新します。

キー管理

キーとエイリアスの作成や削除など、次のAPIを呼び出してキーを管理します。

API

説明

CreateKey

キーを作成します。 KMSによって生成されたキーマテリアルを使用するか、独自のキーマテリアルをインポートできます。 独自のキーマテリアルをインポートすることは、Bring your own key (BYOK) として知られています。

GetParametersForImport

キーマテリアルをキーにインポートするために使用されるパラメータを照会します。

ImportKeyMaterial

キーマテリアルをキーにインポートします。

EnableKey

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

DisableKey

キーのステータスをDisabledに変更します。

DescribeKey

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

リストキー

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

UpdateKeyDescription

キーの説明を更新します。

CreateAlias

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

UpdateAlias

エイリアスにバインドされているキーのIDを更新します。

DeleteAlias

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

ListAliases

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

ListAliasesByKeyId

キーにバインドされているエイリアスを照会します。

SetDeletionProtection

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

ScheduleKeyDeletion

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

CancelKeyDeletion

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

DeleteKeyMaterial

キーマテリアルを削除します。

重要

削除できるのは、デフォルトキーとして使用されている顧客マスターキー (CMK) の外部キーマテリアルのみです。

CreateKeyVersion

バージョンを作成します。 ソフトウェアキー管理タイプのKMSインスタンスの対称キーは、この操作をサポートしています。 KMS外部の非対称キーはこの操作をサポートします。

DescribeKeyVersion

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

ListKeyVersions

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

UpdateRotationPolicy

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

暗号化操作

データの暗号化、データキーの生成、データの復号化、署名の計算など、KMSキーを使用してデータに対して暗号化操作を実行します。

API

説明

暗号化

対称キーを使用して、平文を暗号文に暗号化します。

GenerateDataKey

オンプレミスデータの暗号化に使用されるランダムなデータキーを生成します。

GenerateDataKeyWithoutPlaintext

オンプレミスのデータを暗号化するために使用できるランダムなデータキーを生成します。

ExportDataKey

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

GenerateAndExportDataKey

ランダムなデータキーを生成します。 データキーは、指定したKMSキーと公開キーを使用して暗号化されます。 この操作は、KMSキーと公開キーの両方で暗号化されたデータキーの暗号文を返します。

解読

暗号文を復号化します。

ReEncrypt

暗号文を再暗号化します。 この操作を呼び出すと、KMSは暗号文を復号し、別のキーを使用して生成された平文またはデータキーを再暗号化し、新しい暗号文を返します。

非対称性サイン

非対称キーを使用して署名を生成します。

非対称性検証

非対称キーを使用して署名を検証します。

AsymmetricDecrypt

非対称キーを使用してデータを復号化します。

AsymmetricEncrypt

非対称キーを使用してデータを暗号化します。

GetPublicKey

非対称キーペアの公開キーを照会します。 公開鍵を使用して、ローカルデータを暗号化し、署名を検証できます。

秘密管理

API操作を呼び出してシークレットを管理、保護、配布、およびローテーションします。

API

説明

CreateSecret

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

ListSecrets

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

DescribeSecret

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

UpdateSecret

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

PutSecretValue

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

説明

ジェネリックシークレットのみがこの操作をサポートしています。

UpdateSecretVersionStage

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

説明

ジェネリックシークレットのみがこの操作をサポートしています。

DeleteSecret

シークレットの削除を削除またはスケジュールします。

RestoreSecret

削除予定のシークレットを復元します。

ListSecretVersionIds

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

GetRandomPassword

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

RotateSecret

秘密を手動で回転させます。

UpdateSecretRotationPolicy

シークレットのローテーションポリシーを更新します。

シークレット値の取得

GetSecretValue: シークレット値を取得します。

タグの管理

複数のタグをキーまたはシークレットに追加します。各タグはタグキーとタグ値を含みます。

説明

TagResourceUntagResource、およびListResourceTagsは、単一のリソースに対する操作を許可します。 TagResourcesUntagResources、およびListTagResourcesは、複数のリソースに対するバッチ操作を有効にします。

API

説明

TagResource

キーまたはシークレットにタグを追加します。

UntagResource

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

ListResourceTags

キーのすべてのタグを照会します。

TagResources

複数のキーまたはシークレットにタグを追加します。

UntagResources

一度に複数のキーまたはシークレットからタグを削除します。

ListTagResources

複数のキーまたはシークレットのすべてのタグまたは特定のタグを一度に照会します。

アプリケーション管理

API

説明

CreateNetworkRule

KMSインスタンスへのアクセスを許可するプライベートIPアドレスまたはCIDRブロックを設定するためのアクセス制御ルールを作成します。

DeleteNetworkRule

ネットワークアクセスルールを削除します。

DescribeNetworkRule

ネットワークアクセスルールの詳細を照会します。

ListNetworkRules

ネットワークアクセスルールのリストを照会します。

UpdateNetworkRule

ネットワークアクセスルールを更新します。

CreatePolicy

アプリケーションがアクセスできるキーとシークレットを構成する権限ポリシーを作成します。

DeletePolicy

権限ポリシーを削除します。

DescribePolicy

権限ポリシーの詳細を照会します。

UpdatePolicy

権限ポリシーを更新します。

ListPolicies

権限ポリシーのクエリを実行します。

CreateApplicationAccessPoint

アプリケーションアクセスポイント (AAP) を作成します。

DeleteApplicationAccessPoint

AAPを削除します。

DescribeApplicationAccessPoint

AAPの詳細を照会します。

ListApplicationAccessPoints

AAPのリストを照会します。

UpdateApplicationAccessPoint

AAPに関する情報を更新します。

CreateClientKey

クライアントキーを作成します。

DeleteClientKey

クライアントキーを削除します。

ListClientKeys

クライアントキーのリストを照会する

GetClientKey

クライアントキーに関する情報を照会します。