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

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 DescribeDeviceAutoUpgradePolicy

The operation that you want to perform.

Set the value to DescribeDeviceAutoUpgradePolicy.

RegionId String Yes cn-shanghai

The ID of the region where the SAG instance is deployed.
SerialNumber String Yes sage62x022502****

The serial number of the SAG device.
SmartAGId String Yes sag-kxe2cv7hot7qrv****

The ID of the SAG instance.
VersionType String No Device

The type of the software for which you want to query the automatic upgrade policy.

  • Device: The operating system of the SAG device.
  • Dpi: The signature database used by the SAG device.

Response parameters

Parameter Type Example Description
CronExpression String 0 0 4 1/1 * ?

The time when upgrades start. Valid values: Set the parameter in a cron expression.

For example, 0 0 4 1/1 * ? indicates that upgrades start at 4:00:00 (UTC+8) on the first day of each month.

Duration String 60

The time period during which upgrades are performed.

Valid values: 30 to 120.

Unit: minutes.
Jitter String 5

The time differences between upgrades. Unit: minutes.
RequestId String 0E20FBB8-BCFC-4F5E-BD94-77FF6A2133D0

The ID of the request.
SerialNumber String sage62x022502****

The serial number of the SAG device.
SmartAGId String sag-kxe2cv7hot7qrv****

The ID of the SAG instance.
TimeZone String Asia/Shanghai

The time zone.
UpgradeType String scheduled

The upgrade type. Valid values:

  • scheduled: scheduled upgrade.
  • boot: automatic upgrade upon device startup.
  • manual: manual upgrade.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeDeviceAutoUpgradePolicy
&RegionId=cn-shanghai
&SerialNumber=sage62x022502****
&SmartAGId=sag-1um5x5nwhilymw****
&<Common request parameters>

Sample success responses

XML format 

<DescribeDeviceAutoUpgradePolicyResponse>
  <SerialNumber>sage62x022502****</SerialNumber>
  <SmartAGId>sag-kxe2cv7hot7qrv****</SmartAGId>
  <UpgradeType>scheduled</UpgradeType>
  <Duration>60</Duration>
  <RequestId>0E20FBB8-BCFC-4F5E-BD94-77FF6A2133D0</RequestId>
  <CronExpression>0 0 4 1/1 * ? </CronExpression>
  <TimeZone>Asia/Shanghai</TimeZone>
</DescribeDeviceAutoUpgradePolicyResponse>

JSON format 

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

Error codes

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