可以使用 REST API 创建、更新和删除 K2 流。
要创建、更新或删除流,您的 API token 需要 K2 Config Write 权限。要获取或列出流,需要 K2 Config Read 权限。
| 设置 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
name |
string | 是 | 无 | 1 到 128 个字母、数字或下划线。在账户内必须唯一。不区分大小写。 |
retention_seconds |
integer | 否 | 604800 |
K2 保留记录的时长,从 3600(一小时)到 2592000(30 天)。 |
http |
object | 是 | 无 | 配置 HTTP 输入。请参阅 HTTP 输入。 |
worker_binding |
object | 否 | { enabled: true } |
配置 Workers 绑定输入。请参阅 Workers 绑定输入。 |
http 或 worker_binding 至少必须启用一个。
创建流后无法重命名。
输入是生产者向流写入记录的方式。K2 支持两种输入:
- HTTP: 生产者将记录发送到流的
/produce端点。 - Workers 绑定: Worker 通过绑定发送记录。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
enabled |
boolean | 是 | 启用 /produce 端点。 |
authentication |
boolean | 否 | 生产时需要具有 K2 Produce 权限的 API token。如果省略或为 false,任何拥有流端点的人都可以生产。 |
cors.origins |
array of strings | 否 | 允许从浏览器生产的源。请参阅 CORS。 |
当 authentication 为 true 时,使用 HTTP API 的生产者必须在 Authorization: Bearer <TOKEN> 标头中发送 API token。该 token 必须具有在拥有该流的账户中向 K2 流生产(K2 Produce)的权限。
配置 cors.origins 以允许浏览器从网页生产记录。每个条目必须是以下之一:
http://或https://源,例如https://example.com。源不能包含路径、查询字符串、片段或凭据。*,以允许任意源。如果使用*,它必须是唯一条目。
最多可配置五个源。每个源必须唯一。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
enabled |
boolean | 是 | 允许 Workers 通过绑定向流生产。 |
创建流时如果省略 worker_binding,则启用 Workers 绑定输入。
retention_seconds 设置 K2 在收到记录后保留记录的时长。
该值必须介于 3600(一小时)和 2592000(30 天)之间。
默认值为 604800(七天)。
K2 在后台删除过期记录。记录在保留期结束后仍可能在一段时间内可读,因此不要依赖保留期在精确时刻移除数据。
要更改流的设置,请发送包含要更改设置的 PATCH 请求。您可以更新 retention_seconds、http 和 worker_binding。至少包含其中一个字段。
curl "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/k2/streams/$STREAM_ID" \
--request PATCH \
--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"retention_seconds": 86400,
"worker_binding": { "enabled": false }
}'响应包含更新后的流:
{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "241fa65b438a4d539a19371f58bfdae0",
"name": "orders",
"retention_seconds": 86400,
"endpoint": "https://241fa65b438a4d539a19371f58bfdae0.k2.cloudflarestorage.com",
"http": {
"enabled": true,
"authentication": true
},
"worker_binding": {
"enabled": false
},
"created_at": "2026-09-24T21:19:19.246Z",
"modified_at": "2026-09-29T14:25:54.712Z"
}
}更新输入时,新对象会替换现有对象。例如,要向 HTTP 输入添加 CORS 源,请发送完整的 http 对象,包括 enabled 和 authentication。要禁用某个输入,将其设置为 { "enabled": false }。不能同时禁用两个输入。