All Products
Search
Document Center

Smart Access Gateway:DescribeSagRemoteAccess

Last Updated:Mar 03, 2024

Queries remote logon information about 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:DescribeSagRemoteAccessRead
  • SmartAccessGateway
    acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SmartAGIdstringYes

The ID of the SAG instance.

sag-1um5x5nwhilymw****
SerialNumberstringNo

The serial number of the SAG device.

sage62x022502****
RegionIdstringYes

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

cn-shanghai

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The error code. The 200 error code indicates that the query task is successful.

200
Messagestring

The error message. The Successful error message indicates that the query task is successful.

successful
RequestIdstring

The ID of the request.

E38E950D-28A4-4C41-9428-A8908EC6AE5C
Successboolean

Indicates whether the query task is successful. Valid values:

  • true: The query task is successful.
  • false: The query task failed.
true
SmartAGIdstring

The ID of the SAG instance.

sag-1um5x5nwhilymw****
RemoteAccessesobject []

Remote logon information about the SAG device.

SerialNumberstring

The serial number of the SAG device.

sage62x022502****
RemoteAccessIpstring

The private IP address where the remote logon is initiated.

192.XX.XX.1

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "E38E950D-28A4-4C41-9428-A8908EC6AE5C",
  "Success": true,
  "SmartAGId": "sag-1um5x5nwhilymw****",
  "RemoteAccesses": {
    "RemoteAccess": [
      {
        "SerialNumber": "sage62x022502****",
        "RemoteAccessIp": "192.XX.XX.1"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InstanceNotExitThe specified instance does not exist.The specified instance does not exist.
400InvalidId.SNThe specified smart access gateway serial number does not exist.The specified smart access gateway serial number does not exist.
500InternalErrorAn error occurred while processing your request.An error occurred while processing your request.

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