查询策略列表
最近更新时间: 2024-10-18 10:38:46
1. 接口描述
接口请求域名： cam.api3.fincloud.tencent.cn。
本接口（ListPolicies）可用于查询策略列表。
默认接口请求频率限制：20次/秒。
接口更新时间：2022-12-02 16:37:36。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：ListPolicies |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-01-16 |
| Region | 是 | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Rp | 否 | 否 | Uint64 | 每页数量，默认值是 20，必须大于 0 且小于或等于 200 |
| Page | 否 | 否 | Uint64 | 页码，默认值是 1，从 1开始，不能大于 200 |
| Scope | 否 | 否 | String | 可取值 'All'、'QCS' 和 'Local'，'All' 获取所有策略，'QCS' 只获取预设策略，'Local' 只获取自定义策略，默认取 'All' |
| Keyword | 否 | 否 | String | 按策略名匹配 |
| TargetUin | 否 | 否 | Uint64 | 按Uin匹配 |
| TargetGroupId | 否 | 否 | Uint64 | 按组Id匹配 |
| TargetRoleId | 否 | 否 | Uint64 | 按角色Id匹配 |
| ServiceType | 否 | 否 | String | 按产品Id匹配，如cvm |
| Client | 否 | 否 | String | 调用来源，控制台为"console" |
| FlagUin | 否 | 否 | Uint64 | 按Uin标记关联 |
| FlagGroupId | 否 | 否 | Uint64 | 按GroupId标记关联 |
| FlagRoleId | 否 | 否 | Uint64 | 按角色Id标记关联 |
| CreateMode | 否 | 否 | Uint64 | 创建类型：1.按产品功能或项目权限创建；2.按策略语法创建；3.按策略生成器创建；4.按标签授权创建；5.按权限边界规则创建 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalNum | Uint64 | 此参数对外不可见。 策略总数 |
| List | StrategyInfo | 此参数对外不可见。 策略数组，数组每个成员包括 policyId、policyName、addTime、type、description、 createMode 字段。其中： <br>policyId：策略 id <br>policyName：策略名<br>addTime：策略创建时间<br>type：1 表示自定义策略，2 表示预设策略 <br>description：策略描述 <br>createMode：1 表示按业务权限创建的策略，其他值表示可以查看策略语法和通过策略语法更新策略<br>Attachments: 关联的用户数<br>ServiceType: 策略关联的产品<br>IsAttached: 当需要查询标记实体是否已经关联策略时不为null。0表示未关联策略，1表示已关联策略 |
| ServiceTypeList | String | 此参数对外不可见。 服务列表 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.ParamError | |
| InvalidParameter.UinError | |
| InternalError.SystemError | |
| InvalidParameter.ScopeError | |
| InvalidParameter.KeywordError | |
| InvalidParameter.GroupIdError | |
| InvalidParameter.ServiceTypeError |