Queries the ports enabled on hosts and the services provided by the ports.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListUserPorts

The operation that you want to perform. Set the value to ListUserPorts.

Search String No port:80

Specifies the host port or service you want to query.

CurrentPage Integer No 1

The number of the page to return.

Default value: 1.

PageSize Integer No 10

The number of entries to return on each page.

Default value: 10.

Maximum value: 10.

Response parameters

Parameter Type Example Description
CurrentPage Integer 1

The number of the returned page.

PageSize Integer 10

The number of entries returned per page.

Records Array

The ports enabled on hosts and the services provided by the ports.

Fingerprint String HTTPAPI httpd

The information of the port fingerprint.

IP String 192.168.1.1

The IP address.

Id Integer 1

The ID of the record.

Index Integer 1

The index number.

Port Integer 80

The port number.

Product String Microsoft HTTPAPI httpd

The name of the product.

Protocol String tcp

The name of the protocol.

Service String http

The name of the service.

UpdatedAt Long 1581348084000

The update time.

Version String 1.0

The version number.

RequestId String 8F39E2EA-2CED-48CD-8F98-C50F3D910975

The ID of the request.

TotalCount Integer 10

The total number of returned entries.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListUserPorts
&<Common request parameters>

Sample success responses

XML format

<ListUserPortsResponse>
  <Records>
        <UpdatedAt>1582630431000</UpdatedAt>
        <Service>http</Service>
        <Port>80</Port>
        <Index>1</Index>
        <Product>Tengine httpd</Product>
        <IP>1.1.1.1</IP>
        <Id>18970</Id>
        <Version></Version>
        <Protocol>tcp</Protocol>
        <Fingerprint></Fingerprint>
  </Records>
  <Records>
        <UpdatedAt>1582561718000</UpdatedAt>
        <Service>http</Service>
        <Port>80</Port>
        <Index>2</Index>
        <Product>Tengine httpd</Product>
        <IP>2.2.2.2</IP>
        <Id>18576</Id>
        <Version></Version>
        <Protocol>tcp</Protocol>
        <Fingerprint></Fingerprint>
  </Records>
  <Records>
        <UpdatedAt>1582544019000</UpdatedAt>
        <Service>http</Service>
        <Port>80</Port>
        <Index>3</Index>
        <Product>Tengine httpd</Product>
        <IP>3.3.3.3</IP>
        <Id>18369</Id>
        <Version></Version>
        <Protocol>tcp</Protocol>
        <Fingerprint></Fingerprint>
  </Records>
  <Records>
        <UpdatedAt>1581356439000</UpdatedAt>
        <Service>http</Service>
        <Port>80</Port>
        <Index>4</Index>
        <Product>unknown http service</Product>
        <IP>4.4.4.4</IP>
        <Id>20348</Id>
        <Version></Version>
        <Protocol>tcp</Protocol>
        <Fingerprint></Fingerprint>
  </Records>
  <Records>
        <UpdatedAt>1581356439000</UpdatedAt>
        <Service>http</Service>
        <Port>80</Port>
        <Index>5</Index>
        <Product>Microsoft IIS httpd</Product>
        <IP>5.5.5.5</IP>
        <Id>20346</Id>
        <Version>8.5</Version>
        <Protocol>tcp</Protocol>
        <Fingerprint></Fingerprint>
  </Records>
  <Records>
        <UpdatedAt>1581356439000</UpdatedAt>
        <Service>http</Service>
        <Port>80</Port>
        <Index>6</Index>
        <Product>Apache httpd</Product>
        <IP>6.6.6.6</IP>
        <Id>20292</Id>
        <Version>2.2.8</Version>
        <Protocol>tcp</Protocol>
        <Fingerprint></Fingerprint>
  </Records>
  <Records>
        <UpdatedAt>1581356439000</UpdatedAt>
        <Service>http</Service>
        <Port>80</Port>
        <Index>7</Index>
        <Product>Tengine httpd</Product>
        <IP>7.7.7.7</IP>
        <Id>20145</Id>
        <Version></Version>
        <Protocol>tcp</Protocol>
        <Fingerprint></Fingerprint>
  </Records>
  <Records>
        <UpdatedAt>1581356439000</UpdatedAt>
        <Service>http</Service>
        <Port>80</Port>
        <Index>8</Index>
        <Product>Tengine httpd</Product>
        <IP>8.8.8.8</IP>
        <Id>20143</Id>
        <Version></Version>
        <Protocol>tcp</Protocol>
        <Fingerprint></Fingerprint>
  </Records>
  <Records>
        <UpdatedAt>1581356439000</UpdatedAt>
        <Service>http</Service>
        <Port>80</Port>
        <Index>9</Index>
        <Product>nginx</Product>
        <IP>9.9.9.9</IP>
        <Id>20142</Id>
        <Version>1.10.2</Version>
        <Protocol>tcp</Protocol>
        <Fingerprint></Fingerprint>
  </Records>
  <Records>
        <UpdatedAt>1581356439000</UpdatedAt>
        <Service>http</Service>
        <Port>80</Port>
        <Index>10</Index>
        <Product>Tengine httpd</Product>
        <IP>10.10.10.10</IP>
        <Id>20139</Id>
        <Version></Version>
        <Protocol>tcp</Protocol>
        <Fingerprint></Fingerprint>
  </Records>
  <TotalCount>553</TotalCount>
  <PageSize>10</PageSize>
  <RequestId>FD9203C8-528D-4072-B00D-1ED688D31D00</RequestId>
  <CurrentPage>1</CurrentPage>
