tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeVulDefenceEvent

最后更新时间：2024-07-22 11:07:32

    1. API Description

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

    This API is used to query the list of exploit prevention events.

    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: DescribeVulDefenceEvent.
    Version Yes String Common Params. The value used for this API: 2020-11-01.
    Region No String Common Params. This parameter is not required.
    Filters.N No Array of RunTimeFilters Filter
  • Status- String - Required: No - Plugin status. Valid values: EVENT_UNDEAL (pending); EVENT_DEALED (processed); EVENT_IGNORE (ignored); EVENT_DEFENDED (defended).
  • ContainerStatus- String - Required: No - Container status. Valid values: CREATED (created); RUNNING (running); PAUSED (suspended); STOPPED (stopped); RESTARTING (restarting); REMOVING (removing); DESTROYED (terminated).
  • ContainerNetStatus- String - Required: No - Container network status. Valid values: NORMAL (not isolated); ISOLATED (isolated); ISOLATE_FAILED (isolation failed); RESTORE_FAILED (recovery failed); RESTORING (recovering); ISOLATING (isolating).
  • EventType - String - Required: No - Intrusion status. Valid values: EVENT_DEFENDED (defended successfully); EVENT_ATTACK (attack attempt).
  • TimeRange- String - Required: No - Time range. The first value indicates the start time, and the second the end time.
  • VulName- string - Required: No - Vulnerability name
  • CVEID- string - Required: No - CVE No.
  • SourceIP- string - Required: No - Attacker IP
  • ContainerName- string - Required: No - Container name
  • ContainerID- string - Required: No - Container ID
  • ImageName- string - Required: No - Image name
  • ImageID- string - Required: No - Image ID
  • HostName- string - Required: No - Server name
  • HostIP- string - Required: No - Private IP
    		•
    Limit No Integer Number of results to be returned. Default value: 10. Maximum value: 100.
    Offset No Integer Offset. Default value: 0.
    Order No String Sorting order. Valid values: asc, desc.
    By No String Sorting field: EventCount (number of events).

    3. Output Parameters

    Parameter Name Type Description
    List Array of VulDefenceEvent List of exploit prevention events
    TotalCount Integer Total number
    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 list of exploit prevention events

    DescribeVulDefenceEvent

    Input Example

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

{
    "Limit": "10",
    "Offset": "0"
}

    Output Example

    {
    "Response": {
        "List": [
            {
                "CVEID": "abc",
                "VulName": "abc",
                "PocID": "abc",
                "EventType": "abc",
                "SourceIP": "abc",
                "City": "abc",
                "EventCount": 0,
                "ContainerID": "abc",
                "ContainerName": "abc",
                "ImageID": "abc",
                "ImageName": "abc",
                "Status": "abc",
                "EventID": 0,
                "CreateTime": "abc",
                "ContainerNetStatus": "abc",
                "MergeTime": "abc",
                "ContainerStatus": "abc",
                "ContainerNetSubStatus": "abc",
                "ContainerIsolateOperationSrc": "abc",
                "QUUID": "abc",
                "HostIP": "abc",
                "HostName": "abc",
                "ClusterID": "abc",
                "NodeType": "abc"
            }
        ],
        "TotalCount": 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.
    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.
    隐私条款服务条款缓存条款