Querying Open Port Statistics

This API is used to query the list of open ports. The number of servers can be queried by port or protocol type.

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

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

Table 2 Query Parameters
Parameter	Mandatory	Type	Description
port	No	Integer	Port number, which is used for exact match.
port_string	No	String	Port string, which is used for fuzzy match.
type	No	String	Port type
enterprise_project_id	No	String	Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps.
sort_key	No	String	Sort key. Currently, sorting by port number is supported.
sort_dir	No	String	Whether to sort data in ascending or descending order. Default value: asc
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

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.

Status code: 200

Table 4 Response body parameters
Parameter	Type	Description
total_num	Integer	Number of open ports
data_list	Array of PortStatisticResponseInfo objects	Open port statistics list

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

Status code: 200

Request succeeded.

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

Status Code	Description
200	Request succeeded.

Была ли эта статья полезна?