Tests the connectivity between a Smart Access Gateway (SAG) instance and a specified access point.

Background information

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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No ProbeAccessPointNetworkQuality

The operation that you want to perform. Set the value to ProbeAccessPointNetworkQuality.

RegionId String Yes cn-shanghai

The ID of the region where the SAG instance is deployed.

You can call the DescribeRegions operation to query the most recent region list.

SmartAGId String Yes sag-6z21oj0vjjrx6s****

The ID of the SAG instance.

AccessPointIds.N Integer Yes 110

The ID of the access point.

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.

Response parameters

Parameter Type Example Description
RequestId String E26DBAAE-A796-4A48-98B4-B45AFCD1F299

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ProbeAccessPointNetworkQuality
&RegionId=cn-shanghai
&SmartAGId=sag-6z21oj0vjjrx6s****
&AccessPointIds=[110]
&Common request parameters

Sample responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<ProbeAccessPointNetworkQualityResponse>
    <RequestId>E26DBAAE-A796-4A48-98B4-B45AFCD1F299</RequestId>
</ProbeAccessPointNetworkQualityResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HttpCode Error code Error message Description
400 ProbeFrequencyTooHigh The probe frequency is too high. Please try again later. The error message returned because the frequency of tests is too high. Try again later.

For a list of error codes, visit the API Error Center.