查询策略附加实体列表

文档中心 >

下载PDF文档

查询策略关联实体列表（ListEntitiesForPolicy）

描述

查询策略附加到关联实体列表

注1：由于列表可能很长，因此可使用MaxItems和Marker来进行分页截断显示。

注2：金山云IAM一期目前支持IAM用户一种关联实体，因此结果只返回一种关联实体类型。

返回API概览

请求参数

名称	类型	必须	长度限制(字符)	参数格式	描述
Action	String	是	确定值	`[a-zA-Z]+`	操作接口名，系统规定参数，取值：ListEntitiesForPolicy
PathPrefix	String	否	最短1,最长512	`\/[:graph:]*`	可选参数，用于过滤关联实体列表（目前只有用户一种类型的实体），如果未传入则默认值是`/`
Marker	String	否	最短1,最长320	`[:graph:]+`	当返回结果被截断时，使用本次返回的Marker值用于标示下次调用查询关联实体操作的起始点
MaxItems	Integer	否	最小值1，最大值1000，默认100		用于限制本次查询结果返回的关联实体数量，如果仍有额外关联实体未显示，则返回元素中的IsTruncated的值会被设置为true，同时返回下次查询的起始点Marker值
PolicyKrn	String	是	最短是25,最长2048	格式：krn:ksc:iam::account-id:policy/policy-name	待查询关联实体的策略标识

返回元素（调用成功）

名称	类型	描述
IsTruncated	Boolean	截断标志位，用于说明是否仍有更多的关联实体未显示全
Marker	String	如果截断标志位是true，Marker值被设定，用于标识下次查询的起始点
PolicyUsers	PolicyUserType List	策略关联用户信息列表

错误码（调用不成功）

错误代码(Code)	错误消息(Message)	HTTP 状态码	中文描述（语义）
InvalidParameterValue	An value must be supplied for the input parameter %s.	400	输入参数%s的值不能为空，具体参数名在%s说明
InvalidParameterValue	An invalid or out-of-range value was supplied for the input parameter %s.	400	输入参数 %s的值无效、不合法或者超出范围，具体参数名在%s说明
PolicyNoSuchEntity	The request was rejected because it referenced 'Policy' that does not exist.	404	请求被拒绝，因其引用的“策略”不存在

示例（调用成功）

请求示例

https://iam.api.ksyun.com/?Action=ListEntitiesForPolicy
&PolicyKrn=krn:ksc:iam::12345678901234567890:policy/IAMadmin
&公共请求参数

返回示例

XML格式

<ListEntitiesForPolicyResponse>
    <ListEntitiesForPolicyResult>
        <Marker/>
        <IsTruncated>false</IsTruncated>
        <PolicyUsers>
            <member>
                <UserName>Bob</UserName>
            </member>
        </PolicyUsers>
    </ListEntitiesForPolicyResult>
    <ResponseMetadata>
        <RequestId>a3d501b8-e7af-444f-ab11-94d0ef3370fe</RequestId>
    </ResponseMetadata>
</ListEntitiesForPolicyResponse>

JSON示例

{
  "ListEntitiesForPolicyResult": {
    "PolicyUsers": {
      "member": [
        {
          "UserName": "Bob"
        }
      ]
    },
    "IsTruncated": false
  },
  "ResponseMetadata": {
    "RequestId": "66073ca3-c076-4dc2-aad1-9b800925a3d1"
  }
}