GetNetworkReachableAnalysis_网络智能服务_API文档-阿里云OpenAPI开发者门户

GetNetworkReachableAnalysis_网络智能服务_API文档

2021-12-16

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

安装

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

安装

接口说明

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

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

流控信息

请求速率为120/60(s)。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

nis:GetNetworkReachableAnalysis	Get	NetworkReachableAnalysis acs:nis:*:{#accountId}:networkreachableanalysis/{#NetworkReachableAnalysisId}	无	无

请求参数

字段名称	字段详情
RegionIdstring	网络可达性分析任务的地域 ID。示例值:cn-shanghai
NetworkReachableAnalysisIdstring	网络可达性分析任务 ID。您可以通过调用 CreateNetworkRearchableAnalysis 接口获取网络可达性分析 ID。示例值:nra-90eef36a9e6e4662****参考取值来源: CreateNetworkReachableAnalysis

返回参数

字段名称	字段详情
NetworkPathIdstring	创建的网络实例的路径 ID。示例值:np-2a1332214fa346b6****
NetworkReachableAnalysisIdstring	网络可达性分析任务 ID。示例值:nra-8607514e71c1484****
NetworkReachableAnalysisStatusstring	网络可达性分析任务的状态。取值：展开详情示例值:finish
NetworkReachableAnalysisResultstring	用于展示网络可达性分析结果，包括网络路径拓扑、网络不可达错误码、网络不可达规则等。示例值:{ "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**" } }
Reachableboolean	网络路径是否可达。取值：展开详情示例值:true
CreateTimestring	创建时间。示例值:2023-03-16T07:11:27Z
AliUidinteger<int64>	用户 UID。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:123147627844****
RequestIdstring	请求 ID。示例值:DEE0FEAF-59AE-5CDD-AA07-626BC365D571
NetworkPathParameterstring	网络路径详细参数。示例值:{ "sourceId": "i-bp100g5pbp6kj4p9**", "sourceType": "ecs", "targetId": "i-t4n4ltwgbbomzb0g**", "targetType": "ecs" }

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

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.	诊断
400	IllegalParam.StepMinutes	The specified sampling interval (%s) is invalid.	诊断
400	IllegalParam.BeginTime	The specified begin time (%s) is invalid.	诊断
400	IllegalParam.EndTime	The specified end time (%s) is invalid.	诊断
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.	诊断
404	ResourceNotFound.NetworkReachableAnalysis	The specified resource of %s is not found.	诊断

变更历史

	变更时间	变更内容概要	操作
	2024-01-19	变更错误码400