调用该接口,为指定的边缘实例创建消息路由。
限制条件
- 如果在企业版实例中调用该接口,必须传入参数IotInstanceId的值。否则,调用接口会失败。
-
单阿里云账号调用该接口的每秒请求数(QPS)最大限制为10。说明 RAM用户共享阿里云账号配额。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateEdgeInstanceMessageRouting |
系统规定参数。取值:CreateEdgeInstanceMessageRouting。 |
InstanceId | String | 是 | nF9oXo7kLRWQ******** |
边缘实例ID。在边缘计算控制台的边缘实例页面中,鼠标指针悬浮在目标边缘实例名称上获取ID。 |
SourceType | String | 是 | device |
消息来源,取值如下:
|
TargetType | String | 是 | function |
消息接收者,取值分如下几种情况:
|
IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** |
物联网平台的实例ID:
|
Name | String | 否 | le_lite2 |
消息路由名称。长度限制为4~32个字符,汉字和全角符号算2个字符。 |
TopicFilter | String | 否 | all |
消息过滤条件,取值如下:
|
SourceData | String | 否 | # |
消息来源的数据,取值分如下几种情况:
|
TargetData | String | 否 | 58c46749ac934db3925fe5******** |
消息接收者的数据,取值分如下几种情况:
|
TargetIotHubQos | Integer | 否 | 0 |
服务级别。取值如下:
说明 当TargetType为IoTHub时,必须传入此参数。
|
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | Success |
接口返回码:
|
ErrorMessage | String | request parameter error |
调用失败时,返回的出错信息。 |
RequestId | String | AC786033-00C5-4FD6-8435-F2807740D9FA |
阿里云为该请求生成的唯一标识符。 |
RouteId | Long | 123456 |
消息路由的ID。 |
Success | Boolean | true |
是否调用成功:
|
示例
请求示例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=CreateEdgeInstanceMessageRouting
&TargetData=58c46749ac934db3925fe5********
&TopicFilter=all
&InstanceId=nF9oXo7kLRWQ********
&SourceType=device
&TargetType=function
&SourceData=#
&Name=le_lite2
&<公共请求参数>
正常返回示例
XML
格式
<CreateEdgeInstanceMessageRoutingResponse>
<RequestId>BBE0E0C7-913A-47B8-A255-F2C6038B5FD8</RequestId>
<RouteId>123456</RouteId>
<Code>Success</Code>
<Success>true</Success>
</CreateEdgeInstanceMessageRoutingResponse>
JSON
格式
{
"RequestId": "BBE0E0C7-913A-47B8-A255-F2C6038B5FD8",
"RouteId": 123456,
"Code": "Success",
"Success": true
}