ListPolicies - 获取策略列表--访问控制-火山引擎

文档中心

立即注册

导航

ListPolicies - 获取策略列表

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

获取全部策略列表（包含系统预设策略和自定义策略）。

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListPolicies	要执行的操作，取值：ListPolicies。
Version	String	是	2018-01-01	API的版本，取值：2018-01-01。
Scope	String	否	System	策略类型筛选。All代表全部策略类型，System代表系统预设策略，Custom代表自定义策略。默认值为All。
WithServiceRolePolicy	Integer	否	0	是否返回服务关联角色的策略。0代表不返回，1代表返回。默认值为0。
Limit	Integer	否	10	分页条数，默认为10。
Offset	Integer	否	0	分页起始索引，默认为0。

返回参数

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

参数	类型	示例值	描述
PolicyMetadata	Array of Object	请参考数据结构内具体参数示例值。	策略的数据结构。
Limit	Integer	10	分页条数。
Offset	Integer	0	分页起始索引。
Total	Integer	20	总数。

请求示例

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240912220125192218098218160B84",
    "Action": "ListPolicies",
    "Version": "2018-01-01",
    "Service": "iam",
    "Region": "cn-beijing"
  },
  "Result": {
    "PolicyMetadata": [
      {
        "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"
      }
    ],
    "Limit": 10,
    "Offset": 0,
    "Total": 1
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。