访问管理查询策略列表-策略相关接口-API 中心-腾讯云

1. 接口描述

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

本接口（ListPolicies）可用于查询策略列表。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ListPolicies。
Version	是	String	公共参数，本接口取值：2019-01-16。
Region	否	String	公共参数，此参数为可选参数。
Rp	否	Integer	每页数量，默认值是 20，必须大于 0 且小于或等于 200 示例值：1
Page	否	Integer	页码，默认值是 1，从 1开始，不能大于 200 示例值：10
Scope	否	String	可取值 'All'、'QCS' 和 'Local'，'All' 获取所有策略，'QCS' 只获取预设策略，'Local' 只获取自定义策略，默认取 'All' 示例值：All
Keyword	否	String	按策略名匹配示例值：name

3. 输出参数

参数名称	类型	描述
TotalNum	Integer	策略总数示例值：239
List	Array of StrategyInfo	策略数组，数组每个成员包括 policyId、policyName、addTime、type、description、 createMode 字段。其中： policyId：策略 id policyName：策略名 addTime：策略创建时间 type：1 表示自定义策略，2 表示预设策略 description：策略描述 createMode：1 表示按业务权限创建的策略，其他值表示可以查看策略语法和通过策略语法更新策略 Attachments: 关联的用户数 ServiceType: 策略关联的产品 IsAttached: 当需要查询标记实体是否已经关联策略时不为null。0表示未关联策略，1表示已关联策略
ServiceTypeList	Array of String	保留字段注意：此字段可能返回 null，表示取不到有效值。示例值：[]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查看策略列表

输入示例

POST / HTTP/1.1
Host: cam.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListPolicies
<公共请求参数>

{
    "Rp": "1",
    "Page": "10"
}

输出示例

{
    "Response": {
        "ServiceTypeList": [
            "xx"
        ],
        "List": [
            {
                "PolicyId": 16313162,
                "PolicyName": "QcloudAccessForCDNRole",
                "AddTime": "2019-04-19 10:55:31",
                "Type": 2,
                "Description": "腾讯云内容分发网络(CDN)操作权限含日志服务(CLS)的增删改查日志集，增删改查日志主题，搜索下载上传日志。",
                "CreateMode": 2,
                "Attachments": 0,
                "ServiceType": "cooperator",
                "IsAttached": 1,
                "Deactived": 1,
                "DeactivedDetail": [
                    "cvm"
                ],
                "IsServiceLinkedPolicy": 1,
                "UpdateTime": "2019-04-19 10:55:31",
                "AttachEntityCount": 0,
                "AttachEntityBoundaryCount": 0
            }
        ],
        "TotalNum": 239,
        "RequestId": "ae2bd2b7-1d55-4b0a-8154-e02407a2b390"
    }
}

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.GroupIdError	GroupId字段不合法。
InvalidParameter.KeywordError	Keyword字段不合法。
InvalidParameter.ParamError	非法入参。
InvalidParameter.ScopeError	Scope字段不合法。
InvalidParameter.SearchKeywordLengthError	查询关键字长度错误。
InvalidParameter.ServiceTypeError	ServiceType字段不合法。
InvalidParameter.UinError	Uin字段不合法。

查询策略列表

本页目录：