All Products
Search
Document Center

Smart Access Gateway:DescribeSmartAccessGatewayVersions

Last Updated:Mar 29, 2024

Queries the version 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
smartag:DescribeSmartAccessGatewayVersionsRead
  • SmartAccessGateway
    acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
SmartAGIdstringYes

The ID of the SAG instance.

sag-d3m51apgw4po5*****
SmartAGSnstringNo

The serial number of the SAG device.

sage62x022502****
VersionTypestringNo

The type of software run by the SAG device. Valid values:

  • Device: The operating system run by the SAG device. This is the default value.
  • Dpi: The signature database used by the SAG device.
Device

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

765AB188-69BF-47C6-BEDD-B9FC72BFBB0
SmartAGVersionsobject []

The information about the version of the SAG device.

Typestring

The type of the version. Valid values:

  • beta: a preview version.
  • release: an officially released version.
release
CreateTimelong

The timestamp when the version was released.

1522744623000
VersionNamestring

The name of the version.

testpackage1
VersionCodestring

The version number.

1.0

Examples

Sample success responses

JSONformat

{
  "RequestId": "765AB188-69BF-47C6-BEDD-B9FC72BFBB0",
  "SmartAGVersions": {
    "SmartAGVersion": [
      {
        "Type": "release",
        "CreateTime": 1522744623000,
        "VersionName": "testpackage1",
        "VersionCode": "1.0"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400VersionNotExistThe specified version does not exist.The specified version does not exist.
403ForbiddenUser not authorized to operate on the specified resource.You do not have permissions to manage the specified resource.

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