• 沒有找到結果。

注意事项

HTTP 状态码

1.11 数据流转规则管理

1.11.1 查询规则条件列表

Operation not allowed. User not found by IAM token or the authorized user has not subscribed IOTDA service.

没有找到IAM Token所对应的用户 信息或该用户没有 订阅设备接入服务

(IOTDA)

请排查IAM Token 所在用户是否订阅

Request reached the maximum rate limit %s

请求已经达到限制 速率

请降低请求频率, 该 请求速率已达到限 制。

500 IOTDA .00002 0

Decrypt IAM token

failed. IAM Token解析失

败 请联系华为工程师

您可以在API Explorer中调试该接口。

URI

请求方法 GET

URI /v5/iot/{project_id}/routing-rule/rules 传输协议 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。

resource 可选 String Quer

y 参数说明:订阅的资源名称。

取值范围:

● device:设备。

● device.property:设备属性。

● device.message:设备消息。

● device.message.status:设备 消息状态。

● device.status:设备状态。

● batchtask:批量任务。

● product:产品。

● device.command.status:设备 异步命令状态。

名称 必选/可 选

类型 位置 说明

event 可选 String Quer

y 参数说明:订阅的资源事件。

取值范围:与资源有关,不同的资 源,事件不同。 event需要与 resource关联使用,具体的

“resource:event”映射关系如 下:

● device:create(设备添加)

● device:delete(设备删除)

● device:update(设备更新)

● device.status:update (设备 状态变更)

● device.property:report(设备 属性上报)

● device.message:report(设备 消息上报)

● device.message.status:

update(设备消息状态变更)

● batchtask:update (批量任 务状态变更)

● product:create(产品添加)

● product:delete(产品删除)

● product:update(产品更新)

● device.command.status:

update(设备异步命令状态更 新)。

app_type 可选 String Quer

y 参数说明:租户规则的生效范围。

取值范围:

● GLOBAL:生效范围为租户级。

● APP:生效范围为资源空间级。

如果类型为APP,可携带app_id 查询指定资源空间下的规则动 作列表,不携带app_id则查询 默认资源空间下的规则列表。

app_id 可选 String Quer

y 参数说明:资源空间ID。此参数为 非必选参数,携带app_id查询指定 资源空间下的规则动作列表,不携 带app_id则查询默认资源空间下的 规则动作列表。

取值范围:长度不超过36,只允许 字母、数字、下划线(_)、连接 符(-)的组合。

名称 必选/可 选

类型 位置 说明

rule_nam

e 可选 String Quer

y 参数说明:用户自定义的规则名称 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。

响应参数

名称 类型 说明

名称 类型 说明

count Integer 满足查询条件的记录总数。

marker String 本次分页查询结果中最后一条记录的ID,可在下 一次分页查询时使用。

1-49 RoutingRule

名称 类型 说明

rule_id String 规则触发条件ID,用于唯一标识一个规则触发条 件,在创建规则条件时由物联网平台分配获得。

rule_name String 用户自定义的规则名称。

description String 用户自定义的规则描述。

subject RoutingRuleSu

bject Object 资源事件信息,即资源变化事件。

app_type String 租户规则的生效范围,取值如下:

● GLOBAL:生效范围为租户级

● APP:生效范围为资源空间级。

app_id String 资源空间ID

select String 用户自定义sql select语句,最大长度500,该参 数仅供标准版和企业版用户使用。

where String 用户自定义sql where语句,最大长度500,该参 数仅供标准版和企业版用户使用。

active Boolean 规则条件的状态是否为激活。

1-50 RoutingRuleSubject

名称 类型 说明

resource String 参数说明:资源名称。

取值范围:

● device:设备。

● device.property:设备属性。

● device.message:设备消息。

● device.message.status:设备消息状态。

● device.status:设备状态。

● batchtask:批量任务。

● product:产品。

● device.command.status:设备异步命令状 态。

event String 参数说明:资源事件。

取值范围:与资源有关,不同的资源,事件不 同。event需要与resource关联使用,具体的

“resource:event”映射关系如下:

● device:create(设备添加)

● device:delete(设备删除)

● device:update(设备更新)

● device.status:update (设备状态变更)

● device.property:report(设备属性上报)

● device.message:report(设备消息上报)

● device.message.status:update(设备消息状 态变更)

● batchtask:update (批量任务状态变更)

● product:create(产品添加)

● product:delete(产品删除)

● product:update(产品更新)

● device.command.status:update(设备异步 命令状态更新)

请求示例

GET https://{Endpoint}/v5/iot/{project_id}/routing-rule/rules?

resource={resource}&event={event}&app_type={app_type}&app_id={app_id}&rule_name={rule_name}&limit

={limit}&marker={marker}&offset={offset}

Content-Type: application/json X-Auth-Token: ********

Instance-Id: ********

响应示例

Status Code: 200 OK

Content-Type: application/json { "rules" : [ {

"rule_id" : "5bcaddda-75bf-4623-8c8d-26175c41fcca", "app_type" : "GLOBAL",

"select" : "*",

"rule_name" : "rulename", "subject" : {

"resource" : "device", "event" : "create"

},

"description" : "description", "active" : true,

"where" : "product_id='d89c-44dd-8265-b1653d951ce0'", "app_id" : "1a7ffc5c-d89c-44dd-8265-b1653d951ce0"

} ],

"count" : 10,

"marker" : "5c90fa7d3c4e4405e8525079"

}

错误码

HTTP 状态码

错误码 错误码英文描述 错误码中文描述 处理建议

400 IOTDA .00000 6

Invalid input data. 请求参数不合法 请排查请求参数是 否符合华为云文档 要求。

IOTDA .00001 7

Invalid input. The specified

parameter 'limit' is out of range.

请求中limit参数超

Invalid input. The specified

parameter 'marker' is out of range.

请求中marker参数

Invalid parameter

app_id app_id不合法 请确认请求中的 app_id是否正确。

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.

应用与用户信息不

匹配 请排查该用户下是

否有指定的应用。

404 IOTDA .01000 2

The rule does not

exist. 该规则不存在 请确认平台是否存

在该规则或请求参 数是否正确。

HTTP 状态码

错误码 错误码英文描述 错误码中文描述 处理建议

500 IOTDA .00000