Help & DocumentationCloud Workload ProtectionAPI documentationVulnerability Management-Related APIsDescribeAgentVuls

DescribeAgentVuls

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

PDF

1. API Description

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

This API is used to get the list of vulnerabilities on a single server.

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: DescribeAgentVuls.
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.
VulType Yes String Vulnerability type.
  • WEB: web application vulnerability
  • SYSTEM: system component vulnerability
  • BASELINE: security baseline
    		•
    Uuid Yes String Agent UUID.
    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 Filter Filter.
  • Status - String - Required: No - Filter by status (UN_OPERATED: to be processed, FIXED: fixed)
    		•

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of records
    AgentVuls Array of AgentVul Server vulnerability information
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Getting the list of vulnerabilities on server

    This example shows you how to get the list of vulnerabilities on a server.

    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": {
    "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
    "AgentVuls": [
      {
        "Id": 4,
        "VulId": 1001,
        "MachineIp": "10.10.120.12",
        "Description": "Vulnerability description",
        "VulName": "Vulnerability name",
        "VulLevel": "HIGHT",
        "VulStatus": "UN_OPERATED",
        "LastScanTime": "2018-03-19 17:38:56"
      }
    ],
    "TotalCount": 10
  }
}

    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.