GetKeyPolicy - 查询密钥策略

查询指定密钥的密钥策略。

接口说明

  • RAM 用户或 RAM 角色调用该 OpenAPI 需要被授予的权限策略详情,请参见访问控制

  • 由于密钥策略名称仅支持设置为 default,因此查询时密钥策略名称(PolicyName)仅支持输入 default,否则会提示Not Found

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

KeyId

string

密钥 ID 或密钥资源名称(ARN)。

说明

访问其他阿里云账号下的密钥时,必须输入密钥 ARN。密钥 ARN 的格式为acs:kms:${region}:${account}:key/${keyid}

key-hzz630494463ejqjx****

PolicyName

string

密钥策略名称。仅支持固定值 default。

default

返回参数

名称

类型

描述

示例值

object

RequestId

string

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

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

Policy

string

密钥策略。

{"Statement": [{"Action": ["kms:*"],"Effect": "Allow","Principal": {"RAM": ["acs:ram::190325303126****:*","acs:ram::119285303511****:*"]},"Resource": ["*"],"Sid": "kms default key policy"}],"Version": "1" }

示例

正常返回示例

JSON格式

{
  "RequestId": "381D5D33-BB8F-395F-8EE4-AE3B84B523C8",
  "Policy": "{\"Statement\": [{\"Action\": [\"kms:*\"],\"Effect\": \"Allow\",\"Principal\": {\"RAM\": [\"acs:ram::190325303126****:*\",\"acs:ram::119285303511****:*\"]},\"Resource\": [\"*\"],\"Sid\": \"kms default key policy\"}],\"Version\": \"1\" }"
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameter The specified parameter is not valid. 参数非法。
400 MissingParameter The parameter needed but no provided. 需要的参数未提供
400 Forbidden.NoPermission This operation is forbidden by permission system. 该操作无权限
400 Forbidden.KeyPolicyUnSupported The specified key does not support key policy. 指定的密钥不支持密钥策略。
404 Forbidden.KeyNotFound The specified Key is not found. 指定的密钥不存在。
404 Forbidden.ResourceNotFound Policy not found. 策略找不到。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情