Li, Qiao a5e72d5590 HSS API 20240206 version

Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com>
Reviewed-by: Drobnak, David <david.drobnak@t-systems.com>
Co-authored-by: Li, Qiao <qiaoli@huawei.com>
Co-committed-by: Li, Qiao <qiaoli@huawei.com>

2024-05-28 20:54:21 +00:00

12 KiB

Raw Permalink Blame History

Asset Fingerprint - Open Port Information

Function

This API is used to check open port information in asset fingerprints.

URI

GET /v5/{project_id}/asset/port/statistics

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID Minimum: 1 Maximum: 256

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
port	No	Integer	Port number Minimum: 1 Maximum: 65535
type	No	String	Port type: TCP or UDP. Minimum: 1 Maximum: 256
enterprise_project_id	No	String	Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. Default: 0 Minimum: 0 Maximum: 128
limit	No	Integer	Number of records on each page. Minimum: 10 Maximum: 200 Default: 10
offset	No	Integer	Offset, which specifies the start position of the record to be returned. Minimum: 0 Maximum: 2000000 Default: 0
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. Minimum: 32 Maximum: 4096

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Number of open ports Minimum: 0 Maximum: 10000
data_list	Array of PortStatisticResponseInfo objects	Open port statistics list Array Length: 0 - 10000

**Table 5** PortStatisticResponseInfo
Parameter	Type	Description
port	Integer	Port number Minimum: 0 Maximum: 65535
type	String	Port type: TCP or UDP.
num	Integer	Number of ports Minimum: 0 Maximum: 10000

Example Requests

The first 10 open ports whose port number is 123 and type is host are queried by default.

GET https://{endpoint}/v5/{project_id}/asset/port/statistics?port=123&category=host

Example Responses

Status code: 200

Returns the port information, including the port number, type, and quantity.

{
  "total_num" : 1,
  "data_list" : [ {
    "num" : 4,
    "port" : 123,
    "type" : "UDP"
  } ]
}

Status Codes

Status Code	Description
200	Returns the port information, including the port number, type, and quantity.

Error Codes

See Error Codes.

Parent topic: Asset Management

12 KiB Raw Permalink Blame History