tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Container Security Service
    Documentation
    Download PDF

    DescribeVirusTaskList

    Last updated: 2024-07-22 11:05:13
    Download PDF

      1. API Description

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

      This API is used to query the list of virus scanning tasks 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: DescribeVirusTaskList.
      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 Yes String Task ID
      Limit No Integer Number of results to be returned. Default value: 10. Maximum value: 100.
      Offset No Integer Offset. Default value: 0.
      Filters.N No Array of RunTimeFilters Filter
    • ContainerName- String - Required: No - Container name
    • ContainerId - String - Required: No - Container ID
    • Hostname - String - Required: No - Server name
    • HostIp- String - Required: No - Server IP
    • ImageId- String - Required: No - Image ID
    • ImageName- String - Required: No - Image name
    • Status- String - Required: No - Status
      		•
      By No String Sorting field
      Order No String Sorting order

      3. Output Parameters

      Parameter Name Type Description
      List Array of VirusTaskInfo Virus scanning list
      TotalCount Integer Total number (number of container tasks)
      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 list of virus scanning tasks at runtime

      This example shows you how to query the list of virus scanning tasks at runtime.

      Input Example

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

{
    "TaskId": "dskaldjskld"
}

      Output Example

      {
    "Response": {
        "List": [],
        "RequestId": "ff49ad4b-fe52-4f9d-8810-ba377eab9124",
        "TotalCount": 6
    }
}

      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.InvalidFormat The parameter format is incorrect.
      InvalidParameter.MissingParameter The required parameter is missing.
      InvalidParameter.ParsingError A parameter parsing error occurred.
      ResourceNotFound The resource does not exist.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy