有奖:语音产品征文挑战赛火热进行中> HOT

1. 接口描述

接口请求域名: config.tencentcloudapi.com 。

账号组获取规则列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ListAggregateConfigRules。
Version String 公共参数,本接口取值:2022-08-02。
Region String 公共参数,详见产品支持的 地域列表
Limit Integer 每页限制
示例值:10
Offset Integer 偏移量
示例值:1
AccountGroupId String 账号组ID
示例值:ca-sdfs7734h24h3
OrderType String 排序类型, 倒序:desc,顺序:asc
示例值:desc
RiskLevel.N Array of Integer 风险等级
1:高风险。
2:中风险。
3:低风险。
示例值:[1,2]
State String 规则状态
示例值:ACTIVE
ComplianceResult.N Array of String 评估结果
示例值:["COMPLIANT"]
RuleName String 规则名
示例值:规则1
RuleOwnerId Integer 规则所属账号ID
示例值:98332222

3. 输出参数

参数名称 类型 描述
Total Integer 总数
示例值:4
Items Array of ConfigRule 详情
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 账号组获取规则列表

账号组获取规则列表

输入示例

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



{
    "Offset": 0,
    "Limit": 10,
    "OrderType": "",
    "RiskLevel": [],
    "State": "ACTIVE",
    "ComplianceResult": [
        "abc"
    ],
    "RuleName": "",
    "RuleOwnerId": 1,
    "AccountGroupId": "ca-sdfs7734h24h3"
}

输出示例

{
    "Response": {
        "RequestId": "149e116a-90ef-45f3-9d5d-3d77fd1c9eb3",
        "Items": [
            {
                "RegionsScope": [
                    "ap-shanghai"
                ],
                "TagsScope": [
                    {
                        "TagKey": "tag1",
                        "TagValue": "tag2"
                    }
                ],
                "ExcludeResourceIdsScope": [
                    "ins-asdasd"
                ],
                "Annotation": null,
                "CompliancePackId": "cp-xzfz0vu007feuhwi8auv",
                "CompliancePackName": "合规1",
                "ComplianceResult": "NON_COMPLIANT",
                "ConfigRuleId": "cr-13vkg9c31dixgabkepxe",
                "ConfigRuleInvokedTime": null,
                "CreateTime": "2022-11-16 14:25:01",
                "Description": "帐号访问管理中用户至少关联一个用户组,则符合规则。",
                "Identifier": "cam-user-group-bound",
                "IdentifierType": "SYSTEM",
                "InputParameter": [],
                "Labels": [],
                "ManageInputParameter": [],
                "ResourceType": [
                    "QCS::CAM::User"
                ],
                "RiskLevel": 3,
                "RuleName": "CAM访问管理子用户必须关联用户组",
                "ServiceFunction": null,
                "SourceCondition": [
                    {
                        "DesiredValue": "1",
                        "EmptyAs": "COMPLIANT",
                        "Operator": "GreaterOrEquals",
                        "Required": false,
                        "SelectPath": "$User.GroupBindNum"
                    }
                ],
                "Status": "ACTIVE",
                "TriggerType": [
                    {
                        "MaximumExecutionFrequency": "TwentyFour_Hours",
                        "MessageType": "ScheduledNotification"
                    }
                ]
            }
        ],
        "Total": 1
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameter 参数错误。
ResourceNotFound.AccountGroupIsNotExist 账号组不存在。