Skip to content

除 CLI 外,eKuiper 还提供了一组用于流和规则管理的 REST API。

默认情况下,REST API 在端口9081中运行。您可以在 /etc/kuiper.yaml 中通过restPort 属性更改端口。

获取信息

该 API 用于获取版本号、系统类型、程序运行时长。

shell
GET http://localhost:9081
json
{
"version": "1.0.1-22-g119ee91",
"os": "darwin",
"upTimeSeconds": 14
}

ping

shell
GET http://localhost:9081/ping

批量请求

该 API 用于将多个请求合并为一个请求发送执行

shell
POST http://localhost:9081/batch/req

[
    {
        "method": "POST",
        "path": "/streams",
        "body": "{\"sql\":\"CREATE stream demobatch() WITH (DATASOURCE=\\\"/data1\\\", TYPE=\\\"websocket\\\")\"}"
    },
    {
        "method": "GET",
        "path": "/streams/demobatch"
    }
]

Response

[
    {
        "code": 201,
        "response": "Stream demobatch is created."
    },
    {
        "code": 200,
        "response": "{\"Name\":\"demobatch\",\"StreamFields\":null,\"Options\":{\"datasource\":\"/data1\",\"type\":\"websocket\"},\"StreamType\":0,\"Statement\":null}"
    }
]