DescribeSagRemoteAccess - 查询智能接入网关设备远程登录信息

调用DescribeSagRemoteAccess查询智能接入网关设备远程登录信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
smartag:DescribeSagRemoteAccessRead
  • SmartAccessGateway
    acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}

请求参数

名称类型必填描述示例值
SmartAGIdstring

智能接入网关实例 ID。

sag-1um5x5nwhilymw****
SerialNumberstring

智能接入网关设备序列号。

sage62x022502****
RegionIdstring

智能接入网关实例所属地域 ID。

cn-shanghai

返回参数

名称类型描述示例值
object
Codestring

错误码。200 标识查询任务成功。

200
Messagestring

错误信息。Successful 标识查询任务成功。

successful
RequestIdstring

请求 ID。

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

标识查询任务是否成功。

  • true:表示查询任务成功。
  • false:表示查询任务未成功。
true
SmartAGIdstring

智能接入网关实例 ID。

sag-1um5x5nwhilymw****
RemoteAccessesobject []

智能接入网关设备远程登录信息。

SerialNumberstring

智能接入网关设备序列号。

sage62x022502****
RemoteAccessIpstring

远程登录私网 IP 地址。

192.XX.XX.1

示例

正常返回示例

JSON格式

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

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InstanceNotExitThe specified instance does not exist.指定的实例不存在。
400InvalidId.SNThe specified smart access gateway serial number does not exist.输入的SAG序列号不存在。
500InternalErrorAn error occurred while processing your request.请求失败,发生未知错误。

访问错误中心查看更多错误码。