文档

CreateAndAnalyzeNetworkPath - 发起网络可达性分析任务

更新时间:

调用CreateAndAnalyzeNetworkPath接口,发起网络可达性分析任务。

接口说明

该接口根据输入的源和目的信息,无需创建网络分析路径,直接发起可达性分析任务。返回分析结果后,将不在系统中记录,如需在 NIS 中留存网络路径或可达性分析任务结果,建议使用 createNetworkReachableAnalysis 接口。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
nis:CreateAndAnalyzeNetworkPathWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
SourceIdstring

源资源 ID。

i-uf62y8khhbkbdrp6****
SourceIpAddressstring

源 IP 地址。

192.168.XX.XX
TargetIpAddressstring

目的 IP 地址。

172.50.XX.XX
SourceTypestring

源资源类型。

  • ecs:云服务器 ECS(Elastic Compute Service)。
  • internetIp:公网 IP 地址。
  • vsw:交换机(vSwitch)。
  • vpn:VPN 网关。
  • vbr:边界路由器 VBR(Virtual Border Router)。
ecs
SourcePortinteger

源端口。

0
TargetIdstring

目的资源 ID。

i-m5eactvw7wtpktv5****
TargetTypestring

目的资源类型。

  • ecs:云服务器 ECS(Elastic Compute Service)。
  • internetIp:公网 IP 地址。
  • vsw:交换机(vSwitch)。
  • vpn:VPN 网关。
  • vbr:边界路由器 VBR(Virtual Border Router)。
  • clb:传统型负载均衡 CLB(Classic Load Balancer)。
ecs
TargetPortinteger

目的端口。

80
Protocolstring

协议类型。取值:

  • tcp:传输控制协议。
  • udp:用户数据报协议。
  • icmp:网络控制报文协议。
tcp
RegionIdstring

要发起网络可达性分析任务的地域 ID。

cn-shanghai

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

D5E98683-355B-5867-8D3D-A24755F6895B
NetworkReachableAnalysisIdstring

发起的网络可达性分析任务 ID。

nra-dfe9e53d2b524568****
SourceIdstring

源资源 ID。

i-uf62y8khhbkbdrp6****
TargetIdstring

目的资源 ID。

i-m5eactvw7wtpktv5****
SourceTypestring

源资源类型。

ecs
TargetTypestring

目的资源类型。

ecs
SourcePortstring

源端口。

0
TargetPortstring

目的端口。

80
Protocolstring

协议类型。

tcp
SourceIpAddressstring

源 IP 地址。

192.168.XX.XX
TargetIpAddressstring

目的 IP 地址。

172.50.XX.XX

示例

正常返回示例

JSON格式

{
  "RequestId": "D5E98683-355B-5867-8D3D-A24755F6895B",
  "NetworkReachableAnalysisId": "nra-dfe9e53d2b524568****",
  "SourceId": "i-uf62y8khhbkbdrp6****\n",
  "TargetId": "i-m5eactvw7wtpktv5****\n",
  "SourceType": "ecs",
  "TargetType": "ecs",
  "SourcePort": "0",
  "TargetPort": "80",
  "Protocol": "tcp",
  "SourceIpAddress": "192.168.XX.XX\n",
  "TargetIpAddress": "172.50.XX.XX\n"
}

错误码

HTTP status code错误码错误信息描述
400IllegalParam.InternetIPThe specified IP address (%s) is not an internet IP address.指定的IP(%s)不是公网地址。即IP地址不能在10.0.0.0~10.255.255.255、172.16.0.0 ~172.31.255.255、192.168.0.0~192.168.255.255 这3个地址段内。
400IllegalParam.IPThe specified IP address (%s) is invalid.指定的IP地址(%s)无效。
400Mismatch.SourceIdAndTargetIdReachability Analyzer does not support the scenario in which source and target Internet IP addresses and ECS instance ID (%s and %s) are bound.路径分析不支持源与目的的公网IP和ECS实例ID(%s和%s)具有绑定关系。
400IllegalParam.SourceAndTargetInternetIpBoth source ID and target ID are IP addresses, but are not Internet IP addresses. Reachability Analyzer does not support the scenario.源与目的都是IP,但都不是阿里云公网IP,路径分析不支持这种场景。
400IllegalParam.SourcePortThe specified SourcePort(%s) value is invalid. The value must be within the range of (0,65536].SourcePort参数不合法,必须介于0到65536(含)之间。
400IllegalParam.TargetPortThe specified TargetPort(%s) value is invalid. The value must be within the range of (0,65536].TargetPort参数不合法,必须介于0到65536(含)之间。
400IllegalParam.SourceIdThe specified SourceId(%s) may be not exist.指定的实例(%s)可能不存在,请检查是否拼写错误。
400IllegalParam.TargetIdThe specified TargetId(%s) may be not exist.指定的实例(%s)可能不存在,请检查是否拼写错误。
400IllegalParam.SourceIpPlease enter a valid source IP.请输入合法的源IP
400IllegalParam.SourceTypeThe specified source type (%s) is invalid.指定的源类型(%s)无效。
400IllegalParam.ProtocolThe specified Protocol(%s) is invalid.指定的Protocol(%s)参数不合法。
400IllegalParam.TargetTypeThe specified target type (%s) is invalid.指定的目的类型(%s)无效。
400IllegalParam.TargetIpThe specified target ip (%s) is invalid.指定的目的IP(%s)格式不正确。
400IllegalParam.NotSupportHaVpnThe specified VPN(%s), which is not currently supported for such instances.指定的VPN(%s)是HaVpn,此类实例目前尚不支持。
400IllegalParam.SourceNotBoundElastic public network IP(%s) is not bound to resources, and analysis is not supported for the time being.弹性公网IP(%s)未绑定资源,暂不支持分析。
400IllegalParam.TargetNotBoundElastic public network IP(%s) is not bound to resources, and analysis is not supported for the time being.弹性公网IP(%s)未绑定资源,暂不支持分析。
400IllegalParam.NotPublicIpThe specified (%s) is invalid.指定的参数 (%s) 不是公网IP。
400IllegalParam.SourceEqualTargetThe specified source and destination are identical, which is not supported for analysis.指定的源和目的相同,不支持分析。
400IllegalParam.TypeAndIdMismatchThe specified instanceId (%s) and type do not match.指定的实例 (%s) 和实例类型不匹配。
403Forbidden.NetworkPathThe current user has not activated NIS and is not authorized to use the path analysis interface.当前用户未开通NIS,无权限使用路径分析接口。

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

变更历史

变更时间变更内容概要操作
2024-04-23OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
2024-04-09OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
2024-03-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    新增错误码:403
2023-12-12OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2023-09-04OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    删除入参:AuditParam
2023-08-31OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:AuditParam
2023-06-05OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2023-06-02OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
  • 本页导读 (1)