Last updated: 2019-06-26 20:08:01

1. API Description

Domain name for API request:

This API (DescribeOpenPorts) is used to obtain the port list.

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: DescribeOpenPorts.
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.
Uuid No String Unique Uuid of the HS client. Either Port or Uuid should be specified. If Uuid is specified, it means querying the host list.
Port No Integer Open port. Either Port or Uuid should be specified. If Port is specified, it means querying the port list.
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 condition.
  • Port - Uint64 - Required: No - Port
  • ProcessName - String - Required: No - Process name
  • MachineIp - String - Required: No - Host private IP
  • 3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of ports in the list.
    OpenPorts Array of OpenPort Port list.
    RequestId String The unique ID of a request, which is required for each troubleshooting case.

    4. Example

    Example 1 Obtain port list

    Input example
    &<Common request parameters>

    Output example

      "Response": {
        "OpenPorts": [
            "Uuid": "6b6cd843-6bc1-4011-a74c-dc3fd26a7dd1",
            "MachineName": "h2-stevenyu",
            "Pid": 14456,
            "MachineIp": "",
            "ProcessName": "mysql",
            "CreateTime": "2018-01-01 12:12:12",
            "ModifyTime": "2018-01-01 12:12:12",
            "Id": 1,
            "Port": 3306
        "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
        "TotalCount": 100

    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.IllegalRequest Invalid request.
    InvalidParameter.InvalidFormat Incorrect parameter format.
    MissingParameter A parameter is missing.