Last updated: 2019-06-26 20:07:58

1. API Description

Domain name for API request:

This API (DescribeVulInfo) is used to get details about a vulnerability.

Default request rate limit: 20/sec.

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: 2/28/2018
Region No String Common parameter. This parameter is not required for this API.
VulId Yes Integer Vulnerability type ID.

3. Output Parameters

Parameter Name Type Description
VulId Integer Vulnerability type ID.
VulName String Vulnerability name.
VulLevel String Vulnerability level.
VulType String Vulnerability type.
Description String Vulnerability description.
RepairPlan String Repair solution.
CveId String Vulnerability CVE.
Reference String Reference link.
RequestId String The unique ID of a request, which is required for each troubleshooting case.

4. Example

Example 1 Get details about a vulnerability

Input example
&<Common request parameters>

Output example

  "Response": {
    "CveId": "CVE-001",
    "Description": "Vulnerability description",
    "VulType": "WEB",
    "VulName": "Vulnerability name",
    "VulLevel": "HIGHT",
    "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
    "VulId": 1001,
    "RepairPlan": "Repair solution",
    "Reference": ""

5. Resources for Developers

API Explorer

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

6. Error Codes

The following only lists the error codes related to this API. 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 A parameter is missing.
ResourceNotFound Resource does not exist.