tencent cloud

APIs

DescribeVulScanTaskDetail

Download
Modo Foco
Tamanho da Fonte
Última atualização: 2026-08-11 19:10:24

1. API Description

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

This API is used to retrieve vulnerability scanning task detail

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

Task ID.

MemberId.N No Array of String

Group account member id

Filters.N No Array of Filters

Filter criteria, support the following Name:

  • InstanceId - Asset Instance ID, exact match
  • InstanceName - Asset instance name, fuzzy matching (exact matching when ExactMatch=1)
  • Ip - Asset IP, exact match
  • Status - Scan status, exact match
  • Limit No Integer

    Page size. Default: 10. Maximum: 100

    Offset No Integer

    Pagination offset, starting from 0

    Order No String

    Sorting order: asc (ascending)/ desc (descending). Default is desc.

    By No String

    Sorting field, default sorting order is creation time (CreateTime)

    3. Output Parameters

    Parameter Name Type Description
    List Array of VulScanTaskDetail

    Task Detail List

    Total Integer

    Total.

    Vuls Integer

    Vulnerability count

    Scanned Integer

    Number of scans

    Risk Integer

    Risk quantity.

    Failed Integer

    Number of failures.

    Progress Integer

    Scan progress (0-100)

    TaskPdf String

    Task pdf report address

    TaskExcel String

    Task excel report address

    StartTime String

    Task start time, format: 2006-01-02T15:04:05+08:00

    EndTime String

    Task end time, format: 2006-01-02T15:04:05+08:00

    VulId Array of Integer

    Vulnerability ID

    KbNo Array of String

    KB No.

    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 Retrieve Vulnerability Scan Task Details

    Input Example

    POST / HTTP/1.1
    Host: csip.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeVulScanTaskDetail
    <Common request parameters>
    
    {
        "Id": 127,
        "Filters": [
            {
                "Name": "InstanceId",
                "Values": [
                    "ins-2f***t2k"
                ]
            }
        ],
        "Limit": 2,
        "Offset": 0,
        "Order": "DESC",
        "By": "CreateTime"
    }

    Output Example

    {
        "Response": {
            "EndTime": "2026-06-10T13:33:00Z",
            "Failed": 24,
            "List": [
                {
                    "AppId": 260083796,
                    "Description": "",
                    "EndTime": "2026-06-10T12:33:13Z",
                    "Id": "2346",
                    "InstanceId": "ins-2f****2k",
                    "InstanceName": "tke_cls-dqum4px0_master_etcd3",
                    "OS": "TencentOS Server 3.1 (Final)",
                    "PrivateIp": "172.16.0.108",
                    "PublicIp": "",
                    "StartTime": "2026-06-10T12:32:44Z",
                    "Status": "SUCCESS",
                    "Vuls": 0
                }
            ],
            "Progress": 100,
            "Risk": 1,
            "Scanned": 51,
            "StartTime": "2026-06-10T12:31:14Z",
            "TaskExcel": "https://*****r*-1**8*4**99.cos.ap-guangzhou.myqcloud.com/vul*s*an**",
            "TaskPdf": "https://*****r*-1**8*4**99.cos.ap-guangzhou.myqcloud.com/vul*s*an**",
            "Total": 1,
            "Vuls": 1,
            "RequestId": "4df6736c-24d7-48e9-8876-dde3a615328b"
        }
    }

    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 Internal error.

    Ajuda e Suporte

    Esta página foi útil?

    comentários