</ListUserPortsResponse>

JSON format

{
    "Records": [
        {
            "UpdatedAt": 1582630431000,
            "Service": "http",
            "Port": 80,
            "Index": 1,
            "Product": "Tengine httpd",
            "IP": "1.1.1.1",
            "Id": 18970,
            "Version": "",
            "Protocol": "tcp",
            "Fingerprint": ""
        },
        {
            "UpdatedAt": 1582561718000,
            "Service": "http",
            "Port": 80,
            "Index": 2,
            "Product": "Tengine httpd",
            "IP": "2.2.2.2",
            "Id": 18576,
            "Version": "",
            "Protocol": "tcp",
            "Fingerprint": ""
        },
        {
            "UpdatedAt": 1582544019000,
            "Service": "http",
            "Port": 80,
            "Index": 3,
            "Product": "Tengine httpd",
            "IP": "3.3.3.3",
            "Id": 18369,
            "Version": "",
            "Protocol": "tcp",
            "Fingerprint": ""
        },
        {
            "UpdatedAt": 1581356439000,
            "Service": "http",
            "Port": 80,
            "Index": 4,
            "Product": "unknown http service",
            "IP": "4.4.4.4",
            "Id": 20348,
            "Version": "",
            "Protocol": "tcp",
            "Fingerprint": ""
        },
        {
            "UpdatedAt": 1581356439000,
            "Service": "http",
            "Port": 80,
            "Index": 5,
            "Product": "Microsoft IIS httpd",
            "IP": "5.5.5.5",
            "Id": 20346,
            "Version": "8.5",
            "Protocol": "tcp",
            "Fingerprint": ""
        },
        {
            "UpdatedAt": 1581356439000,
            "Service": "http",
            "Port": 80,
            "Index": 6,
            "Product": "Apache httpd",
            "IP": "6.6.6.6",
            "Id": 20292,
            "Version": "2.2.8",
            "Protocol": "tcp",
            "Fingerprint": ""
        },
        {
            "UpdatedAt": 1581356439000,
            "Service": "http",
            "Port": 80,
            "Index": 7,
            "Product": "Tengine httpd",
            "IP": "7.7.7.7",
            "Id": 20145,
            "Version": "",
            "Protocol": "tcp",
            "Fingerprint": ""
        },
        {
            "UpdatedAt": 1581356439000,
            "Service": "http",
            "Port": 80,
            "Index": 8,
            "Product": "Tengine httpd",
            "IP": "8.8.8.8",
            "Id": 20143,
            "Version": "",
            "Protocol": "tcp",
            "Fingerprint": ""
        },
        {
            "UpdatedAt": 1581356439000,
            "Service": "http",
            "Port": 80,
            "Index": 9,
            "Product": "nginx",
            "IP": "9.9.9.9",
            "Id": 20142,
            "Version": "1.10.2",
            "Protocol": "tcp",
            "Fingerprint": ""
        },
        {
            "UpdatedAt": 1581356439000,
            "Service": "http",
            "Port": 80,
            "Index": 10,
            "Product": "Tengine httpd",
            "IP": "10.10.10.10",
            "Id": 20139,
            "Version": "",
            "Protocol": "tcp",
            "Fingerprint": ""
        }
    ],
    "TotalCount": 553,
    "PageSize": 10,
    "RequestId": "FD9203C8-528D-4072-B00D-1ED688D31D00",
    "CurrentPage": 1
}

Error codes

For a list of error codes, visit the API Error Center.