Queries the ports that are open to the Internet.
Operation description
QPS limit
The queries per second (QPS) limit for this operation is 10 calls per second for each user. If you exceed this limit, API calls are throttled. This may affect your business. Plan your calls accordingly.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| SourceIp |
string |
No |
The source IP address. |
114.242.33.XXX |
| Lang |
string |
No |
The language of the content. Valid values:
|
zh |
| Lang |
string |
No |
The language of the content. Valid values:
|
zh |
| ServiceName |
string |
No |
The name of the application. This is an exact match. If you do not specify this parameter, all applications are queried. |
SMB |
| ServiceNameFuzzy |
string |
No |
The name of the application. This is a fuzzy match. If you do not specify this parameter, all applications are queried. |
SMB |
| RiskLevel |
string |
No |
The risk level. Valid values:
|
3 |
| SuggestLevel |
string |
No |
The recommended policy level. Valid values:
|
10 |
| Port |
string |
No |
The port number. |
80 |
| StartTime |
string |
No |
The start of the time range to query. The value is a UNIX timestamp. Unit: seconds. |
1735264800 |
| EndTime |
string |
No |
The end of the time range to query. The value is a UNIX timestamp. Unit: seconds. |
1748358644 |
| CurrentPage |
string |
No |
The page number for a paged query. |
1 |
| PageSize |
string |
No |
The number of entries per page for a paged query. |
10 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
F3637663-991B-547F-9163-1A5AC367**** |
| PageInfo |
object |
The pagination information. |
|
| CurrentPage |
integer |
The current page number. |
1 |
| PageSize |
integer |
The number of entries per page. |
10 |
| TotalCount |
integer |
The total number of entries. |
39 |
| DataList |
array<object> |
The list of returned data. |
|
|
object |
The list of returned data. |
||
| RiskLevel |
integer |
The risk level. Valid values:
|
3 |
| ProbRiskDesc |
string |
The description of the security threat. |
desc |
| TrafficPercent1Day |
string |
The percentage of traffic in the last 24 hours. Valid values: 1 to 100. |
10 |
| Protocol |
string |
The protocol. |
tcp |
| PublicIpNum |
integer |
The number of public IP addresses that have the port open. |
10 |
| SuggestLevel |
integer |
The recommended policy level. Valid values:
|
20 |
| DetailNum |
integer |
The number of details. |
5 |
| Port |
integer |
The open port. |
80 |
| TrafficPercent7Day |
string |
The percentage of traffic in the last 7 days. |
30 |
| TrafficPercent30Day |
string |
The percentage of traffic in the last 30 days. |
48 |
| ProbRisk |
string |
The security threat. |
test |
| RiskReason |
string |
The description of the risk. |
test |
| ServiceNameList |
array |
The list of applications. |
|
|
string |
The list of applications. |
['HTTPS', 'RDP', 'SSL', 'Unknown'] |
|
| InBytes |
integer |
The inbound traffic. |
1456536639.0 |
| OutBytes |
integer |
The outbound traffic. |
117200.0 |
| TotalBytes |
integer |
The total traffic. Unit: bytes. |
621404 |
| UnknownReason |
array |
The reason why the protocol is not identified when the protocol is detected as Unknown. |
|
|
string |
The reason why the protocol is not identified when the protocol is detected as Unknown. |
no_payload |
Examples
Success response
JSON format
{
"RequestId": "F3637663-991B-547F-9163-1A5AC367****",
"PageInfo": {
"CurrentPage": 1,
"PageSize": 10,
"TotalCount": 39
},
"DataList": [
{
"RiskLevel": 3,
"ProbRiskDesc": "desc",
"TrafficPercent1Day": "10",
"Protocol": "tcp",
"PublicIpNum": 10,
"SuggestLevel": 20,
"DetailNum": 5,
"Port": 80,
"TrafficPercent7Day": "30",
"TrafficPercent30Day": "48",
"ProbRisk": "test",
"RiskReason": "test",
"ServiceNameList": [
"['HTTPS', 'RDP', 'SSL', 'Unknown']"
],
"InBytes": 1456536639,
"OutBytes": 117200,
"TotalBytes": 621404,
"UnknownReason": [
"no_payload"
]
}
]
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | ErrorDBSelectError | A database select error occurred. | The error message returned because an internal error has occurred in querying the database. |
| 400 | ErrorParameters | A parameter error occurred. | A parameter error occurred. |
| 400 | ErrorMarshalJSON | internal error. | Internal error. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.