调用GetNetworkReachableAnalysis获取网络可达性分析结果-网络智能服务-阿里云-网络智能服务(NIS)-阿里云帮助中心

调用GetNetworkReachableAnalysis接口，获取网络可达性分析结果。

接口说明

GetNetworkReachableAnalysis 接口属于异步接口，即系统会返回一个任务 ID，但该网络可达性分析结果尚未成功获取，系统后台的获取任务仍在进行。您可以查询网络可达性分析任务的状态：

当网络可达性分析任务处于 init 状态时，表示网络可达性分析任务正在进行中。
当网络可达性分析任务处于 finish 状态时，表示网络可达性分析任务已完成，即可获取结果。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

nis:GetNetworkReachableAnalysis

get

*NetworkReachableAnalysis

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

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	网络可达性分析任务的地域 ID。	cn-shanghai
NetworkReachableAnalysisId	string	是	网络可达性分析任务 ID。您可以通过调用 CreateNetworkRearchableAnalysis 接口获取网络可达性分析 ID。	nra-90eef36a9e6e4662****

返回参数

名称	类型	描述	示例值
	object
NetworkPathId	string	创建的网络实例的路径 ID。	np-2a1332214fa346b6****
NetworkReachableAnalysisId	string	网络可达性分析任务 ID。	nra-8607514e71c1484****
NetworkReachableAnalysisStatus	string	网络可达性分析任务的状态。取值： init：初始化。 finish：已完成。 error：分析错误。 timeout：已超时。	finish
NetworkReachableAnalysisResult	string	用于展示网络可达性分析结果，包括网络路径拓扑、网络不可达错误码、网络不可达规则等。	{ "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	网络路径是否可达。取值： true：可达。 false：不可达。	true
CreateTime	string	创建时间。	2023-03-16T07:11:27Z
AliUid	integer	用户 UID。	123147627844****
RequestId	string	请求 ID。	DEE0FEAF-59AE-5CDD-AA07-626BC365D571
NetworkPathParameter	string	网络路径详细参数。	{ "sourceId": "i-bp100g5pbp6kj4p9**", "sourceType": "ecs", "targetId": "i-t4n4ltwgbbomzb0g**", "targetType": "ecs" }

示例

正常返回示例

JSON格式

{
  "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}"
}

错误码

HTTP status code	错误码	错误信息	描述
400	SizeExceeds.Zones	The length of the specified available zones exceeds the limit.	指定的可用区列表长度超过限制。
400	SizeExceeds.DiskCategories	The length of the specified disk categories exceeds the limit.	指定的磁盘类型列表长度超过限制。
400	OperationDenied.ZonesConflict	The specified available zones do not belong to the same region.	指定的可用区不属于同一个地域。
400	IllegalParam.ZoneId	The specified available zone (%s) is invalid.	指定的可用区(%s)不合法。
400	IllegalParam.StepMinutes	The specified sampling interval (%s) is invalid.	指定的采样间隔(%s)不合法。
400	IllegalParam.BeginTime	The specified begin time (%s) is invalid.	指定的开始时间(%s)不合法。
400	IllegalParam.EndTime	The specified end time (%s) is invalid.	指定的结束时间(%s)不合法。
400	Mismatch.BeginTimeAndEndTime	The specified begin time must be earlier than the end time.	指定的开始时间在结束时间之后。
400	OperationDenied.NetworkReachableAnalysis	The operation is not allowed because of invalid parameters.	请求存在非法参数，当前操作不被允许。
403	Forbidden.NetworkReachableAnalysisId	The user does not have permission on the instance parameter (%s).	该用户没有该资源(%s)权限.
404	ResourceNotFound.NetworkReachableAnalysisId	The instance resource (%s) does not exist.	该资源(%s)不存在。
404	ResourceNotFound.NetworkReachableAnalysis	The specified resource of %s is not found.	指定的网络路径分析ID %s不存在，可能已删除或者指定的ID错误。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。