Tencent Cloud

Download PDF

DescribeSystemVulList

Last updated: 2023-12-04 17:12:48

Download PDF

1. API Description

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

This API is used to query the list of system 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.

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: DescribeSystemVulList.
Version	Yes	String	Common Params. The value used for this API: 2020-11-01.
Region	No	String	Common Params. This parameter is not required.
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 OnlyAffectedContainer- string - Required: No - Show only vulnerabilities that affect containers. Valid values: `true`, `false`. OnlyAffectedNewestImage-string - Required: No - Show only vulnerabilities that affect the latest image tags. Valid values: `true`, `false`. Level- String - Required: No - Severity. Valid values: `CRITICAL` (critical); `HIGH` (high); `MIDDLE` (medium); `LOW` (low). Tags- string - Required: No - Vulnerability tag. Valid values: `POC`, `EXP`. CanBeFixed- string - Required: No - Whether the vulnerability can be fixed. Valid values: `true`, `false`. CVEID- string - Required: No - CVE No. ImageID- string - Required: No - Image ID ImageName- String - Required: No - Image name ContainerID- string - Required: No - Container ID ContainerName- string - Required: No - Container name ComponentName- string - Required: No - Component name ComponentVersion- string - Required: No - Component version Name- string - Required: No - Vulnerability name FocusOnType - string - Required: No - Urgency. Valid values: `ALL` (all); `SERIOUS_LEVEL (critical and high risks);` IS_SUGGEST`(high-priority);`POC_EXP`(POC/EXP);`NETWORK_EXP` (remote EXP).
Order	No	String	Sorting order
By	No	String	Sorting field

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of vulnerabilities
List	Array of VulInfo	List of vulnerabilities
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the list of system vulnerabilities

Input Example

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

{
    "Limit": "10",
    "Offset": "0"
}

Output Example

{
    "Response": {
        "TotalCount": 0,
        "List": [
            {
                "Category": "xx",
                "CVEID": "xx",
                "RegistryImageCount": 0,
                "DefenceScope": "xx",
                "Name": "xx",
                "Level": "xx",
                "CVSSV3Score": 0.0,
                "Tags": [
                    "xx"
                ],
                "FoundTime": "xx",
                "DefenceStatus": "xx",
                "DefendedCount": 0,
                "ContainerCount": 0,
                "PocID": "xx",
                "LocalImageCount": 0,
                "LatestFoundTime": "xx",
                "ID": 0,
                "DefenceHostCount": 0
            }
        ],
        "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

Tencent Cloud CLI 3.0

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.
InternalError.MainDBFail	The database operation failed.
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.

tencent cloud

Recent Pages

DescribeSystemVulList

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying the list of system vulnerabilities

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?

tencent cloud

Sign Up

Log in

Recent Pages

DescribeSystemVulList

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying the list of system vulnerabilities

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?