Domain name for API request: csip.intl.tencentcloudapi.com.
Create Risk Center Scan Task
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: CreateRiskCenterScanTask. |
| Version | Yes | String | Common Params. The value used for this API: 2022-11-21. |
| Region | No | String | Common Params. This parameter is not required. |
| TaskName | Yes | String | Task name. |
| ScanAssetType | Yes | Integer | 0: Full Scan; 1: Specified Asset Scan; 2: Excluded Asset Scan; 3: Manual Entry Scan. 1 and 2 require the Assets field; 3 requires SelfDefiningAssets. |
| ScanItem.N | Yes | Array of String | Scan items. port/poc/weakpass/webcontent/configrisk/exposedserver. |
| ScanPlanType | Yes | Integer | 0: Periodic Task; 1: Scan Now; 2: Scheduled Scan; 3: Custom. If 0, 2, 3, ScanPlanContent is required. |
| MemberId.N | No | Array of String | Group Account Member ID |
| Assets.N | No | Array of TaskAssetObject | Scanned Asset Information List |
| ScanPlanContent | No | String | Scan Plan Details |
| SelfDefiningAssets.N | No | Array of String | IP/Domain/URL Array |
| ScanFrom | No | String | Request initiation source. vss refers to Vulnerability Scan Service. Users of CSC should fill in csip. Default value: csip. |
| TaskAdvanceCFG | No | TaskAdvanceCFG | Advanced configuration |
| TaskMode | No | Integer | Checkup Mode. 0: Standard Mode; 1: Quick Mode; 2: Advanced Mode. Standard Mode by default. |
| Tags | No | AssetTag | Asset tag |
| FinishWebHook | No | String | webhook URL for task completion callback |
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | String | Task ID. |
| Status | Integer | 0: Task creation succeeded; less than 0: Failed; -1: Unauthenticated assets exist. |
| UnAuthAsset | Array of String | Unauthenticated Asset List |
| 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. |
Create Risk Center Scan Task
POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRiskCenterScanTask
<Common request parameters>
{
"MemberId": [
"mem-68b8087a65268000"
],
"TaskName": "scan-task",
"Assets": [
{
"AssetName": "insname",
"InstanceType": "CVM",
"AssetType": "Instance",
"Asset": "ns-mx19k34r",
"Region": "ap-guangzhou"
}
],
"ScanAssetType": 1,
"ScanItem": [
"port"
],
"ScanPlanType": 2,
"ScanPlanContent": "38 53 11 */1 * * *",
"SelfDefiningAssets": [],
"ScanFrom": "csip",
"TaskAdvanceCFG": {
"PortRisk": [
{
"PortSets": "80",
"CheckType": 0,
"Detail": "port info",
"Enable": 0
}
]
},
"TaskMode": 0
}{
"Response": {
"TaskId": "rmis-18yeflff",
"RequestId": "7cf2ba3d-87ad-4691-a374-fd92ec11d9c8"
}
}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 |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| DryRunOperation | DryRun operation means the request will be successful, but the DryRun parameter is passed. |
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue | Parameter value error. |
| LimitExceeded | The quota limit is exceeded. |
| MissingParameter | Parameters are missing. |
| OperationDenied | Operation denied. |
| RequestLimitExceeded | Number of requests exceeds the frequency limit. |
| ResourceInUse | The resource is occupied. |
| ResourceInsufficient | Insufficient resources. |
| ResourceNotFound | The resource does not exist. |
| ResourceUnavailable | Resources are unavailable. |
| ResourcesSoldOut | Resources are sold out. |
| UnauthorizedOperation | Unauthorized operation. |
| UnknownParameter | Unknown parameter error. |
| UnsupportedOperation | The operation is not supported. |
Apakah halaman ini membantu?
Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.
masukan