调用该接口，获取边缘实例中消息路由的详细信息。

限制条件

  • 如果在企业版实例中调用该接口，必须传入参数IotInstanceId的值。否则，调用接口会失败。
  • 单阿里云账号调用该接口的每秒请求数（QPS）最大限制为10。
    说明 RAM用户共享阿里云账号配额。

调试

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

请求参数

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

系统规定参数。取值：GetEdgeInstanceMessageRouting。
InstanceId String 是 8jKxIuMVT9rX********

边缘实例ID。在边缘计算控制台的边缘实例页面中，鼠标指针悬浮在目标边缘实例名称上获取ID。

RouteId Long 是 123456

消息路由ID。您可以调用QueryEdgeInstanceMessageRouting接口获取。

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

物联网平台的实例ID：

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

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

返回数据

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

接口返回码：

  • Success：表示成功。
  • 其它：表示错误码。错误码详情，请参见错误码。
Data Struct

调用成功时，返回的数据。
GmtCreate String 2020-05-25 19:54:59

创建消息路由的时间。
GmtCreateTimestamp Long 1590407699000

创建消息路由的Unix时间戳。
GmtModified String 2020-05-25 19:54:59

最后一次更新消息路由的时间。
GmtModifiedTimestamp Long 1590407699000

最后一次更新消息路由的Unix时间戳。
Name String sample

消息路由名称。
RouteContext Struct

消息来源和消息接收者的补充信息。
Qos String 1

服务级别：

  • 0：表示消息仅发送一次，不管是否被消息接收者成功接收。
  • 1：表示最少发送一次消息，直至收到消息接收者的返回信息，则停止发送该消息。
SourceApplicationName String le_object_detector

SourceType为function，且SourceData中指定的边缘应用，是函数计算类型的边缘应用时，返回此参数，表示函数计算类型边缘应用的名称。

SourceFcFunctionName String object_detector_app

SourceType为function，且SourceData中指定的边缘应用，是函数计算类型的边缘应用时，返回此参数，表示函数计算类型边缘应用中的函数名称。

SourceFcServiceName String EdgeFC

SourceType为function，且SourceData中指定的边缘应用，是函数计算类型的边缘应用时，返回此参数，表示函数计算类型边缘应用中的服务名称。

TargetApplicationName String le_object_detector

TargetType为function，且TargetData中指定的边缘应用，是函数计算类型的边缘应用时，返回此参数，表示函数计算类型边缘应用的名称。

TargetFcFunctionName String lightSensorDataFilter

TargetType为function，且TargetData中指定的边缘应用，是函数计算类型的边缘应用时，返回此参数，表示函数计算类型边缘应用中的函数名称。

TargetFcServiceName String EdgeFC

TargetType为function，且TargetData中指定的边缘应用，是函数计算类型的边缘应用时，返回此参数，表示函数计算类型边缘应用中的函数名称。

SourceData String #

消息来源的数据：

  • SourceType为device时：
    • 此处参数值格式为/{Your_ProductKey}/{Your_DeviceName}：表示消息来源为指定产品下的指定设备。
      说明 {Your_ProductKey}和{Your_DeviceName}是您实际设备的ProductKey和DeviceName。
    • 此处参数值格式为/{Your_ProductKey}/+：表示消息来源为指定产品下的所有设备。
      说明 {Your_ProductKey}是您实际设备的ProductKey。
    • 此处参数值为#：表示消息来源为边缘实例中所有产品下的所有设备。
  • SourceType为function时：此处是边缘应用的ID。
  • SourceType为IotHub时：此处为空。
SourceType String device

消息来源：

  • device：表示消息由设备发出。
  • function：表示消息由边缘应用发出。
  • IotHub：表示消息由云端发出。
TargetData String 58c46749ac934db3925fe5********

消息接收者的数据：

  • TargetType为function时：此处是边缘应用的ID。
  • TargetType为IotHub时：此处为空。
TargetType String IotHub

消息接收者：

  • function：表示消息发送给边缘应用。
  • IotHub：表示消息发送给云端。
TopicFilter String all

消息过滤条件。
ErrorMessage String request parameter error

调用失败时，返回的出错信息。
RequestId String 8A248DEC-887C-4A37-8DE5-E128FFA3698D

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

是否调用成功：

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

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=GetEdgeInstanceMessageRouting
&InstanceId=8jKxIuMVT9rX********
&RouteId=123456
&<公共请求参数>

正常返回示例

XML格式 

<GetEdgeInstanceMessageRoutingResponse>
    <RequestId>8A248DEC-887C-4A37-8DE5-E128FFA3698D</RequestId>
    <Data>
        <TargetData></TargetData>
        <TopicFilter>all</TopicFilter>
        <GmtCreate>2020-05-25 19:54:59</GmtCreate>
        <GmtCreateTimestamp>1590407699000</GmtCreateTimestamp>
        <SourceType>device</SourceType>
        <TargetType>IotHub</TargetType>
        <GmtModified>2020-05-25 19:54:59</GmtModified>
        <RouteId>170101</RouteId>
        <GmtModifiedTimestamp>1590407699000</GmtModifiedTimestamp>
        <Name>sample</Name>
        <SourceData>#</SourceData>
        <RouteContext>
            <Qos>0</Qos>
        </RouteContext>
    </Data>
    <Code>Success</Code>
    <Success>true</Success>
</GetEdgeInstanceMessageRoutingResponse>

JSON格式 

{
  "RequestId": "8A248DEC-887C-4A37-8DE5-E128FFA3698D",
  "Data": {
    "TargetData": "",
    "TopicFilter": "all",
    "GmtCreate": "2020-05-25 19:54:59",
    "GmtCreateTimestamp": 1590407699000,
    "SourceType": "device",
    "TargetType": "IotHub",
    "GmtModified": "2020-05-25 19:54:59",
    "RouteId": 170101,
    "GmtModifiedTimestamp": 1590407699000,
    "Name": "sample",
    "SourceData": "#",
    "RouteContext": {
      "Qos": 0
    }
  },
  "Code": "Success",
  "Success": true
}