# 规则管理
eKuiper REST api 可以管理规则，例如创建、显示、删除、描述、启动、停止和重新启动规则。
# 创建规则
该 API 接受 JSON 内容并创建和启动规则。
POST http://localhost:9081/rules
1
请求示例：
{
"id": "rule1",
"sql": "SELECT * FROM demo",
"actions": [{
"log": {}
}]
}
1
2
3
4
5
6
7
2
3
4
5
6
7
# 展示规则
该 API 用于显示服务器中定义的所有规则和简要状态描述。
GET http://localhost:9081/rules
1
响应示例：
[
{
"id": "rule1",
"status": "Running"
},
{
"id": "rule2",
"status": "Stopped: canceled by error."
}
]
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
# 描述规则
该 API 用于打印规则的详细定义。
GET http://localhost:9081/rules/{id}
1
路径参数 id 是规则的 id 或名称。
响应示例：
{
"sql": "SELECT * from demo",
"actions": [
{
"log": {}
},
{
"mqtt": {
"server": "tcp://127.0.0.1:1883",
"topic": "demoSink"
}
}
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
# 更新规则
该 API 接受 JSON 内容并更新规则。
PUT http://localhost:9081/rules/{id}
1
路径参数 id 是原有规则的 id 或名称。
请求示例：
{
"id": "rule1",
"sql": "SELECT * FROM demo",
"actions": [{
"log": {}
}]
}
1
2
3
4
5
6
7
2
3
4
5
6
7
# 删除规则
该 API 用于删除规则。
DELETE http://localhost:9081/rules/{id}
1
# 启动规则
该 API 用于开始运行规则。
POST http://localhost:9081/rules/{id}/start
1
# 停止规则
该 API 用于停止运行规则。
POST http://localhost:9081/rules/{id}/stop
1
# 重启规则
该 API 用于重启规则。
POST http://localhost:9081/rules/{id}/restart
1
# 获取规则的状态
该命令用于获取规则的状态。 如果规则正在运行，则将实时检索状态指标。 状态可以是：
- $metrics
- 停止： $reason
GET http://localhost:9081/rules/{id}/status
1
响应示例：
{
"source_demo_0_records_in_total":5,
"source_demo_0_records_out_total":5,
"source_demo_0_exceptions_total":0,
"source_demo_0_process_latency_ms":0,
"source_demo_0_buffer_length":0,
"source_demo_0_last_invocation":"2020-01-02T11:28:33.054821",
...
"op_filter_0_records_in_total":5,
"op_filter_0_records_out_total":2,
"op_filter_0_exceptions_total":0,
"op_filter_0_process_latency_ms":0,
"op_filter_0_buffer_length":0,
"op_filter_0_last_invocation":"2020-01-02T11:28:33.054821",
...
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# 验证规则
该 API 用于验证规则。
POST http://localhost:9081/rules/validate
1
请求示例：
{
"id": "rule1",
"sql": "SELECT * FROM demo",
"actions": [{
"log": {}
}]
}
1
2
3
4
5
6
7
2
3
4
5
6
7
对于 API，以下是状态码的含义说明：
- 如果请求体不正确，将返回状态码 400，表示发送了一个无效的请求。
- 如果规则验证未通过，将返回状态码 422，表示规则无效。
- 如果规则通过验证，将返回状态码 200，表示规则有效且验证通过。