Domain name for API request: csip.intl.tencentcloudapi.com.
Modify 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: ModifyRiskCenterScanTask. |
| 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 |
| ScanPlanType | Yes | Integer | 0: Periodic Task; 1: Scan Now; 2: Scheduled Scan; 3: Custom. If 0, 2, 3, ScanPlanContent is required. |
| TaskId | Yes | String | Task ID to be Modified |
| 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 |
| TaskAdvanceCFG | No | TaskAdvanceCFG | Advanced configuration. |
| TaskMode | No | Integer | Checkup Mode. 0: Standard Mode; 1: Quick Mode; 2: Advanced Mode. Standard Mode by default. |
| FinishWebHook | No | String | Task complete callback webhook url. |
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | String | Task ID. |
| Status | Integer | 0: Modification succeeded; others: 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. |
Modify Risk Center Scan Task
POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRiskCenterScanTask
<Common request parameters>
{
"MemberId": [
"mem-fe191feeedcc2567"
],
"TaskName": "asset scan task",
"Assets": [
{
"AssetName": "cvm-t1",
"InstanceType": "CVM",
"AssetType": "Instance",
"Asset": "ins-mx19k3r4",
"Region": "guangzhou"
}
],
"ScanAssetType": 0,
"ScanItem": [
"port"
],
"ScanPlanType": 0,
"ScanPlanContent": "38 53 11 */1 * * *",
"SelfDefiningAssets": [
"120.53.53.53"
],
"TaskId": "rmis-112hq236",
"TaskAdvanceCFG": {
"PortRisk": [
{
"PortSets": "80",
"CheckType": 0,
"Detail": "port info",
"Enable": 0
}
],
"VulRisk": [
{
"RiskId": "fc41d3fb24eb96a6dfb12c68e20ebf4b",
"Enable": 0
}
],
"WeakPwdRisk": [
{
"CheckItemId": 151,
"Enable": 0
}
],
"CFGRisk": [
{
"ItemId": "161",
"Enable": 0,
"ResourceType": "CentOS7"
}
]
},
"TaskMode": 0
}{
"Response": {
"TaskId": "rmis-112hq236",
"Status": 0,
"RequestId": "f9184c15-9721-456d-8ca0-4263967b5ead"
}
}
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 | The request would have succeeded, but the DryRun parameter was used. |
| FailedOperation | Operation failed. |
| InternalError | An internal error occurs. |
| InvalidParameter | The parameter is incorrect. |
| InvalidParameterValue | Invalid parameter value. |
| LimitExceeded | The quota limit is reached. |
| MissingParameter | Missing parameters. |
| OperationDenied | Operation denied. |
| RequestLimitExceeded | Too many requests. |
| ResourceInUse | Occupied resource |
| ResourceInsufficient | Resources are insufficient. |
| ResourceNotFound | The resource doesn't exist. |
| ResourceUnavailable | The resource is unavailable |
| ResourcesSoldOut | The resources have been sold out. |
| UnauthorizedOperation | The operation is unauthorized. |
| UnknownParameter | The parameter is unknown. |
| UnsupportedOperation | The operation is not supported. |
Feedback