tencent cloud

APIs

CreateCSIPManualMalwareScan

Download
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-09-01 10:21:27

1. API Description

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

This API is used to create a CSIP manual scan.

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

Scan mode: 0=full disk scan / 1=quick scan, consistent with the semantics of the scan_type field in cwp_malware Scan RPC

Scope Yes Integer

Effective scope gear selection: 0 = specified hosts (ScopeSpecified) / 1 = select all CSIP paid machines (ScopeAll). If the old frontend does not pass this parameter, the zero value defaults to 0 for compatibility

MemberId.N No Array of String

Group account member id

EnableMemShellScan No Integer

Whether to enable Java Webshell scan (0/1), passed through to cwp_malware

Timeout No Integer

Standalone scan timeout seconds; <=0 takes default 3600

TargetAppIDs.N No Array of Integer

Target app IDs in a multi-account system; if empty, fallback to [req.AppId] (self only). Regardless of Scope=0/1, they are validated through csip.ValidateTargetAppIDsViaCSIP

EngineType No Integer

Scan engine type, passed through to cwp_malware at the cloudapi layer and not persisted to the primary table. Engine mode: 1 standard mode, 2 enhanced mode, 3 strict mode. Enumerated values: 1: standard mode, 2: enhanced mode, 3: strict mode

InstanceIDsWithAppId.N No Array of InstanceIDWithAppIdItem

Specify the machine list and instance ID version

ExcludeInstanceIDsWithAppId.N No Array of InstanceIDWithAppIdItem

Machines excluded during select all, instance ID version

3. Output Parameters

Parameter Name Type Description
TaskId Integer

Task ID.

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 Create a manual scan API

Input Example

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

{
    "ScanPattern": 1,
    "Scope": 1,
    "MemberId": [
        "mem-tencent-e74488e0ba0cd8fe"
    ],
    "EnableMemShellScan": 0,
    "Timeout": 3600,
    "TargetAppIDs": [
        260199983
    ],
    "EngineType": 1,
    "InstanceIDsWithAppId": [
        {
            "AppId": 260199983,
            "InstanceID": "ins-f9324z7u"
        }
    ],
    "ExcludeInstanceIDsWithAppId": [
        {
            "AppId": 260199983,
            "InstanceID": "ins-9vrkb5nv"
        }
    ]
}

Output Example

{
    "Response": {
        "TaskId": 3086642,
        "RequestId": "39fa9803-e092-476f-b6b0-484c1319db2a"
    }
}

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.
InternalError Internal error.
InvalidParameter Parameter error.

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan