Synchronizes the settings of a Smart Access Gateway (SAG) device to the associated SAG instance.
Operation description
SynchronizeSmartAGWebConfig is an asynchronous operation. After you send a request, the request ID is returned but the operation is still being performed in the system background. You can call the DescribeSAGDeviceInfo operation to query the status of an SAG device.
- If an SAG device is in the Synchronizing state, the settings of the SAG device are being synchronized to the associated SAG instance.
- If an SAG device is in the Synchronized state, the settings of the SAG device are synchronized to the associated SAG instance.
Debugging
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 Resourcesis 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:SynchronizeSmartAGWebConfig | Write |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The ID of the region where the SAG instance is deployed. | cn-shanghai |
| SmartAGId | string | Yes | The ID of the SAG instance. | sag-nylv14tghsk26c**** |
| SmartAGSn | string | Yes | The serial number of the SAG device. | sag32a30**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "CBBE5EBF-69C1-4395-B36B-26B7605F87EA"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | SAG.InstanceNoFound | The specified SAG instance does not exist. | The specified SAG instance does not exist. |
| 400 | SAG.SoftwareNotSupport | The specified SAG software edition instance does not support ACL. | The specified SAG software edition instance does not support ACL. |
| 400 | SAG.SoftwareNotSupportFeature | The specified SAG Software instance does not support this feature. | The specified SAG Software instance does not support this feature. |
| 403 | SmartAccessGatewayNotOnline | The specified smart access gateway is not online. | The specified SAG device is disconnected. The operation cannot be processed. |
| 500 | SmartAccessGatewayInArrears | The specified Smart Access Gateway has expired. | The specified Smart Access Gateway has expired. |
| 500 | SmartAccessGatewayNotActivated | The specified Smart Access Gateway has not been activated. | The specified SAG instance is inactive. You must activate the instance first. |
| 500 | SmartAccessGatewayOffline | The request cannot be completed. The Smart Access Gateway is offline. | The SAG device is disconnected. The request cannot be processed. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|