1. API Description
Domain name for API request: tcss.intl.tencentcloudapi.com.
This API is used to query the list of containers affected by vulnerabilities.
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.
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: DescribeVulContainerList. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2020-11-01. |
| Region |
No |
String |
Common Params. This parameter is not required. |
| PocID |
Yes |
String |
POC ID |
| Limit |
No |
Integer |
Number of results to be returned. Default value: 10. Maximum value: 100. |
| Offset |
No |
Integer |
Offset. Default value: 0. |
| Filters.N |
No |
Array of RunTimeFilters |
Filter OnlyAffectedNewestImage- Bool- Required: No - Show only vulnerabilities that affect the latest image tagsContainerID- string - Required: No - Container IDContainerName- String - Required: No - Container name |
3. Output Parameters
| Parameter Name |
Type |
Description |
| List |
Array of VulAffectedContainerInfo |
List of containers |
| TotalCount |
Integer |
Total number of containers |
| 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 Querying the list of containers affected by vulnerabilities
https:
&PocID=1
&<Common request parameters>
Output Example
{
"Response": {
"TotalCount": 0,
"List": [
{
"HostID": "xx",
"HostName": "xx",
"ContainerID": "xx",
"PublicIP": "xx",
"PodIP": "xx",
"PodName": "xx",
"ContainerName": "xx",
"HostIP": "xx"
}
],
"RequestId": "xx"
}
}
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 |
A CAM signature/authentication error occurred. |
| 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. |
| InvalidParameterValue |
The parameter value is incorrect. |
| MissingParameter |
The parameter is missing. |
| ResourceNotFound |
The resource does not exist. |