ProbeAccessPointNetworkQuality - Smart Access Gateway - Alibaba Cloud Documentation Center

Probes the network connectivity between a Smart Access Gateway (SAG) instance and an access point.

Operation description

You can call this operation to test the connectivity between an SAG instance and a specified access point.

If the SAG instance can connect to the access point, the ID of the request is returned in this operation.
If the SAG instance cannot connect to the access point, the ID of the request and corresponding error messages are returned in this operation.

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
smartag:ProbeAccessPointNetworkQuality	Write	SmartAccessGateway acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the SAG instance is deployed. You can call the DescribeRegions operation to query the most recent region list.	cn-shanghai
SmartAGId	string	Yes	The ID of the SAG instance.	sag-6z21oj0vjjrx6s****
AccessPointIds	array	Yes	The IDs of the access point.
	integer	Yes	You can enter multiple access point IDs at a time. Valid values of N are 1 to 5. You can call the ListAccessPoints operation to query the IDs of access points in a specified region.	110

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	E26DBAAE-A796-4A48-98B4-B45AFCD1F299

Examples

Sample success responses

JSONformat

{
  "RequestId": "E26DBAAE-A796-4A48-98B4-B45AFCD1F299"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ProbeFrequencyTooHigh	The probe frequency is too high. Please try again later.	The probe frequency has reached the upper limit. Try again later.

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