Domain name for API request: tcss.intl.tencentcloudapi.com.
This API is used to create a vulnerability 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: CreateVulScanTask. |
| Version | Yes | String | Common Params. The value used for this API: 2020-11-01. |
| Region | No | String | Common Params. This parameter is not required. |
| LocalImageScanType | No | String | Local image scan range type Enumeration value:
|
| LocalImageIDs.N | No | Array of String | Scan by authorized local image IDs, which takes precedence over scanning by authorized local images that meet the conditions. |
| RegistryImageScanType | No | String | Repository image scan range type. ALL: All repository images. NOT_SCAN: Total authorized unscanned repository images. IMAGEIDS: Selected repository image IDs. |
| RegistryImageIDs.N | No | Array of Integer | Scan by authorized repository image IDs, which takes precedence over scanning by authorized repository images that meet the conditions. |
| LocalTaskID | No | Integer | Task ID for local image re-vulnerability scanning |
| RegistryTaskID | No | Integer | Task ID for repository image re-vulnerability scanning |
| LocalImageContainerRunning | No | Boolean | Local image container runtime |
| RegistryImageContainerRunning | No | Boolean | Image Container in repository is running |
| IsLatest | No | Boolean | Whether the repository image is the latest |
| ExcludeLocalImageIDs.N | No | Array of String | Local image id to remove |
| ExcludeRegistryImageIDs.N | No | Array of Integer | id of the repository image to remove |
| LocalClusterIDs.N | No | Array of String | Cluster ID. |
| Parameter Name | Type | Description |
|---|---|---|
| LocalTaskID | Integer | Task ID for local image re-vulnerability scanning |
| RegistryTaskID | Integer | Task ID for repository image re-vulnerability scanning |
| 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. |
https://tcss.intl.tencentcloudapi.com/?Action=CreateVulScanTask
&LocalImageScanType=ALL
&RegistryImageScanType=ALL
&<Common request parameters>
{
"Response": {
"LocalTaskID": 36002,
"RegistryTaskID": 0,
"RequestId": "5d02bef4-9f93-4d9d-90a9-47d7be4c8fc0"
}
}
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 | A CAM signature/authentication error occurred. |
| FailedOperation | The operation failed. |
| InternalError | An internal error occurred. |
| InvalidParameter | The parameter is incorrect. |
| InvalidParameter.InvalidFormat | The parameter format is incorrect. |
| InvalidParameter.MissingParameter | The required parameter is missing. |
| InvalidParameter.ParsingError | A parameter parsing error occurred. |
| MissingParameter | The parameter is missing. |
| ResourceInUse | The resource is in use. |
| ResourceNotFound | The resource does not exist. |
| ResourceUnavailable | The resource is unavailable. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback