調(diào)用CreateAndAnalyzeNetworkPath接口,發(fā)起網(wǎng)絡(luò)可達(dá)性分析任務(wù)。
接口說明
該接口根據(jù)輸入的源和目的信息,無需創(chuàng)建網(wǎng)絡(luò)分析路徑,直接發(fā)起可達(dá)性分析任務(wù)。返回分析結(jié)果后,將不在系統(tǒng)中記錄,如需在 NIS 中留存網(wǎng)絡(luò)路徑或可達(dá)性分析任務(wù)結(jié)果,建議使用 createNetworkReachableAnalysis 接口。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
nis:CreateAndAnalyzeNetworkPath | create |
|
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
SourceId | string | 是 | 源資源 ID。 | i-uf62y8khhbkbdrp6**** |
SourceIpAddress | string | 否 | 源 IP 地址。 | 192.168.XX.XX |
TargetIpAddress | string | 否 | 目的 IP 地址。 | 172.50.XX.XX |
SourceType | string | 是 | 源資源類型。
| ecs |
SourcePort | integer | 否 | 源端口。 | 0 |
TargetId | string | 否 | 目的資源 ID。 說明
調(diào)用該 API 時,TargetId 參數(shù)必須輸入。
| i-m5eactvw7wtpktv5**** |
TargetType | string | 否 | 目的資源類型。
說明
調(diào)用該 API 時,TargetType 參數(shù)必須輸入。
| ecs |
TargetPort | integer | 否 | 目的端口。 | 80 |
Protocol | string | 否 | 協(xié)議類型。取值:
說明
調(diào)用該 API 時,Protocol 參數(shù)必須輸入。
| tcp |
RegionId | string | 否 | 要發(fā)起網(wǎng)絡(luò)可達(dá)性分析任務(wù)的地域 ID。 | cn-shanghai |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "D5E98683-355B-5867-8D3D-A24755F6895B",
"NetworkReachableAnalysisId": "nra-dfe9e53d2b524568****",
"SourceId": "i-uf62y8khhbkbdrp6****",
"TargetId": "i-m5eactvw7wtpktv5****",
"SourceType": "ecs",
"TargetType": "ecs",
"SourcePort": "0",
"TargetPort": "80",
"Protocol": "tcp",
"SourceIpAddress": "192.168.XX.XX",
"TargetIpAddress": "172.50.XX.XX"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | IllegalParam.InternetIP | The specified IP address (%s) is not an internet IP address. | 指定的IP(%s)不是公網(wǎng)地址。即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個地址段內(nèi)。 |
400 | IllegalParam.IP | The specified IP address (%s) is invalid. | 指定的IP地址(%s)無效。 |
400 | Mismatch.SourceIdAndTargetId | Reachability Analyzer does not support the scenario in which source and target Internet IP addresses and ECS instance ID (%s and %s) are bound. | 路徑分析不支持源與目的的公網(wǎng)IP和ECS實(shí)例ID(%s和%s)具有綁定關(guān)系。 |
400 | IllegalParam.SourceAndTargetInternetIp | Both source ID and target ID are IP addresses, but are not Internet IP addresses. Reachability Analyzer does not support the scenario. | 源與目的都是IP,但都不是阿里云公網(wǎng)IP,路徑分析不支持這種場景。 |
400 | IllegalParam.SourcePort | The specified SourcePort(%s) value is invalid. The value must be within the range of (0,65536]. | SourcePort參數(shù)不合法,必須介于0到65536(含)之間。 |
400 | IllegalParam.TargetPort | The specified TargetPort(%s) value is invalid. The value must be within the range of (0,65536]. | TargetPort參數(shù)不合法,必須介于0到65536(含)之間。 |
400 | IllegalParam.SourceId | The specified SourceId(%s) may be not exist. | 指定的實(shí)例(%s)可能不存在,請檢查是否拼寫錯誤。 |
400 | IllegalParam.TargetId | The specified TargetId(%s) may be not exist. | 指定的實(shí)例(%s)可能不存在,請檢查是否拼寫錯誤。 |
400 | IllegalParam.SourceIp | Please enter a valid source IP. | 請輸入合法的源IP |
400 | IllegalParam.SourceType | The specified source type (%s) is invalid. | 指定的源類型(%s)無效。 |
400 | IllegalParam.Protocol | The specified Protocol(%s) is invalid. | 指定的Protocol(%s)參數(shù)不合法。 |
400 | IllegalParam.TargetType | The specified target type (%s) is invalid. | 指定的目的類型(%s)無效。 |
400 | IllegalParam.TargetIp | The specified target ip (%s) is invalid. | 指定的目的IP(%s)格式不正確。 |
400 | IllegalParam.NotSupportHaVpn | The specified VPN(%s), which is not currently supported for such instances. | 指定的VPN(%s)是HaVpn,此類實(shí)例目前尚不支持。 |
400 | IllegalParam.SourceNotBound | Elastic public network IP(%s) is not bound to resources, and analysis is not supported for the time being. | 彈性公網(wǎng)IP(%s)未綁定資源,暫不支持分析。 |
400 | IllegalParam.TargetNotBound | Elastic public network IP(%s) is not bound to resources, and analysis is not supported for the time being. | 彈性公網(wǎng)IP(%s)未綁定資源,暫不支持分析。 |
400 | IllegalParam.NotPublicIp | The specified (%s) is invalid. | 指定的參數(shù) (%s) 不是公網(wǎng)IP。 |
400 | IllegalParam.SourceEqualTarget | The specified source and destination are identical, which is not supported for analysis. | 指定的源和目的相同,不支持分析。 |
400 | IllegalParam.TypeAndIdMismatch | The specified instanceId (%s) and type do not match. | 指定的實(shí)例 (%s) 和實(shí)例類型不匹配。 |
403 | Forbidden.NetworkPath | The current user has not activated NIS and is not authorized to use the path analysis interface. | 當(dāng)前用戶未開通NIS,無權(quán)限使用路徑分析接口。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-04-23 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2024-04-09 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2024-03-22 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2023-12-12 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2023-09-04 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2023-08-31 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2023-06-05 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2023-06-02 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |