Asset Fingerprints - Port - Server List
Function
Servers or containers having the port
URI
GET /v5/{project_id}/asset/ports/detail
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Project ID |
Parameter | Mandatory | Type | Description |
---|---|---|---|
enterprise_project_id | No | String | Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps. |
host_name | No | String | Server name |
host_ip | No | String | Server IP address |
port | Yes | Integer | Port number |
type | No | String | Port type: TCP or UDP. |
category | No | String | Type. The default value is host. The options are as follows:
|
limit | No | Integer | Number of records on each page |
offset | No | Integer | Offset, which specifies the start position of the record to be returned. |
Request 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
Parameter | Type | Description |
---|---|---|
total_num | Integer | Total servers |
data_list | Array of PortHostResponseInfo objects | Server information list |
Parameter | Type | Description |
---|---|---|
container_id | String | Image ID |
host_id | String | Server ID |
host_ip | String | Server IP address |
host_name | String | Server name |
laddr | String | Listening IP address |
path | String | Path of the process execution file. |
pid | Integer | pid |
port | Integer | Port |
status | String | Status |
type | String | Port type: TCP or UDP. |
container_name | String | Container name |
agent_id | String | Agent ID |
Example Requests
The first 10 servers whose port number is 22 are queried by default.
GET https://{endpoint}/v5/{project_id}/asset/ports/detail?port=22
Example Responses
Status code: 200
Request succeeded.
{"total_num" : 1,"data_list" : [ {"host_id" : "03117200-xxxx-xxxx-xxxx-a89a10e66dbe","host_ip" : "192.168.0.1","host_name" : "ecs-eule","laddr" : "0.0.0.0","path" : "C:\\Windows\\system32\\svchost.exe","port" : 888,"status" : "unknow","type" : "UDP","container_id" : "ce794b8a6-xxxx-xxxx-xxxxx-36bedf2c7a4f6083fb82e5bbc82709b50018","container_name" : "hss_imagescan_W73V1WO6","agent_id" : "03jjj-xxxx-xxxx-wwwsedf"} ]}
Status Codes
Status Code | Description |
---|---|
200 | Request succeeded. |
Error Codes
See Error Codes.
- URI