访问管理查询策略关联的实体列表-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： cam.tencentcloudapi.com 。

本接口（ListEntitiesForPolicy）可用于查询策略关联的实体列表。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ListEntitiesForPolicy。
Version	是	String	公共参数，本接口取值：2019-01-16。
Region	否	String	公共参数，此参数为可选参数。
PolicyId	是	Integer	策略 id 示例值：524497
Page	否	Integer	页码，默认值是 1，从 1 开始示例值：1
Rp	否	Integer	每页大小，默认值是 20 示例值：10
EntityFilter	否	String	可取值 'All'、'User'、'Group' 和 'Role'，'All' 表示获取所有实体类型，'User' 表示只获取子账号，'Group' 表示只获取用户组，'Role' 表示只获取角色，默认取 'All' 示例值：All

3. 输出参数

参数名称	类型	描述
TotalNum	Integer	实体总数注意：此字段可能返回 null，表示取不到有效值。示例值：1
List	Array of AttachEntityOfPolicy	实体列表注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询策略关联的实体列表

输入示例

https://cam.tencentcloudapi.com/?Action=ListEntitiesForPolicy
&PolicyId=524497
&Page=1
&Rp=10
&EntityFilter=All
&<公共请求参数>

输出示例

{
    "Response": {
        "List": [
            {
                "Id": "1133398",
                "RelatedType": 1,
                "Uin": 3449203261,
                "AttachmentTime": "2021-11-11 19:38:01",
                "Name": "test1"
            }
        ],
        "TotalNum": 1,
        "RequestId": "836d7034-9854-44f0-9d4a-ee57842f8644"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError.SystemError	内部错误。
InvalidParameter.EntityFilterError	EntityFilter字段不合法。
InvalidParameter.ParamError	非法入参。
InvalidParameter.PolicyIdError	输入参数PolicyId不合法。

查询策略关联的实体列表

本页目录：