Help Center> Host Security Service (New)> API Reference> API Description> Asset Management> Asset Fingerprint of a Server - Open Port Information
Updated on 2023-01-12 GMT+08:00

Asset Fingerprint of a Server - Open Port Information

Function

This API is used to check open port information in the asset fingerprints of a server.

URI

GET /v5/{project_id}/asset/ports

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

User ID

Minimum: 1

Maximum: 256

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

host_id

No

String

Server ID

Minimum: 0

Maximum: 128

host_name

No

String

Server name

Minimum: 0

Maximum: 128

host_ip

No

String

Server IP address

Minimum: 0

Maximum: 128

port

No

Integer

Port number

Minimum: 1

Maximum: 65535

type

No

String

Port type

Minimum: 0

Maximum: 128

enterprise_project_id

No

String

Enterprise project

Minimum: 0

Maximum: 256

limit

No

Integer

Default value: 10

Minimum: 10

Maximum: 100

Default: 10

offset

No

Integer

Default value: 0

Minimum: 0

Maximum: 10000

Default: 0

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

x-auth-token

Yes

String

iam token

Minimum: 32

Maximum: 4096

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Total number

Minimum: 0

Maximum: 10000

data_list

Array of PortResponseInfo objects

Port information list

Table 5 PortResponseInfo

Parameter

Type

Description

host_id

String

Server ID

Minimum: 1

Maximum: 128

laddr

String

Listening IP address

Minimum: 1

Maximum: 128

status

String

Port status.

  • normal

  • "danger"

  • "unknow"

Minimum: 1

Maximum: 10

port

Integer

Port number

Minimum: 0

Maximum: 65535

type

String

Type

Minimum: 1

Maximum: 64

pid

Integer

Process ID

Minimum: 1

Maximum: 65535

path

String

Program file

Minimum: 1

Maximum: 256

Example Requests

None

Example Responses

Status code: 200

Port information list

{
  "total_num" : 1,
  "data_list" : [ {
    "host_id" : "3702fbd6-xxxx-xxxx-xxxx-6715770bxxxx",
    "laddr" : "0.0.0.0",
    "path" : "/usr/sbin/",
    "pid" : 1554,
    "port" : 22,
    "status" : "unknown",
    "type" : "TCP"
  } ]
}

Status Codes

Status Code

Description

200

Port information list

Error Codes

See Error Codes.