tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Cloud Firewall
    Documentation

    ModifyAssetScan

    Last updated: 2023-05-04 17:40:09

    1. API Description

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

    This API is used to modify asset scan settings.

    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: ModifyAssetScan.
    Version Yes String Common Params. The value used for this API: 2019-09-04.
    Region No String Common Params. This parameter is not required for this API.
    ScanRange Yes Integer Scan range. 1: port; 2: port + vulnerability scan
    ScanDeep Yes String Scan mode: 'heavy', 'medium', 'light'
    RangeType Yes Integer Scan type. 1: scan now; 2: periodic scan
    ScanPeriod No String Scheduled task time, required when RangeType is 2
    ScanFilterIp.N No Array of String Scans this field now and passes the filtered IPs
    ScanType No Integer 1: all; 2: single

    3. Output Parameters

    Parameter Name Type Description
    ReturnMsg String Return message
    Note: This field may return null, indicating that no valid value was found.
    ReturnCode Integer Error code. 0: success; non-0: failed
    Note: This field may return null, indicating that no valid value was found.
    Status Integer Status value. 0: success; 1: scanning; others: failed
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Scanning

    Input Example

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

{
    "ScanRange": 1,
    "ScanDeep": "heavy",
    "RangeType": 2,
    "ScanPeriod": "Every Thursday/12:51:00",
    "ScanFilterIp": [
        "11",
        "22"
    ]
}

    Output Example

    {
    "Response": {
        "Status": 0,
        "ReturnCode": 0,
        "ReturnMsg": "success",
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

    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
    FailedOperation Operation failed.
    InvalidParameter Invalid parameter.
    LimitExceeded The quota limit has been reached.
    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