All Products
Search
Document Center

Smart Access Gateway:DiagnoseSmartAccessGateway

Last Updated:Mar 03, 2024

Enables diagnostics for Smart Access Gateway (SAG) devices

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:DiagnoseSmartAccessGatewayWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SmartAGIdstringYes

The ID of the SAG instance.

sag-1um5x5nwhilymw****
SmartAGSnstringYes

The serial number (SN) of the SAG device.

sage62x022502****
RegionIdstringYes

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

cn-shanghai

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

193AE392-76C2-4D3E-9420-889A51B43CC0

Examples

Sample success responses

JSONformat

{
  "RequestId": "193AE392-76C2-4D3E-9420-889A51B43CC0"
}

Error codes

HTTP status codeError codeError messageDescription
403MissingParameterThe input parameter is missing, please check your input.Missing parameters. Check whether all required parameters are set.

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