DescribeDeviceAutoUpgradePolicy - Smart Access Gateway - Alibaba Cloud Documentation Center

Queries the automatic upgrade policy of a Smart Access Gateway (SAG) instance.

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:DescribeDeviceAutoUpgradePolicy	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the SAG instance.	cn-shanghai
SmartAGId	string	Yes	The ID of the SAG instance.	sag-kxe2cv7hot7qrv****
SerialNumber	string	Yes	The serial number of the SAG instance.	sage62x022502****
VersionType	string	No	The type of the software for which you want to query the automatic upgrade policy. Valid values: Device: The operating system that is run by the SAG instance. Dpi: The signature database that is used by the SAG instance.	Device

Response parameters

Parameter	Type	Description	Example
	object
UpgradeType	string	The update type. Valid values: scheduled: scheduled upgrade. boot: automatic upgrade upon instance startup. manual: manual upgrade.	scheduled
TimeZone	string	The time zone in which the trigger period takes effect.	Asia/Shanghai
SerialNumber	string	The serial number of the SAG instance.	sage62x022502****
RequestId	string	The ID of the request.	0E20FBB8-BCFC-4F5E-BD94-77FF6A2133D0
Jitter	string	The time differences between upgrades. Unit: minutes.	5
Duration	string	The time period during which upgrades are performed. Valid values: 30 to 120. Unit: minutes.	60
CronExpression	string	The time when upgrades start. The time was configured by using a cron expression. Example value: `0 0 4 1/1 * ?`. The example value indicates that upgrades start at 04:00:00 (UTC+8) on the first day of each month.	0 0 4 1/1 * ?
SmartAGId	string	The ID of the SAG instance.	sag-kxe2cv7hot7qrv****

Examples

Sample success responses

JSONformat

{
  "UpgradeType": "scheduled",
  "TimeZone": "Asia/Shanghai",
  "SerialNumber": "sage62x022502****",
  "RequestId": "0E20FBB8-BCFC-4F5E-BD94-77FF6A2133D0",
  "Jitter": "5",
  "Duration": "60",
  "CronExpression": "0 0 4 1/1 * ?",
  "SmartAGId": "sag-kxe2cv7hot7qrv****"
}

Error codes

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