注意事项
HTTP 状态码
1.11 数据流转规则管理
1.11.6 查询规则动作列表
接口说明
应用服务器可调用此接口查询物联网平台中设置的规则动作列表。
调试
您可以在API Explorer中调试该接口。
URI
请求方法 GET
URI /v5/iot/{project_id}/routing-rule/actions 传输协议 HTTPS
请求参数
名称 必选/可
选
类型 位置 说明
X-Auth-Token 必选 String Head
er 参数说明：用户Token。通过调用 IAM服务 获取IAM用户Token接口 获取，接口返回的响应消息头中
“X-Subject-Token”就是需要获 取的用户Token。简要的获取方法 样例请参见 Token认证。
Instance-Id 可选 String Head
er 参数说明：实例ID。物理多租下各 实例的唯一标识，一般华为云租户 无需携带该参数，仅在物理多租场 景下从管理面访问API时需要携带 该参数。
project_i
d 必选 String Path 参数说明：项目ID。获取方法请参 见 获取项目ID。
名称 必选/可 选
类型 位置 说明
rule_id 可选 String Quer
y 参数说明：规则触发条件ID。
取值范围：长度不超过36，只允许 字母、数字、下划线（_）、连接 符（-）的组合。
channel 可选 String Quer
y 参数说明：规则动作的类型。
取值范围：
● HTTP_FORWARDING：HTTP 服务消息类型。
● DIS_FORWARDING：转发DIS 服务消息类型。
● OBS_FORWARDING：转发 OBS服务消息类型。
● AMQP_FORWARDING：转发 AMQP服务消息类型。
● DMS_KAFKA_FORWARDING：
转发kafka消息类型。
app_type 可选 String Quer
y 参数说明：租户规则的生效范围。
取值范围：
● GLOBAL：生效范围为租户级。
● APP：生效范围为资源空间级。
如果类型为APP，可携带app_id 查询指定资源空间下的规则动 作列表，不携带app_id则查询 默认资源空间下的规则动作列 表。
app_id 可选 String Quer
y 参数说明：资源空间ID。此参数为 非必选参数，rule_id不携带且 app_type为APP时，该参数生效，
可携带app_id查询指定资源空间下 的规则动作列表，不携带app_id则 查询默认资源空间下的规则动作列 表。
取值范围：长度不超过36，只允许 字母、数字、下划线（_）、连接 符（-）的组合。
limit 可选 Integer Quer
y 参数说明：分页查询时每页显示的 记录数。默认每页10条记录，最大 设定每页50条记录。
取值范围：1-50的整数，默认值为 10。
名称 必选/可 选
类型 位置 说明
marker 可选 String Quer
y 参数说明：上一次分页查询结果中 最后一条记录的ID，在上一次分页 查询时由物联网平台返回获得。分 页查询时物联网平台是按marker 也就是记录ID降序查询的，越新的 数据记录ID也会越大。若填写 marker，则本次只查询记录ID小 于marker的数据记录。若不填 写，则从记录ID最大也就是最新的 一条数据开始查询。如果需要依次 查询所有数据，则每次查询时必须 填写上一次查询响应中的marker 值。
取值范围：长度为24的十六进制字 符串，默认值为
ffffffffffffffffffffffff。
offset 可选 Integer Quer
y 参数说明：表示从marker后偏移 offset条记录开始查询。默认为0，
取值范围为0-500的整数。当 offset为0时，表示从marker后第 一条记录开始输出。 - 限制offset 最大值是出于API性能考虑，您可 以搭配marker使用该参数实现翻 页，例如每页50条记录，1-11页 内都可以直接使用offset跳转到指 定页，但到11页后，由于offset限 制为500，您需要使用第11页返回 的marker作为下次查询的
marker，以实现翻页到12-22页。
取值范围：0-500的整数，默认为 0。
响应参数
名称 类型 说明
actions List<RoutingRu
leAction> 规则动作信息列表。
count Integer 满足查询条件的记录总数。
marker String 本次分页查询结果中最后一条记录的ID，可在下 一次分页查询时使用。
表1-55 RoutingRuleAction
名称 类型 说明
action_id String 规则动作ID，用于唯一标识一条规则动作，在创 建规则动作时由物联网平台分配获得，创建时无 需携带，由平台统一分配唯一的action_id。
rule_id String 规则动作对应的的规则触发条件ID。
app_id String 资源空间ID。
channel String 规则动作的类型，取值范围：
● HTTP_FORWARDING：HTTP服务消息类型。
● DIS_FORWARDING：转发DIS服务消息类型。
● OBS_FORWARDING：转发OBS服务消息类 型。
● AMQP_FORWARDING：转发AMQP服务消息 类型。
● DMS_KAFKA_FORWARDING：转发kafka消息 类型。
channel_det
ail ChannelDetail
Object 通道配置信息。
表1-56 ChannelDetail
名称 类型 说明
http_forwar
ding HttpForwardin
g Object 参数说明：http服务器转发消息内容。当type为 HTTP_FORWARDING时，必填。
dis_forwardi
ng DisForwarding
Object 参数说明：转发DIS服务消息内容。当type为 DIS_FORWARDING时，必填。
obs_forward
ing ObsForwardin
g Object 参数说明：转发OBS服务消息内容。当type为 OBS_FORWARDING时，必填。
amqp_forwa
rding AmqpForwardi
ng Object 参数说明：转发AMQP服务消息内容。当type为 AMQP_FORWARDING时，必填。
dms_kafka_f
orwarding DmsKafkaForw
arding Object 参数说明：转发Kafka消息内容。当type为 DMS_KAFKA_FORWARDING时，必填。
表1-57 HttpForwarding
名称 类型 说明
url String 参数说明：用于接收满足规则条件数据的http服 务器地址。
名称 类型 说明
cert_id String 参数说明：证书id，请参见获取证书ID
cn_name String 参数说明：当sni_enable为true时，此字段需要填 写，内容为将要请求的服务端证书的域名,举 例:domain:8443;当sni_enbale为false时，此字段 默认不填写。
sni_enable Boolean 参数说明：需要https服务端和客户端都支持此功 能，默认为false，设成true表明Https的客户端在 发起请求时，需要携带cn_name；https服务端根 据cn_name返回对应的证书；设为false可关闭此 功能。
表1-58 DisForwarding
名称 类型 说明
region_nam
e String 参数说明：DIS服务对应的region区域 project_id String 参数说明：DIS服务对应的projectId信息 stream_nam
e String 参数说明：DIS服务对应的通道名称，stream_id 和stream_name两个参数必须携带一个，优先使 用stream_id
stream_id String 参数说明：DIS服务对应的通道ID，stream_id和 stream_name两个参数必须携带一个，优先使用 stream_id
表1-59 ObsForwarding
名称 类型 说明
region_nam
e String 参数说明：OBS服务对应的region区域 project_id String 参数说明：OBS服务对应的projectId信息 bucket_nam
e String 参数说明：OBS服务对应的桶名称
location String 参数说明：OBS服务对应桶的区域
名称 类型 说明
file_path String 参数说明：OBS服务中存储通道文件的自定义目 录,多级目录可用(/)进行分隔，不可以斜杠(/)开 头或结尾，不能包含两个以上相邻的斜杠(/) 取值范围: 英文字母(a-zA-Z)、数字(0-9)、下划 线(_)、中划线(-)、斜杠(/)和大括号({})，最大字 符长度256个字符。其中大括号只能用于对应模 板参数。
模板参数:
- \{YYYY\} 年 - \{MM\} 月 - \{DD\} 日 - \{HH\} 小时
例如:自定义目录结构为\{YYYY\}/\{MM\}/\{DD
\}/\{HH\},则会在转发数据时，根据当前时间往对 应的目录结构2021>08>11>09下生成对应的数 据。
表1-60 AmqpForwarding
名称 类型 说明
queue_nam
e String 参数说明：用于接收满足规则条件数据的amqp
queue。
表1-61 DmsKafkaForwarding
名称 类型 说明
region_nam
e String 参数说明：Kafka服务对应的region区域 project_id String 参数说明：Kafka服务对应的projectId信息 addresses List<NetAddres
s> 参数说明：转发kafka消息对应的地址列表
topic String 参数说明：转发kafka消息关联的topic信息。
username String 参数说明：转发kafka关联的用户名信息。
password String 参数说明：转发kafka关联的密码信息。
名称 类型 说明
mechanism String 参数说明：转发kafka关联的鉴权机制。
取值范围：
● PAAS：非SASL鉴权。
● PLAIN：SASL/PLAIN模式。需要填写对应的用 户名密码信息。
表1-62 NetAddress
名称 类型 说明
ip String 参数说明：服务的对应IP
port Integer 参数说明：服务对应端口 domain String 参数说明：服务对应的域名
请求示例
GET https://{Endpoint}/v5/iot/{project_id}/routing-rule/actions?
rule_id={rule_id}&channel={channel}&app_type={app_type}&app_id={app_id}&limit={limit}&marker={marker }&offset={offset}
Content-Type: application/json X-Auth-Token: ********
Instance-Id: ********
响应示例
Status Code: 200 OK
Content-Type: application/json { "actions" : [ {
"rule_id" : "1a7ffc5c-d89c-44dd-8265-b1653d951ce1", "action_id" : "1a7ffc5c-d89c-44dd-8265-b1653d951ce0", "channel_detail" : {
"amqp_forwarding" : { "queue_name" : "test"
},
"obs_forwarding" : {
"file_path" : "device_property_report/{YYYY}/{MM}/{DD}/{HH}", "project_id" : "project_id",
"bucket_name" : "bucket_name", "region_name" : "region_name", "location" : "location"
},
"http_forwarding" : { "sni_enable" : false, "cn_name" : "domain:8443",
"cert_id" : "0ae892cfeff641158920300b2292d2ca", "url" : "http://host:port/callbackurltest"
},
"dis_forwarding" : {
"region_name" : "region_name"
"channel" : "HTTP_FORWARDING",
"app_id" : "1a7ffc5c-d89c-44dd-8265-b1653d951ce2"
} ],
"count" : 10,
"marker" : "5c90fa7d3c4e4405e8525079"
}
错误码
HTTP 状态码
错误码 错误码英文描述 错误码中文描述 处理建议
400 IOTDA .00000 6
Invalid input data. 请求参数不合法 请排查请求参数是 否符合华为云文档 要求。
IOTDA .00001 1
Invalid input. The specified
parameter
'pageNo' is out of range.
Invalid input. The specified
parameter
'pageSize' is out of range.
请求参数中
pageSize超出范围 请排查请求参数中 的pageSize大小是
Invalid input. The parameter
'pageSize' multiply 'pageNo' exceeds the upper limit.
查询范围查过最大
限制。 请检查pageSize和 pageNo参数的大 小。
403 IOTDA .00002 1
Operation not allowed. User not found by IAM token or the authorized user has not subscribed IOTDA service.
没有找到IAM Token所对应的用户 信息或该用户没有 订阅设备接入服务
（IOTDA）
请排查IAM Token 所在用户是否订阅 了设备接入服务 (IOTDA)。
HTTP
Operation not allowed. The user does not have the permission
The application
does not exist. 该应用不存在 请确定是否已在平
Operation not allowed. The application has not been authorized.
该应用没有权限访
Operation not allowed. The parameter 'app_id' is not carried, and the authorized user has more than one applications.
Include the
parameter 'app_id', or contact Huawei technical support engineers to merge application data.
Operation not allowed.
Application not found by
authorized user or the authorized user has no application.
Operation not allowed. The application does not belong to the authorized user.
应用与用户信息不
匹配 请排查该用户下是
否有指定的应用。
500 IOTDA .00000 1
Internal server
error. 服务器内部错误 请联系华为工程师
分析解决。
HTTP 状态码
错误码 错误码英文描述 错误码中文描述 处理建议
IOTDA .00002 0
Decrypt IAM token
failed. IAM Token解析失 败
请联系华为工程师 分析解决。