tencent cloud

Feedback

SeparateMalwares

Last updated: 2024-08-27 11:32:18

    1. API Description

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

    This API is used to isolate Trojans.

    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: SeparateMalwares.
    Version Yes String Common Params. The value used for this API: 2018-02-28.
    Region No String Common Params. This parameter is not required.
    Ids.N Yes Array of Integer Trojan event ID array (The maximum number of IDs is 100.)
    KillProcess No Boolean Whether to kill the process

    3. Output Parameters

    Parameter Name Type Description
    SuccessIds Array of Integer Successfully isolated arrays of IDs; if none, an empty array is returned.
    FailedIds Array of Integer Unsuccessfully isolated arrays of IDs; if none, an empty array is returned.
    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 Isolating Trojans

    This example shows you how to isolate Trojans using this API (SeparateMalwares).

    Input Example

    POST / HTTP/1.1
    Host: cwp.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: SeparateMalwares
    <Common request parameters>
    
    {
        "Ids": [
            1,
            2,
            3
        ]
    }
    

    Output Example

    {
        "Response": {
            "SuccessIds": [
                123,
                456
            ],
            "FailedIds": [],
            "RequestId": "4985eb7f-62d6-4da8-898f-d92a08660a38"
        }
    }
    

    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
    FailedOperation.PartSeparate Isolation of multiple hosts partially or completely failed.
    FailedOperation.SingleSeparate Isolation of a single host failed.
    InternalError Internal error
    InvalidParameter Incorrect parameter.
    InvalidParameter.InvalidFormat Incorrect parameter format.
    InvalidParameter.MissingParameter Missing parameter.
    InvalidParameter.ParsingError Incorrect parameter parsing.
    InvalidParameterValue Invalid parameter value.
    MissingParameter Missing parameter error.