全部產品
Search
文件中心

Key Management Service:GetKeyPolicy - 查詢密鑰策略

更新時間:Jul 29, 2025

查詢指定密鑰的密鑰策略。

介面說明

  • RAM 使用者或 RAM 角色調用該 OpenAPI 需要被授與權限策略詳情,請參見存取控制

  • 由於密鑰策略名稱稱僅支援設定為 default,因此查詢時密鑰策略名稱稱(PolicyName)僅支援輸入 default,否則會提示Not Found

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

KeyId

string

金鑰識別碼 或密鑰資源名稱(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. 策略找不到。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情