GetKeyPolicy_密钥管理服务(KMS)-阿里云帮助中心

说明由于密钥策略名称仅支持设置为default，因此查询时密钥策略名称（PolicyName）仅支持输入default，否则会提示Not Found。

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	GetKeyPolicy	要执行的操作。取值：GetKeyPolicy。
KeyId	String	是	key-hzz630494463ejqjx****	密钥ID或密钥资源名称（ARN）。说明访问其他阿里云账号下的密钥时，必须输入密钥ARN。密钥ARN的格式为`acs:kms:${region}:${account}:key/${keyid}`。
PolicyName	String	否	default	密钥策略名称。仅支持固定值default。

返回数据

名称	类型	示例值	描述
RequestId	String	381D5D33-BB8F-395F-8EE4-AE3B84B523C8	本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。
Policy	String	{"Statement": [{"Action": ["kms:"],"Effect": "Allow","Principal": {"RAM": ["acs:ram::190325303126**:","acs:ram::119285303511***:"]},"Resource": ["*"],"Sid": "kms default key policy"}],"Version": "1" }	密钥策略。

示例

请求示例

http(s)://[Endpoint]/?Action=GetKeyPolicy
&KeyId=key-hzz630494463ejqjx****
&PolicyName=default
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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\" }"
}

错误码

HttpCode	错误码	错误信息	描述
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.	策略找不到。

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