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
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| port | No | Integer | Port number |
| 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. |
| limit | No | Integer | Number of records displayed on each page. The default value is 10. |
| offset | No | Integer | Default value: 0 |
| category | No | String | Type. The default value is host. The options are as follows:
|
Request 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 token. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| total_num | Integer | Number of open ports |
| data_list | Array of PortStatisticResponseInfo objects | Open port statistics list |
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.