API 標準および多言語対応の SDK
本製品 (Kms/2016-01-20) の API は、RPC 標準に準拠した OpenAPI 仕様を採用しています。Alibaba Cloud には主要なプログラミング言語に対応した SDK が用意され、リクエスト署名のような手間がかかる手順を省略できます。そのため、開発者は HTTP 通信の詳細を意識することなく、各言語の構文で API を呼び出すことが可能になります。
カスタム署名
署名のカスタマイズが必要な場合、「署名メカニズム」を参照してリクエストに手動で署名できます。手動署名プロセスは非常に煩雑で、通常はおよそ 5 営業日かかります。詳細については、DingTalk サポート窓口 (グループチャット ID：147535001692) までお問い合わせください。
はじめに
Alibaba Cloud アカウント (root ユーザー) は最高レベルの管理権限を持ち、その AccessKey ペアが悪用されると、関連するすべてのリソースが不正にアクセスされ、重大なセキュリティリスクを引き起こす可能性があります。そのため、必要な場合以外は、Alibaba Cloud アカウントを使用しないでください。その代わりに、API のみでのアクセスを許可された Resource Access Management (RAM) ユーザーを作成し、RAM ポリシーを設定することで、最小権限の原則 (PoLP) を徹底してください。
API セキュリティを確保するには、以下を作成し、設定する必要があります。
RAM ユーザー
RAM ユーザー用の AccessKey ペア
サービス管理
|
API |
タイトル |
説明 |
| DescribeAccountKmsStatus | DescribeAccountKmsStatus | ご利用の Alibaba Cloud アカウントにおける Key Management Service (KMS) のステータスを照会します。 |
| OpenKmsService | OpenKmsService | Alibaba Cloud アカウントの Key Management Service (KMS) を有効にします。 |
インスタンス管理
|
API |
タイトル |
説明 |
| ListKmsInstances | ListKmsInstances | KMS インスタンスを一覧表示します。 |
| ConnectKmsInstance | ConnectKmsInstance | Key Management Service (KMS) インスタンスを有効化します。 |
| GetKmsInstance | GetKmsInstance | KMS インスタンスの詳細を取得します。 |
| UpdateKmsInstanceBindVpc | UpdateKmsInstanceBindVpc | Key Management Service (KMS) インスタンスに設定されている VPC (VPC) を更新します。 |
| ReleaseKmsInstance | ReleaseKmsInstance | 従量課金 KMS インスタンスを解放します。 |
| GetDefaultKmsInstance | GetDefaultKmsInstance | デフォルトの KMS インスタンスを取得します。 |
キー管理
|
API |
タイトル |
説明 |
| CreateKey | CreateKey | マスターキーを作成します。 |
| ListKeys | ListKeys | 現在のリージョンで、呼び出し元のマスターキーの ID をクエリします。 |
| DescribeKey | DescribeKey | キーの情報を照会します。 |
| UpdateKeyDescription | UpdateKeyDescription | キーの説明を更新します。 |
| EnableKey | EnableKey | キーを有効化し、データの暗号化と復号を可能にします。 |
| DisableKey | DisableKey | キーを無効化します。 |
| GetPublicKey | GetPublicKey | 非対称鍵の公開鍵を取得します。 公開鍵を使用して、デバイスでデータを暗号化したり、署名を検証したりできます。 |
| CreateAlias | CreateAlias | キーのエイリアスを作成します。 |
| ListAliases | ListAliases | 現在のリージョンにおける、現在のアカウントのすべてのエイリアスを照会します。 |
| ListAliasesByKeyId | ListAliasesByKeyId | キーにバインドされているすべてのエイリアスを照会します。 |
| DeleteAlias | DeleteAlias | エイリアスを削除します。 |
| UpdateAlias | UpdateAlias | 既存のエイリアスを別のカスタマーマスターキー (CMK) ID にバインドします。 |
| GetParametersForImport | GetParametersForImport | カスタマーマスターキー (CMK) のキーマテリアルをインポートするために使用されるパラメーターをクエリします。 |
| ImportKeyMaterial | ImportKeyMaterial | ImportKeyMaterial 操作を呼び出して、キーマテリアルをインポートします。 |
| DeleteKeyMaterial | DeleteKeyMaterial | インポートしたキーマテリアルを削除します。 |
| ScheduleKeyDeletion | ScheduleKeyDeletion | 指定されたカスタマーマスターキー (CMK) を削除します。 |
| CancelKeyDeletion | CancelKeyDeletion | カスタマーマスターキー (CMK) の削除タスクをキャンセルします。 |
| SetDeletionProtection | 削除保護の設定。 | カスタマーマスターキー (CMK) の削除保護を有効または無効にします。 |
| UpdateRotationPolicy | UpdateRotationPolicy | キーローテーションポリシーを更新します。 |
| DescribeKeyVersion | DescribeKeyVersion | キーバージョンの情報をクエリします。 |
| CreateKeyVersion | CreateKeyVersion | カスタマーマスターキー (CMK) のバージョンを作成します。 |
| ListKeyVersions | ListKeyVersions | キーのすべてのバージョンを照会します。 |
| SetKeyPolicy | SetKeyPolicy | KMS インスタンスのキーにキーポリシーを設定します。 |
| GetKeyPolicy | GetKeyPolicy | 指定されたキーのポリシーをクエリします。 |
暗号操作
|
API |
タイトル |
説明 |
| GenerateDataKey | GenerateDataKey | ローカルでデータを暗号化するために使用されるランダムなデータキーを生成します。 |
| GenerateAndExportDataKey | GenerateAndExportDataKey | この操作は、ランダムなデータキーを生成します。 データキーは、カスタマーマスターキー (CMK) と指定した公開キーを使用して暗号化されます。 この操作は、CMK によって暗号化されたデータキーの暗号文と、公開キーによって暗号化されたデータキーの暗号文を返します。 |
| Encrypt | Encrypt | 対称キーを使用してプレーンテキストを暗号文に暗号化します。 |
| Decrypt | Decrypt | 暗号文を復号します。 |
| ReEncrypt | ReEncrypt | 暗号文を再暗号化します。 この操作では、暗号文を復号化し、新しいマスターキーを使用してデータまたはデータキーを再暗号化します。 この操作は、再暗号化された暗号文を返します。 |
| ExportDataKey | ExportDataKey | 指定された公開鍵で暗号化されたデータキーをエクスポートします。 |
| GenerateDataKeyWithoutPlaintext | GenerateDataKeyWithoutPlaintext | ローカルデータ暗号化用のランダムなデータキーを生成します。 |
| AsymmetricSign | AsymmetricSign | 非対称キーでデータを署名します。 |
| AsymmetricVerify | AsymmetricVerify | 非対称キーを使用して署名を検証します。 |
| AsymmetricEncrypt | AsymmetricEncrypt | 非対称キーを使用してデータを暗号化します。 |
| AsymmetricDecrypt | AsymmetricDecrypt | 非対称キーを使用してデータを復号します。 |
| GenerateMac | HMAC メッセージ認証コードを生成します。 | 指定されたキーを使用して、メッセージの HMAC メッセージ認証コードを生成します。 |
| VerifyMac | HMAC メッセージ認証コードを検証します。 | 指定されたキーを使用して、特定のメッセージの HMAC メッセージ認証コードを検証します。 |
シークレット管理
|
API |
タイトル |
説明 |
| ListSecrets | ListSecrets | 現在のリージョン内のすべてのシークレットをクエリします。 |
| GetSecretValue | GetSecretValue | シークレットの値を取得します。 |
| BatchGetSecretValue | シークレットの値をバッチで取得します。 | シークレットの値をバッチで取得します。 |
| DeleteSecret | DeleteSecret | シークレットを削除します。 |
| CreateSecret | CreateSecret | シークレットを作成し、その初期バージョンを保存します。 |
| UpdateSecret | UpdateSecret | シークレットのメタデータを更新します。 |
| UpdateSecretVersionStage | UpdateSecretVersionStage | シークレットのバージョンステージを更新します。 |
| UpdateSecretRotationPolicy | UpdateSecretRotationPolicy | シークレットの回転ポリシーを更新します。 |
| DescribeSecret | DescribeSecret | シークレットのメタデータを照会します。 |
| ListSecretVersionIds | シークレットのすべてのバージョン情報を照会します。 | シークレットのすべてのバージョン情報を照会します。 |
| GetRandomPassword | GetRandomPassword | ランダムなパスワード文字列を取得します。 |
| PutSecretValue | PutSecretValue | 汎用シークレットの新しいバージョンのシークレット値を保存します。 |
| RestoreSecret | RestoreSecret | 削除済みのシークレットを復元します。 |
| RotateSecret | RotateSecret | 手動でシークレットを回転させます。 |
| SetSecretPolicy | SetSecretPolicy | KMS インスタンスのシークレットにシークレットポリシーを設定します。 |
| GetSecretPolicy | GetSecretPolicy | 指定された認証情報のアクセス ポリシーをクエリします。 |
タグ管理
|
API |
タイトル |
説明 |
| UntagResources | UntagResources | キーまたはシークレットからタグを削除します。 |
| TagResources | TagResources | キーまたはシークレットにタグを追加します。 |
| ListTagResources | ListTagResources | キーまたはシークレットのタグを照会します。 |
| GetKmsInstanceQuotaInfos | GetKmsInstanceQuotaInfos | KMS インスタンスのクォータ使用量と上限を照会します。 |
| ListResourceTags | ListResourceTags | カスタマーマスターキー (CMK) のタグを照会します。 |
| TagResource | TagResource | カスタマーマスターキー (CMK)、シークレット、または証明書にタグを追加します。 |
| UntagResource | UntagResource | マスターキー、認証情報、または証明書からタグをデタッチします。 |
アプリケーション管理
|
API |
タイトル |
説明 |
| CreateNetworkRule | CreateNetworkRule | Key Management Service (KMS) インスタンスへのアクセスを許可するプライベート IP アドレスまたはプライベート CIDR ブロックを設定するためのネットワークアクセスルールを作成します。 |
| ListNetworkRules | ListNetworkRules | ネットワークアクセスルールのリストを照会します。 |
| DescribeNetworkRule | DescribeNetworkRule | 指定されたネットワークルールの詳細を照会します。 |
| UpdateNetworkRule | UpdateNetworkRule | ネットワークコントロールルールを更新します。 |
| DeleteNetworkRule | DeleteNetworkRule | ネットワーク制御ルールを削除します。 |
| CreatePolicy | CreatePolicy | アクセスを許可するキーとシークレットを設定するための権限ポリシーを作成します。 |
| ListPolicies | ListPolicies | 権限ポリシーのリストを照会します。 |
| DescribePolicy | DescribePolicy | 権限ポリシーの詳細をクエリします。 |
| UpdatePolicy | UpdatePolicy | 権限ポリシーを更新します。 |
| DeletePolicy | DeletePolicy | 権限ポリシーを削除します。 |
| CreateApplicationAccessPoint | CreateApplicationAccessPoint | アプリケーションアクセスポイント (AAP) を作成します。 |
| ListApplicationAccessPoints | ListApplicationAccessPoints | アプリケーションアクセスポイント (AAP) のリストを照会します。 |
| DescribeApplicationAccessPoint | DescribeApplicationAccessPoint | アプリケーションアクセスポイント (AAP) を記述します。 |
| UpdateApplicationAccessPoint | UpdateApplicationAccessPoint | アプリケーションアクセスポイント (AAP) の情報を更新します。 |
| DeleteApplicationAccessPoint | DeleteApplicationAccessPoint | アプリケーションアクセスポイント (AAP) を削除します。 |
| CreateClientKey | CreateClientKey | クライアントキーを作成します。 |
| ListClientKeys | ListClientKeys | クライアントキーのリストを照会します。 |
| GetClientKey | GetClientKey | クライアントキーに関する情報を取得します。 |
| DeleteClientKey | DeleteClientKey | アプリケーション ID クレデンシャルである ClientKey を削除します。 |
その他
|
API |
タイトル |
説明 |
| DescribeRegions | DescribeRegions | 現在のアカウントのアクティブなリージョンについて説明します。 |
| GetManagedDataKey | 管理対象データキーのプレーンテキストを取得します。 | 管理対象データキー (DK) のプレーンテキストを取得します。 |
| ListManagedDataKeyVersions | 管理データキーのキーバージョンを一覧表示します。 | 指定された管理データキー (DK) のキーバージョンを一覧表示します。 |