調用CreateNetworkPath接口,創建網絡分析路徑,用于云上網絡路徑可達性分析。
接口說明
- CreateNetworkPath 接口支持多種組網場景以及多種資源間的路徑創建,路徑創建后,路徑參數將被保存,便于重復分析。
- 一個阿里云賬號(主賬號)最多支持創建 100 條路徑。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
nis:CreateNetworkPath | create |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 | 要創建網絡分析路徑的地域 ID。 | cn-hangzhou |
NetworkPathName | string | 是 | 路徑名稱。 | ecs2PublicIp |
SourceId | string | 是 | 源資源 ID。 | i-2zef4ngqfarepyun**** |
SourceType | string | 是 | 源資源類型。
| ecs |
SourceIpAddress | string | 否 | 源 IP 地址。 | 172.17.XX.XX |
SourcePort | integer | 否 | 源端口。 | 443 |
TargetId | string | 否 | 目的資源 ID。 說明
調用該 API 時,TargetId 參數必須輸入。
| i-bp13d0e064gubm**** |
TargetType | string | 否 | 目的資源類型。
說明
調用該 API 時,TargetType 參數必須輸入。
| ecs |
TargetIpAddress | string | 否 | 目的 IP 地址。 | 192.168.XX.XX |
TargetPort | integer | 否 | 目的端口。 | 80 |
Protocol | string | 否 | 協議類型。取值:
說明
調用該 API 時,Protocol 參數必須輸入。
| tcp |
NetworkPathDescription | string | 否 | 網絡路徑的描述信息。 | 分析ECS到ECS路徑 |
Tag | array<object> | 否 | 標簽列表。 | |
object | 否 | 標簽信息。 | ||
Key | string | 否 | 標簽鍵。最多支持 128 個字符,不能以 一次調用最多支持添加 20 個標簽。 | role |
Value | string | 否 | 標簽值。最多支持輸入 20 個標簽值。一旦輸入該值,可以為空字符串。 最多支持 128 個字符,不能以 | ops |
ResourceGroupId | string | 否 | 路徑所屬的資源組。 | rg-acfm27qsxjj**** |
返回參數
示例
正常返回示例
JSON
格式
{
"NetworkPathId": "np-4cbf598673d14d27****",
"RequestId": "92DD9FFB-06FB-56F7-83EF-5CEF98F5562A"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | IllegalParam.InternetIP | The 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個地址段內。 |
400 | IllegalParam.IP | The specified IP address (%s) is invalid. | 指定的IP地址(%s)無效。 |
400 | QuotaExceeded.NetworkPath | The quota of %s is exceeded, usage %s/%s. | 網絡路徑數量(%s)超過閾值,使用率:%s/%s。 |
400 | ResourceAlreadyExist.NetworkPath | The specified resource of %s already exists. | 指定的網絡路徑配置%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. | 路徑分析不支持源與目的的公網IP和ECS實例ID(%s和%s)具有綁定關系。 |
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,但都不是阿里云公網IP,路徑分析不支持這種場景。 |
400 | IllegalParam.SourcePort | The specified SourcePort(%s) value is invalid. The value must be within the range of (0,65536]. | SourcePort參數不合法,必須介于0到65536(含)之間。 |
400 | IllegalParam.TargetPort | The specified TargetPort(%s) value is invalid. The value must be within the range of (0,65536]. | TargetPort參數不合法,必須介于0到65536(含)之間。 |
400 | IllegalParam.SourceId | The specified SourceId(%s) may be not exist. | 指定的實例(%s)可能不存在,請檢查是否拼寫錯誤。 |
400 | IllegalParam.TargetId | The specified TargetId(%s) may be not exist. | 指定的實例(%s)可能不存在,請檢查是否拼寫錯誤。 |
400 | MissingParameter.TagValue | You must specify Tag.N.Value. | 必須指定Tag的Value。 |
400 | NumberExceed.Tags | The maximum number of Tags is exceeded. | 超過了標簽的最大數目。 |
400 | Duplicate.TagKey | The Tag.N.Key contains duplicate keys. | Tag的包含重復的key。 |
400 | MissingParameter.TagKey | You must specify Tag.N.Key. | 必須指定Tag的Key。 |
400 | InvalidParameter.TagKey | The Tag.N.Key parameter is invalid. | Tag的Key參數無效 |
400 | InvalidParameter.TagValue | The Tag.N.Value parameter is invalid. | Tag的Value參數無效。 |
400 | IllegalParam.SourceIp | Please enter a valid source IP. | 請輸入合法的源IP |
400 | IllegalParam.Protocol | The specified Protocol(%s) is invalid. | 指定的Protocol(%s)參數不合法。 |
400 | IllegalParam.TargetType | The specified target type (%s) is invalid. | 指定的目的類型(%s)無效。 |
400 | IllegalParam.SourceType | The specified source 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,此類實例目前尚不支持。 |
400 | IllegalParam.SourceNotBound | Elastic public network IP(%s) is not bound to resources, and analysis is not supported for the time being. | 彈性公網IP(%s)未綁定資源,暫不支持分析。 |
400 | IllegalParam.TargetNotBound | Elastic public network IP(%s) is not bound to resources, and analysis is not supported for the time being. | 彈性公網IP(%s)未綁定資源,暫不支持分析。 |
400 | IllegalParam.NotPublicIp | The specified (%s) is invalid. | 指定的參數 (%s) 不是公網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. | 指定的實例 (%s) 和實例類型不匹配。 |
403 | Forbidden.NetworkPath | The current user has not activated NIS and is not authorized to use the path analysis interface. | 當前用戶未開通NIS,無權限使用路徑分析接口。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-04-23 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-04-09 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-03-22 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-12-12 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-11-06 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-07-11 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2022-06-17 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |