DescribeInternetOpenDetail - Obtain details about internet exposure-阿里云帮助中心

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-cloudfirewall:DescribeInternetOpenDetail

get

*All resources

*

None

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: en: English zh: Chinese	zh
Lang	string	No	The language of the content. Valid values: en: English zh: Chinese	zh
ServiceName	string	No	The name of the application for an exact match. If you leave this parameter empty, all applications are queried.	SMB
ServiceNameFuzzy	string	No	The name of the application for a fuzzy match. 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: 0: No risk 1: Low 2: Medium 3: High -1: In assessment	3
SuggestLevel	string	No	The recommended policy level. Valid values: 0: Unknown 10: Allow 20: Observe 30: Deny -1: In assessment	10
Port	string	No	The port for an exact match. The value must be an integer from 1 to 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 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 for an exact match. If you leave this parameter empty, all asset types are queried.	EcsPublicIP
StartTime	string	No	The start of the time range to query. The value is a UNIX timestamp. Unit: seconds.	1656837360
EndTime	string	No	The end of the time range to query. The value is a UNIX timestamp. Unit: seconds.	1745251200
CurrentPage	string	No	The page number of the returned page.	1
PageSize	string	No	The number of the page to return.	10
SortList	array<object>	No	The sorting conditions.
	object	No	The sorting criteria.
Dir	string	No	The sort order. Valid values: asc: Ascending desc: Descending	asc
SortKey	string	No	The sorting key. Valid values: ServiceName: Sort by application. PublicIp: Sort by public IP address. Port: Sort by port.	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 of the returned page.	1
PageSize	integer	The number of entries returned per page.	50
TotalCount	integer	The total number of entries returned.	5
DataList	array<object>	The list of returned data.
	object	The list of returned data.
RiskLevel	integer	The risk level. Valid values: 0: None 1: Low 2: Medium 3: High -1: In assessment	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: 0: Unknown 10: Allow 20: Observe 30: Deny -1: In assessment	20
Protocol	string	The protocol type.	tcp
RegionNo	string	The region ID of the instance.	cn-shenzhen
AssetsName	string	The instance name.	launch-advisor-2023****
AssetsType	string	The asset type of the instance.	EcsEIP
Port	integer	The 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 cause of the risk.	test
InBytes	integer	The inbound traffic. Unit: bytes.	0.0
OutBytes	integer	The outbound traffic. Unit: bytes.	0.0
TotalBytes	integer	The total traffic.	0
UnknownReason	array	The reason why the protocol is not detected when the protocol is identified as Unknown.
	string	The reason why the protocol is not detected when the protocol is identified as 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.	Internal error: A database query error occurred.
400	ErrorParameters	A parameter error occurred.	The parameters are invalid.
400	ErrorUnMarshalJSON	internal error.	An internal error occurred.
400	ErrorMarshalJSON	internal error.	An internal error occurred.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.