tencent cloud

APIs

DescribeCSIPMalwareScanTaskDetail

Download
Focus Mode
Font Size
Last updated: 2026-09-01 10:21:10

1. API Description

Domain name for API request: csip.intl.tencentcloudapi.com.

This API is used to get host details of a CSIP scan task.

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: DescribeCSIPMalwareScanTaskDetail.
Version Yes String Common Params. The value used for this API: 2022-11-21.
Region No String Common Params. This parameter is not required.
TaskId Yes Integer

Task ID.

MemberId.N No Array of String

Group account member id

Filters.N No Array of EDRFilter

PolicyType - int - required: no - policy typePolicyName - string - required: no - Policy NameDomain - string - required: no - Domain name (URL-encode the Domain name first, then encode it with base64)PolicyAction- int - required: no - policy actionIsEnabled - int - required: no - whether it takes effect

Limit No Integer

Limit number. Default value: 10. Maximum value: 100

Offset No Integer

Offset. Default: 0

Order No String

Sorting method: [ASC: ascending order|DESC: descending order]

By No String

Optional sorting column. Sorting is not currently supported. By default, sort by id in descending order.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer

Total.

List Array of CSIPMalwareScanUuidDetailItem

List

ScanBeginTime String

Scan start time, format 2006-01-02 15:04:05

ScanEndTime String

Scan end time in the format 2006-01-02 15:04:05. It is an empty string if the scan is not completed.

ScanMachineCount Integer

Total number of scanning machines.

RiskMachineCount Integer

Number of affected machines (Real Servers at risk)

ScanContent Array of String

Scan content. 0: full disk scan; 1: quick scan

Type Integer

Task type. 0: one-click scan, 1: scheduled scan, 2: rescan

ScanLeftTime Integer

Estimated remaining scan time in minutes. It is 0 when the scan is complete.

StoppingAll Boolean

Whether all machines are stopping. true indicates stopping

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 View Scan Details

Input Example

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

{
    "TaskId": 3069416
}

Output Example

{
    "Response": {
        "List": [
            {
                "CreateTime": "2026-05-14 20:16:42",
                "Exception": 0,
                "ExceptionMessage": "",
                "MachineAppId": 260108008,
                "MachineIP": "172.16.0.3",
                "MachineName": "VM-0-3-tencentos",
                "ModifyTime": "2026-05-14 20:17:12",
                "OsType": "TencentOS Server 4.4",
                "Quuid": "f314201c-ef88-4ab8-bc7d-f8daefdca3be",
                "RiskCount": 0,
                "Status": 3,
                "UsedTimeS": 0,
                "Uuid": "f314201c-ef88-4ab8-bc7d-f8daefdca3be"
            }
        ],
        "TotalCount": 2,
        "ScanBeginTime": "2026-05-14 20:16:42",
        "ScanEndTime": "2026-05-14 20:17:12",
        "ScanMachineCount": 2,
        "RiskMachineCount": 0,
        "ScanContent": [
            "0"
        ],
        "Type": 0,
        "ScanLeftTime": 0,
        "StoppingAll": false,
        "RequestId": "df06ef5a-8b70-4e5b-b499-fb59ed21d75a"
    }
}

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 Operation failed.
InternalError Internal error.
InvalidParameter Parameter error.

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback