tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateVulScanTask

Last updated: 2024-07-22 11:04:45

    1. API Description

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

    This API is used to create a vulnerability 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: CreateVulScanTask.
    Version Yes String Common Params. The value used for this API: 2020-11-01.
    Region No String Common Params. This parameter is not required.
    LocalImageScanType No String Local image scan scope. Valid values: ALL (all local images); NOT_SCAN (all licensed but not scanned local images); IMAGEIDS (IDs of specified local images).
    LocalImageIDs.N No Array of String Scan by licensed local image ID, with a higher priority than scan by licensed local image that meets the condition.
    RegistryImageScanType No String Repository image scan scope. Valid values: ALL (all repository images); NOT_SCAN (all licensed but not scanned repository images); IMAGEIDS (IDs of specified repository images).
    RegistryImageIDs.N No Array of Integer Scan by licensed repository image ID, with a higher priority than scan by licensed repository image that meets the condition.
    LocalTaskID No Integer ID of the task to scan local images again for vulnerabilities
    RegistryTaskID No Integer ID of the task to scan repository images again for vulnerabilities

    3. Output Parameters

    Parameter Name Type Description
    LocalTaskID Integer ID of the task to scan local images again for vulnerabilities
    RegistryTaskID Integer ID of the task to scan repository images again for vulnerabilities
    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 Creating a vulnerability scan task

    Input Example

    https://tcss.tencentcloudapi.com/?Action=CreateVulScanTask
&LocalImageScanType=ALL
&RegistryImageScanType=ALL
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "xx",
        "LocalTaskID": 0,
        "RegistryTaskID": 0
    }
}

    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 A CAM signature/authentication error occurred.
    FailedOperation The operation failed.
    InternalError An internal error occurred.
    InvalidParameter The parameter is incorrect.
    InvalidParameter.InvalidFormat The parameter format is incorrect.
    InvalidParameter.MissingParameter The required parameter is missing.
    InvalidParameter.ParsingError A parameter parsing error occurred.
    MissingParameter The parameter is missing.
    ResourceInUse The resource is in use.
    ResourceNotFound The resource does not exist.
    ResourceUnavailable The resource is unavailable.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy