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.

For details, see Calling APIs.

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
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	Default value: 10
offset	No	Integer	Default value: 0
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	iam 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

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

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

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

Parent topic: Asset Management

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.