tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeAccessControlRuleDetail

最后更新时间：2024-12-06 15:47:11

    1. API Description

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

    This API is used to query the details of an access control policy at runtime.

    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: DescribeAccessControlRuleDetail.
    Version Yes String Common Params. The value used for this API: 2020-11-01.
    Region No String Common Params. This parameter is not required.
    RuleId No String Unique policy ID
    ImageId No String Image ID, which is used only when allowing an event.
    Limit No Integer Number of results to be returned. Default value: 10. Maximum value: 100.
    Offset No Integer Offset. Default value: 0.

    3. Output Parameters

    Parameter Name Type Description
    RuleDetail AccessControlRuleInfo Runtime policy 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 Querying the rule details of the current image by image ID (user policy)

    Input Example

    https://tcss.intl.tencentcloudapi.com/?Action=DescribeAccessControlRuleDetail
&ImageId=xxx
&Limit=10
&Offset=0
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "1af946cb-d3d5-4b03-bbfc-3d5ad306f753",
        "RuleDetail": {
            "RuleId": "6045899634b9a9000c4ae5bb",
            "IsEnable": true,
            "IsDefault": false,
            "RuleName": "kkkkk",
            "ChildRules": [
                {
                    "RuleId": "603279ba34b9a9000c0897ae",
                    "RuleMode": "RULE_MODE_HOLDUP",
                    "ProcessPath": "/usr/bin/vi",
                    "TargetFilePath": "*.txt"
                },
                {
                    "RuleId": "60327a7b34b9a9000c0897af",
                    "RuleMode": "RULE_MODE_ALERT",
                    "ProcessPath": "/data/a.out",
                    "TargetFilePath": "/tmp/test2.txt"
                },
                {
                    "RuleId": "6033081234b9a9000c0897b0",
                    "RuleMode": "RULE_MODE_HOLDUP",
                    "ProcessPath": "/usr/bin/coreutils",
                    "TargetFilePath": "/tmp/test.txt"
                },
                {
                    "RuleId": "60337e1034b9a9000c2240c9",
                    "RuleMode": "RULE_MODE_ALERT",
                    "ProcessPath": "/data/a.out",
                    "TargetFilePath": "/tmp/test.txt"
                },
                {
                    "RuleId": "60361e8234b9a9000cf7a3ee",
                    "RuleMode": "RULE_MODE_ALERT",
                    "ProcessPath": "/usr/bin/vi",
                    "TargetFilePath": "*.HTML"
                },
                {
                    "RuleId": "603772d334b9a9000cd92ae8",
                    "RuleMode": "RULE_MODE_ALERT",
                    "ProcessPath": "/usr/bin/iv",
                    "TargetFilePath": "*.HTML"
                },
                {
                    "RuleId": "6045899634b9a9000c4ae5bc",
                    "RuleMode": "RULE_MODE_RELEASE",
                    "ProcessPath": "/usr/bin/vi",
                    "TargetFilePath": "/1.txt"
                }
            ],
            "SystemChildRules": [],
            "ImageIds": [
                "sha256:300e315adb2f96afe5f0b2780b87f28ae95231fe3bdd1e16b9ba606307728f55",
                "sha256:e50c909a8df2b7c8b92a6e8730e210ebe98e5082871e66edd8ef4d90838cbd25",
                "sha256:298ec0e28760b8eb1aad79711dc29c19041c61d7cf342dd1f445e91f30500549"
            ]
        }
    }
}

    Example2 Querying the rule details of the current image by image ID (preset policy)

    Input Example

    https://tcss.intl.tencentcloudapi.com/?Action=DescribeAccessControlRuleDetail
&RuleId=xxx
&Limit=10
&Offset=0
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "1af946cb-d3d5-4b03-bbfc-3d5ad306f753",
        "RuleDetail": {
            "RuleId": "60484042d620f3f9012c521e",
            "IsEnable": true,
            "IsDefault": true,
            "RuleName": "kkkkk",
            "ChildRules": [],
            "SystemChildRules": [
                {
                    "RuleId": "200000000000000000000001",
                    "IsEnable": true,
                    "RuleMode": "RULE_MODE_ALERT",
                    "RuleType": "CHANGE_CRONTAB"
                },
                {
                    "RuleId": "200000000000000000000002",
                    "IsEnable": true,
                    "RuleMode": "RULE_MODE_ALERT",
                    "RuleType": "CHANGE_SYS_BIN"
                },
                {
                    "RuleId": "200000000000000000000003",
                    "IsEnable": true,
                    "RuleMode": "RULE_MODE_ALERT",
                    "RuleType": "CHANGE_USRCFG"
                }
            ],
            "ImageIds": [
                "sha256:300e315adb2f96afe5f0b2780b87f28ae95231fe3bdd1e16b9ba606307728f55",
                "sha256:e50c909a8df2b7c8b92a6e8730e210ebe98e5082871e66edd8ef4d90838cbd25",
                "sha256:298ec0e28760b8eb1aad79711dc29c19041c61d7cf342dd1f445e91f30500549"
            ]
        }
    }
}

    Example3 Querying rule details by rule ID (user policy)

    Input Example

    https://tcss.intl.tencentcloudapi.com/?Action=DescribeAccessControlRuleDetail
