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

:SetKeyPolicy

最終更新日:Jul 29, 2025

KMS インスタンスのキーにキーポリシーを設定します。

操作説明

  • RAM ユーザーまたは RAM ロールがこの API 操作を呼び出すために必要なアクセス ポリシーについては、「リソースアクセス管理」をご参照ください。

  • キーポリシーの詳細については、「キーポリシーの概要」をご参照ください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター

タイプ

必須 / 任意

説明

KeyId

string

必須

キーの ID または Alibaba Cloud リソースネーム (ARN)。

説明

別の Alibaba Cloud アカウントのキーにアクセスするには、キーの ARN を指定する必要があります。キー ARN の形式は acs:kms:${region}:${account}:key/${keyid} です。

key-hzz630494463ejqjx****

PolicyName

string

任意

キーポリシーの名前。名前は `default` のみ可能です。

default

Policy

string

必須

キーポリシー。ポリシーは JSON 形式です。ポリシーの長さは最大 32,768 バイトです。

キーポリシーには、次の要素が含まれています。

  • Version: キーポリシーのバージョン。値は 1 のみ可能です。

  • Statement: キーポリシーのステートメント。各キーポリシーには、1 つ以上のステートメントを含めることができます。

次のコードは、キーポリシーの例を示しています。

{
    "Version": "1",
    "Statement": [
        {
            "Sid": "Enable RAM User Permissions", // RAM ユーザー権限の有効化
            "Effect": "Allow", // 許可
            "Principal": {
              "RAM": ["acs:ram::112890462****:*"]
            },
            "Action": [
                "kms:*"
            ],
            "Resource": [
                "*"
            ]
        }
    ]
}

次のセクションでは、Statement の要素について説明します。

  • Sid: オプション。カスタムステートメント ID。値の長さは最大 128 文字で、大文字、小文字、数字、および次の特殊文字を含めることができます: _ / + = . @ -。

  • Effect: 必須。ポリシーステートメントの効果。有効な値: Allow および Deny。

  • Principal: 必須。キーへのアクセスを承認されているプリンシパル。このパラメーターは、現在の Alibaba Cloud アカウント、現在の Alibaba Cloud アカウントの RAM ユーザーまたは RAM ロール、または別の Alibaba Cloud アカウントの RAM ユーザーまたは RAM ロールに設定できます。

  • Action: 必須。許可または拒否される API 操作。値は kms: で始まる必要があります。操作の詳細については、「キーポリシーの概要」をご参照ください。リストに含まれていない操作を指定した場合、その操作は有効になりません。

  • Resource: 必須。キー。値は * のみ可能です。

  • Condition: オプション。ポリシーを有効にするための条件。条件を使用して API リクエストのコンテキストを評価し、ポリシーステートメントが適用可能かどうかを判断できます。形式は "Condition": {"condition operator": {"condition key": "condition value"}} です。詳細については、「キーポリシーの概要」をご参照ください。

説明

別の Alibaba Cloud アカウントの RAM ユーザーまたは RAM ロールに権限を付与した後、RAM ユーザーまたは RAM ロールが属する Alibaba Cloud アカウントを使用して、RAM コンソールでキーを使用するための権限を RAM ユーザーまたは RAM ロールに付与する必要があります。詳細については、「KMS のカスタムポリシー」、「RAM ユーザーへの権限の付与」、および「RAM ロールへの権限の付与」をご参照ください。

{"Statement":[{"Action":["kms:*"],"Effect":"Allow","Principal":{"RAM":["acs:ram::119285303511****:*"]},"Resource":["*"],"Sid":"kms default key policy"},{"Action":["kms:List*","kms:Describe*","kms:Create*","kms:Enable*","kms:Disable*","kms:Get*","kms:Set*","kms:Update*","kms:Delete*","kms:Cancel*","kms:TagResource","kms:UntagResource","kms:ImportKeyMaterial","kms:ScheduleKeyDeletion"],"Effect":"Allow","Principal":{"RAM":["acs:ram::119285303511****:user/for_test_policy"]},"Resource":["*"]}],"Version":"1"}

レスポンスパラメーター

パラメーター

タイプ

説明

object

RequestId

string

リクエスト ID。Alibaba Cloud によって生成される一意の識別子です。この ID を使用して問題のトラブルシューティングを行うことができます。

381D5D33-BB8F-395F-8EE4-AE3BB4B523C8

成功レスポンス

JSONJSON

{
  "RequestId": "381D5D33-BB8F-395F-8EE4-AE3BB4B523C8"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 MissingParameter The parameter needed but no provided.
400 InvalidParameter The specified parameter is not valid.
400 Forbidden.NoPermission This operation is forbidden by permission system.
400 Forbidden.KeyPolicyUnSupported The specified key does not support key policy.
400 Rejected.ShareQuotaExceedLimit Instance Share Quota Exceed Limit.
500 InternalFailure Internal Failure
403 Forbidden.DKMSInstanceStateInvalid The DKMS instance state is invalid.
404 Forbidden.KeyNotFound The specified Key is not found. アクセスキーが有効になっていません。
404 Forbidden.ResourceNotFound Policy not found.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。