tencent cloud

文档反馈

DescribeCanNotSeparateMachine

最后更新时间:2024-08-27 11:41:00

1. API Description

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

This API is used to obtain hosts where Trojans cannot be isolated.

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: DescribeCanNotSeparateMachine.
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 No Array of Integer An array of event IDs that need to be modified, and batch operation is supported.
UpdateAll No Boolean Whether to update all, i.e. whether to operate on all events; this parameter is invalid when IDs are not left blank.
ExcludeId.N No Array of Integer Excluded event ID: When operating on all events, this ID needs to be excluded.
Filters.N No Array of Filters
  • IpOrAlias - String - required: no - filter by host IP or alias
  • FilePath - String - required: no - filter by path
  • VirusName - String - required: no - filter by description
  • CreateBeginTime - String - required: no - filter by creation time - start time
  • CreateEndTime - String - required: no - filter by creation time - end time
  • Status - String - required: no - status for filtering: 4: pending; 5: trusted; 6: isolated; 10: isolating; 11: canceling isolation
  • 3. Output Parameters

    Parameter Name Type Description
    List Array of CanNotSeparateInfo List of non-isolatable hosts
    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 Example

    This example shows you how to obtain the host where the Trojan cannot be isolated.

    Input Example

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

    Output Example

    {
        "Response": {
            "List": [
                {
                    "Uuid": "xx",
                    "PrivateIp": "xx",
                    "PublicIp": "xx",
                    "Alias": "xx",
                    "Reason": 1,
                    "Quuid": "xx"
                }
            ],
            "RequestId": "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 CAM signature/authentication error.
    AuthFailure.UnauthorizedOperation Authentication for the current user failed.
    InternalError Internal error
    InternalError.MainDBFail Failed to manipulate the data.
    InvalidParameter Incorrect parameter.
    InvalidParameter.InvalidFormat Incorrect parameter format.
    OperationDenied The operation was denied.
    ResourceNotFound The resource does not exist.
    UnauthorizedOperation Unauthorized operation.
    UnsupportedOperation The operation is not supported.