&RuleId=xxx
&Limit=10
&Offset=0
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "1af946cb-d3d5-4b03-bbfc-3d5ad306f753",
        "RuleDetail": {
            "RuleId": "6045899634b9a9000c4ae5bb",
            "IsEnable": true,
            "IsDefault": false,
            "RuleName": "kkkkk",
            "ChildRules": [
                {
                    "RuleId": "603279ba34b9a9000c0897ae",
                    "RuleMode": "RULE_MODE_HOLDUP",
                    "ProcessPath": "/usr/bin/vi",
                    "TargetFilePath": "*.txt"
                },
                {
                    "RuleId": "60327a7b34b9a9000c0897af",
                    "RuleMode": "RULE_MODE_ALERT",
                    "ProcessPath": "/data/a.out",
                    "TargetFilePath": "/tmp/test2.txt"
                },
                {
                    "RuleId": "6033081234b9a9000c0897b0",
                    "RuleMode": "RULE_MODE_HOLDUP",
                    "ProcessPath": "/usr/bin/coreutils",
                    "TargetFilePath": "/tmp/test.txt"
                },
                {
                    "RuleId": "60337e1034b9a9000c2240c9",
                    "RuleMode": "RULE_MODE_ALERT",
                    "ProcessPath": "/data/a.out",
                    "TargetFilePath": "/tmp/test.txt"
                },
                {
                    "RuleId": "60361e8234b9a9000cf7a3ee",
                    "RuleMode": "RULE_MODE_ALERT",
                    "ProcessPath": "/usr/bin/vi",
                    "TargetFilePath": "*.HTML"
                },
                {
                    "RuleId": "603772d334b9a9000cd92ae8",
                    "RuleMode": "RULE_MODE_ALERT",
                    "ProcessPath": "/usr/bin/iv",
                    "TargetFilePath": "*.HTML"
                },
                {
                    "RuleId": "6045899634b9a9000c4ae5bc",
                    "RuleMode": "RULE_MODE_RELEASE",
                    "ProcessPath": "/usr/bin/vi",
                    "TargetFilePath": "/1.txt"
                }
            ],
            "SystemChildRules": [],
            "ImageIds": [
                "sha256:300e315adb2f96afe5f0b2780b87f28ae95231fe3bdd1e16b9ba606307728f55",
                "sha256:e50c909a8df2b7c8b92a6e8730e210ebe98e5082871e66edd8ef4d90838cbd25",
                "sha256:298ec0e28760b8eb1aad79711dc29c19041c61d7cf342dd1f445e91f30500549"
            ]
        }
    }
}

    Example4 Querying rule details by rule ID (preset policy)

    Input Example

    https://tcss.intl.tencentcloudapi.com/?Action=DescribeAccessControlRuleDetail
&RuleId=xxx
&Limit=10
&Offset=0
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "1af946cb-d3d5-4b03-bbfc-3d5ad306f753",
        "RuleDetail": {
            "RuleId": "60484042d620f3f9012c521e",
            "IsEnable": true,
            "IsDefault": true,
            "RuleName": "kkkkk",
            "ChildRules": [],
            "SystemChildRules": [
                {
                    "RuleId": "200000000000000000000001",
                    "IsEnable": true,
                    "RuleMode": "RULE_MODE_ALERT",
                    "RuleType": "CHANGE_CRONTAB"
                },
                {
                    "RuleId": "200000000000000000000002",
                    "IsEnable": true,
                    "RuleMode": "RULE_MODE_ALERT",
                    "RuleType": "CHANGE_SYS_BIN"
                },
                {
                    "RuleId": "200000000000000000000003",
                    "IsEnable": true,
                    "RuleMode": "RULE_MODE_ALERT",
                    "RuleType": "CHANGE_USRCFG"
                }
            ],
            "ImageIds": [
                "sha256:300e315adb2f96afe5f0b2780b87f28ae95231fe3bdd1e16b9ba606307728f55",
                "sha256:e50c909a8df2b7c8b92a6e8730e210ebe98e5082871e66edd8ef4d90838cbd25",
                "sha256:298ec0e28760b8eb1aad79711dc29c19041c61d7cf342dd1f445e91f30500549"
            ]
        }
    }
}

    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
    AuthFailure A CAM signature/authentication error occurred.
    FailedOperation.RuleNotFind The rule is not found.
    InternalError An internal error occurred.
    InvalidParameter The parameter is incorrect.
    InvalidParameter.InvalidFormat The parameter format is incorrect.
    InvalidParameter.MissingParameter The required parameter is missing.
    InvalidParameterValue The parameter value is incorrect.
    ResourceNotFound The resource does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款