Help Center/ Host Security Service/ API Reference/ API Description/ Asset Management/ Querying Open Port Statistics
Updated on 2026-04-03 GMT+08:00
View PDF
Share

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.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID.

To query assets in all enterprise projects, set this parameter to all_granted_eps.

Constraints

You need to set this parameter only after the enterprise project function is enabled.

Range

The value can contain 1 to 256 characters.

Default Value

0: default enterprise project.

category

No

String

Definition

Type.

Constraints

N/A

Range

  • host

  • container

Default Value

N/A

sort_dir

No

String

Definition

Sorting order.

Constraints

N/A

Range

  • asc: ascending

  • desc: descending

Default Value

Sort in ascending order.

limit

No

Integer

Definition

Number of records displayed on each page.

Constraints

N/A

Range

Value range: 10-200

Default Value

10

offset

No

Integer

Definition

Offset, which specifies the start position of the record to be returned.

Constraints

N/A

Range

The value range is 0 to 2,000,000.

Default Value

The default value is 0.

port

No

Integer

Definition

Port number, which is used for exact match.

Constraints

When this parameter and port_string are used together, an exact match search is performed if one of them contains the other. If neither of them contains the other, no results will be returned.

Range

Minimum value: 1. Maximum value: 65535.

Default Value

N/A

port_string

No

String

Definition

Port string, which is used for fuzzy match.

Constraints

When this parameter and port are used together, an exact match search is performed if one of them contains the other. If neither of them contains the other, no results will be returned.

Range

Minimum value: 1. Maximum value: 65535.

Default Value

N/A

type

No

String

Definition

Port type.

Constraints

N/A

Range

  • UDP

  • UDP6

  • TCP

  • TCP6

Default Value

N/A

status

No

String

Definition

Port Status

Constraints

N/A

Range

  • danger: dangerous port

  • normal: normal port

  • unknown: port without known risks

Default Value

N/A

sort_key

No

String

Definition

Sort key. Currently, sorting by port number is supported.

Constraints

N/A

Range

  • port: port number

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Definition

Number of open ports.

Range

The value range is 0 to 10,000.

data_list

Array of PortStatisticResponseInfo objects

Definition

Open port statistics list.

Range

The value range is 0 to 10,000.
Table 5 PortStatisticResponseInfo

Parameter

Type

Description

port

Integer

Definition

Port number.

Range

The value ranges from 0 to 65,535.

type

String

Definition

Port type.

Range

  • UDP

  • UDP6

  • TCP

  • TCP6

num

Integer

Definition

Number of ports.

Range

The value ranges from 0 to 65,535.

status

String

Definition

Risk type.

Range

  • danger: dangerous port

  • normal: normal port

  • unknown: port without known risks

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

Request succeeded.

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

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Asset Management