Retrieves the details of assets exposed to the Internet.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| SourceIp |
string |
No |
The source IP address of the access request. |
222.212.86.7XXX |
| Lang |
string |
No |
The language of the content. Valid values: Valid values:
|
zh |
| Lang |
string |
No |
The language of the content. Valid values: Valid values:
|
zh |
| ServiceName |
string |
No |
The application name. This parameter is used for an exact match. If you leave this parameter empty, all applications are queried. |
SMB |
| ServiceNameFuzzy |
string |
No |
The application name. This parameter is used for a fuzzy search. If you leave this parameter empty, all applications are queried. |
SMB |
| RiskLevel |
string |
No |
The risk level. If you leave this parameter empty, all risk levels are queried. Valid values: Valid values:
|
3 |
| SuggestLevel |
string |
No |
The recommended policy level. Valid values: Valid values:
|
10 |
| Port |
string |
No |
The port number. This parameter is used for an exact match. The value must be between 1 and 65535. If you leave this parameter empty, all ports are queried. |
9100 |
| AssetsInstanceId |
string |
No |
The ID of the asset. Fuzzy search is supported. |
i-uf6faknmuby7ezht**** |
| AssetsInstanceName |
string |
No |
The name of the asset. Fuzzy search is supported. |
instance_test |
| PublicIp |
string |
No |
The public IP address. This parameter is used for an exact match. If you leave this parameter empty, all public IP addresses are queried. |
203.0.13.XX |
| RegionNo |
string |
No |
The region ID. |
cn-shanghai |
| AssetsType |
string |
No |
The type of the asset. This parameter is used for an exact match. If you leave this parameter empty, all asset types are queried. |
EcsPublicIP |
| StartTime |
string |
No |
The start time. The default value is 7 days before the current time. |
1656837360 |
| EndTime |
string |
No |
The end time. The default value is the current time. |
1745251200 |
| CurrentPage |
string |
No |
The page number. |
1 |
| PageSize |
string |
No |
The number of the page to return. |
10 |
| SortList |
array<object> |
No |
The sorting conditions. |
|
|
object |
No |
The sorting conditions. |
||
| Dir |
string |
No |
The sort order. Valid values: Valid values:
|
asc |
| SortKey |
string |
No |
The sort key. Valid values: Valid values:
|
ServiceName |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The ID of the request. |
3495E758-BB4B-5F5C-8AE0-897489F**** |
| PageInfo |
object |
The pagination information. |
|
| CurrentPage |
integer |
The page number. |
1 |
| PageSize |
integer |
The number of entries returned on each page. |
50 |
| TotalCount |
integer |
The total number of entries. |
5 |
| DataList |
array<object> |
The list of returned data. |
|
|
object |
The list of returned data. |
||
| RiskLevel |
integer |
The risk level. Valid values: Valid values:
|
3 |
| ProbRiskDesc |
string |
The description of the security threat. |
test |
| TrafficPercent1Day |
string |
The percentage of traffic in the last 24 hours. |
10 |
| SuggestLevel |
integer |
The recommended policy level. Valid values: Valid values:
|
20 |
| Protocol |
string |
The protocol type. |
tcp |
| RegionNo |
string |
The region ID of the instance. |
cn-shenzhen |
| AssetsName |
string |
The name of the instance. |
launch-advisor-2023**** |
| AssetsType |
string |
The asset type of the instance. |
EcsEIP |
| Port |
integer |
The public port that is exposed to the Internet. |
3389 |
| 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 |
| PublicIp |
string |
The public IP address. |
39.101.167.XX |
| ServiceName |
string |
The application name. |
Redis |
| Id |
string |
The ID of the details. |
1123 |
| AssetsInstanceId |
string |
The ID of the asset instance. |
i-bp1ix9w22kv6aew9**** |
| RiskReason |
string |
The reason for the risk. |
test |
| InBytes |
integer |
The inbound traffic in bytes. |
0.0 |
| OutBytes |
integer |
The outbound traffic in bytes. |
0.0 |
| TotalBytes |
integer |
The total traffic. |
0 |
| UnknownReason |
array |
The reason why the protocol is not identified when the protocol is `Unknown`. |
|
|
string |
The reason why the protocol is not identified when the protocol is `Unknown`. |
[ "no_payload", "tcp_not_establish" ] |
Examples
Success response
JSON format
{
"RequestId": "3495E758-BB4B-5F5C-8AE0-897489F****",
"PageInfo": {
"CurrentPage": 1,
"PageSize": 50,
"TotalCount": 5
},
"DataList": [
{
"RiskLevel": 3,
"ProbRiskDesc": "test",
"TrafficPercent1Day": "10",
"SuggestLevel": 20,
"Protocol": "tcp",
"RegionNo": "cn-shenzhen",
"AssetsName": "launch-advisor-2023****",
"AssetsType": "EcsEIP",
"Port": 3389,
"TrafficPercent7Day": "30",
"TrafficPercent30Day": "48",
"ProbRisk": "test",
"PublicIp": "39.101.167.XX",
"ServiceName": "Redis",
"Id": "1123",
"AssetsInstanceId": "i-bp1ix9w22kv6aew9****",
"RiskReason": "test",
"InBytes": 0,
"OutBytes": 0,
"TotalBytes": 0,
"UnknownReason": [
"[\n \"no_payload\",\n \"tcp_not_establish\"\n]"
]
}
]
}
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 | ErrorUnMarshalJSON | internal error. | Internal Error |
| 400 | ErrorMarshalJSON | internal error. | Internal error. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.