Querying Open Port Statistics
Function
This API is used to query the list of open ports. The number of servers can be queried by port or protocol type.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/asset/port/statistics
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
project_id |
Yes |
String |
Project ID Minimum: 1 Maximum: 256 |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
port |
No |
Integer |
Port number, which is used for exact match. Minimum: 1 Maximum: 65535 |
port_string |
No |
String |
Port string, which is used for fuzzy match. Minimum: 1 Maximum: 256 |
type |
No |
String |
Port type Minimum: 1 Maximum: 256 |
enterprise_project_id |
No |
String |
Enterprise project Minimum: 0 Maximum: 128 |
sort_key |
No |
String |
Sort key. Currently, sorting by port number is supported. Minimum: 1 Maximum: 128 |
sort_dir |
No |
String |
Whether to sort data in ascending or descending order. Default value: asc Minimum: 1 Maximum: 32 |
limit |
No |
Integer |
Default value: 10 Minimum: 10 Maximum: 200 Default: 10 |
offset |
No |
Integer |
Default value: 0 Minimum: 0 Maximum: 2000000 Default: 0 |
category |
No |
String |
Type. The default value is host. The options are as follows:
Minimum: 0 Maximum: 64 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
x-auth-token |
Yes |
String |
iam token Minimum: 32 Maximum: 4096 |
Response Parameters
Status code: 200
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 |
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, quantity, and risk status.
{
"total_num" : 1,
"data_list" : [ {
"num" : 4,
"port" : 123,
"type" : "UDP",
"status" : "danger"
} ]
}
Status Codes
Status Code |
Description |
|---|---|
200 |
Returns the port information, including the port number, type, quantity, and risk status. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
