ListEntitiesForPolicy - 获取策略关联的实体列表--访问控制-火山引擎

文档中心

立即注册

导航

ListEntitiesForPolicy - 获取策略关联的实体列表

最近更新时间：2024.09.14 14:54:46首次发布时间：2021.02.23 10:42:33

获取指定策略所绑定的身份列表（包含用户、用户组或角色）。

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListEntitiesForPolicy	要执行的操作，取值：ListEntitiesForPolicy。
Version	String	是	2018-01-01	API的版本，取值：2018-01-01。
PolicyName	String	是	ECSFullAccess	策略名。
PolicyType	String	是	System	策略类型。System代表系统预设策略，Custom代表自定义策略。
EntityFilter	String	否	User	按身份类型筛选。User代表筛选绑定的用户，Role代表筛选绑定的角色，UserGroup代表筛选绑定的用户组。不传递时代表不按身份类型筛选，即获取策略所绑定的所有类型身份。
Limit	Integer	否	10	分页条数，默认为10。
Offset	Integer	否	0	分页起始索引，默认为0。

返回参数

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

参数	类型	示例值	描述
PolicyUsers	Array of Object	请参考数据结构内具体参数示例值。	策略绑定的用户列表，EntityFilter按User筛选或不筛选时返回。
PolicyUserGroups	Array of Object	请参考数据结构内具体参数示例值。	策略绑定的用户组列表，EntityFilter按UserGroup筛选或不筛选时返回。
PolicyRoles	Array of Object	请参考数据结构内具体参数示例值。	策略绑定的角色列表，EntityFilter按Role筛选或不筛选时返回。
Limit	Integer	10	分页条数。
Offset	Integer	0	分页起始索引。
Total	Integer	20	总数。

请求示例

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240912173154118254082022E9B144",
    "Action": "ListEntitiesForPolicy",
    "Version": "2018-01-01",
    "Service": "iam",
    "Region": "cn-beijing"
  },
  "Result": {
    "PolicyUsers": [
      {
        "Id": 10000,
        "UserName": "Bob",
        "DisplayName": "鲍勃",
        "Description": "鲍勃",
        "AttachDate": "20240820T131043Z",
        "PolicyScope": [
          {
            "PolicyScopeType": "Global",
            "ProjectName": "",
            "ProjectDisplayName": "",
            "AttachDate": "20240820T131043Z"
          }
        ]
      }
    ],
    "PolicyUserGroups": [
      {
        "Id": 20000,
        "UserGroupName": "dev-group",
        "DisplayName": "开发组",
        "Description": "开发组",
        "AttachDate": "20220820T131043Z",
        "PolicyScope": [
          {
            "PolicyScopeType": "Project",
            "ProjectName": "game-project",
            "ProjectDisplayName": "游戏项目",
            "AttachDate": "20220820T131043Z"
          }
        ]
      }
    ],
    "PolicyRoles": [
      {
        "Id": 30000,
        "RoleName": "ops-role",
        "DisplayName": "运维角色",
        "Description": "运维角色",
        "AttachDate": "20230820T131043Z",
        "PolicyScope": [
          {
            "PolicyScopeType": "Global",
            "ProjectName": "",
            "ProjectDisplayName": "",
            "AttachDate": "20230820T131043Z"
          }
        ]
      }
    ],
    "Limit": 10,
    "Offset": 0,
    "Total": 3
  }
}

错误码

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