tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeVulDefenceSetting

Last updated: 2024-07-22 11:07:25

    1. API Description

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

    This API is used to query the exploit prevention settings.

    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: DescribeVulDefenceSetting.
    Version Yes String Common Params. The value used for this API: 2020-11-01.
    Region No String Common Params. This parameter is not required.

    3. Output Parameters

    Parameter Name Type Description
    IsEnabled Integer Whether it is enabled. Valid values: 0 (disabled); 1 (enabled).
    Scope Integer Scope of servers with exploit prevention enabled. Valid values: 0 (specified servers); 1 (all servers).
    HostCount Integer Number of servers with exploit prevention enabled
    ExceptionHostCount Integer Number of abnormal servers with exploit prevention enabled
    HostIDs Array of String Specified servers with exploit prevention enabled
    Note: This field may return null, indicating that no valid values can be obtained.
    HostTotalCount Integer Total number of servers with TCSS activated
    Note: This field may return null, indicating that no valid values can be obtained.
    SupportDefenseVulCount Integer Number of vulnerabilities that can be prevented
    Note: This field may return null, indicating that no valid values can be obtained.
    HostNodeCount Integer Number of normal nodes
    SuperScope Integer Super node scope
    SuperNodeCount Integer Number of super nodes
    SuperNodeIds Array of String List of super node IDs
    NodeTotalCount Integer Total number of super nodes with TCSS activated
    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 exploit prevention settings

    This example shows you how to query the exploit prevention settings.

    Input Example

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

{}

    Output Example

    {
    "Response": {
        "IsEnabled": 0,
        "Scope": 0,
        "HostCount": 0,
        "ExceptionHostCount": 0,
        "HostIDs": [
            "abc"
        ],
        "HostTotalCount": 0,
        "SupportDefenseVulCount": 0,
        "HostNodeCount": 0,
        "SuperScope": 0,
        "SuperNodeCount": 0,
        "SuperNodeIds": [
            "abc"
        ],
        "NodeTotalCount": 0,
        "RequestId": "abc"
    }
}

    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 The operation failed.
    InternalError An internal error occurred.
    InvalidParameter The parameter is incorrect.
    InvalidParameter.InvalidFormat The parameter format is incorrect.
    InvalidParameter.MissingParameter The required parameter is missing.
    InvalidParameter.ParsingError A parameter parsing error occurred.
    InvalidParameterValue The parameter value is incorrect.
    MissingParameter The parameter is missing.
    UnknownParameter The parameter is unknown.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy