tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ListConfigRules

Last updated: 2024-12-02 15:06:08

1. API Description

Domain name for API request: config.intl.tencentcloudapi.com.

This API is used to get the rule list.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: ListConfigRules.
Version Yes String Common Params. The value used for this API: 2022-08-02.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Limit Yes Integer Page limit
Offset Yes Integer Offset.
OrderType No String Sort type. Descending: desc, Ascending: asc.
RiskLevel.N No Array of Integer Risk level

1: High risk.
2: Medium risk.
3: Low risk.
State No String Rule status
ComplianceResult.N No Array of String Evaluation result
RuleName No String Name of the rule

3. Output Parameters

Parameter Name Type Description
Total Integer Total number
Items Array of ConfigRule Details
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Getting Rule List

Input Example

POST / HTTP/1.1
Host: config.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListConfigRules
<Common request parameters>

{
    "Offset": 0,
    "Limit": 10,
    "OrderType": "",
    "RiskLevel": [],
    "State": "ACTIVE",
    "ComplianceResult": [],
    "RuleName": ""
}

Output Example

{
    "Response": {
        "RequestId": "149e116a-90ef-45f3-9d5d-3d77fd1c9eb3",
        "Items": [
            {
                "Annotation": null,
                "CompliancePackId": "cp-xzfz0vu007feuhwi8auv",
                "CompliancePackName": "Compliance 1",
                "ComplianceResult": "NON_COMPLIANT",
                "ConfigRuleId": "cr-13vkg9c31dixgabkepxe",
                "ConfigRuleInvokedTime": null,
                "CreateTime": "2022-11-16 14:25:01",
                "Description": "The user must be associated with at least one user group in CAM access management to comply with the rule.",
                "Identifier": "cam-user-group-bound",
                "IdentifierType": "SYSTEM",
                "InputParameter": [],
                "Labels": [],
                "ManageInputParameter": [],
                "ResourceType": [
                    "QCS::CAM::User"
                ],
                "RiskLevel": 3,
                "RuleName": "Associate CAM sub-user with user group"
                "ServiceFunction": null,
                "SourceCondition": [
                    {
                        "DesiredValue": "1",
                        "EmptyAs": "COMPLIANT",
                        "Operator": "GreaterOrEquals",
                        "Required": false,
                        "SelectPath": "$User.GroupBindNum"
                    }
                ],
                "Status": "ACTIVE",
                "TriggerType": [
                    {
                        "MaximumExecutionFrequency": "TwentyFour_Hours",
                        "MessageType": "ScheduledNotification"
                    }
                ]
            },
            {
                "Annotation": null,
                "CompliancePackId": "",
                "CompliancePackName": null,
                "ComplianceResult": "NON_COMPLIANT",
                "ConfigRuleId": "cr-bdunf5kx3aywn0ac5bkk",
                "ConfigRuleInvokedTime": null,
                "CreateTime": "2022-11-16 14:22:59",
                "Description": "In CAM, a user must be associated with at least one user group to comply with the rule."
                "Identifier": "cam-user-group-bound",
                "IdentifierType": "SYSTEM",
                "InputParameter": [],
                "Labels": [],
                "ManageInputParameter": [],
                "ResourceType": [
                    "QCS::CAM::User"
                ],
                "RiskLevel": 3,
                "RuleName": "Associate CAM sub-user with user group"
                "ServiceFunction": null,
                "SourceCondition": [
                    {
                        "DesiredValue": "1",
                        "EmptyAs": "COMPLIANT",
                        "Operator": "GreaterOrEquals",
                        "Required": false,
                        "SelectPath": "$User.GroupBindNum"
                    }
                ],
                "Status": "ACTIVE",
                "TriggerType": [
                    {
                        "MaximumExecutionFrequency": "TwentyFour_Hours",
                        "MessageType": "ScheduledNotification"
                    }
                ]
            },
            {
                "Annotation": null,
                "CompliancePackId": "",
                "CompliancePackName": null,
                "ComplianceResult": "NON_COMPLIANT",
                "ConfigRuleId": "cr-2d3brhnvyazqb9j1el6o",
                "ConfigRuleInvokedTime": null,
                "CreateTime": "2022-11-16 11:36:45",
                "Description": "In CAM, a user must be associated with at least one user group to comply with the rule."
                "Identifier": "cam-user-group-bound",
                "IdentifierType": "SYSTEM",
                "InputParameter": [],
                "Labels": [],
                "ManageInputParameter": [],
                "ResourceType": [
                    "QCS::CAM::User"
                ],
                "RiskLevel": 3,
                "RuleName": "Associate CAM sub-user with user group"
                "ServiceFunction": null,
                "SourceCondition": [
                    {
                        "DesiredValue": "1",
                        "EmptyAs": "COMPLIANT",
                        "Operator": "GreaterOrEquals",
                        "Required": false,
                        "SelectPath": "$User.GroupBindNum"
                    }
                ],
                "Status": "ACTIVE",
                "TriggerType": [
                    {
                        "MaximumExecutionFrequency": "TwentyFour_Hours",
                        "MessageType": "ScheduledNotification"
                    }
                ]
            }
        ],
        "Total": 3
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InvalidParameter Parameter error.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy