# 查询规则 - ListRules #### 功能介绍 查询规则。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ROMA/doc?api=ListRules)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-roma/roma_06_0018.html)。 #### URI GET /v2/{project_id}/link/instances/{instance_id}/rules 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID。兼容20.0场景默认为default。项目ID，获取方式请参见API参考的"附录 \> 获取项目ID"章节。 | | instance_id | 是 | String | 实例ID。兼容20.0场景默认为default。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | 每页显示条目数量，最大数量999，超过999后只返回999。 | | app_id | 否 | String | 应用ID。 | | name | 否 | String | 规则名称。 | | offset | 否 | Integer | 偏移量，表示从此偏移量开始查询，offset大于等于0。 | | created_by | 否 | String | 创建人。 | | created_date_start | 否 | Long | 创建起始时间，创建时间起始，格式timestamp(ms)，使用UTC时区。 | | created_date_end | 否 | Long | 创建结束时间，创建时间起始，格式timestamp(ms)，使用UTC时区。 | | dest_type | 否 | Integer | 操作类型，枚举值：0-目标端为本ROMA实例内MQS；2-目标端为本ROMA实例内MRS KAFKA数据源；3-目标端为本ROMA实例内KAFKA数据源；6-目标端为DIS数据源；7-目标端为设备；8-目标端为规则插件。 | | dest_topic | 否 | String | 目标端Topic。 | | src_type | 否 | String | 源端类型，取值为 "product" 或 "device" 或 "device_only"。取值为"product"时，查询产品级别源端Topic；取值为"device"时，查询设备级别源端Topic及所属产品的产品级别源端Topic；取值为"device_only"时，查询设备级别源端Topic。未填写时，根据是否填写应用ID查询指定应用源端或全部源端。 | | product_id | 否 | Integer | src_type为 "product" 或 "device" 或 "device_only" 时生效。 | | product_name | 否 | String | src_type为 "product" 时生效。 | | device_name | 否 | String | src_type为 "device" 或 "device_only" 时生效。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | | X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | 总数。 | | size | Integer | 本次返回数量。 | | items | Array of [Rule] objects | 规则列表。 | 表5Rule | 参数 | 参数类型 | 描述 | |:---|:---|:---| | permissions | Array of strings | 权限。 | | rule_id | Integer | 规则ID，该字段为数据库中的自增唯一标识符；通过调用查询规则接口：GET /v2/{project_id}/link/instances/{instance_id}/rules获取响应体中对应的rule_id字段值。 | | name | String | 规则名称，支持英文大小写、数字、下划线和中划线，长度1-64。 | | app_id | String | 应用ID。 | | app_name | String | 应用名称。 | | description | String | 描述。 | | status | Integer | 规则状态，0-启用，1-停用。 | | data_parsing_status | Integer | 数据解析状态，ENABLE时data_parsing必填，0-启用，1-停用。 | | sql_field | String | SQL查询字段。 | | sql_where | String | SQL查询条件。 | | rule_express | String | 完整的规则表达式。 | | created_user | [CreatedUser] object | 创建时的用户。 | | last_updated_user | [LastUpdatedUser] object | 最后更新时的用户。 | | created_datetime | Long | 创建时间，timestamp(ms)，使用UTC时区。 | | last_updated_datetime | Long | 最后修改时间，timestamp(ms)，使用UTC时区。 | 表6CreatedUser | 参数 | 参数类型 | 描述 | |:---|:---|:---| | user_id | String | 用户ID(保留字段，未使用)。 | | user_name | String | 用户名。 | 表7LastUpdatedUser | 参数 | 参数类型 | 描述 | |:---|:---|:---| | user_id | String | 用户ID(保留字段，未使用) | | user_name | String | 用户名。 | **状态码：400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 | | error_msg | String | 错误描述。 | | request_id | String | 消息ID。 | **状态码：404** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 | | error_msg | String | 错误描述。 | | request_id | String | 消息ID。 | **状态码：500** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 | | error_msg | String | 错误描述。 | | request_id | String | 消息ID。 | #### 请求示例 ``` GET /{project_id}/link/instances/{instance_id}/rules ``` #### 响应示例 **状态码：200** OK ``` { "total" : 1, "size" : 1, "items" : [ { "permissions" : [ "read", "access", "delete", "modify" ], "rule_id" : 702244, "name" : "rule", "app_id" : "a1503e51-46f7-4d23-8617-7cb2d28dde98", "app_name" : "app-link", "description" : null, "status" : 0, "data_parsing_status" : 1, "sql_field" : null, "sql_where" : null, "rule_express" : null, "created_user" : { "user_id" : "", "user_name" : "user" }, "last_updated_user" : { "user_id" : "", "user_name" : "user" }, "created_datetime" : 1607598152997, "last_updated_datetime" : 1607598152997 } ] } ``` **状态码：400** Bad Request ``` { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-rule.query]. Parameter is [X-Auth-Token]. Processor is [header].", "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01" } ``` **状态码：404** Not Found ``` { "error_code" : "SCB.00000000", "error_msg" : "Not Found", "request_id" : "624c8be1-39b6-47b7-941d-c159aced368a-1619602544650-cnnorth7a-P-romalink-service01" } ``` **状态码：500** Internal Server Error ``` { "error_code" : "ROMA.00110002", "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611", "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | | 404 | Not Found | | 500 | Internal Server Error | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-roma/ErrorCode.html)。