tencent cloud

All product documents
APIs
DocumentationAPIsCloud Security CenterScan Task APIsCreateRiskCenterScanTask
CreateRiskCenterScanTask
Last updated: 2024-07-22 10:38:37
CreateRiskCenterScanTask
Last updated: 2024-07-22 10:38:37

1. API Description

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

This API is used to create a risk scan task.

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: 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 Values: 0 (Scan all); 1 (Scan specific assets); 2 (Scan all expect the specified assets); 3 (Custom assets). When ScanAssetType=1/2, Assets is required. When ScanAssetType=3, SelfDefiningAssets is required.
ScanItem.N Yes Array of String Project to scan: port/poc/weakpass/webcontent/configrisk/exposedserver
ScanPlanType Yes Integer Task type. 0: Scheduled task, 1: Scan immediately; 2: Scanned at the specified time; 3: Custom. When ScanPlanType=0,2,3, ScanPlanContent is required.
Assets.N No Array of TaskAssetObject List of assets to scan
ScanPlanContent No String Details of a scheduled scan task
SelfDefiningAssets.N No Array of String IP/Domain name/URL
ScanFrom No String Request source. Values: vss (Vulnerability Scan Service), csip (Cloud Security Center). It defaults to vss.
TaskAdvanceCFG No TaskAdvanceCFG Advanced settings
TaskMode No Integer Scan task mode: 0 (Standard), 1 (Quick), 2 (Advanced). Default: 0
Tags No AssetTag Asset tags

3. Output Parameters

Parameter Name Type Description
TaskId String Task ID.
Status Integer 0: Task created successfully. -1: There are unauthorized assets.
UnAuthAsset Array of String List of unauthorized assets
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 Creating a risk scan task

This example shows you how to create a risk scan task.

Input Example

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

{
    "TaskName": "abc",
    "Assets": [
        {
            "AssetName": "abc",
            "InstanceType": "abc",
            "AssetType": "abc",
            "Asset": "abc",
            "Region": "abc"
        }
    ],
    "ScanAssetType": 0,
    "ScanItem": [
        "abc"
    ],
    "ScanPlanType": 0,
    "ScanPlanContent": "abc",
    "SelfDefiningAssets": [
        "abc"
    ],
    "ScanFrom": "abc",
    "TaskAdvanceCFG": {},
    "TaskMode": 0
}

Output Example

{
    "Response": {
        "TaskId": "abc",
        "RequestId": "abc"
    }
}

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
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.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

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
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon