CreateNetworkReachableAnalysis - Network Intelligence Service

Creates a task for analyzing network reachability.

Operation description

The CreateNetworkReachableAnalysis operation is used to create a task for analyzing the reachability of the network path that is created by calling the CreateNetworkPath operation and record the analysis results.
The CreateNetworkReachableAnalysis operation can be called to repeatedly analyze the reachability of a network path.
You can create up to 1,000 reachability analysis records within one Alibaba Cloud account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
nis:CreateNetworkReachableAnalysis	create	NetworkReachableAnalysis acs:nis::{#accountId}:networkreachableanalysis/	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region for which you want to create a task for analyzing network reachability.	cn-shanghai
NetworkPathId	string	Yes	The ID of the network path. You can call the CreateNetworkPath operation to obtain the ID of the network path.	np-b2f618ceb2c84057****
Tag	array<object>	No	The tags to add to the resource.
	object	No
Key	string	No	The key of the tag to add to the resource. The tag key can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag key cannot start with `acs:` or `aliyun`. You can add up to 20 tags in each call.	Team
Value	string	No	The value of the tag to add to the resource. The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag value cannot start with `acs:` or `aliyun`. The tag value can be an empty string. You can add up to 20 tag values in each call.	ops

Response parameters

Parameter	Type	Description	Example
	object
NetworkReachableAnalysisId	string	The ID of the task for analyzing network reachability.	nra-2fede05617494417****
RequestId	string	The request ID.	A7F0D6EC-E19E-58AC-AC9F-08036763960F

Examples

Sample success responses

JSONformat

{
  "NetworkReachableAnalysisId": "nra-2fede05617494417****",
  "RequestId": "A7F0D6EC-E19E-58AC-AC9F-08036763960F"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectStatus.NetworkPath	The last analysis status of %s is %s. Please try again later.	The Reachability Analyzer task %s is not completed. Try again after the task is completed.
400	QuotaExceeded.ParallelNraLimit	The maximum number of parallel reachability analysis task is exceeded.	The number of parallel Reachability Analyzer tasks exceeds the upper limit.
400	QuotaExceeded.MaxNraCount	The maximum number of reachability analysis task is exceeded.	The number of saved Reachability Analyzer tasks exceeds the upper limit.
400	IllegalParam.ZoneId	The specified available zone (%s) is invalid.	The specified zone (%s) is invalid.
400	IllegalParam.StepMinutes	The specified sampling interval (%s) is invalid.	The specified sampling interval (%s) is invalid.
400	IllegalParam.BeginTime	The specified begin time (%s) is invalid.	The specified start time (%s) is invalid.
400	IllegalParam.EndTime	The specified end time (%s) is invalid.	The specified end time (%s) is invalid.
400	Mismatch.BeginTimeAndEndTime	The specified begin time must be earlier than the end time.	The specified start time must be earlier than the end time.
400	MissingParameter.TagValue	You must specify Tag.N.Value.	-
400	NumberExceed.Tags	The maximum number of Tags is exceeded.	-
400	MissingParameter.TagKey	You must specify Tag.N.Key.	-
400	Duplicate.TagKey	The Tag.N.Key contains duplicate keys.	-
400	InvalidParameter.TagKey	The Tag.N.Key parameter is invalid.	-
400	InvalidParameter.TagValue	The Tag.N.Value parameter is invalid.	-
404	ResourceNotFound.NetworkPath	The specified resource of %s is not found.	The specified network path %s does not exist.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-09-04	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-08-31	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-07-11	The Error code has changed. The request parameters of the API has changed	View Change Details