Initiates a network reachability analysis task.
Operation description
This operation initiates a reachability analysis task directly based on the specified source and destination information without creating a network analysis path. The analysis results are not recorded in the system. To retain the network path or reachability analysis task results in Network Intelligence Service (NIS), use the CreateNetworkReachableAnalysis operation.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
nis:CreateAndAnalyzeNetworkPath |
create |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| SourceId |
string |
Yes |
The ID of the source resource. |
i-uf62y8khhbkbdrp6**** |
| SourceIpAddress |
string |
No |
The source IP address. |
192.168.XX.XX |
| TargetIpAddress |
string |
No |
The destination IP address. |
172.50.XX.XX |
| SourceType |
string |
Yes |
The source resource type. Valid values:
|
ecs |
| SourcePort |
integer |
No |
The source port. |
0 |
| TargetId |
string |
No |
The ID of the destination resource. Note
The TargetId parameter is required when you call this operation. |
i-m5eactvw7wtpktv5**** |
| TargetType |
string |
No |
The destination resource type. Valid values:
Note
The TargetType parameter is required when you call this operation. |
ecs |
| TargetPort |
integer |
No |
The destination port. |
80 |
| Protocol |
string |
No |
The protocol type. Valid values:
Note
The Protocol parameter is required when you call this operation. |
tcp |
| RegionId |
string |
No |
The ID of the region where you want to initiate the network reachability analysis task. |
cn-shanghai |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The request ID. |
D5E98683-355B-5867-8D3D-A24755F6895B |
| NetworkReachableAnalysisId |
string |
The ID of the initiated network reachability analysis task. |
nra-dfe9e53d2b524568**** |
| SourceId |
string |
The ID of the source resource. |
i-uf62y8khhbkbdrp6**** |
| TargetId |
string |
The ID of the destination resource. |
i-m5eactvw7wtpktv5**** |
| SourceType |
string |
The source resource type. |
ecs |
| TargetType |
string |
The destination resource type. |
ecs |
| SourcePort |
string |
The source port. |
0 |
| TargetPort |
string |
The destination port. |
80 |
| Protocol |
string |
The protocol type. |
tcp |
| SourceIpAddress |
string |
The source IP address. |
192.168.XX.XX |
| TargetIpAddress |
string |
The destination IP address. |
172.50.XX.XX |
Examples
Success response
JSON format
{
"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"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | IllegalParam.InternetIP | The specified IP address (%s) is not an internet IP address. | The specified IP address (%s) is not a public IP address. The IP address must not fall within the following ranges: 10.0.0.0 to 10.255.255.255, 172.16.0.0 to 172.31.255.255, or 192.168.0.0 to 192.168.255.255. |
| 400 | IllegalParam.IP | The specified IP address (%s) is invalid. | The specified IP address (%s) is invalid. |
| 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. | Reachability Analyzer does not support the scenario in which the public IP addresses of the source and destination are associated with the ECS instance (%s and %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. | Both the source and destination are IP addresses, but not Alibaba Cloud public IP addresses. Reachability Analyzer supports only Alibaba Cloud public IP addresses. |
| 400 | IllegalParam.SourcePort | The specified SourcePort(%s) value is invalid. The value must be within the range of (0,65536]. | The value of SourcePort is invalid. Valid values: 0 to 65536. |
| 400 | IllegalParam.TargetPort | The specified TargetPort(%s) value is invalid. The value must be within the range of (0,65536]. | The value of TargetPort is invalid. Valid values: 0 to 65536. |
| 400 | IllegalParam.SourceId | The specified SourceId(%s) may be not exist. | The specified instance (%s) may not exist. Check the spelling. |
| 400 | IllegalParam.TargetId | The specified TargetId(%s) may be not exist. | The specified instance (%s) may not exist. Check the spelling. |
| 400 | IllegalParam.SourceIp | Please enter a valid source IP. | Please enter a valid source IP |
| 400 | IllegalParam.SourceType | The specified source type (%s) is invalid. | The specified source type (%s) is invalid. |
| 400 | IllegalParam.Protocol | The specified Protocol(%s) is invalid. | The Protocol(%s) parameter is invalid. |
| 400 | IllegalParam.TargetType | The specified target type (%s) is invalid. | The specified destination type () is invalid. |
| 400 | IllegalParam.TargetIp | The specified target ip (%s) is invalid. | The specified destination IP() is not in the correct format. |
| 400 | IllegalParam.NotSupportHaVpn | The specified VPN(%s), which is not currently supported for such instances. | The specified VPN(), which is not currently supported for such instances. |
| 400 | IllegalParam.SourceNotBound | Elastic public network IP(%s) is not bound to resources, and analysis is not supported for the time being. | Elastic public network IP() is not bound to resources, and analysis is not supported for the time being. |
| 400 | IllegalParam.TargetNotBound | Elastic public network IP(%s) is not bound to resources, and analysis is not supported for the time being. | The elastic IP address (%s) is not associated with any resource. Analysis is currently not supported. |
| 400 | IllegalParam.NotPublicIp | The specified (%s) is invalid. | The specified parameter is illegal. |
| 400 | IllegalParam.SourceEqualTarget | The specified source and destination are identical, which is not supported for analysis. | The specified source and destination are the same, and analysis is not supported. |
| 400 | IllegalParam.TypeAndIdMismatch | The specified instanceId (%s) and type do not match. | The specified instanceId and its type do not match. |
| 403 | Forbidden.NetworkPath | The current user has not activated NIS and is not authorized to use the path analysis interface. | The current user has not activated NIS and is not authorized to use the path analysis interface. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.