Domain name for API request: csip.intl.tencentcloudapi.com.
Triggered after you click start scanning. It supports multi-account and multiple asset types. When both hosts and container clusters are selected, it splits into two independent tasks (host + container).
A maximum of 20 requests can be initiated per second for this API.
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: CreateEDRManualScan. |
| Version | Yes | String | Common Params. The value used for this API: 2022-11-21. |
| Region | No | String | Common Params. This parameter is not required. |
| AssetSelectionType | Yes | String | Asset selection method: all - all assets/tag - select by tag (hosts only)/direct - direct selection |
| ScanType | Yes | String | Detection mode: full - full-disk detection / quick - rapid detection / include - detect specified paths only / exclude - exclude specified paths |
| MemberId.N | No | Array of String | Group account member id |
| InstanceIDsWithAppId.N | No | Array of InstanceIDWithAppIdItem | Directly selected host list (used when AssetSelectionType=direct or all) |
| ExcludeInstanceIDsWithAppId.N | No | Array of InstanceIDWithAppIdItem | Host list for removal (used when AssetSelectionType=all) |
| TagIds.N | No | Array of Integer | Tag ID corresponding to the host |
| ClusterIDsWithAppId.N | No | Array of ClusterWithAppIdItem | Cluster list for direct selection |
| ExcludeClusterIDsWithAppId.N | No | Array of ClusterWithAppIdItem | Cluster list for removal (used when AssetSelectionType=all) |
| CustomPaths.N | No | Array of String | Selected path list (required when ScanType is include or exclude, up to 100 entries) |
| Timeout | No | Integer | Timeout period in seconds, upper limit 7200 |
| EnableMemShellScan | No | Integer | Whether deep detection is enabled: 0-No/1-Yes |
| Parameter Name | Type | Description |
|---|---|---|
| Tasks | Array of CreatedTaskItem | List of created tasks (one for the host and one for the container) |
| 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. |
POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateEDRManualScan
<Common request parameters>
{
"AssetSelectionType": "tag",
"ScanType": "include",
"MemberId": [
"mem-tencent-54213b157ddf7170"
],
"TagIds": [
139
],
"CustomPaths": [
"/tmp"
],
"Timeout": 1800,
"EnableMemShellScan": 0
}{
"Response": {
"Tasks": [
{
"AppId": 260199972,
"TaskId": 304,
"TaskType": "HOST"
}
],
"RequestId": "00dc20af-e070-4c80-b24c-becae48e73cb"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
| InvalidParameterValue | Parameter value error. |
| MissingParameter | Parameters are missing. |
| OperationDenied | Operation denied. |
| ResourceNotFound | The resource does not exist. |
文档反馈