1. API Description
Domain name for API request: cwp.intl.tencentcloudapi.com.
This API is used to obtain the list of components 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: DescribeVulEffectModules. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2018-02-28. |
| Region |
No |
String |
Common Params. This parameter is not required. |
| Limit |
Yes |
Integer |
Number of entries on each page. Maximum value: 100. |
| Offset |
Yes |
Integer |
Paging offset |
| VulId |
Yes |
Integer |
Vulnerability ID |
| Filters.N |
No |
Array of Filter |
Filter criteria: Uuid - String array - Uuid string array |
3. Output Parameters
| Parameter Name |
Type |
Description |
| TotalCount |
Integer |
Total number of lists |
| VulEffectModuleInfo |
Array of VulEffectModuleInfo |
List of affected hosts Note: This field may return null, indicating that no valid values can be obtained. |
| 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 List of Hosts Affected by the Vulnerability
This example shows you the list of hosts affected by the vulnerability.
POST / HTTP/1.1
Host: cwp.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVulEffectModules
<Common request parameters>
{
"Offset": "0",
"Limit": "10",
"VulId": "100435"
}
Output Example
{
"Response": {
"TotalCount": 1,
"VulEffectModuleInfo": [
{
"Name": "openssl-devel",
"Version": "1:1.0.2k-19.el7",
"FixCmd": "sudo yum update openssl-devel\n",
"Path": "/usr/include/openssl",
"Rule": "openssl-devel version less than 1:1.0.2k-22.el7_9",
"Uuids": [
"05f0bcab-726c-4ea4-8109-bcd03d5598f7"
],
"Quuids": [
"05f0bcab-726c-4ea4-8109-bcd03d5598f7"
]
}
],
"RequestId": "be6f6eec-0825-4e67-ab9a-c8568bbf736c"
}
}
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 |
| InternalError |
Internal error |
| InvalidParameter |
Incorrect parameter. |
| InvalidParameter.IllegalRequest |
Invalid request. |
| InvalidParameter.InvalidFormat |
Incorrect parameter format. |
| InvalidParameter.MissingParameter |
Missing parameter. |
| InvalidParameter.ParsingError |
Incorrect parameter parsing. |
| InvalidParameterValue |
Invalid parameter value. |
| MissingParameter |
Missing parameter error. |