# 查询规则动作列表 #### 功能介绍 应用服务器可调用此接口查询设施云平台中设置的规则动作列表。 #### URI GET /v1/iotfm/routing-rules/{rule_id}/actions 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | rule_id | 是 | String | **参数说明**：规则条件ID。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数说明**：分页查询时每页显示的记录数。 **取值范围**：默认值为10，取值范围为1-50的整数。 | | marker | 否 | String | **参数说明**：上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。 **取值范围**：长度固定24，只允许大小写字母、数组的组合。 | | offset | 否 | Integer | **参数说明**：表示从marker后偏移offset条记录开始查询。当offset为0时，表示从marker后第一条记录开始输出。限制offset最大值是出于API性能考虑，您可以搭配marker使用该参数实现翻页，例如每页50条记录，1-11页内都可以直接使用offset跳转到指定页，但到11页后，由于offset限制为500，您需要使用第11页返回的marker作为下次查询的marker，以实现翻页到12-22页。 **取值范围**：默认为0，取值范围为0-500的整数。 | | channel | 否 | String | 规则动作的类型，取值范围: - DMS_KAFKA_FORWARDING：转发kafka消息类型。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数说明** ：用户Token。通过调用 [生成Token](https://support.huaweicloud.com/api-ocsmartcampus/ocsmartcampus_06_0008.html) 接口获取，接口返回的响应消息头中"X-Subject-Token"就是需要获取的用户Token。 | | X-Instance-Id | 是 | String | **参数说明**：实例ID。通过访问智能设施云平台界面后获取，智能设施云平台资源均为实例级隔离，所有业务接口必须填写正确的实例ID才能被成功调用。 **取值范围**：长度8-36，只允许大小写字母、数字和-字符的组合。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | actions | Array of [RuleAction] objects | 规则动作信息列表。 | | page | [Page] object | 查询批量分页结构体，定义了分页页码、每页记录数、记录总数、该页记录的最大ID。 | 表5RuleAction | 参数 | 参数类型 | 描述 | |:---|:---|:---| | action_id | String | 规则动作ID，用于唯一标识一条规则动作，在创建规则动作时由设施云平台分配获得，创建时无需携带，由平台统一分配唯一的action_id。 | | rule_id | String | 规则动作对应的的规则触发条件ID。 | | channel | String | 规则动作的类型。取值范围：DMS_KAFKA_FORWARDING：转发kafka消息类型。 | | channel_detail | [ChannelDetail] object | 通道配置信息。 | 表6ChannelDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | dms_kafka_forwarding | [DmsKafkaForwarding] object | 转发kafka消息内容。当type为DMS_KAFKA_FORWARDING时,必填。 | 表7DmsKafkaForwarding | 参数 | 参数类型 | 描述 | |:---|:---|:---| | addresses | Array of [NetAddress] objects | 转发kafka消息对应的地址列表,只支持ip | | topic | String | 转发kafka消息关联的topic信息。 | | username | String | 转发kafka关联的用户名信息。 | | password | String | 转发kafka关联的密码信息。 | | mechanism | String | 转发kafka关联的鉴权机制，此字段不填默认为PLAIN。 类型说明： PLAIN：SASL/PLAIN模式。需要填写对应的用户名密码信息。一种简单的用户名密码校验机制，在SASL_PLAINTEXT场景下，不建议使用。 SCRAM-SHA-512: SASL/SCRAM-SHA-512模式。需要填写对应的用户名密码信息。采用哈希算法对用户名与密码生成凭证，进行身份校验的安全认证机制，比PLAIN机制安全性更高。 | | security_protocol | String | kafka传输安全协议，此字段不填默认为SASL_SSL。 SASL_SSL：采用SSL证书进行加密传输，支持帐号密码认证，安全性更高。 SASL_PLAINTEXT：明文传输，支持帐号密码认证，性能更好，建议mechanism使用SCRAM-SHA-512机制。 | 表8NetAddress | 参数 | 参数类型 | 描述 | |:---|:---|:---| | ip | String | 服务的对应IP | | port | Integer | 服务对应端口 | | domain | String | 服务对应的域名 | 表9Page | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Long | **参数说明**：本次分页查询结果中，获取的记录总数。 | | marker | String | **参数说明**：本次分页查询结果中最后一条记录的ID，可在下一次分页查询时使用。 **取值范围**：长度0-64。 | **状态码：400** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数说明**：错误码。 **取值范围**：长度8-36。 | | error_msg | String | **参数说明**：错误描述。 **取值范围**：长度2-512。 | #### 请求示例 查询规则动作列表 ``` GET https://{endpoint}/v1/iotfm/routing-rules/5bcaddda-75bf-4623-8c8d-26175c41fcca/actions ``` #### 响应示例 **状态码：200** Successful response ``` { "actions" : [ { "action_id" : "9f340252-f1c4-46cb-b6b6-c59b245b60d6", "rule_id" : "5bcaddda-75bf-4623-8c8d-26175c41fcca", "channel" : "DMS_KAFKA_FORWARDING", "channel_detail" : { "dms_kafka_forwarding" : { "addresses" : [ { "ip" : "127.0.0.1", "port" : 9095 } ], "topic" : "kafka_topic", "username" : "username", "mechanism" : "PLAIN" } } } ], "page" : { "count" : 1, "marker" : "18c04a7f9d2a69c132cbaf91" } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Successful response | | 400 | Bad Request | | 403 | Forbidden | | 404 | Not Found | | 500 | Internal Server Error |