tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeVirusScanTaskStatus

Last updated: 2024-07-22 11:05:17

    1. API Description

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

    This API is used to query the status of a virus scanning task at runtime.

    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: DescribeVirusScanTaskStatus.
    Version Yes String Common Params. The value used for this API: 2020-11-01.
    Region No String Common Params. This parameter is not required.
    TaskID No String Task ID

    3. Output Parameters

    Parameter Name Type Description
    ContainerTotal Integer Number of scanned containers
    RiskContainerCnt Integer Number of containers at risk
    Status String Scan task status:
    SCAN_NONE: None.
    SCAN_SCANNING: Scanning.
    SCAN_FINISH: Scanned.
    SCAN_TIMEOUT: Scan timed out.
    SCAN_CANCELING: Canceling.
    SCAN_CANCELED: Canceled.
    Schedule Integer Scanning progress
    ContainerScanCnt Integer Number of scanned containers
    RiskCnt Integer Number of risks
    LeftSeconds Integer Remaining scan time
    StartTime String Scan start time
    EndTime String Scan end time
    ScanType String Scan type. Valid values: CYCLE (periodic scan); MANUAL (manual scan).
    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 status of a virus scanning task at runtime

    This example shows you how to query the status of a virus scanning task at runtime.

    Input Example

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

{
    "TaskID": "dskaldjskld"
}

    Output Example

    {
    "Response": {
        "ContainerScanCnt": 0,
        "ContainerTotal": 339,
        "LeftSeconds": 4666,
        "RequestId": "b9e9e86e-5b7e-476c-9be1-a8c6399afef3",
        "RiskCnt": 0,
        "Schedule": 0,
        "Status": "SCANNING",
        "RiskContainerCnt": 0,
        "StartTime": "",
        "EndTime": "",
        "ScanType": 1
    }
}

    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
    InternalError An internal error occurred.
    InvalidParameter The parameter is incorrect.
    ResourceNotFound The resource does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy