tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeScanTaskList

Last updated: 2024-07-22 10:38:34

    1. API Description

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

    This API is used to get the list of scan tasks.

    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: DescribeScanTaskList.
    Version Yes String Common Params. The value used for this API: 2022-11-21.
    Region No String Common Params. This parameter is not required.
    Filter No Filter Filter conditions
    Tags.N No Array of Tags Tags

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of entries
    Note: This field may return null, indicating that no valid values can be obtained.
    Data Array of ScanTaskInfoList List of scan tasks
    Note: This field may return·null, indicating that no valid values can be obtained.
    UINList Array of String List of account UINs
    Note: This field may return·null, indicating that no valid values can be obtained.
    TaskModeList Array of FilterDataObject List of task modes
    Note: This field may return·null, indicating that no valid values can be obtained.
    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 Getting the list of scan tasks

    This example shows you how to get the list of scan tasks.

    Input Example

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

{
    "Filter": {
        "Limit": 0,
        "Offset": 0,
        "Order": "abc",
        "By": "abc",
        "Filters": [
            {
                "Name": "abc",
                "Values": [
                    "abc"
                ],
                "OperatorType": 0
            }
        ],
        "StartTime": "abc",
        "EndTime": "abc"
    }
}

    Output Example

    {
    "Response": {
        "TotalCount": 1,
        "Data": [
            {
                "TaskName": "abc",
                "StartTime": "abc",
                "EndTime": "abc",
                "ScanPlanContent": "abc",
                "TaskType": 0,
                "InsertTime": "abc",
                "TaskId": "abc",
                "SelfDefiningAssets": [
                    "abc"
                ],
                "PredictTime": 0,
                "PredictEndTime": "abc",
                "ReportNumber": 0,
                "AssetNumber": 0,
                "ScanStatus": 0,
                "Percent": 0,
                "ScanItem": "abc",
                "ScanAssetType": 0,
                "VSSTaskId": "abc",
                "CSPMTaskId": "abc",
                "CWPPOCId": "abc",
                "CWPBlId": "abc",
                "VSSTaskProcess": 0,
                "CSPMTaskProcess": 1,
                "CWPPOCProcess": 0,
                "CWPBlProcess": 1,
                "ErrorCode": 0,
                "ErrorInfo": "abc",
                "StartDay": 0,
                "Frequency": 0,
                "CompleteNumber": 0,
                "CompleteAssetNumber": 0,
                "RiskCount": 0,
                "Assets": [
                    {
                        "AssetName": "abc",
                        "InstanceType": "abc",
                        "AssetType": "abc",
                        "Asset": "abc",
                        "Region": "abc"
                    }
                ],
                "AppId": "abc",
                "UIN": "abc",
                "UserName": "abc",
                "TaskMode": 0,
                "ScanFrom": "abc",
                "IsFree": 0
            }
        ],
        "UINList": [
            "abc"
        ],
        "TaskModeList": [
            {
                "Value": "abc",
                "Text": "abc"
            }
        ],
        "RequestId": "abc"
    }
}

    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.
    DryRunOperation The request would have succeeded, but the DryRun parameter was used.
    FailedOperation Operation failed.
    InternalError An internal error occurs.
    InvalidParameter The parameter is incorrect.
    InvalidParameterValue Invalid parameter value.
    LimitExceeded The quota limit is reached.
    MissingParameter Missing parameters.
    OperationDenied Operation denied.
    RequestLimitExceeded Too many requests.
    ResourceInUse Occupied resource
    ResourceInsufficient Resources are insufficient.
    ResourceNotFound The resource doesn't exist.
    ResourceUnavailable The resource is unavailable
    ResourcesSoldOut The resources have been sold out.
    UnauthorizedOperation The operation is unauthorized.
    UnknownParameter The parameter is unknown.
    UnsupportedOperation The operation is not supported.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy