tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Cloud Workload Protection Platform
    Documentation
    Download PDF

    DescribeSecurityProtectionStat

    Last updated: 2024-08-27 11:39:20
    Download PDF

    1. API Description

    Domain name for API request: cwp.tencentcloudapi.com.

    This API is used to obtain the summary of security protection statuses.

    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: DescribeSecurityProtectionStat.
    Version Yes String Common Params. The value used for this API: 2018-02-28.
    Region No String Common Params. This parameter is not required.

    3. Output Parameters

    Parameter Name Type Description
    AssetManageStat Integer 0: asset not paid; 1: agent not installed; 2: Pro or Ultimate Edition for some assets; 3: Pro or Ultimate Edition for all assets.
    VulManageStat Integer 0: never scanned or asset not paid; 1: vulnerability risk found; 2: no risk.
    SecureBasicLineStat Integer 0: never scanned or asset not paid; 1: baseline risk found; 2: no risk.
    MalwareScanStat Integer 0: never scanned or asset not paid; 1: scanned and malicious files found; 2: scanned but isolation protection disabled; 3: scanned, protection enabled, and no risk found.
    DefenseBruteAttackStat Integer Enabling status of password cracking prevention. 0: disabled or asset not paid; 1: enabled; 2: events pending fixing found.
    FileTamperStat Integer Core file monitoring. 0: disabled (asset not paid); 1: enabled.
    WebPageStat Integer Web page tamper prevention. 0: disabled; 1: enabled.
    LoginLogStat Integer Abnormal log-in. 0: unfixed risks found; 1: no risk and allowlist not configured; 2: no risk and allowlist configured.
    DiscoverBruteAttackStat Integer Password cracking risk detection. 0: unfixed risks found; 1: no risk with detection in progress.
    MaliciousRequestStat Integer Malicious request. 0: no asset in Pro or Ultimate Edition; 1: unfixed malicious request risks found; 2: paid assets found with no risk.
    PrivilegeStat Integer Local privilege escalation. 0: no asset in Pro or Ultimate Edition; 1: unfixed risks found; 2: paid assets found with no risk.
    ReverseShellStat Integer Reverse shell. 0: no asset in Pro or Ultimate Edition; 1: unfixed risks found; 2: paid assets found with no risk.
    ExpertServiceStat Integer Expert service. 0: disabled; 1: enabled.
    LogAnalysisStat Integer Log analysis. 0: disabled; 1: enabled.
    WarningSetStat Integer Security alarm. 0: disabled (for all assets); 1: enabled (for at least one asset).
    EventBashStat Integer High-risk command. 0: no asset in Pro or Ultimate Edition; 1: unfixed risks found; 2: paid assets found with no risk.
    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 Obtaining the Security Protection Status

    Input Example

    https://cwp.tencentcloudapi.com/?Action=DescribeSecurityProtectionStat
&<Common request parameters>

    Output Example

    {
    "Response": {
        "AssetManageStat": 1,
        "SecureBasicLineStat": 1,
        "ExpertServiceStat": 1,
        "LoginLogStat": 1,
        "VulManageStat": 1,
        "FileTamperStat": 1,
        "WarningSetStat": 1,
        "DiscoverBruteAttackStat": 1,
        "DefenseBruteAttackStat": 1,
        "RequestId": "e79efea3-3f70-46c0-a7e1-ed38a2476098",
        "ReverseShellStat": 1,
        "LogAnalysisStat": 1,
        "PrivilegeStat": 1,
        "MalwareScanStat": 1,
        "WebPageStat": 1,
        "EventBashStat": 1,
        "MaliciousRequestStat": 1
    }
}

    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
    InternalError Internal error
    InternalError.MainDBFail Failed to manipulate the data.
    UnauthorizedOperation Unauthorized operation.
    UnknownParameter Unknow parameter error.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy