tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateRiskDnsEventExportJob

Last updated: 2024-07-22 11:04:51

    1. API Description

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

    This API is used to export malicious request 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: CreateRiskDnsEventExportJob.
    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 Filters.
  • EventStatus - String - Optional - Event status. Values: EVENT_UNDEAL (Pending); EVENT_DEALED (Handled); EVENT_IGNORE (Ignored); EVENT_ADD_WHITE (Added to the allowlist)
  • ContainerStatus - String - Optional - Container running status. CREATED, RUNNING, PAUSED, STOPPED, RESTARTING: REMOVING, DESTROYED (Terminated)</li><li>ContainerNetStatus- String - Optional - Container network status. Values:NORMAL, ISOLATED, ISOLATE_FAILED (Isolation failed; RESTORE_FAILED (Failed to restore from isolation), RESTORING (Restoring); ISOLATING
  • EventType - String - Optional - Event type. Values: DOMAIN (Malicious domain); IP (Malicious IP)
  • TimeRange - String - Optional - Time range, where the first value represents the start time and the second value represents the end time
  • RiskDns - String - Optional - Malicious domain.
  • RiskIP- String - Optional - Malicious IP.
  • ContainerName - String - Optional - Container name.
  • ContainerID - String - Optional - Container ID.
  • ImageName - String - Optional - Image name.
  • ImageID - String - Optional - Image ID.
  • HostName - String - Optional - Server name.
  • HostIP - String - Optional - Private IP.
  • PublicIP - String - Optional - Public IP.
    • Limit No Integer The number of results displayed per page. The maximum value is 100,000.
    Offset No Integer Offset. Default value: 0
    Order No String Sort order: asc, desc
    By No String Sorting field: Number of events: EventCount

    3. Output Parameters

    Parameter Name Type Description
    JobId String ID of the exportation job. You can query the job progress by using this ID on the console.
    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 Exporting malicious request events

    Input Example

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

{
    "Order": "xx",
    "Limit": 10000,
    "By": "xx",
    "Filters": [
        {
            "Values": [
                "xx"
            ],
            "Name": "xx",
            "ExactMatch": true
        }
    ],
    "Offset": 0
}

    Output Example

    {
    "Response": {
        "RequestId": "xx",
        "JobId": "xx"
    }
}

    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