DescribeVulInfo

Last updated: 2020-04-10 10:54:42

PDF

1. API Description

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

This API is used to get vulnerability details.

A maximum of 20 requests can be initiated per second for this API.

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 parameter. The value used for this API: DescribeVulInfo.
Version Yes String Common parameter. The value used for this API: 2018-02-28.
Region No String Common parameter. This parameter is not required for this API.
VulId Yes Integer Vulnerability category ID.

3. Output Parameters

Parameter Name Type Description
VulId Integer Vulnerability category ID.
VulName String Vulnerability name.
VulLevel String Vulnerability level.
VulType String Vulnerability type.
Description String Vulnerability description.
RepairPlan String Repair plan.
CveId String Vulnerability CVE.
Reference String Reference link.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting vulnerability details

This example shows you how to get vulnerability details.

Input Example

https://yunjing.tencentcloudapi.com/?Action=DescribeVulInfo
&VulId=1001
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
    "VulId": 1001,
    "VulName": "Vulnerability name",
    "VulLevel": "HIGH",
    "VulType": "WEB",
    "Description": "Vulnerability description",
    "RepairPlan": "Repair plan",
    "CveId": "CVE-001",
    "Reference": "http://www.qcloud.com"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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.InvalidFormat Incorrect parameter format.
InvalidParameter.ParsingError Parameter parsing error.
MissingParameter Missing parameter.
ResourceNotFound The resource does not exist.