Querying the Open Port List of a Single Server_Asset Management_API Description_API Reference (Ally Region)

Function

This API is used to query the open port list of a single server.

URI

GET /v5/{project_id}/asset/ports

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
host_id	Yes	String	Server ID
host_name	No	String	Server name
host_ip	No	String	Server IP address
port	No	Integer	Port number
type	No	String	Port type: TCP or UDP.
enterprise_project_id	No	String	Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps.
limit	No	Integer	Number of records on each page
offset	No	Integer	Offset, which specifies the start position of the record to be returned.
category	No	String	Type. The default value is host. The options are as follows: host container

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a user token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Number of open ports
data_list	Array of PortResponseInfo objects	Port information list

**Table 5** PortResponseInfo
Parameter	Type	Description
host_id	String	Server ID
laddr	String	Listening IP address
status	String	Port status. normal danger unknown
port	Integer	Port number
type	String	Port type: TCP or UDP.
pid	Integer	Process ID
path	String	Path of the process execution file.
agent_id	String	Agent ID
container_id	String	Container ID

Example Requests

The first 10 open ports whose host_id is dd91cd32-a238-4c0e-bc01-3b11653714ac are queried by default.

GET https://{endpoint}/v5/{project_id}/asset/ports?hlimit=10&offset=0&host_id=dd91cd32-a238-4c0e-bc01-3b11653714ac

Example Responses

Status code: 200

Request succeeded.

{
  "data_list" : [ {
    "agent_id" : "eb5d03f02fffd85aaf5d0ba5c992d97713244f420e0b076dcf6ae0574c78aa4b",
    "container_id" : "",
    "host_id" : "dd91cd32-a238-4c0e-bc01-3b11653714ac",
    "laddr" : "0.0.0.0",
    "path" : "/usr/sbin/dhclient",
    "pid" : 1507,
    "port" : 68,
    "status" : "unknow",
    "type" : "UDP"
  }, {
    "agent_id" : "eb5d03f02fffd85aaf5d0ba5c992d97713244f420e0b076dcf6ae0574c78aa4b",
    "container_id" : "",
    "host_id" : "dd91cd32-a238-4c0e-bc01-3b11653714ac",
    "laddr" : "127.0.0.1",
    "path" : "/usr/sbin/chronyd",
    "pid" : 493,
    "port" : 323,
    "status" : "unknow",
    "type" : "UDP"
  } ],
  "total_num" : 2
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Querying the Open Port List of a Single Server