GetPolicy - 查询策略详情--访问控制-火山引擎

文档中心

立即注册

导航

GetPolicy - 查询策略详情

最近更新时间：2024.09.18 21:13:56首次发布时间：2021.02.23 10:42:33

查询指定策略的详情信息。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	GetPolicy	要执行的操作，取值：GetPolicy。
Version	String	是	2018-01-01	API的版本，取值：2018-01-01。
PolicyName	String	是	IAMFullAccess	策略名。
PolicyType	String	是	System	策略类型。System代表系统策略，Custom代表自定义策略。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Policy	Object	请参考数据结构内具体参数示例值。	策略的数据结构。

请求示例

GET /?Action=GetPolicy&Version=2018-01-01&PolicyName=IAMFullAccess&PolicyType=System HTTP/1.1
Host: iam.volcengineapi.com
X-Date: 20240912T084639Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240912/cn-beijing/iam/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240912164649013247139224FB4A02",
    "Action": "GetPolicy",
    "Version": "2018-01-01",
    "Service": "iam",
    "Region": "cn-beijing"
  },
  "Result": {
    "Policy": {
      "PolicyName": "IAMFullAccess",
      "PolicyTrn": "trn:iam::2000000000:policy/IAMFullAccess",
      "PolicyType": "System",
      "Description": "访问控制（IAM）完全管理权限",
      "PolicyDocument": "{\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iam:*\"],\"Resource\":[\"*\"]}]}",
      "Category": "iam",
      "AttachmentCount": "10",
      "IsServiceRolePolicy": 0,
      "CreateDate": "20220912T061318Z",
      "UpdateDate": "20220912T061318Z"
    }
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidPolicyType	Invalid PolicyType '%s', err: '%s'
404	PolicyNotExist	Policy '%s' does not exist or is not attachable.