物联网边缘计算 GetDeviceTunnelStatus

By | 2021年4月23日

调用该接口查询网关设备的隧道状态。

限制条件

  • 如果在企业版实例中调用该接口,必须传入参数IotInstanceId的值。否则,调用接口会失败。
  • 单阿里云账号调用该接口的每秒请求数(QPS)最大限制为20。

    说明 RAM用户共享阿里云账号配额。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetDeviceTunnelStatus

系统规定参数。取值:GetDeviceTunnelStatus。

DeviceName String LEGatewayAuto_B3XM******

要查询的网关设备名称。

ProductKey String a1kqtIX****

网关所属产品的Key,产品的唯一标识符。

IotInstanceId String iot_instc_pu****_c*-v64********

实例ID:

  • 企业版实例:必须传入此参数。您可在物联网平台控制台的实例概览页面,查看您的企业版实例ID。
  • 公共实例:无需传入此参数。

调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

返回数据

名称 类型 示例值 描述
Code String Success

接口返回码:

  • Success:表示成功。
  • 其它:表示错误码。错误码详情,请参见错误码
Data String online

调用成功时,返回的数据:

  • online:表示网关隧道已开启。
  • offline:表示网关隧道已关闭。
ErrorMessage String request parameter error

调用失败时,返回的出错信息。

RequestId String 7CCFF08F-34D1-4FBD-ACA9-22D9364EA5A4

阿里云为该请求生成的唯一标识符。

Success Boolean true

是否调用成功:

  • true:表示调用成功。
  • false:表示调用失败。

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=GetDeviceTunnelStatus
&ProductKey=a1Wmy******
&DeviceName=LEGatewayAuto_B3XM******
&<公共请求参数>

正常返回示例

XML格式

<GetDeviceTunnelStatusResponse>
    <RequestId>7CCFF08F-34D1-4FBD-ACA9-22D9364EA5A4</RequestId>
    <Data>online</Data>
    <Code>Success</Code>
    <Success>true</Success>
</GetDeviceTunnelStatusResponse>

JSON格式

{
  "RequestId": "7CCFF08F-34D1-4FBD-ACA9-22D9364EA5A4",
  "Data": "online",
  "Code": "Success",
  "Success": true
}

请关注公众号获取更多资料

发表评论

电子邮件地址不会被公开。 必填项已用*标注

Iconic One Theme | Powered by Wordpress