Query Network Reachability Analysis Results with GetNetworkReachableAnalysis - Network Intelligence Service - Alibaba Cloud - Network Intelligence Service

Calls the GetNetworkReachableAnalysis operation to obtain the results of a network reachability analysis task.

Operation description

GetNetworkReachableAnalysis is an asynchronous operation. The system returns a task ID, but the network reachability analysis result has not been obtained yet because the background task is still in progress. You can query the status of the network reachability analysis task:

When the network reachability analysis task is in the init state, the task is in progress.
When the network reachability analysis task is in the finish state, the task is complete and you can obtain the results.

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

nis:GetNetworkReachableAnalysis

get

*NetworkReachableAnalysis

acs:nis:*:{#accountId}:networkreachableanalysis/{#NetworkReachableAnalysisId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the network reachability analysis task.	cn-shanghai
NetworkReachableAnalysisId	string	Yes	The ID of the network reachability analysis task. You can obtain the network reachability analysis ID by calling the CreateNetworkRearchableAnalysis operation.	nra-90eef36a9e6e4662****

Response elements

Element	Type	Description	Example
	object
NetworkPathId	string	The path ID of the created network instance.	np-2a1332214fa346b6****
NetworkReachableAnalysisId	string	The ID of the network reachability analysis task.	nra-8607514e71c1484****
NetworkReachableAnalysisStatus	string	The status of the network reachability analysis task. Valid values: init: initializing. finish: complete. error: analysis error. timeout: timed out.	finish
NetworkReachableAnalysisResult	string	The network reachability analysis result, including the network path topology, network unreachable error codes, and network unreachable rules.	{ "errorCode": "", "networkAclData": { "networkAclItems": [ ] }, "nraId": "nra-f2c8701a36424094**", "requestId": "B931F8A0-620E-5230-B77F-3BD7F612", "routeData": { "routeItems": [ ] }, "securityGroupData": { "policy": "accept", "securityGroupItems": [ { "description": "default_sg_access_rule", "matchedRule": { "bizProtocol": "ALL", "creatingTime": "2022-11-10T03:24:49Z", "description": "", "destinationCidr": "", "destinationGroupId": "sg-wz980j96p8y99co5", "direction": "egress", "policy": "Accept", "portRange": "-1/-1", "priority": "1", "sourceCidr": "", "sourceGroupId": "" }, "policy": "accept", "resourceId": "eni-wz92ce4saz1jzazg", "securityGroupId": "sg-wz980j96p8y99co5" }, { "description": "user_acl_drop_rule", "matchedRule": { "bizProtocol": "", "creatingTime": "", "description": "", "destinationCidr": "", "destinationGroupId": "", "direction": "", "policy": "", "portRange": "", "priority": "", "sourceCidr": "", "sourceGroupId": "" }, "policy": "", "resourceId": "eni-wz97vry93t6z4lbd", "securityGroupId": "sg-wz980j96p8y99co" } ], "securityGroupReportId": "sgr-4479d23bb37241aab" }, "status": "security_group_checking_target", "topologyData": { "positive": { "linkList": [ { "id": "i-wz91dk7bor557hp93zyv-->eni-wz92ce4saz1jzazg", "source": "i-wz91dk7bor557hp9", "target": "eni-wz92ce4saz1jzazg" }, { "id": "eni-wz92ce4saz1jzazgi13d-->vsw-wz9slpwdcppwfrnee", "source": "eni-wz92ce4saz1jzazg", "target": "vsw-wz9slpwdcppwfrnee" }, { "id": "vsw-wz9slpwdcppwfrneebcrp-->eni-wz97vry93t6z4lbd", "source": "vsw-wz9slpwdcppwfrnee", "target": "eni-wz97vry93t6z4lbd" }, { "id": "eni-wz97vry93t6z4lbdgmfi-->i-wz91dk7bor557hp9", "source": "eni-wz97vry93t6z4lbd", "target": "i-wz91dk7bor557hp9" } ], "nodeList": [ { "aZone": "cn-shenzhen-d", "bizInsId": "i-wz91dk7bor557hp9", "id": "i-wz91dk7bor557hp9", "level": 1, "matchedRoute": { "nextHopSet": [ ] }, "nodeType": "VM", "regionNo": "cn-shenzhen-st3-a01", "regionNoAlias": "cn-shenzhen", "trafficLogs": [ ] }, { "aZone": "cn-shenzhen-d", "bizInsId": "i-wz91dk7bor557hp9", "id": "i-wz91dk7bor557hp9", "level": 3, "matchedRoute": { "nextHopSet": [ ] }, "nodeType": "VM", "regionNo": "cn-shenzhen-st3-a01", "regionNoAlias": "cn-shenzhen", "trafficLogs": [ ] }, { "aZone": "cn-shenzhen-d", "bizInsId": "vsw-wz9slpwdcppwfrnee", "cidr": "192.168.0.0/24", "id": "vsw-wz9slpwdcppwfrnee", "level": 2, "matchedRoute": { "nextHopSet": [ ] }, "nodeType": "VSW", "regionNo": "cn-shenzhen-st3-a01", "regionNoAlias": "cn-shenzhen", "trafficLogs": [ ] }, { "bizInsId": "eni-wz92ce4saz1jzazg", "id": "eni-wz92ce4saz1jzazg", "ip": "192.168.0.33", "mac": "00:XXXX:3e:16:7c:50", "matchedRoute": { "nextHopSet": [ ] }, "nodeType": "ENI", "regionNo": "cn-shenzhen-st3-a01", "regionNoAlias": "cn-shenzhen", "status": "InUse", "trafficLogs": [ ] }, { "bizInsId": "eni-wz97vry93t6z4lbd", "id": "eni-wz97vry93t6z4lbd", "ip": "192.168.0.34", "mac": "00:XXXX:3e:14:70:c2", "matchedRoute": { "nextHopSet": [ ] }, "nodeType": "ENI", "regionNo": "cn-shenzhen-st3-a01", "regionNoAlias": "cn-shenzhen", "status": "InUse", "trafficLogs": [ ] } ] }, "reverse": { "revLinkList": [ { "id": "i-wz91dk7bor557hp93zys-->eni-wz97vry93t6z4lbd", "source": "i-wz91dk7bor557hp9", "target": "eni-wz97vry93t6z4lbd" }, { "id": "eni-wz97vry93t6z4lbdgmfi-->vsw-wz9slpwdcppwfrnee", "source": "eni-wz97vry93t6z4lbd", "target": "vsw-wz9slpwdcppwfrnee" }, { "id": "vsw-wz9slpwdcppwfrneebcrp-->eni-wz92ce4saz1jzazg", "source": "vsw-wz9slpwdcppwfrnee", "target": "eni-wz92ce4saz1jzazg" }, { "id": "eni-wz92ce4saz1jzazgi13d-->i-wz91dk7bor557hp9", "source": "eni-wz92ce4saz1jzazg", "target": "i-wz91dk7bor557hp9" } ], "revNodeList": [ { "aZone": "cn-shenzhen-d", "bizInsId": "i-wz91dk7bor557hp9", "id": "i-wz91dk7bor557hp9", "level": 1, "nodeType": "VM", "regionNo": "cn-shenzhen-st3-a01", "regionNoAlias": "cn-shenzhen", "revMatchedRoute": { "revNextHopSet": [ ] } }, { "aZone": "cn-shenzhen-d", "bizInsId": "i-wz91dk7bor557hp9", "id": "i-wz91dk7bor557hp9", "level": 3, "nodeType": "VM", "regionNo": "cn-shenzhen-st3-a01", "regionNoAlias": "cn-shenzhen", "revMatchedRoute": { "revNextHopSet": [ ] } }, { "aZone": "cn-shenzhen-d", "bizInsId": "vsw-wz9slpwdcppwfrnee", "cidr": "192.168.0.0/24", "id": "vsw-wz9slpwdcppwfrnee", "level": 2, "nodeType": "VSW", "regionNo": "cn-shenzhen-st3-a01", "regionNoAlias": "cn-shenzhen", "revMatchedRoute": { "revNextHopSet": [ ] } }, { "bizInsId": "eni-wz97vry93t6z4lbd", "id": "eni-wz97vry93t6z4lbd", "ip": "192.168.0.34", "mac": "00:XXXX:3e:14:70:c2", "nodeType": "ENI", "regionNo": "cn-shenzhen-st3-a01", "regionNoAlias": "cn-shenzhen", "revMatchedRoute": { "revNextHopSet": [ ] }, "status": "InUse" }, { "bizInsId": "eni-wz92ce4saz1jzazg", "id": "eni-wz92ce4saz1jzazg", "ip": "192.168.0.33", "mac": "00:XXXX:3e:16:7c:50", "nodeType": "ENI", "regionNo": "cn-shenzhen-st3-a01", "regionNoAlias": "cn-shenzhen", "revMatchedRoute": { "revNextHopSet": [ ] }, "status": "InUse" } ] }, "topologyReportId": "tpr-21cf60002715491b8**" } }
Reachable	boolean	Indicates whether the network path is reachable. Valid values: true: reachable. false: not reachable.	true
CreateTime	string	The creation time in ISO 8601 format (UTC).	2023-03-16T07:11:27Z
AliUid	integer	The user UID.	123147627844****
RequestId	string	The request ID.	DEE0FEAF-59AE-5CDD-AA07-626BC365D571
NetworkPathParameter	string	The detailed parameters of the network path.	{ "sourceId": "i-bp100g5pbp6kj4p9**", "sourceType": "ecs", "targetId": "i-t4n4ltwgbbomzb0g**", "targetType": "ecs" }

Examples

Success response

JSON format

{
  "NetworkPathId": "np-2a1332214fa346b6****",
  "NetworkReachableAnalysisId": "nra-8607514e71c1484****",
  "NetworkReachableAnalysisStatus": "finish",
  "NetworkReachableAnalysisResult": "{\n  \"errorCode\": \"\",\n  \"networkAclData\": {\n    \"networkAclItems\": [\n      \n    ]\n  },\n  \"nraId\": \"nra-f2c8701a36424094****\",\n  \"requestId\": \"B931F8A0-620E-5230-B77F-3BD7F612****\",\n  \"routeData\": {\n    \"routeItems\": [\n      \n    ]\n  },\n  \"securityGroupData\": {\n    \"policy\": \"accept\",\n    \"securityGroupItems\": [\n      {\n        \"description\": \"default_sg_access_rule\",\n        \"matchedRule\": {\n          \"bizProtocol\": \"ALL\",\n          \"creatingTime\": \"2022-11-10T03:24:49Z\",\n          \"description\": \"\",\n          \"destinationCidr\": \"\",\n          \"destinationGroupId\": \"sg-wz980j96p8y99co5****\",\n          \"direction\": \"egress\",\n          \"policy\": \"Accept\",\n          \"portRange\": \"-1/-1\",\n          \"priority\": \"1\",\n          \"sourceCidr\": \"\",\n          \"sourceGroupId\": \"\"\n        },\n        \"policy\": \"accept\",\n        \"resourceId\": \"eni-wz92ce4saz1jzazg****\",\n        \"securityGroupId\": \"sg-wz980j96p8y99co5****\"\n      },\n      {\n        \"description\": \"user_acl_drop_rule\",\n        \"matchedRule\": {\n          \"bizProtocol\": \"\",\n          \"creatingTime\": \"\",\n          \"description\": \"\",\n          \"destinationCidr\": \"\",\n          \"destinationGroupId\": \"\",\n          \"direction\": \"\",\n          \"policy\": \"\",\n          \"portRange\": \"\",\n          \"priority\": \"\",\n          \"sourceCidr\": \"\",\n          \"sourceGroupId\": \"\"\n        },\n        \"policy\": \"\",\n        \"resourceId\": \"eni-wz97vry93t6z4lbd****\",\n        \"securityGroupId\": \"sg-wz980j96p8y99co****\"\n      }\n    ],\n    \"securityGroupReportId\": \"sgr-4479d23bb37241aab****\"\n  },\n  \"status\": \"security_group_checking_target\",\n  \"topologyData\": {\n    \"positive\": {\n      \"linkList\": [\n        {\n          \"id\": \"i-wz91dk7bor557hp93zyv-->eni-wz92ce4saz1jzazg****\",\n          \"source\": \"i-wz91dk7bor557hp9****\",\n          \"target\": \"eni-wz92ce4saz1jzazg****\"\n        },\n        {\n          \"id\": \"eni-wz92ce4saz1jzazgi13d-->vsw-wz9slpwdcppwfrnee****\",\n          \"source\": \"eni-wz92ce4saz1jzazg****\",\n          \"target\": \"vsw-wz9slpwdcppwfrnee****\"\n        },\n        {\n          \"id\": \"vsw-wz9slpwdcppwfrneebcrp-->eni-wz97vry93t6z4lbd****\",\n          \"source\": \"vsw-wz9slpwdcppwfrnee****\",\n          \"target\": \"eni-wz97vry93t6z4lbd****\"\n        },\n        {\n          \"id\": \"eni-wz97vry93t6z4lbdgmfi-->i-wz91dk7bor557hp9****\",\n          \"source\": \"eni-wz97vry93t6z4lbd****\",\n          \"target\": \"i-wz91dk7bor557hp9****\"\n        }\n      ],\n      \"nodeList\": [\n        {\n          \"aZone\": \"cn-shenzhen-d\",\n          \"bizInsId\": \"i-wz91dk7bor557hp9****\",\n          \"id\": \"i-wz91dk7bor557hp9****\",\n          \"level\": 1,\n          \"matchedRoute\": {\n            \"nextHopSet\": [\n              \n            ]\n          },\n          \"nodeType\": \"VM\",\n          \"regionNo\": \"cn-shenzhen-st3-a01\",\n          \"regionNoAlias\": \"cn-shenzhen\",\n          \"trafficLogs\": [\n            \n          ]\n        },\n        {\n          \"aZone\": \"cn-shenzhen-d\",\n          \"bizInsId\": \"i-wz91dk7bor557hp9****\",\n          \"id\": \"i-wz91dk7bor557hp9****\",\n          \"level\": 3,\n          \"matchedRoute\": {\n            \"nextHopSet\": [\n              \n            ]\n          },\n          \"nodeType\": \"VM\",\n          \"regionNo\": \"cn-shenzhen-st3-a01\",\n          \"regionNoAlias\": \"cn-shenzhen\",\n          \"trafficLogs\": [\n            \n          ]\n        },\n        {\n          \"aZone\": \"cn-shenzhen-d\",\n          \"bizInsId\": \"vsw-wz9slpwdcppwfrnee****\",\n          \"cidr\": \"192.168.0.0/24\",\n          \"id\": \"vsw-wz9slpwdcppwfrnee****\",\n          \"level\": 2,\n          \"matchedRoute\": {\n            \"nextHopSet\": [\n              \n            ]\n          },\n          \"nodeType\": \"VSW\",\n          \"regionNo\": \"cn-shenzhen-st3-a01\",\n          \"regionNoAlias\": \"cn-shenzhen\",\n          \"trafficLogs\": [\n            \n          ]\n        },\n        {\n          \"bizInsId\": \"eni-wz92ce4saz1jzazg****\",\n          \"id\": \"eni-wz92ce4saz1jzazg****\",\n          \"ip\": \"192.168.0.33\",\n          \"mac\": \"00:XXXX:3e:16:7c:50\",\n          \"matchedRoute\": {\n            \"nextHopSet\": [\n              \n            ]\n          },\n          \"nodeType\": \"ENI\",\n          \"regionNo\": \"cn-shenzhen-st3-a01\",\n          \"regionNoAlias\": \"cn-shenzhen\",\n          \"status\": \"InUse\",\n          \"trafficLogs\": [\n            \n          ]\n        },\n        {\n          \"bizInsId\": \"eni-wz97vry93t6z4lbd****\",\n          \"id\": \"eni-wz97vry93t6z4lbd****\",\n          \"ip\": \"192.168.0.34\",\n          \"mac\": \"00:XXXX:3e:14:70:c2\",\n          \"matchedRoute\": {\n            \"nextHopSet\": [\n              \n            ]\n          },\n          \"nodeType\": \"ENI\",\n          \"regionNo\": \"cn-shenzhen-st3-a01\",\n          \"regionNoAlias\": \"cn-shenzhen\",\n          \"status\": \"InUse\",\n          \"trafficLogs\": [\n            \n          ]\n        }\n      ]\n    },\n    \"reverse\": {\n      \"revLinkList\": [\n        {\n          \"id\": \"i-wz91dk7bor557hp93zys-->eni-wz97vry93t6z4lbd****\",\n          \"source\": \"i-wz91dk7bor557hp9****\",\n          \"target\": \"eni-wz97vry93t6z4lbd****\"\n        },\n        {\n          \"id\": \"eni-wz97vry93t6z4lbdgmfi-->vsw-wz9slpwdcppwfrnee****\",\n          \"source\": \"eni-wz97vry93t6z4lbd****\",\n          \"target\": \"vsw-wz9slpwdcppwfrnee****\"\n        },\n        {\n          \"id\": \"vsw-wz9slpwdcppwfrneebcrp-->eni-wz92ce4saz1jzazg****\",\n          \"source\": \"vsw-wz9slpwdcppwfrnee****\",\n          \"target\": \"eni-wz92ce4saz1jzazg****\"\n        },\n        {\n          \"id\": \"eni-wz92ce4saz1jzazgi13d-->i-wz91dk7bor557hp9****\",\n          \"source\": \"eni-wz92ce4saz1jzazg****\",\n          \"target\": \"i-wz91dk7bor557hp9****\"\n        }\n      ],\n      \"revNodeList\": [\n        {\n          \"aZone\": \"cn-shenzhen-d\",\n          \"bizInsId\": \"i-wz91dk7bor557hp9****\",\n          \"id\": \"i-wz91dk7bor557hp9****\",\n          \"level\": 1,\n          \"nodeType\": \"VM\",\n          \"regionNo\": \"cn-shenzhen-st3-a01\",\n          \"regionNoAlias\": \"cn-shenzhen\",\n          \"revMatchedRoute\": {\n            \"revNextHopSet\": [\n              \n            ]\n          }\n        },\n        {\n          \"aZone\": \"cn-shenzhen-d\",\n          \"bizInsId\": \"i-wz91dk7bor557hp9****\",\n          \"id\": \"i-wz91dk7bor557hp9****\",\n          \"level\": 3,\n          \"nodeType\": \"VM\",\n          \"regionNo\": \"cn-shenzhen-st3-a01\",\n          \"regionNoAlias\": \"cn-shenzhen\",\n          \"revMatchedRoute\": {\n            \"revNextHopSet\": [\n              \n            ]\n          }\n        },\n        {\n          \"aZone\": \"cn-shenzhen-d\",\n          \"bizInsId\": \"vsw-wz9slpwdcppwfrnee****\",\n          \"cidr\": \"192.168.0.0/24\",\n          \"id\": \"vsw-wz9slpwdcppwfrnee****\",\n          \"level\": 2,\n          \"nodeType\": \"VSW\",\n          \"regionNo\": \"cn-shenzhen-st3-a01\",\n          \"regionNoAlias\": \"cn-shenzhen\",\n          \"revMatchedRoute\": {\n            \"revNextHopSet\": [\n              \n            ]\n          }\n        },\n        {\n          \"bizInsId\": \"eni-wz97vry93t6z4lbd****\",\n          \"id\": \"eni-wz97vry93t6z4lbd****\",\n          \"ip\": \"192.168.0.34\",\n          \"mac\": \"00:XXXX:3e:14:70:c2\",\n          \"nodeType\": \"ENI\",\n          \"regionNo\": \"cn-shenzhen-st3-a01\",\n          \"regionNoAlias\": \"cn-shenzhen\",\n          \"revMatchedRoute\": {\n            \"revNextHopSet\": [\n              \n            ]\n          },\n          \"status\": \"InUse\"\n        },\n        {\n          \"bizInsId\": \"eni-wz92ce4saz1jzazg****\",\n          \"id\": \"eni-wz92ce4saz1jzazg****\",\n          \"ip\": \"192.168.0.33\",\n          \"mac\": \"00:XXXX:3e:16:7c:50\",\n          \"nodeType\": \"ENI\",\n          \"regionNo\": \"cn-shenzhen-st3-a01\",\n          \"regionNoAlias\": \"cn-shenzhen\",\n          \"revMatchedRoute\": {\n            \"revNextHopSet\": [\n              \n            ]\n          },\n          \"status\": \"InUse\"\n        }\n      ]\n    },\n    \"topologyReportId\": \"tpr-21cf60002715491b8****\"\n  }\n}",
  "Reachable": true,
  "CreateTime": "2023-03-16T07:11:27Z",
  "AliUid": 0,
  "RequestId": "DEE0FEAF-59AE-5CDD-AA07-626BC365D571",
  "NetworkPathParameter": "{\n  \"sourceId\": \"i-bp100g5pbp6kj4p9****\",\n  \"sourceType\": \"ecs\",\n  \"targetId\": \"i-t4n4ltwgbbomzb0g****\",\n  \"targetType\": \"ecs\"\n}"
}

Error codes

HTTP status code	Error code	Error message	Description
400	SizeExceeds.Zones	The length of the specified available zones exceeds the limit.	The specified number of zones exceeds the upper limit.
400	SizeExceeds.DiskCategories	The length of the specified disk categories exceeds the limit.	The specified number of disk categories exceeds the upper limit.
400	OperationDenied.ZonesConflict	The specified available zones do not belong to the same region.	The specified zones do not belong to the same region.
400	IllegalParam.ZoneId	The specified available zone (%s) is invalid.	The specified zone (%s) is invalid.
400	IllegalParam.StepMinutes	The specified sampling interval (%s) is invalid.	The specified sampling interval (%s) is invalid.
400	IllegalParam.BeginTime	The specified begin time (%s) is invalid.	The specified start time (%s) is invalid.
400	IllegalParam.EndTime	The specified end time (%s) is invalid.	The specified end time (%s) is invalid.
400	Mismatch.BeginTimeAndEndTime	The specified begin time must be earlier than the end time.	The specified start time must be earlier than the end time.
400	OperationDenied.NetworkReachableAnalysis	The operation is not allowed because of invalid parameters.	The request has invalid parameters. The current operation is not allowed.
403	Forbidden.NetworkReachableAnalysisId	The user does not have permission on the instance parameter (%s).	The user does not have permission to the resource (%s).
404	ResourceNotFound.NetworkReachableAnalysisId	The instance resource (%s) does not exist.	The resource (%s) does not exist.
404	ResourceNotFound.NetworkReachableAnalysis	The specified resource of %s is not found.	The specified network path ID %s is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.