Contents:
1. API Description
Domain name for API request: yunjing.tencentcloudapi.com.
This API (DescribeAgentVuls) is used to get the list of vulnerabilities of a host.
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 valueused for this API: DescribeAgentVuls. |
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. |
VulType | Yes | String | Vulnerability type. |
Uuid | Yes | String | UUID of the client. |
Limit | No | Integer | Number of returned results. It defaults to 10. The maximum is 100. |
Offset | No | Integer | Offset. It defaults to 0. |
Filters.N | No | Array of Filter | Filter. |
3. Output Parameters
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Total number of records. |
AgentVuls | Array of AgentVul | Information on the vulnerabilities of a host. |
RequestId | String | The unique ID of a request, which is required for each troubleshooting case. |
4. Example
Example 1 Get the list of vulnerabilities of a host
Input example
https://yunjing.tencentcloudapi.com/?Action=DescribeAgentVuls
&Uuid=add4a78a-0d59-11e8-b7ab-00e081e1a5c5
&VulType=WEB
&Limit=10
&Offset=0
&<Common request parameters>
Output example
{
"Response": {
"TotalCount": 10,
"RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
"AgentVuls": [
{
"Description": "Vulnerability description",
"VulName": "Vulnerability name",
"LastScanTime": "2018-03-19 17:38:56",
"Id": 4,
"VulLevel": "HIGHT",
"VulStatus": "UN_OPERATED",
"VulId": 1001,
"MachineIp": "10.10.120.12"
}
]
}
}
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.
SDK
Cloud API 3.0 comes with the software development kit (SDK) that supports multiple programming languages and makes it easier to call the APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
Command line tools
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. |