查询指定身份策略附加的所有实体 - ListEntitiesForPolicyV5
功能介绍
该接口可用于查询指定身份策略附加的所有实体。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| iam:policies:listEntitiesV5 | List | policy * | - | - | - |
URI
GET /v5/policies/{policy_id}/attached-entities
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| policy_id | 是 | String | 身份策略ID,长度为1到64个字符,只包含字母、数字和"-"的字符串。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| entity_type | 否 | String | 实体类型,包含user、 group 和 agency三种类型。 |
| limit | 否 | Integer | 每页显示的条目数量,范围为1到200条,默认为100条。 最小值:1 最大值:200 缺省值:100 |
| marker | 否 | String | 分页标记,长度为4到400个字符,只包含字母、数字、"+"、"/"、"="、"-"和"_"的字符串。 最小长度:4 最大长度:400 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| policy_agencies | Array of PolicyAgency objects | 委托及信任委托列表。 |
| policy_groups | Array of PolicyGroup objects | 用户组列表。 |
| policy_users | Array of PolicyUser objects | IAM用户列表。 |
| page_info | PageInfo object | 分页信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| agency_id | String | 委托或信任委托ID,长度为1到64个字符,只包含字母、数字和"-"的字符串。 |
| attached_at | String | 身份策略的附加时间。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| group_id | String | 用户组ID,长度为1到64个字符,只包含字母、数字和"-"的字符串。 |
| attached_at | String | 身份策略的附加时间。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| next_marker | String | 如果存在,则表示还有后续的条目未显示在当前返回体中。请使用该值作为下一次请求的分页标记参数以获得下一页信息。请反复调用该接口直至该字段不存在。 |
| current_count | Integer | 本页返回条目数量。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误信息。 |
| request_id | String | 请求ID。 |
| encoded_authorization_message | String | 加密后的认证失败信息,可以通过STS5解密接口进行解密。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误信息。 |
| request_id | String | 请求ID。 |
请求示例
查询指定身份策略附加的所有实体。
GET https://{endpoint}/v5/policies/{policy_id}/attached-entities 响应示例
状态码:200
请求成功。
{
"policy_agencies" : [ {
"agency_id" : "string",
"attached_at" : "2023-09-25T09:29:06.817Z"
} ],
"policy_groups" : [ {
"group_id" : "string",
"attached_at" : "2023-09-25T09:29:06.817Z"
} ],
"policy_users" : [ {
"user_id" : "string",
"attached_at" : "2023-09-25T09:29:06.817Z"
} ],
"page_info" : {
"next_marker" : "marker",
"current_count" : 3
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功。 |
| 403 | 没有操作权限。 |
| 404 | 未找到相应的资源。 |
错误码
请参见错误码。