InfluxDB 云 API 服务 (2.x)

License: MIT

InfluxDB v2 HTTP API 提供了一个用于与 InfluxDB v2 进行所有交互的编程接口。

InfluxDB v2 HTTP API 提供了一个编程接口，用于与 InfluxDB v2 进行所有交互。使用 /api/v2/ 和与 InfluxDB v1 兼容的端点访问 InfluxDB API。

此文档由 InfluxDB OpenAPI 规范生成。

快速入门

查看API快速入门以获取使用令牌进行身份验证、写入存储桶和查询数据的快速指南。

InfluxDB API 客户端库 适用于流行的语言，并准备好导入到您的应用程序中。

认证

使用以下方案之一来验证 InfluxDB API：

Token authentication
Basic authentication
Querystring authentication

基本认证

基本认证方案

对于支持 HTTP 基本认证方案的 InfluxDB /api/v2 API 操作，请使用该方案：

语法

Authorization: Basic BASE64_ENCODED_CREDENTIALS

要构建 BASE64_ENCODED_CREDENTIALS，将用户名和密码用冒号 (USERNAME:PASSWORD) 连接，然后对结果字符串进行 base64 编码。许多HTTP客户端在发送请求之前会为您编码凭据。

警告: Base64 编码可以轻易地被反向解码以获得原始的用户名和密码。它用于保持数据的完整性，并不提供安全性。您在进行身份验证或发送敏感信息的请求时应始终使用 HTTPS。

示例

在示例中，替换以下内容：

EMAIL_ADDRESS: InfluxDB Cloud username (the email address the user signed up with)
PASSWORD: InfluxDB Cloud API token
INFLUX_URL: your InfluxDB Cloud URL

使用cURL编码凭据

以下示例显示了如何使用cURL发送一个使用基本身份验证的API请求。使用--user选项时，cURL对凭据进行编码并将其传递在Authorization: Basic头中。

curl --get "INFLUX_URL/api/v2/signin"
    --user "EMAIL_ADDRESS":"PASSWORD"

使用Flux编码凭证

The Flux http.basicAuth() function 返回一个使用指定的用户名和密码组合生成的 Base64 编码的基本身份验证头。

使用JavaScript编码凭据

以下示例展示了如何使用JavaScript btoa() 函数创建一个Base64编码的字符串：

btoa('EMAIL_ADDRESS:PASSWORD')

输出如下：

'VVNFUk5BTUU6UEFTU1dPUkQ='

一旦您拥有了Base64编码的凭证，您可以将它们放入Authorization头中--例如：

curl --get "INFLUX_URL/api/v2/signin"
    --header "Authorization: Basic VVNFUk5BTUU6UEFTU1dPUkQ="

要了解有关HTTP验证的更多信息，请参见 Mozilla Developer Network (MDN) Web Docs, HTTP authentication._

安全方案类型	HTTP
HTTP 授权方案	basic

令牌认证

使用令牌认证方案来对InfluxDB API进行认证。

在您的API请求中，发送一个 Authorization 头。对于头部值，提供单词 Token 后跟一个空格和一个InfluxDB API令牌。单词 Token 是区分大小写的。

语法

Authorization: Token INFLUX_API_TOKEN

示例

使用令牌认证与cURL

以下示例演示如何使用 cURL 发送一个使用令牌身份验证的 API 请求：

curl --request GET "INFLUX_URL/api/v2/buckets" \
     --header "Authorization: Token INFLUX_API_TOKEN"

替换以下内容：

INFLUX_URL: your InfluxDB Cloud URL
INFLUX_API_TOKEN: your InfluxDB API token

/authorizations endpoints

安全方案类型	API Key
头部参数名称：	Authorization

支持的操作

下面的表格显示了InfluxDB /api/v2 API支持的最常见操作。某些资源可能支持其他操作，这些操作执行与那些资源更具体的功能。例如，您可以使用 PATCH /api/v2/scripts 端点来更新脚本资源的属性。

操作
写入	将数据（`POST`）写入存储桶。
运行	执行 (`POST`) 查询或脚本并返回结果。
列表	检索 (`GET`) 零个或多个资源的列表。
创建	创建 (`POST`) 一个新的资源并返回该资源。
更新	修改 (`PUT`) 现有资源以反映您请求中的数据。
删除	移除 (`DELETE`) 特定资源。

标题

InfluxDB HTTP API 端点使用标准 HTTP 请求和响应头。以下表格显示了许多 InfluxDB API 端点常用的头。一些端点可能使用其他头，这些头执行更特定于这些端点的功能——例如， POST /api/v2/write 端点接受 Content-Encoding 头以指示应用于请求体中行协议的压缩。

标题	值类型	描述
`Accept`	string	客户端可以理解的内容类型。
`Authorization`	string	授权方案和凭证。
`Content-Length`	integer	发送到数据库的实体主体的大小，单位为字节。
`Content-Type`	string	请求体中数据的格式。

分页

一些 InfluxDB API 列出操作可能支持以下查询参数来分页结果：

查询参数	值类型	描述
`limit`	integer	返回的最大记录数（在应用其他参数后）。
`offset`	integer	要跳过的记录数量（在`limit`之前，在其他参数应用后）。
`after`	字符串（资源 ID）	仅返回在指定资源之后创建的资源。

限制

有关特定端点参数和示例，请参阅端点定义。

如果您指定的 offset 参数值大于记录总数，则 InfluxDB 在响应中返回空列表（因为 offset 跳过了指定数量的记录）。

以下示例传递 offset=50 以跳过前 50 个结果，但用户只有 10 个桶：

curl --request GET "INFLUX_URL/api/v2/buckets?limit=1&offset=50" \
    --header "Authorization: Token INFLUX_API_TOKEN"

响应包含以下内容：

{
  "links": {
      "prev": "/api/v2/buckets?descending=false\u0026limit=1\u0026offset=49\u0026orgID=ORG_ID",
      "self": "/api/v2/buckets?descending=false\u0026limit=1\u0026offset=50\u0026orgID=ORG_ID"
  },
  "buckets": []
}

响应代码

InfluxDB HTTP API 端点使用标准 HTTP 状态码来表示成功和失败的响应。响应主体可能包含额外的细节。关于特定操作的响应的详细信息，请参见该操作的响应和 响应示例。

API 操作可能返回以下 HTTP 状态码：

代码	状态	描述
`200`	成功
`204`	无内容	对于`POST`请求，`204`表示InfluxDB接受了请求并且请求数据是有效的。异步操作，例如`write`，可能尚未完成。
`400`	错误的请求	由于参数不正确或语法错误，InfluxDB 无法解析请求。对于 writes，错误可能指示以下问题之一：行协议格式不正确。响应主体包含数据中第一个格式错误的行，并指明所期望的内容。对于部分写入，写入的点数和被拒绝的点数也包含在内。有关更多信息，请检查 `rejected_points` 测量值在您的 _monitoring bucket 中。 `Authorization` 头丢失或格式不正确，或者 API 令牌没有进行该操作的权限。
`401`	未经授权	可能表明以下之一： `Authorization: Token` 头缺失或格式错误头中缺少API令牌值 API令牌没有权限。有关令牌类型和权限的更多信息，请参见 Manage API tokens
`404`	未找到	请求的资源未找到。`message` 在响应体中提供有关请求资源的详细信息。
`405`	方法不被允许	API路径不支持请求中使用的HTTP方法——例如，你向一个仅允许`GET`的端点发送了`POST`请求。
`413`	请求实体过大	请求负载超过大小限制。
`422`	无法处理的实体	请求数据无效。 `code` 和 `message` 在响应体中提供有关问题的详细信息。
`429`	请求过多	API令牌暂时超过请求配额。`Retry-After`头部描述了何时可以重新尝试请求。
`500`	内部服务器错误
`503`	服务不可用	服务器暂时无法处理请求。`Retry-After`头部描述了何时可以再次尝试请求。

数据输入/输出端点

删除数据

从存储桶中删除数据。

使用此端点在指定时间范围内从存储桶中删除点。

InfluxDB云

当你发送删除请求时，会执行以下操作：
1. Validates the request and queues the delete.
2. If queued, responds with success (HTTP 2xx status code); error otherwise.
3. Handles the delete asynchronously and reaches eventual consistency.

为了确保 InfluxDB Cloud 按照您请求的顺序处理写入和删除，请在发送下一个请求之前等待成功响应（HTTP 2xx 状态码）。

因为写入和删除是异步的，当您收到响应时，您的更改可能尚不可读。

InfluxDB OSS

Validates the request, handles the delete synchronously, and then responds with success or failure.

所需权限

write-buckets or write-bucket BUCKET_ID.

BUCKET_ID 是目标桶的ID。

速率限制（使用InfluxDB Cloud）

write 速率限制适用。有关更多信息，请参见 limits and adjustable quotas。

Delete data
Learn how to use delete predicate syntax.
Learn how InfluxDB handles deleted tags and deleted fields.

授权：

TokenAuthentication

查询参数

桶	字符串桶名称或ID。指定要删除数据的桶。如果同时传递 `bucket` 和 `bucketID`，`bucketID` 优先。
bucketID	string 一个桶的ID。指定要删除数据的桶。如果同时传递 `bucket` 和 `bucketID`，`bucketID` 将优先考虑。
org	string 组织名称或ID。 InfluxDB Cloud 不使用 `org` 参数或 `orgID` 参数。删除与授权（API令牌）关联的组织中的存储桶数据。 InfluxDB OSS 要求必须使用 `org` 参数或 `orgID` 参数。从指定组织中的存储桶删除数据。如果同时传递 `orgID` 和 `org`，则两者都必须有效。
orgID	string 组织 ID。 InfluxDB Cloud 不使用 `org` 参数或 `orgID` 参数。从与授权（API 令牌）相关联的组织中的桶中删除数据。 InfluxDB OSS 需要 `org` 参数或 `orgID` 参数。从指定组织的桶中删除数据。如果同时传递 `orgID` 和 `org`，它们必须都是有效的。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

时间范围参数和一个可选的 删除谓词表达式。

要选择在指定时间范围内删除的点，请在请求主体的 删除谓词表达式 的 predicate 属性中传递一个。如果不传递 predicate，InfluxDB 将删除指定时间范围内所有带有时间戳的数据。

Delete data
Learn how to use delete predicate syntax.

谓词	字符串在删除谓词语法中的表达式。
开始必填	字符串 <date-time> 一个时间戳（RFC3339 日期/时间格式）。删除的最早时间。
停止必需	字符串 <日期-时间> 一个时间戳（RFC3339 日期/时间格式）。可删除的最晚时间。

响应

请求示例

Payload
cURL

Content type

application/json

{"predicate": "tag1=\"value1\" and (tag2=\"value2\" and tag3!=\"value3\")",
"start": "2019-08-24T14:15:22Z",
"stop": "2019-08-24T14:15:22Z"
}

响应示例

400
401
404
500
default

Content type

application/json

{"code": "invalid",
"message": "failed to decode request body: organization not found"
}

查询数据

从存储桶中检索数据。

使用此端点发送Flux查询请求并从桶中检索数据。

速率限制（使用InfluxDB Cloud）

read 限制适用。有关更多信息，请参见限制和可调配额。

授权：

TokenAuthentication

查询参数

组织	字符串组织名称或ID。 InfluxDB Cloud 不使用 `org` 参数或 `orgID` 参数。查询与授权（API令牌）关联的组织中的存储桶。 InfluxDB OSS 需要使用 `org` 参数或 `orgID` 参数。查询指定组织中的存储桶。
orgID	string 组织 ID. InfluxDB Cloud 不使用 `org` 参数或 `orgID` 参数. 查询与授权（API 令牌）关联的组织中的存储桶. InfluxDB OSS 需要 `org` 参数或 `orgID` 参数. 查询指定组织中的存储桶.

头部参数

接收编码	字符串默认: 身份枚举: "gzip" "身份" 客户端可以理解的内容编码（通常是一种压缩算法）。
内容类型	字符串枚举： "application/json" "application/vnd.flux"
Zap-Trace-Span	字符串示例： baggage,[object Object],span_id,1,trace_id,1 OpenTracing span 上下文

请求体模式:
application/json
application/json
application/vnd.flux

要执行的Flux查询或规范

	对象 (Dialect) 表格数据输出选项。默认输出为注释的 CSV，包含标题。有关表格数据方言的更多信息，请参见W3表格数据元数据词汇。
	对象 (文件) 表示来自单个文件的源
现在	字符串 <日期-时间> 指定在查询中应报告的时间作为 `now`。默认是服务器的 `now` 时间。
	对象在查询执行期间作为参数传递的键值对。要在查询中使用参数，请传递一个 `query`，其中包含 `params` 引用（以点表示法）--例如： `query: "from(bucket: params.mybucket)\ \|> range(start: params.rangeStart) \|> limit(n:1)"` 并传递 `params` 和键值对--例如： `params: { "mybucket": "environment", "rangeStart": "-30d" }` 在查询执行期间，InfluxDB 会将 `params` 传递给您的脚本并替换对应的值。限制如果使用 `params`，则不能使用 `extern`。
查询必需	字符串要执行的查询脚本。
类型	字符串值： "flux" 查询的类型。必须是 "flux"。

响应

请求示例

Payload
cURL

Content type

{"dialect": {"annotations": ["group"
],
"commentPrefix": "#",
"dateTimeFormat": "RFC3339",
"delimiter": ",",
"header": true
},
"extern": {"body": [{"text": "string",
"type": "string"
}
],
"imports": [{"as": {"name": "string",
"type": "string"
},
"path": {"type": "string",
"value": "string"
},
"type": "string"
}
],
"name": "string",
"package": {"name": {"name": "string",
"type": "string"
},
"type": "string"
},
"type": "string"
},
"now": "2019-08-24T14:15:22Z",
"params": { },
"query": "string",
"type": "flux"
}

响应示例

Content type

application/csv

result,table,_start,_stop,_time,region,host,_value
mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:00Z,east,A,15.43
mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:20Z,east,B,59.25
mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:40Z,east,C,52.62

脚本列表

列出 scripts.

Invoke custom scripts

授权：

TokenAuthentication

查询参数

限制	整数 [ 0 .. 500 ] 默认: 100 返回的脚本的最大数量。默认值是 `100`。
名称	字符串脚本名称。列出具有指定名称的脚本。
偏移量	整数 >= 0 分页的偏移量。要跳过的记录数。有关分页参数的更多信息，请参见分页。

响应

请求示例

cURL: retrieves the first 100 scripts.

curl --request GET "INFLUX_URL/api/v2/scripts?limit=100&offset=0" \
  --header "Authorization: Token INFLUX_API_TOKEN" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json"

响应示例

200
400
401
500
default

Content type

application/json

{"scripts": [{"createdAt": "2022-07-17T23:49:45.731237Z",
"description": "find the last point from Sample Bucket",
"id": "09afa3b220fe4000",
"language": "flux",
"name": "getLastPointFromSampleBucket",
"orgID": "bea7ea952287f70d",
"script": "from(bucket: SampleBucket) |> range(start: -7d) |> limit(n:1)",
"updatedAt": "2022-07-17T23:49:45.731237Z"
},
{"createdAt": "2022-07-17T23:43:26.660308Z",
"description": "getLastPoint finds the last point in a bucket",
"id": "09afa23ff13e4000",
"language": "flux",
"name": "getLastPoint",
"orgID": "bea7ea952287f70d",
"script": "from(bucket: params.mybucket) |> range(start: -7d) |> limit(n:1)",
"updatedAt": "2022-07-17T23:43:26.660308Z"
}
]
}

获取脚本

检索一个 script。

Invoke custom scripts

授权：

TokenAuthentication

路径参数

脚本ID

必填

字符串

一个脚本的ID。检索指定的脚本。

响应

响应示例

200
401
404
500
default

Content type

application/json

{"createdAt": "2022-07-17T23:49:45.731237Z",
"description": "getLastPoint finds the last point in a bucket",
"id": "09afa3b220fe4000",
"language": "flux",
"name": "getLastPoint",
"orgID": "bea7ea952287f70d",
"script": "from(bucket: my-bucket) |> range(start: -7d) |> limit(n:1)",
"updatedAt": "2022-07-17T23:49:45.731237Z"
}

调用脚本

运行脚本并返回结果。当脚本运行时，InfluxDB 在脚本中引用的 params 键将被请求体中传递的 params 键值替换——例如：

以下示例脚本包含一个 mybucket 参数 :

"script": "from(bucket: params.mybucket)
            |> range(start: -7d)
            |> limit(n:1)"

以下示例 POST /api/v2/scripts/SCRIPT_ID/invoke 请求正文传递了 mybucket 参数的一个值：

{
  "params": {
    "mybucket": "air_sensor"
  }
}

Invoke custom scripts

授权：

TokenAuthentication

路径参数

scriptID

必填

字符串

一个脚本 ID。

运行指定的脚本。

请求体模式: application/json

对象

脚本参数。 params 包含将值映射到 params.keys 的键值对在脚本中。当你使用 params 调用脚本时，InfluxDB 会将值作为调用参数传递给脚本。

响应

请求示例

Payload
cURL

Content type

application/json

{"params": { }
}

响应示例

Content type

text/csv

,result,table,_start,_stop,_time,_value,_field,_measurement,host
,_result,0,2019-10-30T01:28:02.52716421Z,2022-07-26T01:28:02.52716421Z,2020-01-01T00:00:00Z,72.01,used_percent,mem,host2

列出所有任务

检索任务的列表。

要限制返回的任务，请在请求中传递查询参数。如果没有传递查询参数，InfluxDB将返回所有任务，直到默认的 limit。

授权：

TokenAuthentication

查询参数

之后	字符串 A task ID. 仅返回在指定任务之后创建的任务。
限制	整数 [ -1 .. 500 ] 默认值: 100 示例: limit=-1 - 返回所有任务，无需分页。 limit=50 - 最多返回50个任务。要返回的最大任务数量。默认值为`100`。最小值为`1`，最大值为`500`。为了减少负载大小，请结合`type=basic`和`limit`（请参见请求示例）。有关`basic`响应的更多信息，请参见`type`参数。
名称	字符串一个任务名称。仅返回具有指定名称的任务。不同的任务可能具有相同的名称。
偏移量	整数 >= 0 默认: 0 要跳过的记录数。
组织	字符串一个组织名称。仅返回由指定组织拥有的任务。
orgID	string 一个组织 ID。仅返回指定组织拥有的任务。
scriptID	字符串 A script ID. 只返回使用指定可调用脚本的任务。
sortBy	字符串值： "name" 排序字段。仅支持 `name`。指定用于排序列表中记录的字段。
状态	字符串枚举： "active" "inactive" A task 状态。只返回具有指定状态（`active` 或 `inactive`）的任务。
类型	字符串默认: "" 枚举: "basic" "system" 一种任务类型 (`basic` 或 `system`)。默认是 `system`。指定响应中任务的详细程度。默认 (`system`) 响应包含所有任务的元数据属性。若要减小响应大小，传递 `basic` 以省略某些任务属性 (`flux`, `createdAt`, `updatedAt`)。
用户	字符串 A 用户 ID. 仅返回由指定用户拥有的任务。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

请求示例

cURL: all tasks, basic output

curl INFLUX_URL/api/v2/tasks/?limit=-1&type=basic \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Token INFLUX_API_TOKEN'

响应示例

200
401
500
default

Content type

application/json

Example

一个示例响应正文用于 ?type=basic 参数。 type=basic 在响应中省略了一些任务字段 (createdAt 和 updatedAt) 以及字段值 (org, flux)。

{"links": {"self": "/api/v2/tasks?limit=100"
},
"tasks": [{"every": "30m",
"flux": "",
"id": "09956cbb6d378000",
"labels": [ ],
"lastRunStatus": "success",
"latestCompleted": "2022-06-30T15:00:00Z",
"links": {"labels": "/api/v2/tasks/09956cbb6d378000/labels",
"logs": "/api/v2/tasks/09956cbb6d378000/logs",
"members": "/api/v2/tasks/09956cbb6d378000/members",
"owners": "/api/v2/tasks/09956cbb6d378000/owners",
"runs": "/api/v2/tasks/09956cbb6d378000/runs",
"self": "/api/v2/tasks/09956cbb6d378000"
},
"name": "task1",
"org": "",
"orgID": "48c88459ee424a04",
"ownerID": "0772396d1f411000",
"status": "active"
}
]
}

创建任务

创建一个 task 并返回该任务。

使用此端点创建一个运行 Flux 脚本的计划任务。

InfluxDB云

您可以使用 flux 或 scriptID 来提供任务脚本。

flux：一串“原始”的 Flux，包含任务选项和脚本——例如：

{
  "flux": "option task = {name: \"CPU Total 1 Hour New\", every: 1h}\
  from(bucket: \"telegraf\")
    |> range(start: -1h)
    |> filter(fn: (r) => (r._measurement == \"cpu\"))
    |> filter(fn: (r) =>\n\t\t(r._field == \"usage_system\"))
    |> filter(fn: (r) => (r.cpu == \"cpu-total\"))
    |> aggregateWindow(every: 1h, fn: max)
    |> to(bucket: \"cpu_usage_user_total_1h\", org: \"INFLUX_ORG\")",
  "status": "active",
  "description": "This task downsamples CPU data every hour"
}

scriptID：要运行的可调用脚本的ID。使用 scriptID 时，要传递任务选项，将选项作为请求体中的属性传递——例如：

{
  "name": "CPU Total 1 Hour New",
  "description": "This task downsamples CPU data every hour",
  "every": "1h",
  "scriptID": "SCRIPT_ID",
  "scriptParameters":
    {
      "rangeStart": "-1h",
      "bucket": "telegraf",
      "filterField": "cpu-total"
    }
  }

限制：

You can't use flux and scriptID for the same task.

授权：

TokenAuthentication

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

创建任务

cron	字符串一个 Cron 表达式，定义任务运行的时间表。InfluxDB 的 cron 运行基于系统时间。
描述	字符串任务的描述。
每个	字符串任务运行的时间间隔 (duration literal)。 `every` 还决定了任务首次运行的时间，这取决于指定的时间。
flux	字符串任务运行的Flux脚本。限制如果使用`flux`属性，则不能使用`scriptID`和`scriptParameters`属性。
名称	字符串任务的名称
偏移量	字符串 <持续时间> 在预定时间经过后，延迟执行任务的持续时间。 `0` 移除偏移量。
org	string 拥有该任务的组织的名称。
orgID	string 拥有该任务的组织的ID。
脚本ID	字符串任务运行的脚本的ID。限制如果使用 `scriptID` 属性，则不能使用 `flux` 属性。
scriptParameters	对象在任务运行期间传递给脚本（通过 `scriptID` 引用）的参数键值对。限制 `scriptParameters` 需要 `scriptID`。如果使用 `scriptID` 和 `scriptParameters` 属性，则不能使用 `flux` 属性。
状态	字符串 (TaskStatusType) 枚举： "active" "inactive" `inactive` 取消计划运行并防止手动运行任务。

响应

请求示例

Payload
cURL: create a Flux script task
cURL: create a Flux script reference task

Content type

application/json

{"cron": "string",
"description": "string",
"every": "string",
"flux": "string",
"name": "string",
"offset": "string",
"org": "string",
"orgID": "string",
"scriptID": "string",
"scriptParameters": { },
"status": "active"
}

响应示例

201
400
401
500
default

Content type

application/json

{"authorizationID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"cron": "string",
"description": "string",
"every": "string",
"flux": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"lastRunError": "string",
"lastRunStatus": "failed",
"latestCompleted": "2019-08-24T14:15:22Z",
"links": {"labels": "/api/v2/tasks/1/labels",
"logs": "/api/v2/tasks/1/logs",
"members": "/api/v2/tasks/1/members",
"owners": "/api/v2/tasks/1/owners",
"runs": "/api/v2/tasks/1/runs",
"self": "/api/v2/tasks/1"
},
"name": "string",
"offset": "string",
"org": "string",
"orgID": "string",
"ownerID": "string",
"scriptID": "string",
"scriptParameters": { },
"status": "active",
"updatedAt": "2019-08-24T14:15:22Z"
}

检索一个任务

检索一个任务。

授权：

TokenAuthentication

路径参数

任务ID

必需

字符串

一个任务 ID。指定要检索的任务。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

Content type

application/json

{"authorizationID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"cron": "string",
"description": "string",
"every": "string",
"flux": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"lastRunError": "string",
"lastRunStatus": "failed",
"latestCompleted": "2019-08-24T14:15:22Z",
"links": {"labels": "/api/v2/tasks/1/labels",
"logs": "/api/v2/tasks/1/logs",
"members": "/api/v2/tasks/1/members",
"owners": "/api/v2/tasks/1/owners",
"runs": "/api/v2/tasks/1/runs",
"self": "/api/v2/tasks/1"
},
"name": "string",
"offset": "string",
"org": "string",
"orgID": "string",
"ownerID": "string",
"scriptID": "string",
"scriptParameters": { },
"status": "active",
"updatedAt": "2019-08-24T14:15:22Z"
}

开始任务运行，覆盖计划

安排任务立即开始运行，忽略计划中的运行。

使用此端点手动启动任务运行。计划的运行将继续按计划进行。这可能会导致任务并发运行。

要重试之前的运行（并避免创建新的运行），使用POST /api/v2/tasks/{taskID}/runs/{runID}/retry端点。

授权：

TokenAuthentication

路径参数

任务ID

必需

字符串

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

scheduledFor

字符串或空值 <日期-时间>

运行的时间 RFC3339 日期/时间格式用于 now 选项。默认是服务器现在的时间。

响应

请求示例

Payload

Content type

application/json

{"scheduledFor": "2019-08-24T14:15:22Z"
}

响应示例

201
401
500
default

Content type

application/json

{"finishedAt": "2006-01-02T15:04:05.999999999Z07:00",
"flux": "string",
"id": "string",
"links": {"retry": "/api/v2/tasks/1/runs/1/retry",
"self": "/api/v2/tasks/1/runs/1",
"task": "/api/v2/tasks/1"
},
"log": [{"message": "Halt and catch fire",
"runID": "string",
"time": "2006-01-02T15:04:05.999999999Z07:00"
}
],
"requestedAt": "2006-01-02T15:04:05.999999999Z07:00",
"scheduledFor": "2019-08-24T14:15:22Z",
"startedAt": "2006-01-02T15:04:05.999999999Z07:00",
"status": "scheduled",
"taskID": "string"
}

写入数据

将数据写入存储桶。

使用此端点以行协议格式将数据发送到InfluxDB。

InfluxDB云

在发送写请求时执行以下操作：
1. Validates the request and queues the write.
2. If queued, responds with success (HTTP 2xx status code); error otherwise.
3. Handles the delete asynchronously and reaches eventual consistency.
为了确保 InfluxDB Cloud 按照您请求的顺序处理写入和删除，请在发送下一个请求之前等待成功响应（HTTP 2xx 状态码）。
因为写入和删除是异步的，当您收到响应时，您的更改可能尚不可读。

InfluxDB OSS

Validates the request and handles the write synchronously.
If all points were written successfully, responds with HTTP 2xx status code; otherwise, returns the first line that failed.

所需权限

write-buckets 或 write-bucket BUCKET_ID。
BUCKET_ID 是目标桶的ID。

速率限制（使用InfluxDB Cloud）

write 速率限制适用。有关更多信息，请参见 limits and adjustable quotas。

授权：

TokenAuthentication

查询参数

桶必需	字符串一个桶的名称或ID。 InfluxDB将所有批处理中的点写入指定的桶。
组织必需	字符串组织名称或ID。 InfluxDB Cloud 不使用 `org` 参数或 `orgID` 参数。将数据写入与授权（API令牌）相关联的组织中的桶。 InfluxDB OSS 要求使用 `org` 参数或 `orgID` 参数。如果同时传递 `orgID` 和 `org`，它们必须都是有效的。将数据写入指定组织中的桶。
orgID	字符串组织 ID。 InfluxDB Cloud 不使用 `org` 参数或 `orgID` 参数。将数据写入与授权（API 令牌）关联的组织中的桶。 InfluxDB OSS 需要 `org` 参数或 `orgID` 参数中的任意一个。如果同时传递 `orgID` 和 `org`，两者都必须有效。将数据写入指定组织中的桶。
精度	字符串 (WritePrecision) 枚举: "ms" "s" "us" "ns" 线协议批次中 unix 时间戳的精度。

头部参数

接受	字符串默认：application/json 值："application/json" 客户端可以理解的内容类型。仅在失败时写入返回响应体——例如，因格式问题或配额限制。 InfluxDB Cloud 对于格式和限制错误，仅返回 `application/json`。对于某些配额限制错误，仅返回 `text/html`。 InfluxDB OSS 对于格式和限制错误，仅返回 `application/json`。相关指南解决数据写入问题
内容编码	字符串默认: identity 枚举: "gzip" "identity" 应用于请求有效负载的行协议的压缩。要发送gzip有效负载，请传递 `Content-Encoding: gzip` 头部。
内容长度	整数发送到 InfluxDB 的实体主体的大小，以字节为单位。如果长度大于 `max body` 配置选项，服务器将响应状态代码 `413`。
内容类型	字符串默认: text/plain; charset=utf-8 枚举: "text/plain" "text/plain; charset=utf-8" 请求体中数据的格式。要发送行协议有效负载，请传递 `Content-Type: text/plain; charset=utf-8`。
Zap-Trace-Span	字符串示例： baggage,[object Object],span_id,1,trace_id,1 OpenTracing span 上下文

请求体架构: text/plain

在请求体中，以行协议格式提供数据。

要发送压缩数据，请执行以下操作：

Use gzip to compress the line protocol data.
In your request, send the compressed data and the Content-Encoding: gzip header.

Best practices for optimizing writes

string <byte>

响应

请求示例

Payload

Content type

text/plain

airSensors,sensor_id=TLM0201 temperature=73.97038159354763,humidity=35.23103248356096,co=0.48445310567793615 1630424257000000000
airSensors,sensor_id=TLM0202 temperature=75.30007505999716,humidity=35.651929918691714,co=0.5141876544505826 1630424257000000000

响应示例

Content type

application/json

Example

{"code": "invalid",
"message": "partial write error (2 written): unable to parse 'air_sensor,service=S1,sensor=L1 temperature=\"90.5\",humidity=70.0 1632850122': schema: field type for field \"temperature\" not permitted by schema; got String but expected Float"
}

安全和访问端点

列出授权

列出授权。

要限制返回的授权，请在请求中传递查询参数。如果未传递查询参数，InfluxDB 将返回所有授权。

InfluxDB云

InfluxDB Cloud doesn't expose API token values in GET /api/v2/authorizations responses; returns token: redacted for all authorizations.

所需权限

要获取授权，请求必须使用具有以下权限的API令牌：

read-authorizations
read-user for the user that the authorization is scoped to

View tokens

授权：

TokenAuthentication

查询参数

组织	字符串一个组织名称。仅返回属于指定的 organization 的授权。
orgID	string 一个组织的ID。仅返回属于指定的 organization 的授权。
token	字符串一个API token 值。通过其 `token` 属性值指定授权并返回授权。 InfluxDB OSS 不支持此参数。InfluxDB OSS 会忽略 `token=` 参数，应用其他参数，然后返回结果。限制该参数不可重复。如果你指定多个，只有第一个会被使用。如果具有指定属性值的资源不存在，则响应体将包含一个空列表。
用户	字符串一个用户名。仅返回限定于指定用户的授权。
用户ID	字符串用户ID。仅返回限制在指定的用户的授权。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
400
401
500
default

Content type

application/json

{"authorizations": [{"description": "string",
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "/api/v2/authorizations/1",
"user": "/api/v2/users/12"
},
"org": "string",
"orgID": "string",
"permissions": [{"action": "read",
"resource": {"id": "string",
"name": "string",
"org": "string",
"orgID": "string",
"type": "authorizations"
}
}
],
"token": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"user": "string",
"userID": "string"
}
],
"links": {"next": "http://example.com",
"prev": "http://example.com",
"self": "http://example.com"
}
}

创建授权

创建一个授权并返回生成的授权与token。

使用此端点创建一个授权，该授权生成一个具有对特定资源或特定资源类型的read或write权限的API令牌。API令牌是授权的token属性值。

为了遵循安全API令牌生成和检索的最佳实践，InfluxDB 对API令牌实施访问限制。

InfluxDB allows access to the API token value immediately after the authorization is created.
You can’t change access (read/write) permissions for an API token after it’s created.
Tokens stop working when the user who created the token is deleted.

我们建议您采取以下措施来管理您的令牌：

Create a generic user to create and manage tokens for writing data.
Store your tokens in a secure password vault for future access.

所需权限

write-authorizations
write-user for the user that the authorization is scoped to

Create a token

授权：

TokenAuthentication

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

创建的授权。

描述	字符串这是令牌的描述。
orgID 必需	字符串一个组织ID。指定拥有授权的组织。
必需	对象的数组 (Permission) 非空授权的权限列表。在列表中，提供至少一个 `permission` 对象。在 `permission` 中，`resource.type` 属性授予对指定类型的所有资源的访问权限。要仅授予对特定资源的访问权限，请指定 `resource.id` 属性。
状态	字符串默认: "active" 枚举: "active" "inactive" 令牌的状态。如果 `inactive`，InfluxDB 将拒绝使用该令牌的请求。
用户ID	字符串一个用户ID。指定授权范围内的用户。当用户使用用户名和密码进行身份验证时， InfluxDB会生成一个用户会话，具有所有用户授权指定的权限。

响应

请求示例

Payload

Content type

application/json

Example

创建授权。

{"description": "iot_users read buckets",
"orgID": "INFLUX_ORG_ID",
"permissions": [{"action": "read",
"resource": {"type": "buckets"
}
}
]
}

响应示例

201
400
401
500
default

Content type

application/json

{"description": "string",
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "/api/v2/authorizations/1",
"user": "/api/v2/users/12"
},
"org": "string",
"orgID": "string",
"permissions": [{"action": "read",
"resource": {"id": "string",
"name": "string",
"org": "string",
"orgID": "string",
"type": "authorizations"
}
}
],
"token": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"user": "string",
"userID": "string"
}

删除授权

删除授权。

使用该端点删除API令牌。

如果您想禁用一个API令牌而不是删除它，请将授权的状态更新为 inactive。

授权：

TokenAuthentication

路径参数

authID

必需

字符串

一个授权ID。指定要删除的授权。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

400
401
404
500
default

Content type

application/json

{"code": "invalid",
"message": "id must have a length of 16 bytes"
}

获取授权

检索授权。

使用这个端点检索有关API令牌的信息，包括令牌的权限和该令牌所作用的用户。

InfluxDB OSS

InfluxDB OSS returns API token values in authorizations.
If the request uses an operator token, InfluxDB OSS returns authorizations for all organizations in the instance.

View tokens

View tokens

授权：

TokenAuthentication

路径参数

authID

必需

字符串

一个授权ID。指定要检索的授权。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

Content type

application/json

{"description": "string",
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "/api/v2/authorizations/1",
"user": "/api/v2/users/12"
},
"org": "string",
"orgID": "string",
"permissions": [{"action": "read",
"resource": {"id": "string",
"name": "string",
"org": "string",
"orgID": "string",
"type": "authorizations"
}
}
],
"token": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"user": "string",
"userID": "string"
}

更新API令牌为激活或非激活状态

更新授权。

使用此端点将API令牌的状态设置为活动或非活动。 InfluxDB会拒绝使用非活动API令牌的请求。

授权：

TokenAuthentication

路径参数

authID

必需

字符串

一个授权ID。指定要更新的授权。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

在请求体中，提供要更新的授权属性。

描述	字符串这是令牌的描述。
状态	字符串默认: "active" 枚举: "active" "inactive" 令牌的状态。如果 `inactive`，InfluxDB 将拒绝使用该令牌的请求。

响应

请求示例

Payload

Content type

application/json

{"description": "string",
"status": "active"
}

响应示例

200
default

Content type

application/json

{"description": "string",
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "/api/v2/authorizations/1",
"user": "/api/v2/users/12"
},
"org": "string",
"orgID": "string",
"permissions": [{"action": "read",
"resource": {"id": "string",
"name": "string",
"org": "string",
"orgID": "string",
"type": "authorizations"
}
}
],
"token": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"user": "string",
"userID": "string"
}

列出组织

列出 organizations。

要限制返回的组织，可以在请求中传递查询参数。如果未传递查询参数，InfluxDB 将返回所有组织，直到默认的 limit。

InfluxDB云

Only returns the organization that owns the token passed in the request.

View organizations

授权：

TokenAuthentication

查询参数

降序	布尔值默认: false
限制	整数 [ 1 .. 100 ] 默认: 20 限制返回的记录数量。默认值是 `20`。
偏移量	整数 >= 0 分页的偏移量。要跳过的记录数。有关分页参数的更多信息，请参见分页。
org	string 一个组织名称。只返回指定的组织。
orgID	字符串组织 ID。仅返回指定的组织。
用户ID	字符串用户ID。仅返回指定用户为成员或所有者的组织。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

Content type

application/json

{"links": {"self": "/api/v2/orgs"
},
"orgs": [{"createdAt": "2022-07-17T23:00:30.778487Z",
"description": "Example InfluxDB organization",
"id": "INFLUX_ORG_ID",
"links": {"buckets": "/api/v2/buckets?org=INFLUX_ORG",
"dashboards": "/api/v2/dashboards?org=INFLUX_ORG",
"labels": "/api/v2/orgs/INFLUX_ORG_ID/labels",
"logs": "/api/v2/orgs/INFLUX_ORG_ID/logs",
"members": "/api/v2/orgs/INFLUX_ORG_ID/members",
"owners": "/api/v2/orgs/INFLUX_ORG_ID/owners",
"secrets": "/api/v2/orgs/INFLUX_ORG_ID/secrets",
"self": "/api/v2/orgs/INFLUX_ORG_ID",
"tasks": "/api/v2/tasks?org=InfluxData"
},
"name": "INFLUX_ORG",
"updatedAt": "2022-07-17T23:00:30.778487Z"
}
]
}

获取组织

检索一个组织。

使用此端点检索特定组织的信息。

View organizations

授权：

TokenAuthentication

路径参数

orgID

必填

字符串

要检索的组织的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
401
404
500
default

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"defaultStorageType": "tsm",
"description": "string",
"id": "string",
"links": {"buckets": "/api/v2/buckets?org=myorg",
"dashboards": "/api/v2/dashboards?org=myorg",
"labels": "/api/v2/orgs/1/labels",
"members": "/api/v2/orgs/1/members",
"owners": "/api/v2/orgs/1/owners",
"secrets": "/api/v2/orgs/1/secrets",
"self": "/api/v2/orgs/1",
"tasks": "/api/v2/tasks?org=myorg"
},
"name": "string",
"status": "active",
"updatedAt": "2019-08-24T14:15:22Z"
}

列出组织的所有成员

列出所有属于一个组织的用户。

InfluxDB users 有权访问 InfluxDB。

成员是组织内的用户。

InfluxDB云

Doesn't use owner and member roles. Use /api/v2/authorizations to assign user permissions.

限制

Member permissions are separate from API token permissions.
Member permissions are used in the context of the InfluxDB UI.

所需权限

read-orgs INFLUX_ORG_ID

INFLUX_ORG_ID 是您想要检索成员的组织的ID。

授权：

TokenAuthentication

路径参数

orgID

必需

字符串

要检索用户的组织的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

Content type

application/json

{"links": {"self": "/api/v2/orgs/055aa4783aa38398/members"
},
"users": [{"id": "791df274afd48a83",
"links": {"self": "/api/v2/users/791df274afd48a83"
},
"name": "example_user_1",
"role": "member",
"status": "active"
},
{"id": "09cfb87051cbe000",
"links": {"self": "/api/v2/users/09cfb87051cbe000"
},
"name": "example_user_2",
"role": "owner",
"status": "active"
}
]
}

从组织中移除成员

从组织中移除成员。

使用此端点来删除用户在组织中的成员权限。删除成员权限将从组织中移除用户的 read 和 write 权限。

InfluxDB云

Doesn't use owner and member roles. Use /api/v2/authorizations to assign user permissions.

限制

Member permissions are separate from API token permissions.
Member permissions are used in the context of the InfluxDB UI.

所需权限

write-orgs INFLUX_ORG_ID

INFLUX_ORG_ID 是您要移除所有者的组织的ID。

Manage members

授权：

TokenAuthentication

路径参数

orgID 必填	string 要从中移除用户的组织的ID。
用户ID 必需	字符串要移除的用户的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

401
404
500
default

Content type

application/json

{"code": "unauthorized",
"message": "unauthorized access"
}

列出组织的所有拥有者

列出一个组织的所有拥有者。

InfluxDB云

Doesn't use owner and member roles. Use /api/v2/authorizations to assign user permissions.

所需权限

read-orgs INFLUX_ORG_ID

INFLUX_ORG_ID 是您想要检索其所有者列表的组织的ID。

授权：

TokenAuthentication

路径参数

orgID

必填

字符串

用于列出所有者的组织ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
404
default

Content type

application/json

{"links": {"self": "/api/v2/orgs/055aa4783aa38398/owners"
},
"users": [{"id": "09cfb87051cbe000",
"links": {"self": "/api/v2/users/09cfb87051cbe000"
},
"name": "example_user_2",
"role": "owner",
"status": "active"
}
]
}

从组织中移除一个所有者

从组织中移除一个 owner。

组织拥有者有权限删除组织并移除组织中用户和成员的权限。

InfluxDB云

Doesn't use owner and member roles. Use /api/v2/authorizations to assign user permissions.

限制

Owner permissions are separate from API token permissions.
Owner permissions are used in the context of the InfluxDB UI.

所需权限

write-orgs INFLUX_ORG_ID

INFLUX_ORG_ID 是您想要移除所有者的组织的ID。

Authorizations

授权：

TokenAuthentication

路径参数

orgID 必需	字符串要从中移除所有者的组织的ID。
用户ID 必需	字符串要移除的用户的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

401
404
500
default

Content type

application/json

{"code": "unauthorized",
"message": "unauthorized access"
}

列出一个组织的所有秘密密钥

授权：

TokenAuthentication

路径参数

orgID

必需

字符串

组织ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
default

Content type

application/json

{"secrets": ["string"
],
"links": {"org": "string",
"self": "string"
}
}

从组织中删除一个秘密

授权：

TokenAuthentication

路径参数

orgID 必需	字符串组织ID。
secretID 必填	字符串密钥 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

从组织中删除秘密已弃用

授权：

TokenAuthentication

路径参数

orgID

必需

字符串

组织ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

删除的密钥

密钥

字符串的数组

响应

请求示例

Payload

Content type

application/json

{"secrets": ["string"
]
}

响应示例

default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

创建用户会话。

验证基础认证凭据为用户，然后如果成功，则生成用户会话。

要验证用户，请使用 HTTP Authorization 标头，采用 Basic 方案，并提供 base64 编码的用户名和密码。有关语法和更多信息，请参阅 Basic Authentication 以获取语法和更多信息。

如果身份验证成功，InfluxDB 将为用户创建一个新会话，然后在 Set-Cookie 响应头中返回会话 cookie。

InfluxDB 仅在内存中存储用户会话。它们在十分钟内过期，并在 InfluxDB 实例重启期间过期。

带有授权的用户会话

In InfluxDB Cloud, a user session inherits all the user's permissions for the organization.
In InfluxDB OSS, a user session inherits all the user's permissions for all the organizations that the user belongs to.

Signout

授权：

BasicAuthentication

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

请求示例

cURL: signin with --user option encoding

curl --request POST http://localhost:8086/api/v2/signin \
     --user "USERNAME:PASSWORD"

响应示例

401
403
default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

过期用户会话

使由会话 cookie 指定的用户会话过期。

使用此端点使用户会话失效，该会话是在用户通过InfluxDB开发者控制台（UI）或POST /api/v2/signin端点进行身份验证时生成的。

例如，POST /api/v2/signout 端点代表以下三步过程中的第三步用于验证用户，检索user资源，然后使会话失效：

Send a request with the user's Basic authentication credentials to the POST /api/v2/signin endpoint to create a user session and generate a session cookie.
Send a request to the GET /api/v2/me endpoint, passing the stored session cookie from step 1 to retrieve user information.
Send a request to the POST /api/v2/signout endpoint, passing the stored session cookie to expire the session.

请参阅请求示例中的完整示例。

InfluxDB仅将用户会话存储在内存中。如果用户没有注销，则用户会话将在十分钟内自动过期或在InfluxDB实例重启期间过期。

要了解更多关于HTTP请求中的cookie，请参阅 Mozilla Developer Network (MDN) Web Docs, HTTP cookies。

Signin

授权：

TokenAuthentication

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

请求示例

cURL: sign in a user, verify the user session, and then end the session

# The following example shows how to use cURL and the InfluxDB API
# to do the following:
# 1. Sign in a user with a username and password.
# 2. Check that the user session exists for the user.
# 3. Sign out the user to expire the session.
# 4. Check that the session is no longer active.

# 1. Send a request to `POST /api/v2/signin` to sign in the user.
#    In your request, pass the following:
#
#      - `--user` option with basic authentication credentials.
#      - `-c` option with a file path where cURL will write cookies.

      curl --request POST \
        -c ./cookie-file.tmp \
        "$INFLUX_URL/api/v2/signin" \
        --user "${INFLUX_USER_NAME}:${INFLUX_USER_PASSWORD}"

# 2. To check that a user session exists for the user in step 1,
#    send a request to `GET /api/v2/me`.
#    In your request, pass the `-b` option with the session cookie file path from step 1.

      curl --request GET \
        -b ./cookie-file.tmp \
        "$INFLUX_URL/api/v2/me"

#    InfluxDB responds with the `user` resource.

# 3. Send a request to `POST /api/v2/signout` to expire the user session.
#    In your request, pass the `-b` option with the session cookie file path from step 1.

      curl --request POST \
        -b ./cookie-file.tmp \
        "$INFLUX_URL/api/v2/signout"

#     If the user session is successfully expired, InfluxDB responds with
      an HTTP `204` status code.

# 4. To check that the user session is expired, call `GET /api/v2/me` again,
#    passing the `-b` option with the cookie file path.

      curl --request GET \
        -b ./cookie-file.tmp \
        "$INFLUX_URL/api/v2/me"

#    If the user session is expired, InfluxDB responds with an HTTP `401` status code.

响应示例

401
default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

列出用户

列出 users。

要限制返回哪些用户，请在请求中传递查询参数。

InfluxDB云

InfluxDB Cloud doesn't allow listing all users through the API. Use the InfluxDB Cloud user interface (UI) to manage account information.

InfluxDB Cloud所需的权限

操作	所需权限	限制
列出所有用户	操作员令牌	仅供InfluxData内部使用
列出特定用户	`read-users` 或 `read-user USER_ID`

USER_ID 是您想要检索的用户的ID。

Manage users

授权：

TokenAuthentication

查询参数

id	字符串一个用户ID。仅列出指定的用户。
名称	字符串用户名称。仅列出指定的用户。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
401
422
500
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"links": {"self": "/api/v2/users/1"
},
"name": "string",
"status": "active"
}
]
}

更新密码

更新用户密码。

InfluxDB云

Doesn't allow you to manage user passwords through the API. Use the InfluxDB Cloud user interface (UI) to update a password.

授权：

TokenAuthentication

路径参数

用户ID

必需

字符串

要设置密码的用户的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

为用户设置的新密码。

密码

必填

字符串

响应

请求示例

Payload
cURL: use HTTP POST to update the user password

Content type

application/json

{"password": "string"
}

响应示例

400
default

Content type

application/json

{"code": "invalid",
"message": "passwords cannot be changed through the InfluxDB Cloud API"
}

更新密码

更新用户密码。

使用此端点让用户通过基本身份验证凭据进行身份验证并设置新密码。

InfluxDB云

Doesn't allow you to manage user passwords through the API. Use the InfluxDB Cloud user interface (UI) to update a password.

授权：

BasicAuthentication

路径参数

用户ID

必需

字符串

要设置密码的用户的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

为用户设置的新密码。

密码

必填

字符串

响应

请求示例

Payload
cURL: use Basic auth to update the user password

Content type

application/json

{"password": "string"
}

响应示例

400
default

Content type

application/json

{"code": "invalid",
"message": "passwords cannot be changed through the InfluxDB Cloud API"
}

系统信息接口

列出所有顶级路由

检索 InfluxDB API 的所有顶级路由。

限制

Only returns top level routes--for example, the response contains "tasks":"/api/v2/tasks", and doesn't contain resource-specific routes for tasks (/api/v2/tasks/TASK_ID/...).

授权：

TokenAuthentication

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200

Content type

application/json

{"authorizations": "http://example.com",
"buckets": "http://example.com",
"dashboards": "http://example.com",
"external": {"statusFeed": "http://example.com"
},
"flags": "http://example.com",
"me": "http://example.com",
"orgs": "http://example.com",
"query": {"analyze": "http://example.com",
"ast": "http://example.com",
"self": "http://example.com",
"suggestions": "http://example.com"
},
"setup": "http://example.com",
"signin": "http://example.com",
"signout": "http://example.com",
"sources": "http://example.com",
"system": {"debug": "http://example.com",
"health": "http://example.com",
"metrics": "http://example.com"
},
"tasks": "http://example.com",
"telegrafs": "http://example.com",
"users": "http://example.com",
"variables": "http://example.com",
"write": "http://example.com"
}

获取实例状态

检索实例的状态和InfluxDB版本。

使用这个端点来监测 InfluxDB 实例的正常运行时间。响应返回一个 HTTP 204 状态码，以告知您该实例可用。

Influx ping

授权：

TokenAuthentication

响应

列出所有已知资源

授权：

TokenAuthentication

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
default

Content type

application/json

["string"
]

授权（API 令牌）

创建和管理授权（API 令牌）。

一个授权包含组织资源的读和写 权限列表，并提供用于身份验证的API令牌。一个授权属于一个组织，仅包含该组织的权限。

我们建议您采取以下措施来管理您的令牌：

Create a generic user to create and manage tokens for writing data.
Store your tokens in a secure password vault for future access.

带有授权的用户会话

可选地，在创建授权时，您可以将其限制为特定用户。如果用户使用用户名和密码登录，创建一个用户会话，该会话携带所有用户授权所授予的权限。有关更多信息，请参见如何将令牌分配给特定用户。要创建用户会话，请使用POST /api/v2/signin端点。

Signin
Signout

列出授权

列出授权。

要限制返回的授权，请在请求中传递查询参数。如果未传递查询参数，InfluxDB 将返回所有授权。

InfluxDB云

InfluxDB Cloud doesn't expose API token values in GET /api/v2/authorizations responses; returns token: redacted for all authorizations.

所需权限

要获取授权，请求必须使用具有以下权限的API令牌：

read-authorizations
read-user for the user that the authorization is scoped to

View tokens

授权：

TokenAuthentication

查询参数

组织	字符串一个组织名称。仅返回属于指定的 organization 的授权。
orgID	string 一个组织的ID。仅返回属于指定的 organization 的授权。
token	字符串一个API token 值。通过其 `token` 属性值指定授权并返回授权。 InfluxDB OSS 不支持此参数。InfluxDB OSS 会忽略 `token=` 参数，应用其他参数，然后返回结果。限制该参数不可重复。如果你指定多个，只有第一个会被使用。如果具有指定属性值的资源不存在，则响应体将包含一个空列表。
用户	字符串一个用户名。仅返回限定于指定用户的授权。
用户ID	字符串用户ID。仅返回限制在指定的用户的授权。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
400
401
500
default

Content type

application/json

{"authorizations": [{"description": "string",
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "/api/v2/authorizations/1",
"user": "/api/v2/users/12"
},
"org": "string",
"orgID": "string",
"permissions": [{"action": "read",
"resource": {"id": "string",
"name": "string",
"org": "string",
"orgID": "string",
"type": "authorizations"
}
}
],
"token": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"user": "string",
"userID": "string"
}
],
"links": {"next": "http://example.com",
"prev": "http://example.com",
"self": "http://example.com"
}
}

创建授权

创建一个授权并返回生成的授权与token。

使用此端点创建一个授权，该授权生成一个具有对特定资源或特定资源类型的read或write权限的API令牌。API令牌是授权的token属性值。

为了遵循安全API令牌生成和检索的最佳实践，InfluxDB 对API令牌实施访问限制。

InfluxDB allows access to the API token value immediately after the authorization is created.
You can’t change access (read/write) permissions for an API token after it’s created.
Tokens stop working when the user who created the token is deleted.

我们建议您采取以下措施来管理您的令牌：

Create a generic user to create and manage tokens for writing data.
Store your tokens in a secure password vault for future access.

所需权限

write-authorizations
write-user for the user that the authorization is scoped to

Create a token

授权：

TokenAuthentication

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

创建的授权。

描述	字符串这是令牌的描述。
orgID 必需	字符串一个组织ID。指定拥有授权的组织。
必需	对象的数组 (Permission) 非空授权的权限列表。在列表中，提供至少一个 `permission` 对象。在 `permission` 中，`resource.type` 属性授予对指定类型的所有资源的访问权限。要仅授予对特定资源的访问权限，请指定 `resource.id` 属性。
状态	字符串默认: "active" 枚举: "active" "inactive" 令牌的状态。如果 `inactive`，InfluxDB 将拒绝使用该令牌的请求。
用户ID	字符串一个用户ID。指定授权范围内的用户。当用户使用用户名和密码进行身份验证时， InfluxDB会生成一个用户会话，具有所有用户授权指定的权限。

响应

请求示例

Payload

Content type

application/json

Example

创建授权。

{"description": "iot_users read buckets",
"orgID": "INFLUX_ORG_ID",
"permissions": [{"action": "read",
"resource": {"type": "buckets"
}
}
]
}

响应示例

201
400
401
500
default

Content type

application/json

{"description": "string",
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "/api/v2/authorizations/1",
"user": "/api/v2/users/12"
},
"org": "string",
"orgID": "string",
"permissions": [{"action": "read",
"resource": {"id": "string",
"name": "string",
"org": "string",
"orgID": "string",
"type": "authorizations"
}
}
],
"token": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"user": "string",
"userID": "string"
}

删除授权

删除授权。

使用该端点删除API令牌。

如果您想禁用一个API令牌而不是删除它，请将授权的状态更新为 inactive。

授权：

TokenAuthentication

路径参数

authID

必需

字符串

一个授权ID。指定要删除的授权。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

400
401
404
500
default

Content type

application/json

{"code": "invalid",
"message": "id must have a length of 16 bytes"
}

获取授权

检索授权。

使用这个端点检索有关API令牌的信息，包括令牌的权限和该令牌所作用的用户。

InfluxDB OSS

InfluxDB OSS returns API token values in authorizations.
If the request uses an operator token, InfluxDB OSS returns authorizations for all organizations in the instance.

View tokens

View tokens

授权：

TokenAuthentication

路径参数

authID

必需

字符串

一个授权ID。指定要检索的授权。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

Content type

application/json

{"description": "string",
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "/api/v2/authorizations/1",
"user": "/api/v2/users/12"
},
"org": "string",
"orgID": "string",
"permissions": [{"action": "read",
"resource": {"id": "string",
"name": "string",
"org": "string",
"orgID": "string",
"type": "authorizations"
}
}
],
"token": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"user": "string",
"userID": "string"
}

更新API令牌为激活或非激活状态

更新授权。

使用此端点将API令牌的状态设置为活动或非活动。 InfluxDB会拒绝使用非活动API令牌的请求。

授权：

TokenAuthentication

路径参数

authID

必需

字符串

一个授权ID。指定要更新的授权。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

在请求体中，提供要更新的授权属性。

描述	字符串这是令牌的描述。
状态	字符串默认: "active" 枚举: "active" "inactive" 令牌的状态。如果 `inactive`，InfluxDB 将拒绝使用该令牌的请求。

响应

请求示例

Payload

Content type

application/json

{"description": "string",
"status": "active"
}

响应示例

200
default

Content type

application/json

{"description": "string",
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "/api/v2/authorizations/1",
"user": "/api/v2/users/12"
},
"org": "string",
"orgID": "string",
"permissions": [{"action": "read",
"resource": {"id": "string",
"name": "string",
"org": "string",
"orgID": "string",
"type": "authorizations"
}
}
],
"token": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"user": "string",
"userID": "string"
}

存储桶架构

列出一个桶的测量模式

列出显式模式 ("schemaType": "explicit") 用于一个存储桶。

显式模式用于强制规定您的数据的列名、标签、字段和数据类型。

默认情况下，桶具有隐式模式类型（"schemaType": "implicit"）以符合您的数据。

Using bucket schemas

授权：

TokenAuthentication

路径参数

bucketID

必填

字符串

一个桶 ID。列出指定桶的测量模式。

查询参数

名称	字符串一个测量名称。仅返回具有指定名称的测量模式。
组织	字符串组织名称。指定拥有模式的组织。
orgID	string 一个组织 ID。指定拥有该架构的组织。

响应

响应示例

200
400
401
404
500

Content type

application/json

{"measurementSchemas": [{"bucketID": "ba3c5e7f9b0a0010",
"createdAt": "2021-01-21T00:48:40.993Z",
"id": "1a3c5e7f9b0a8642",
"name": "cpu",
"orgID": "0a3c5e7f9b0a0001",
"updatedAt": "2021-01-21T00:48:40.993Z"
},
{"bucketID": "ba3c5e7f9b0a0010",
"createdAt": "2021-01-21T00:48:40.993Z",
"id": "1a3c5e7f9b0a8643",
"name": "memory",
"orgID": "0a3c5e7f9b0a0001",
"updatedAt": "2021-01-21T00:48:40.993Z"
},
{"bucketID": "ba3c5e7f9b0a0010",
"createdAt": "2021-01-21T00:48:40.993Z",
"id": "1a3c5e7f9b0a8644",
"name": "disk",
"orgID": "0a3c5e7f9b0a0001",
"updatedAt": "2021-01-21T00:48:40.993Z"
}
]
}

为桶创建一个测量模式

为一个桶创建一个显式测量模式。

显式模式用于强制规定您的数据的列名、标签、字段和数据类型。

默认情况下，桶具有隐式模式类型（"schemaType": "implicit"）以符合您的数据。

使用此端点创建防止不合规写请求的架构。

限制

Buckets must be created with the "explicit" schemaType in order to use schemas.

授权：

TokenAuthentication

路径参数

bucketID

必填

字符串

一个桶ID。为指定的桶添加模式。

查询参数

组织	字符串组织名称。指定拥有模式的组织。
orgID	string 组织 ID。指定拥有该 schema 的组织。

请求体模式: application/json

必填	数组对象 (MeasurementSchemaColumn) 有序的列定义集合。
名称必填	字符串该测量名称。

响应

请求示例

Payload
cURL

Content type

application/json

{"columns": [{"format": "unix timestamp",
"name": "time",
"type": "integer"
},
{"name": "host",
"type": "tag"
},
{"name": "region",
"type": "tag"
},
{"dataType": "float",
"name": "usage_user",
"type": "field"
},
{"dataType": "float",
"name": "usage_user",
"type": "field"
}
],
"name": "cpu"
}

响应示例

201
400
401
404
500

Content type

application/json

{"bucketID": "ba3c5e7f9b0a0010",
"columns": [{"format": "unix timestamp",
"name": "time",
"type": "integer"
},
{"name": "host",
"type": "tag"
},
{"name": "region",
"type": "tag"
},
{"dataType": "float",
"name": "usage_user",
"type": "field"
},
{"dataType": "float",
"name": "usage_user",
"type": "field"
}
],
"createdAt": "2021-01-21T00:48:40.993Z",
"id": "1a3c5e7f9b0a8642",
"name": "cpu",
"orgID": "0a3c5e7f9b0a0001",
"updatedAt": "2021-01-21T00:48:40.993Z"
}

检索测量架构

检索一个明确的测量 schema。

授权：

TokenAuthentication

路径参数

bucketID 必需	字符串桶的ID。检索指定桶的架构。
measurementID 必填	字符串测量架构的ID。指定要检索的测量架构。

查询参数

org	string 组织名称。指定拥有该模式的组织。
orgID	string 组织 ID。指定拥有该模式的组织。

响应

响应示例

200
401
404
500

Content type

application/json

{"bucketID": "ba3c5e7f9b0a0010",
"columns": [{"format": "unix timestamp",
"name": "time",
"type": "integer"
},
{"name": "host",
"type": "tag"
},
{"name": "region",
"type": "tag"
},
{"dataType": "float",
"name": "usage_user",
"type": "field"
},
{"dataType": "float",
"name": "usage_user",
"type": "field"
}
],
"createdAt": "2021-01-21T00:48:40.993Z",
"id": "1a3c5e7f9b0a8642",
"name": "cpu",
"orgID": "0a3c5e7f9b0a0001",
"updatedAt": "2021-01-21T00:48:40.993Z"
}

更新测量模式

更新一个测量schema。

使用此端点来更新测量模式的字段 (name, type, 和 dataType)。

限制

You can't update the name of a measurement.

授权：

TokenAuthentication

路径参数

bucketID 必需	字符串一个桶 ID。指定要检索架构的桶。
measurementID 必需	字符串一个测量架构ID。检索指定的测量架构。

查询参数

组织	字符串组织名称。指定拥有模式的组织。
orgID	string 组织 ID。指定拥有该 schema 的组织。

请求体模式: application/json

必需	对象的数组（MeasurementSchemaColumn）列定义的有序集合

响应

请求示例

Payload
cURL

Content type

application/json

{"columns": [{"format": "unix timestamp",
"name": "time",
"type": "integer"
},
{"name": "host",
"type": "tag"
},
{"name": "region",
"type": "tag"
},
{"dataType": "float",
"name": "usage_user",
"type": "field"
},
{"dataType": "float",
"name": "usage_user",
"type": "field"
}
]
}

响应示例

200
400
401
404
500

Content type

application/json

{"bucketID": "ba3c5e7f9b0a0010",
"columns": [{"format": "unix timestamp",
"name": "time",
"type": "integer"
},
{"name": "host",
"type": "tag"
},
{"name": "region",
"type": "tag"
},
{"dataType": "float",
"name": "usage_user",
"type": "field"
},
{"dataType": "float",
"name": "usage_user",
"type": "field"
}
],
"createdAt": "2021-01-21T00:48:40.993Z",
"id": "1a3c5e7f9b0a8642",
"name": "cpu",
"orgID": "0a3c5e7f9b0a0001",
"updatedAt": "2021-01-21T00:48:40.993Z"
}

桶

将您的数据存储在 InfluxDB buckets 中。 bucket 是一个命名的位置，用于存储时间序列数据。所有 bucket 都有一个 retention period，每个数据点保留的时间段。InfluxDB 会丢弃所有时间戳早于 bucket 保留期限的点。一个 bucket 属于一个组织。

Manage buckets

列出存储桶

列出 buckets。

InfluxDB 检索由组织拥有的存储桶，这些存储桶与授权 (API token) 相关联。要限制返回的存储桶，可以在请求中传递查询参数。如果没有传递查询参数，InfluxDB 将返回所有存储桶，直到默认 limit。

InfluxDB OSS

If you use an operator token to authenticate your request, InfluxDB retrieves resources for all organizations in the instance. To retrieve resources for only a specific organization, use the org parameter or the orgID parameter to specify the organization.

所需权限

操作	所需权限
检索用户桶	`read-buckets`
检索系统桶	`read-orgs`

Manage buckets

授权：

TokenAuthentication

查询参数

之后	字符串要查找的资源 ID。返回在指定记录之后创建的记录；结果不包括指定记录。请使用 `after` 代替 `offset` 参数。有关分页参数的更多信息，请参见 Pagination。
id	string 一个桶的ID。仅返回具有指定ID的桶。
限制	整数 [ 1 .. 100 ] 默认: 20 限制返回的记录数量。默认值是 `20`。
名称	字符串一个桶的名称。仅返回具有指定名称的桶。
偏移量	整数 >= 0 分页的偏移量。要跳过的记录数。有关分页参数的更多信息，请参见分页。
组织	字符串一个组织名称。 InfluxDB Cloud 不使用 `org` 参数或 `orgID` 参数。列出与授权（API令牌）相关的组织的存储桶。 InfluxDB OSS 列出指定组织的存储桶。
组织ID	字符串一个组织的ID。 InfluxDB Cloud 不使用 `org` 参数或 `orgID` 参数。列出与授权（API令牌）关联的组织的存储桶。 InfluxDB OSS 需要 `org` 参数或 `orgID` 参数。列出指定组织的存储桶。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

请求示例

cURL: filter buckets by name

curl --request GET "http://localhost:8086/api/v2/buckets?name=_monitoring" \
  --header "Authorization: Token INFLUX_TOKEN" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json"

响应示例

200
401
500
default

Content type

application/json

{"buckets": [{"createdAt": "2022-03-15T17:22:33.72617939Z",
"description": "System bucket for monitoring logs",
"id": "77ca9dace40a9bfc",
"labels": [ ],
"links": {"labels": "/api/v2/buckets/77ca9dace40a9bfc/labels",
"members": "/api/v2/buckets/77ca9dace40a9bfc/members",
"org": "/api/v2/orgs/INFLUX_ORG_ID",
"owners": "/api/v2/buckets/77ca9dace40a9bfc/owners",
"self": "/api/v2/buckets/77ca9dace40a9bfc",
"write": "/api/v2/write?org=ORG_ID&bucket=77ca9dace40a9bfc"
},
"name": "_monitoring",
"orgID": "INFLUX_ORG_ID",
"retentionRules": [{"everySeconds": 604800,
"type": "expire"
}
],
"schemaType": "implicit",
"type": "system",
"updatedAt": "2022-03-15T17:22:33.726179487Z"
}
],
"links": {"self": "/api/v2/buckets?descending=false&limit=20&name=_monitoring&offset=0&orgID=ORG_ID"
}
}

创建一个存储桶

创建一个桶并返回桶资源。默认数据保留期限为 30 天。

InfluxDB OSS

A single InfluxDB OSS instance supports active writes or queries for approximately 20 buckets across all organizations at a given time. Reading or writing to more than 20 buckets at a time can adversely affect performance.

限制

InfluxDB Cloud Free Plan allows users to create up to two buckets. Exceeding the bucket quota will result in an HTTP 403 status code. For additional information regarding InfluxDB Cloud offerings, see InfluxDB Cloud Pricing.

授权：

TokenAuthentication

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

要创建的桶。

描述	字符串桶的描述。
名称必需	字符串存储桶名称。
orgID 必填	字符串组织ID。指定拥有该存储桶的组织。
	一组对象 (RetentionRules) 保留规则用于过期或保留数据。 InfluxDB `/api/v2` API 使用 `RetentionRules` 来配置保留期限。 InfluxDB Cloud `retentionRules` 是必需的。 InfluxDB OSS `retentionRules` 不是必需的。
rp	字符串默认值: "0" 存储桶的保留策略。对于 InfluxDB 1.x，指定保留策略中每个数据点持续的时间。如果您需要与 InfluxDB 1.x 兼容，请为 `rp` 属性指定一个值；否则，请参见 `retentionRules` 属性。保留策略是 InfluxDB 1.x 的概念。 InfluxDB 2.x 和 Cloud 的等效概念是保留期限。 InfluxDB `/api/v2` API 使用 `RetentionRules` 来配置保留期限。
模式类型	字符串 (SchemaType) 枚举: "隐式" "显式"

响应

请求示例

Payload
cURL: create a bucket with retention period
cURL

Content type

application/json

{"description": "string",
"name": "string",
"orgID": "string",
"retentionRules": [{"everySeconds": 86400,
"shardGroupDurationSeconds": 0,
"type": "expire"
}
],
"rp": "0",
"schemaType": "implicit"
}

响应示例

Content type

application/json

{"createdAt": "2022-08-03T23:04:41.073704121Z",
"description": "A bucket holding air sensor data",
"id": "37407e232b3911d8",
"labels": [ ],
"links": {"labels": "/api/v2/buckets/37407e232b3911d8/labels",
"members": "/api/v2/buckets/37407e232b3911d8/members",
"org": "/api/v2/orgs/INFLUX_ORG_ID",
"owners": "/api/v2/buckets/37407e232b3911d8/owners",
"self": "/api/v2/buckets/37407e232b3911d8",
"write": "/api/v2/write?org=INFLUX_ORG_ID&bucket=37407e232b3911d8"
},
"name": "air_sensor",
"orgID": "INFLUX_ORG_ID",
"retentionRules": [{"everySeconds": 2592000,
"type": "expire"
}
],
"schemaType": "implicit",
"type": "user",
"updatedAt": "2022-08-03T23:04:41.073704228Z"
}

删除一个桶

删除一个存储桶及其所有相关记录。

InfluxDB云

当你发送删除请求时，会执行以下操作：
1. Validates the request and queues the delete.
2. Returns an HTTP 204 status code if queued; error otherwise.
3. Handles the delete asynchronously.

InfluxDB OSS

Validates the request, handles the delete synchronously, and then responds with success or failure.

限制

Only one bucket can be deleted per request.

Delete a bucket

授权：

TokenAuthentication

路径参数

bucketID

必填

字符串

桶 ID。要删除的桶的 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

请求示例

cURL

curl --request DELETE "http://localhost:8086/api/v2/buckets/BUCKET_ID" \
  --header "Authorization: Token INFLUX_TOKEN" \
  --header 'Accept: application/json'

响应示例

400
401
404
500
default

Content type

application/json

{"code": "invalid",
"message": "id must have a length of 16 bytes"
}

获取一个桶

检索一个存储桶。

使用此端点检索特定存储桶的信息。

授权：

TokenAuthentication

路径参数

bucketID

必需

字符串

要检索的桶的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
401
404
500
default

Content type

application/json

{"createdAt": "2022-08-03T23:04:41.073704121Z",
"description": "bucket for air sensor data",
"id": "37407e232b3911d8",
"labels": [ ],
"links": {"labels": "/api/v2/buckets/37407e232b3911d8/labels",
"members": "/api/v2/buckets/37407e232b3911d8/members",
"org": "/api/v2/orgs/INFLUX_ORG_ID",
"owners": "/api/v2/buckets/37407e232b3911d8/owners",
"self": "/api/v2/buckets/37407e232b3911d8",
"write": "/api/v2/write?org=INFLUX_ORG_ID&bucket=37407e232b3911d8"
},
"name": "air-sensor",
"orgID": "bea7ea952287f70d",
"retentionRules": [{"everySeconds": 2592000,
"type": "expire"
}
],
"schemaType": "implicit",
"type": "user",
"updatedAt": "2022-08-03T23:04:41.073704228Z"
}

更新一个桶

更新一个存储桶。

使用此端点更新存储桶的属性 (name, description, 和 retentionRules)。

InfluxDB云

Requires the retentionRules property in the request body. If you don't provide retentionRules, InfluxDB responds with an HTTP 403 status code.

InfluxDB OSS

Doesn't require retentionRules.

Update a bucket

授权：

TokenAuthentication

路径参数

bucketID

必需

字符串

存储桶的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

桶更新以应用。

描述	字符串桶的描述。
名称	字符串桶的名称。
	对象的数组 (PatchRetentionRules) 更新到规则以过期或保留数据。没有规则意味着没有更新。

响应

请求示例

Payload
cURL

Content type

application/json

{"description": "string",
"name": "string",
"retentionRules": [{"everySeconds": 86400,
"shardGroupDurationSeconds": 0,
"type": "expire"
}
]
}

响应示例

Content type

application/json

{"createdAt": "2022-08-03T23:04:41.073704121Z",
"description": "bucket holding air sensor data",
"id": "37407e232b3911d8",
"labels": [ ],
"links": {"labels": "/api/v2/buckets/37407e232b3911d8/labels",
"members": "/api/v2/buckets/37407e232b3911d8/members",
"org": "/api/v2/orgs/INFLUX_ORG_ID",
"owners": "/api/v2/buckets/37407e232b3911d8/owners",
"self": "/api/v2/buckets/37407e232b3911d8",
"write": "/api/v2/write?org=INFLUX_ORG_ID&bucket=37407e232b3911d8"
},
"name": "air_sensor",
"orgID": "INFLUX_ORG_ID",
"retentionRules": [{"everySeconds": 2592000,
"type": "expire"
}
],
"schemaType": "implicit",
"type": "user",
"updatedAt": "2022-08-07T22:49:49.422962913Z"
}

列出一个桶的所有标签

列出一个桶的所有标签。

标签是包含 labelID, name, description 和 color 键值对的对象。它们可用于对 InfluxDB 资源进行分组和过滤。标签还能够跨不同资源进行分组——例如，您可以将名为 air_sensor 的标签应用于一个存储桶和一个任务，以快速组织资源。

Use the /api/v2/labels InfluxDB API endpoint to retrieve and manage labels.
Manage labels in the InfluxDB UI

授权：

TokenAuthentication

路径参数

bucketID

必需

字符串

要检索标签的桶的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

Content type

application/json

{"labels": [{"id": "09cbd068e7ebb000",
"name": "production_buckets",
"orgID": "INFLUX_ORG_ID"
}
],
"links": {"self": "/api/v2/labels"
}
}

为桶添加标签

向桶中添加标签并返回新的标签信息。

标签是包含 labelID, name, description, 和 color 键值对的对象。它们可以用于对一个或多个资源进行分组和过滤——例如，您可以将名为 air_sensor 的标签应用于一个存储桶和一个任务，以快速组织资源。

限制

Before adding a label to a bucket, you must create the label if you haven't already. To create a label with the InfluxDB API, send a POST request to the /api/v2/labels endpoint).

Use the /api/v2/labels InfluxDB API endpoint to retrieve and manage labels.
Manage labels in the InfluxDB UI

授权：

TokenAuthentication

路径参数

bucketID

必填

字符串

桶 ID。用于标记的桶的 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

一个包含 labelID 的对象，用于添加到桶中。

labelID

必填

字符串

标签ID。指定要附加的标签。

响应

请求示例

Payload
cURL

Content type

application/json

{"labelID": "string"
}

响应示例

Content type

application/json

{"label": {"id": "09cbd068e7ebb000",
"name": "production_buckets",
"orgID": "INFLUX_ORG_ID"
},
"links": {"self": "/api/v2/labels"
}
}

从桶中删除标签

授权：

TokenAuthentication

路径参数

bucketID 必需	字符串存储桶的ID。
labelID 必填	字符串要删除的标签的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

404
default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

列出所有具有桶的成员权限的用户

列出一个存储桶的所有用户。

InfluxDB users 有权访问 InfluxDB。

Members 是在组织中拥有访问指定资源的用户。

使用此端点检索所有可以访问存储桶的用户。

授权：

TokenAuthentication

路径参数

bucketID

必填

字符串

要检索用户的桶的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

Content type

application/json

{"links": {"self": "/api/v2/buckets/37407e232b3911d8/members"
},
"users": [{"id": "791df274afd48a83",
"links": {"self": "/api/v2/users/791df274afd48a83"
},
"name": "example_user_1",
"role": "member",
"status": "active"
},
{"id": "09cfb87051cbe000",
"links": {"self": "/api/v2/users/09cfb87051cbe000"
},
"name": "example_user_2",
"role": "owner",
"status": "active"
}
]
}

将成员添加到存储桶

将用户添加到存储桶并返回新用户信息。

InfluxDB users 有权访问 InfluxDB。

成员是组织中的用户。

使用此端点为用户授予存储桶的成员权限。

授权：

TokenAuthentication

路径参数

bucketID

必填

字符串

要检索用户的桶的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

将用户添加为桶的成员。

id 必需	字符串要添加到资源的用户ID。
姓名	字符串要添加到资源中的用户姓名。

响应

请求示例

Payload
cURL

Content type

application/json

{"id": "string",
"name": "string"
}

响应示例

Content type

application/json

{"id": "09cfb87051cbe000",
"links": {"self": "/api/v2/users/09cfb87051cbe000"
},
"name": "example_user_1",
"role": "member",
"status": "active"
}

从桶中移除成员

从桶中移除一个成员。

使用此端点从一个存储桶中移除用户的成员权限。这将移除该用户对存储桶的 read 和 write 权限。

授权：

TokenAuthentication

路径参数

bucketID 必填	字符串要从中移除用户的存储桶的ID。
用户ID 必需	字符串要移除的用户的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

401
404
500
default

Content type

application/json

{"code": "unauthorized",
"message": "unauthorized access"
}

列出所有存储桶的所有者

列出所有 owners 的存储桶。

桶的拥有者有权限删除桶以及从桶中移除用户和成员的权限。

InfluxDB云

Doesn't use owner and member roles. Use /api/v2/authorizations to assign user permissions.

限制

Owner permissions are separate from API token permissions.
Owner permissions are used in the context of the InfluxDB UI.

所需权限

read-orgs INFLUX_ORG_ID

INFLUX_ORG_ID 是您要检索所有者列表的组织的ID。

Authorizations

Manage users

授权：

TokenAuthentication

路径参数

bucketID

必需

字符串

要检索所有者的桶的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

Content type

application/json

{"links": {"self": "/api/v2/buckets/BUCKET_ID/owners"
},
"users": [{"id": "d88d182d91b0950f",
"links": {"self": "/api/v2/users/d88d182d91b0950f"
},
"name": "example-owner",
"role": "owner",
"status": "active"
}
]
}

为存储桶添加一个所有者

将拥有者添加到桶中，并返回带有角色和用户详细信息的 owners。

使用此端点为存储桶创建一个资源所有者。
存储桶所有者有权删除存储桶并移除用户和成员在存储桶中的权限。

InfluxDB云

Doesn't use owner and member roles. Use /api/v2/authorizations to assign user permissions.

限制

Owner permissions are separate from API token permissions.
Owner permissions are used in the context of the InfluxDB UI.

所需权限

write-orgs INFLUX_ORG_ID
INFLUX_ORG_ID* is the ID of the organization that you want to add an owner for.

Authorizations

Manage users

授权：

TokenAuthentication

路径参数

bucketID

必填

字符串

要添加所有者的存储桶的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

作为存储桶的所有者添加用户。

id 必需	字符串要添加到资源的用户ID。
姓名	字符串要添加到资源中的用户姓名。

响应

请求示例

Payload
cURL

Content type

application/json

{"id": "d88d182d91b0950f",
"links": {"self": "/api/v2/users/d88d182d91b0950f"
},
"name": "example-user",
"role": "owner",
"status": "active"
}

响应示例

Content type

application/json

{"id": "string",
"links": {"self": "/api/v2/users/1"
},
"name": "string",
"status": "active",
"role": "owner"
}

从存储桶中移除所有者

从存储桶中移除一个所有者。

使用此端点移除用户的 owner 角色对一个存储桶。

InfluxDB云

Doesn't use owner and member roles. Use /api/v2/authorizations to assign user permissions.

限制

Owner permissions are separate from API token permissions.
Owner permissions are used in the context of the InfluxDB UI.

所需权限

write-orgs INFLUX_ORG_ID

INFLUX_ORG_ID 是您想要删除某个负责人所属的组织的ID。

Authorizations

Manage users

授权：

TokenAuthentication

路径参数

bucketID 必填	字符串要移除所有者的存储桶的ID。
用户ID 必需	字符串要移除的所有者的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

401
404
500
default

Content type

application/json

{"code": "unauthorized",
"message": "unauthorized access"
}

单元格

创建一个仪表板单元

授权：

TokenAuthentication

路径参数

dashboardID

必填

字符串

要更新的仪表板的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

将要添加的单元格

h	整数 <int32>
名称	字符串
usingView	string 生成所提供视图的副本。
w	整数 <int32>
x	整数 <int32>
y	整数 <int32>

响应

请求示例

Payload

Content type

application/json

{"h": 0,
"name": "string",
"usingView": "string",
"w": 0,
"x": 0,
"y": 0
}

响应示例

201
404
default

Content type

application/json

{"h": 0,
"id": "string",
"links": {"self": "string",
"view": "string"
},
"viewID": "string",
"w": 0,
"x": 0,
"y": 0
}

在仪表板中替换单元格

替换仪表板中的所有单元格。主要用于更新所有单元格的位置实信息。

授权：

TokenAuthentication

路径参数

dashboardID

必填

字符串

要更新的仪表板的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

Array ()

h	整数 <int32>
身份证	字符串
	对象
视图ID	字符串对视图API中的视图的引用。
w	整数 <int32>
x	整数 <int32>
y	整数 <int32>

响应

请求示例

Payload

Content type

application/json

[{"h": 0,
"id": "string",
"links": {"self": "string",
"view": "string"
},
"viewID": "string",
"w": 0,
"x": 0,
"y": 0
}
]

响应示例

201
404
default

Content type

application/json

{"description": "string",
"name": "string",
"orgID": "string",
"cells": [{"h": 0,
"id": "string",
"links": {"self": "string",
"view": "string"
},
"viewID": "string",
"w": 0,
"x": 0,
"y": 0
}
],
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"cells": "/api/v2/dashboards/1/cells",
"labels": "/api/v2/dashboards/1/labels",
"members": "/api/v2/dashboards/1/members",
"org": "/api/v2/labels/1",
"owners": "/api/v2/dashboards/1/owners",
"self": "/api/v2/dashboards/1"
},
"meta": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}

删除一个仪表板单元格

授权：

TokenAuthentication

路径参数

单元格ID 必需	字符串要删除的单元格的ID。
dashboardID 必填	字符串要删除的仪表板的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

404
default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

更新与单元格相关的非位置性信息

更新与单元格相关的非位置性信息。对单个单元格的位置信息进行更新可能会导致网格冲突。

授权：

TokenAuthentication

路径参数

cellID 必填	字符串要更新的单元格的ID。
dashboardID 必填	字符串要更新的仪表板的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

h	整数 <int32>
w	整数 <int32>
x	整数 <int32>
y	整数 <int32>

响应

请求示例

Payload

Content type

application/json

{"h": 0,
"w": 0,
"x": 0,
"y": 0
}

响应示例

200
404
default

Content type

application/json

{"h": 0,
"id": "string",
"links": {"self": "string",
"view": "string"
},
"viewID": "string",
"w": 0,
"x": 0,
"y": 0
}

获取单元格的视图

授权：

TokenAuthentication

路径参数

单元格ID 必需	字符串单元格的ID。
dashboardID 必需	字符串仪表板 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
404
default

Content type

application/json

{"id": "string",
"links": {"self": "string"
},
"name": "string",
"properties": {"adaptiveZoomHide": true,
"axes": {"x": {"base": "",
"bounds": ["string"
],
"label": "string",
"prefix": "string",
"scale": "log",
"suffix": "string"
},
"y": {"base": "",
"bounds": ["string"
],
"label": "string",
"prefix": "string",
"scale": "log",
"suffix": "string"
}
},
"colors": [{"hex": "strings",
"id": "string",
"name": "string",
"type": "min",
"value": 0
}
],
"decimalPlaces": {"digits": 0,
"isEnforced": true
},
"generateXAxisTicks": ["string"
],
"generateYAxisTicks": ["string"
],
"hoverDimension": "auto",
"legendColorizeRows": true,
"legendHide": true,
"legendOpacity": 0,
"legendOrientationThreshold": 0,
"note": "string",
"position": "overlaid",
"prefix": "string",
"queries": [{"builderConfig": {"aggregateWindow": {"fillValues": true,
"period": "string"
},
"buckets": ["string"
],
"functions": [{"name": "string"
}
],
"tags": [{"aggregateFunctionType": "filter",
"key": "string",
"values": ["string"
]
}
]
},
"editMode": "builder",
"name": "string",
"text": "string"
}
],
"shadeBelow": true,
"shape": "chronograf-v2",
"showNoteWhenEmpty": true,
"staticLegend": {"colorizeRows": true,
"heightRatio": 0,
"opacity": 0,
"orientationThreshold": 0,
"show": true,
"valueAxis": "string",
"widthRatio": 0
},
"suffix": "string",
"timeFormat": "string",
"type": "line-plus-single-stat",
"xColumn": "string",
"xTickStart": 0,
"xTickStep": 0,
"xTotalTicks": 0,
"yColumn": "string",
"yTickStart": 0,
"yTickStep": 0,
"yTotalTicks": 0
}
}

更新单元格的视图

授权：

TokenAuthentication

路径参数

cellID 必填	字符串要更新的单元格的ID。
dashboardID 必填	字符串要更新的仪表板的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

名称

必需

字符串

必需

LinePlusSingleStatProperties (object) 或 XYViewProperties (object) 或 SingleStatViewProperties (object) 或 HistogramViewProperties (object) 或 GaugeViewProperties (object) 或 TableViewProperties (object) 或 SimpleTableViewProperties (object) 或 MarkdownViewProperties (object) 或 CheckViewProperties (object) 或 ScatterViewProperties (object) 或 HeatmapViewProperties (object) 或 MosaicViewProperties (object) 或 BandViewProperties (object) 或 GeoViewProperties (object) (ViewProperties)

响应

请求示例

Payload

Content type

application/json

{"name": "string",
"properties": {"adaptiveZoomHide": true,
"axes": {"x": {"base": "",
"bounds": ["string"
],
"label": "string",
"prefix": "string",
"scale": "log",
"suffix": "string"
},
"y": {"base": "",
"bounds": ["string"
],
"label": "string",
"prefix": "string",
"scale": "log",
"suffix": "string"
}
},
"colors": [{"hex": "strings",
"id": "string",
"name": "string",
"type": "min",
"value": 0
}
],
"decimalPlaces": {"digits": 0,
"isEnforced": true
},
"generateXAxisTicks": ["string"
],
"generateYAxisTicks": ["string"
],
"hoverDimension": "auto",
"legendColorizeRows": true,
"legendHide": true,
"legendOpacity": 0,
"legendOrientationThreshold": 0,
"note": "string",
"position": "overlaid",
"prefix": "string",
"queries": [{"builderConfig": {"aggregateWindow": {"fillValues": true,
"period": "string"
},
"buckets": ["string"
],
"functions": [{"name": "string"
}
],
"tags": [{"aggregateFunctionType": "filter",
"key": "string",
"values": ["string"
]
}
]
},
"editMode": "builder",
"name": "string",
"text": "string"
}
],
"shadeBelow": true,
"shape": "chronograf-v2",
"showNoteWhenEmpty": true,
"staticLegend": {"colorizeRows": true,
"heightRatio": 0,
"opacity": 0,
"orientationThreshold": 0,
"show": true,
"valueAxis": "string",
"widthRatio": 0
},
"suffix": "string",
"timeFormat": "string",
"type": "line-plus-single-stat",
"xColumn": "string",
"xTickStart": 0,
"xTickStep": 0,
"xTotalTicks": 0,
"yColumn": "string",
"yTickStart": 0,
"yTickStep": 0,
"yTotalTicks": 0
}
}

响应示例

200
404
default

Content type

application/json

{"id": "string",
"links": {"self": "string"
},
"name": "string",
"properties": {"adaptiveZoomHide": true,
"axes": {"x": {"base": "",
"bounds": ["string"
],
"label": "string",
"prefix": "string",
"scale": "log",
"suffix": "string"
},
"y": {"base": "",
"bounds": ["string"
],
"label": "string",
"prefix": "string",
"scale": "log",
"suffix": "string"
}
},
"colors": [{"hex": "strings",
"id": "string",
"name": "string",
"type": "min",
"value": 0
}
],
"decimalPlaces": {"digits": 0,
"isEnforced": true
},
"generateXAxisTicks": ["string"
],
"generateYAxisTicks": ["string"
],
"hoverDimension": "auto",
"legendColorizeRows": true,
"legendHide": true,
"legendOpacity": 0,
"legendOrientationThreshold": 0,
"note": "string",
"position": "overlaid",
"prefix": "string",
"queries": [{"builderConfig": {"aggregateWindow": {"fillValues": true,
"period": "string"
},
"buckets": ["string"
],
"functions": [{"name": "string"
}
],
"tags": [{"aggregateFunctionType": "filter",
"key": "string",
"values": ["string"
]
}
]
},
"editMode": "builder",
"name": "string",
"text": "string"
}
],
"shadeBelow": true,
"shape": "chronograf-v2",
"showNoteWhenEmpty": true,
"staticLegend": {"colorizeRows": true,
"heightRatio": 0,
"opacity": 0,
"orientationThreshold": 0,
"show": true,
"valueAxis": "string",
"widthRatio": 0
},
"suffix": "string",
"timeFormat": "string",
"type": "line-plus-single-stat",
"xColumn": "string",
"xTickStart": 0,
"xTickStep": 0,
"xTotalTicks": 0,
"yColumn": "string",
"yTickStart": 0,
"yTickStep": 0,
"yTotalTicks": 0
}
}

检查

列出所有检查

授权：

TokenAuthentication

查询参数

限制	整数 [ 1 .. 100 ] 默认: 20 限制返回的记录数量。默认值是 `20`。
偏移量	整数 >= 0 分页的偏移量。要跳过的记录数。有关分页参数的更多信息，请参见分页。
orgID 必填	字符串仅显示属于特定组织 ID 的检查。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
default

Content type

application/json

{"checks": [{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"lastRunError": "string",
"lastRunStatus": "failed",
"latestCompleted": "2019-08-24T14:15:22Z",
"links": {"labels": "/api/v2/checks/1/labels",
"members": "/api/v2/checks/1/members",
"owners": "/api/v2/checks/1/owners",
"query": "/api/v2/checks/1/query",
"self": "/api/v2/checks/1"
},
"name": "string",
"orgID": "string",
"ownerID": "string",
"query": {"builderConfig": {"aggregateWindow": {"fillValues": true,
"period": "string"
},
"buckets": ["string"
],
"functions": [{"name": "string"
}
],
"tags": [{"aggregateFunctionType": "filter",
"key": "string",
"values": ["string"
]
}
]
},
"editMode": "builder",
"name": "string",
"text": "string"
},
"status": "active",
"taskID": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"every": "string",
"level": "UNKNOWN",
"offset": "string",
"reportZero": true,
"staleTime": "string",
"statusMessageTemplate": "string",
"tags": [{"key": "string",
"value": "string"
}
],
"timeSince": "string",
"type": "deadman"
}
],
"links": {"next": "http://example.com",
"prev": "http://example.com",
"self": "http://example.com"
}
}

添加新检查

授权：

TokenAuthentication

请求体模式: application/json

检查以创建

描述	字符串检查的可选描述。
	数组对象（标签）
名称必需	字符串
orgID 必填	字符串拥有此检查的组织的ID。
必需	对象 (DashboardQuery)
状态	字符串 (TaskStatusType) 枚举： "active" "inactive" `inactive` 取消计划运行并防止手动运行任务。
任务ID	字符串与此检查相关的任务的ID。
类型必需	字符串自定义后置检查检查阈值死亡信号自定义

响应

请求示例

Payload

Content type

application/json

Example

{"description": "string",
"labels": [{"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"name": "string",
"orgID": "string",
"query": {"builderConfig": {"aggregateWindow": {"fillValues": true,
"period": "string"
},
"buckets": ["string"
],
"functions": [{"name": "string"
}
],
"tags": [{"aggregateFunctionType": "filter",
"key": "string",
"values": ["string"
]
}
]
},
"editMode": "builder",
"name": "string",
"text": "string"
},
"status": "active",
"taskID": "string",
"type": "custom"
}

响应示例

201
default

Content type

application/json

Example

{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"lastRunError": "string",
"lastRunStatus": "failed",
"latestCompleted": "2019-08-24T14:15:22Z",
"links": {"labels": "/api/v2/checks/1/labels",
"members": "/api/v2/checks/1/members",
"owners": "/api/v2/checks/1/owners",
"query": "/api/v2/checks/1/query",
"self": "/api/v2/checks/1"
},
"name": "string",
"orgID": "string",
"ownerID": "string",
"query": {"builderConfig": {"aggregateWindow": {"fillValues": true,
"period": "string"
},
"buckets": ["string"
],
"functions": [{"name": "string"
}
],
"tags": [{"aggregateFunctionType": "filter",
"key": "string",
"values": ["string"
]
}
]
},
"editMode": "builder",
"name": "string",
"text": "string"
},
"status": "active",
"taskID": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"type": "custom"
}

删除检查

授权：

TokenAuthentication

路径参数

checkID

必填

字符串

检查ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

404
default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

获取支票

授权：

TokenAuthentication

路径参数

checkID

必填

字符串

检查ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
default

Content type

application/json

Example

{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"lastRunError": "string",
"lastRunStatus": "failed",
"latestCompleted": "2019-08-24T14:15:22Z",
"links": {"labels": "/api/v2/checks/1/labels",
"members": "/api/v2/checks/1/members",
"owners": "/api/v2/checks/1/owners",
"query": "/api/v2/checks/1/query",
"self": "/api/v2/checks/1"
},
"name": "string",
"orgID": "string",
"ownerID": "string",
"query": {"builderConfig": {"aggregateWindow": {"fillValues": true,
"period": "string"
},
"buckets": ["string"
],
"functions": [{"name": "string"
}
],
"tags": [{"aggregateFunctionType": "filter",
"key": "string",
"values": ["string"
]
}
]
},
"editMode": "builder",
"name": "string",
"text": "string"
},
"status": "active",
"taskID": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"type": "custom"
}

更新检查

授权：

TokenAuthentication

路径参数

checkID

必填

字符串

检查ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

检查更新以应用

描述	字符串
名称	字符串
状态	字符串枚举： "active" "inactive"

响应

请求示例

Payload

Content type

application/json

{"description": "string",
"name": "string",
"status": "active"
}

响应示例

200
404
default

Content type

application/json

Example

{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"lastRunError": "string",
"lastRunStatus": "failed",
"latestCompleted": "2019-08-24T14:15:22Z",
"links": {"labels": "/api/v2/checks/1/labels",
"members": "/api/v2/checks/1/members",
"owners": "/api/v2/checks/1/owners",
"query": "/api/v2/checks/1/query",
"self": "/api/v2/checks/1"
},
"name": "string",
"orgID": "string",
"ownerID": "string",
"query": {"builderConfig": {"aggregateWindow": {"fillValues": true,
"period": "string"
},
"buckets": ["string"
],
"functions": [{"name": "string"
}
],
"tags": [{"aggregateFunctionType": "filter",
"key": "string",
"values": ["string"
]
}
]
},
"editMode": "builder",
"name": "string",
"text": "string"
},
"status": "active",
"taskID": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"type": "custom"
}

更新检查

授权：

TokenAuthentication

路径参数

checkID

必填

字符串

检查ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

检查更新以应用

描述	字符串检查的可选描述。
	数组对象（标签）
名称必需	字符串
orgID 必填	字符串拥有此检查的组织的ID。
必需	对象 (DashboardQuery)
状态	字符串 (TaskStatusType) 枚举： "active" "inactive" `inactive` 取消计划运行并防止手动运行任务。
任务ID	字符串与此检查相关的任务的ID。
类型必需	字符串自定义后置检查检查阈值死亡信号自定义

响应

请求示例

Payload

Content type

application/json

Example

{"description": "string",
"labels": [{"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"name": "string",
"orgID": "string",
"query": {"builderConfig": {"aggregateWindow": {"fillValues": true,
"period": "string"
},
"buckets": ["string"
],
"functions": [{"name": "string"
}
],
"tags": [{"aggregateFunctionType": "filter",
"key": "string",
"values": ["string"
]
}
]
},
"editMode": "builder",
"name": "string",
"text": "string"
},
"status": "active",
"taskID": "string",
"type": "custom"
}

响应示例

200
404
default

Content type

application/json

Example

{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"lastRunError": "string",
"lastRunStatus": "failed",
"latestCompleted": "2019-08-24T14:15:22Z",
"links": {"labels": "/api/v2/checks/1/labels",
"members": "/api/v2/checks/1/members",
"owners": "/api/v2/checks/1/owners",
"query": "/api/v2/checks/1/query",
"self": "/api/v2/checks/1"
},
"name": "string",
"orgID": "string",
"ownerID": "string",
"query": {"builderConfig": {"aggregateWindow": {"fillValues": true,
"period": "string"
},
"buckets": ["string"
],
"functions": [{"name": "string"
}
],
"tags": [{"aggregateFunctionType": "filter",
"key": "string",
"values": ["string"
]
}
]
},
"editMode": "builder",
"name": "string",
"text": "string"
},
"status": "active",
"taskID": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"type": "custom"
}

列出检查的所有标签

授权：

TokenAuthentication

路径参数

checkID

必填

字符串

检查ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
default

Content type

application/json

{"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"next": "http://example.com",
"prev": "http://example.com",
"self": "http://example.com"
}
}

为复选框添加标签

授权：

TokenAuthentication

路径参数

checkID

必填

字符串

检查ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

要添加的标签

labelID

必填

字符串

标签ID。指定要附加的标签。

响应

请求示例

Payload

Content type

application/json

{"labelID": "string"
}

响应示例

201
default

Content type

application/json

{"label": {"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
},
"links": {"next": "http://example.com",
"prev": "http://example.com",
"self": "http://example.com"
}
}

从检查中删除标签

授权：

TokenAuthentication

路径参数

checkID 必填	字符串检查ID。
labelID 必填	字符串要删除的标签的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

404
default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

检索检查查询

授权：

TokenAuthentication

路径参数

checkID

必填

字符串

检查ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
400
404
default

Content type

application/json

{"flux": "string"
}

配置

获取特征标志

检索为 InfluxDB 实例配置的特性标志键值对。 特性标志 是用于开发和测试实验性 InfluxDB 功能的配置选项，仅供内部使用。

此端点代表配置特性标志的以下三步过程中的第一步：

使用 token authentication 或 user session 与此端点来检索功能标志及其值。
遵循说明启用、禁用或覆盖功能标志的值。
可选: 要确认您的更改已应用，请执行以下操作之一：
- 向此端点发送请求以检索当前功能标志值。
- 发送请求到GET /api/v2/config端点以获取当前运行时服务器配置。

InfluxDB configuration options

授权：

TokenAuthentication

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
401
500
default

Content type

application/json

{ }

仪表板

查看仪表板

列出仪表盘。

Manage dashboards.

授权：

TokenAuthentication

查询参数

降序	布尔值默认: false
id	字符串的数组仪表板ID的列表。仅返回指定的 dashboards。如果您指定 `id` 和 `owner`，则仅使用 `id`。
限制	整数 [ -1 .. 100 ] 默认: 20 返回的仪表板的最大数量。默认是 `20`。最小值是 `-1`，最大值是 `100`。
偏移量	整数 >= 0 分页的偏移量。要跳过的记录数。有关分页参数的更多信息，请参见分页。
组织	字符串一个组织名称。只返回属于指定的 dashboard 的组织。
orgID	字符串组织 ID。仅返回属于指定的 organization 的dashboards。
所有者	字符串用户 ID。仅返回指定用户具有 dashboards 的 `owner` 角色的结果。
sortBy	string 枚举: "ID" "CreatedAt" "UpdatedAt" 要排序的列。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
default

Content type

application/json

{"dashboards": [{"description": "string",
"name": "string",
"orgID": "string",
"cells": [{"h": 0,
"id": "string",
"links": {"self": "string",
"view": "string"
},
"viewID": "string",
"w": 0,
"x": 0,
"y": 0
}
],
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"cells": "/api/v2/dashboards/1/cells",
"labels": "/api/v2/dashboards/1/labels",
"members": "/api/v2/dashboards/1/members",
"org": "/api/v2/labels/1",
"owners": "/api/v2/dashboards/1/owners",
"self": "/api/v2/dashboards/1"
},
"meta": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
],
"links": {"next": "http://example.com",
"prev": "http://example.com",
"self": "http://example.com"
}
}

创建仪表板

授权：

TokenAuthentication

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

创建仪表板

描述	字符串仪表盘面向用户的描述。
名称必填	字符串仪表板的用户可见名称。
orgID 必填	string 拥有仪表板的组织的ID。

响应

请求示例

Payload

Content type

application/json

{"description": "string",
"name": "string",
"orgID": "string"
}

响应示例

201
default

Content type

application/json

Example

{"description": "string",
"name": "string",
"orgID": "string",
"cells": [{"h": 0,
"id": "string",
"links": {"self": "string",
"view": "string"
},
"viewID": "string",
"w": 0,
"x": 0,
"y": 0
}
],
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"cells": "/api/v2/dashboards/1/cells",
"labels": "/api/v2/dashboards/1/labels",
"members": "/api/v2/dashboards/1/members",
"org": "/api/v2/labels/1",
"owners": "/api/v2/dashboards/1/owners",
"self": "/api/v2/dashboards/1"
},
"meta": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}

删除仪表板

授权：

TokenAuthentication

路径参数

dashboardID

必填

字符串

要更新的仪表板的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

404
default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

获取仪表板

授权：

TokenAuthentication

路径参数

dashboardID

必填

字符串

要更新的仪表板的ID。

查询参数

包含	字符串值: "properties" 如果 `properties`，则在响应中包含单元格视图属性。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
404
default

Content type

application/json

Example

{"description": "string",
"name": "string",
"orgID": "string",
"cells": [{"h": 0,
"id": "string",
"links": {"self": "string",
"view": "string"
},
"viewID": "string",
"w": 0,
"x": 0,
"y": 0
}
],
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"cells": "/api/v2/dashboards/1/cells",
"labels": "/api/v2/dashboards/1/labels",
"members": "/api/v2/dashboards/1/members",
"org": "/api/v2/labels/1",
"owners": "/api/v2/dashboards/1/owners",
"self": "/api/v2/dashboards/1"
},
"meta": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}

更新仪表板

授权：

TokenAuthentication

路径参数

dashboardID

必填

字符串

要更新的仪表板的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

仪表板的修补

	对象 (架构)
描述	字符串可选，当提供时将替换描述
名称	字符串可选，当提供时将替换名称

响应

请求示例

Payload

Content type

application/json

{"cells": {"h": 0,
"id": "string",
"links": {"self": "string",
"view": "string"
},
"viewID": "string",
"w": 0,
"x": 0,
"y": 0,
"name": "string",
"properties": {"adaptiveZoomHide": true,
"axes": {"x": {"base": "",
"bounds": ["string"
],
"label": "string",
"prefix": "string",
"scale": "log",
"suffix": "string"
},
"y": {"base": "",
"bounds": ["string"
],
"label": "string",
"prefix": "string",
"scale": "log",
"suffix": "string"
}
},
"colors": [{"hex": "strings",
"id": "string",
"name": "string",
"type": "min",
"value": 0
}
],
"decimalPlaces": {"digits": 0,
"isEnforced": true
},
"generateXAxisTicks": ["string"
],
"generateYAxisTicks": ["string"
],
"hoverDimension": "auto",
"legendColorizeRows": true,
"legendHide": true,
"legendOpacity": 0,
"legendOrientationThreshold": 0,
"note": "string",
"position": "overlaid",
"prefix": "string",
"queries": [{"builderConfig": {"aggregateWindow": {"fillValues": true,
"period": "string"
},
"buckets": ["string"
],
"functions": [{"name": "string"
}
],
"tags": [{"aggregateFunctionType": "filter",
"key": "string",
"values": ["string"
]
}
]
},
"editMode": "builder",
"name": "string",
"text": "string"
}
],
"shadeBelow": true,
"shape": "chronograf-v2",
"showNoteWhenEmpty": true,
"staticLegend": {"colorizeRows": true,
"heightRatio": 0,
"opacity": 0,
"orientationThreshold": 0,
"show": true,
"valueAxis": "string",
"widthRatio": 0
},
"suffix": "string",
"timeFormat": "string",
"type": "line-plus-single-stat",
"xColumn": "string",
"xTickStart": 0,
"xTickStep": 0,
"xTotalTicks": 0,
"yColumn": "string",
"yTickStart": 0,
"yTickStep": 0,
"yTotalTicks": 0
}
},
"description": "string",
"name": "string"
}

响应示例

200
404
default

Content type

application/json

{"description": "string",
"name": "string",
"orgID": "string",
"cells": [{"h": 0,
"id": "string",
"links": {"self": "string",
"view": "string"
},
"viewID": "string",
"w": 0,
"x": 0,
"y": 0
}
],
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"cells": "/api/v2/dashboards/1/cells",
"labels": "/api/v2/dashboards/1/labels",
"members": "/api/v2/dashboards/1/members",
"org": "/api/v2/labels/1",
"owners": "/api/v2/dashboards/1/owners",
"self": "/api/v2/dashboards/1"
},
"meta": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}

创建一个仪表板单元

授权：

TokenAuthentication

路径参数

dashboardID

必填

字符串

要更新的仪表板的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

将要添加的单元格

h	整数 <int32>
名称	字符串
usingView	string 生成所提供视图的副本。
w	整数 <int32>
x	整数 <int32>
y	整数 <int32>

响应

请求示例

Payload

Content type

application/json

{"h": 0,
"name": "string",
"usingView": "string",
"w": 0,
"x": 0,
"y": 0
}

响应示例

201
404
default

Content type

application/json

{"h": 0,
"id": "string",
"links": {"self": "string",
"view": "string"
},
"viewID": "string",
"w": 0,
"x": 0,
"y": 0
}

在仪表板中替换单元格

替换仪表板中的所有单元格。主要用于更新所有单元格的位置实信息。

授权：

TokenAuthentication

路径参数

dashboardID

必填

字符串

要更新的仪表板的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

Array ()

h	整数 <int32>
身份证	字符串
	对象
视图ID	字符串对视图API中的视图的引用。
w	整数 <int32>
x	整数 <int32>
y	整数 <int32>

响应

请求示例

Payload

Content type

application/json

[{"h": 0,
"id": "string",
"links": {"self": "string",
"view": "string"
},
"viewID": "string",
"w": 0,
"x": 0,
"y": 0
}
]

响应示例

201
404
default

Content type

application/json

{"description": "string",
"name": "string",
"orgID": "string",
"cells": [{"h": 0,
"id": "string",
"links": {"self": "string",
"view": "string"
},
"viewID": "string",
"w": 0,
"x": 0,
"y": 0
}
],
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"cells": "/api/v2/dashboards/1/cells",
"labels": "/api/v2/dashboards/1/labels",
"members": "/api/v2/dashboards/1/members",
"org": "/api/v2/labels/1",
"owners": "/api/v2/dashboards/1/owners",
"self": "/api/v2/dashboards/1"
},
"meta": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}

删除一个仪表板单元格

授权：

TokenAuthentication

路径参数

单元格ID 必需	字符串要删除的单元格的ID。
dashboardID 必填	字符串要删除的仪表板的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

404
default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

更新与单元格相关的非位置性信息

更新与单元格相关的非位置性信息。对单个单元格的位置信息进行更新可能会导致网格冲突。

授权：

TokenAuthentication

路径参数

cellID 必填	字符串要更新的单元格的ID。
dashboardID 必填	字符串要更新的仪表板的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

h	整数 <int32>
w	整数 <int32>
x	整数 <int32>
y	整数 <int32>

响应

请求示例

Payload

Content type

application/json

{"h": 0,
"w": 0,
"x": 0,
"y": 0
}

响应示例

200
404
default

Content type

application/json

{"h": 0,
"id": "string",
"links": {"self": "string",
"view": "string"
},
"viewID": "string",
"w": 0,
"x": 0,
"y": 0
}

获取单元格的视图

授权：

TokenAuthentication

路径参数

单元格ID 必需	字符串单元格的ID。
dashboardID 必需	字符串仪表板 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
404
default

Content type

application/json

{"id": "string",
"links": {"self": "string"
},
"name": "string",
"properties": {"adaptiveZoomHide": true,
"axes": {"x": {"base": "",
"bounds": ["string"
],
"label": "string",
"prefix": "string",
"scale": "log",
"suffix": "string"
},
"y": {"base": "",
"bounds": ["string"
],
"label": "string",
"prefix": "string",
"scale": "log",
"suffix": "string"
}
},
"colors": [{"hex": "strings",
"id": "string",
"name": "string",
"type": "min",
"value": 0
}
],
"decimalPlaces": {"digits": 0,
"isEnforced": true
},
"generateXAxisTicks": ["string"
],
"generateYAxisTicks": ["string"
],
"hoverDimension": "auto",
"legendColorizeRows": true,
"legendHide": true,
"legendOpacity": 0,
"legendOrientationThreshold": 0,
"note": "string",
"position": "overlaid",
"prefix": "string",
"queries": [{"builderConfig": {"aggregateWindow": {"fillValues": true,
"period": "string"
},
"buckets": ["string"
],
"functions": [{"name": "string"
}
],
"tags": [{"aggregateFunctionType": "filter",
"key": "string",
"values": ["string"
]
}
]
},
"editMode": "builder",
"name": "string",
"text": "string"
}
],
"shadeBelow": true,
"shape": "chronograf-v2",
"showNoteWhenEmpty": true,
"staticLegend": {"colorizeRows": true,
"heightRatio": 0,
"opacity": 0,
"orientationThreshold": 0,
"show": true,
"valueAxis": "string",
"widthRatio": 0
},
"suffix": "string",
"timeFormat": "string",
"type": "line-plus-single-stat",
"xColumn": "string",
"xTickStart": 0,
"xTickStep": 0,
"xTotalTicks": 0,
"yColumn": "string",
"yTickStart": 0,
"yTickStep": 0,
"yTotalTicks": 0
}
}

更新单元格的视图

授权：

TokenAuthentication

路径参数

cellID 必填	字符串要更新的单元格的ID。
dashboardID 必填	字符串要更新的仪表板的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

名称

必需

字符串

必需

LinePlusSingleStatProperties (object) 或 XYViewProperties (object) 或 SingleStatViewProperties (object) 或 HistogramViewProperties (object) 或 GaugeViewProperties (object) 或 TableViewProperties (object) 或 SimpleTableViewProperties (object) 或 MarkdownViewProperties (object) 或 CheckViewProperties (object) 或 ScatterViewProperties (object) 或 HeatmapViewProperties (object) 或 MosaicViewProperties (object) 或 BandViewProperties (object) 或 GeoViewProperties (object) (ViewProperties)

响应

请求示例

Payload

Content type

application/json

{"name": "string",
"properties": {"adaptiveZoomHide": true,
"axes": {"x": {"base": "",
"bounds": ["string"
],
"label": "string",
"prefix": "string",
"scale": "log",
"suffix": "string"
},
"y": {"base": "",
"bounds": ["string"
],
"label": "string",
"prefix": "string",
"scale": "log",
"suffix": "string"
}
},
"colors": [{"hex": "strings",
"id": "string",
"name": "string",
"type": "min",
"value": 0
}
],
"decimalPlaces": {"digits": 0,
"isEnforced": true
},
"generateXAxisTicks": ["string"
],
"generateYAxisTicks": ["string"
],
"hoverDimension": "auto",
"legendColorizeRows": true,
"legendHide": true,
"legendOpacity": 0,
"legendOrientationThreshold": 0,
"note": "string",
"position": "overlaid",
"prefix": "string",
"queries": [{"builderConfig": {"aggregateWindow": {"fillValues": true,
"period": "string"
},
"buckets": ["string"
],
"functions": [{"name": "string"
}
],
"tags": [{"aggregateFunctionType": "filter",
"key": "string",
"values": ["string"
]
}
]
},
"editMode": "builder",
"name": "string",
"text": "string"
}
],
"shadeBelow": true,
"shape": "chronograf-v2",
"showNoteWhenEmpty": true,
"staticLegend": {"colorizeRows": true,
"heightRatio": 0,
"opacity": 0,
"orientationThreshold": 0,
"show": true,
"valueAxis": "string",
"widthRatio": 0
},
"suffix": "string",
"timeFormat": "string",
"type": "line-plus-single-stat",
"xColumn": "string",
"xTickStart": 0,
"xTickStep": 0,
"xTotalTicks": 0,
"yColumn": "string",
"yTickStart": 0,
"yTickStep": 0,
"yTotalTicks": 0
}
}

响应示例

200
404
default

Content type

application/json

{"id": "string",
"links": {"self": "string"
},
"name": "string",
"properties": {"adaptiveZoomHide": true,
"axes": {"x": {"base": "",
"bounds": ["string"
],
"label": "string",
"prefix": "string",
"scale": "log",
"suffix": "string"
},
"y": {"base": "",
"bounds": ["string"
],
"label": "string",
"prefix": "string",
"scale": "log",
"suffix": "string"
}
},
"colors": [{"hex": "strings",
"id": "string",
"name": "string",
"type": "min",
"value": 0
}
],
"decimalPlaces": {"digits": 0,
"isEnforced": true
},
"generateXAxisTicks": ["string"
],
"generateYAxisTicks": ["string"
],
"hoverDimension": "auto",
"legendColorizeRows": true,
"legendHide": true,
"legendOpacity": 0,
"legendOrientationThreshold": 0,
"note": "string",
"position": "overlaid",
"prefix": "string",
"queries": [{"builderConfig": {"aggregateWindow": {"fillValues": true,
"period": "string"
},
"buckets": ["string"
],
"functions": [{"name": "string"
}
],
"tags": [{"aggregateFunctionType": "filter",
"key": "string",
"values": ["string"
]
}
]
},
"editMode": "builder",
"name": "string",
"text": "string"
}
],
"shadeBelow": true,
"shape": "chronograf-v2",
"showNoteWhenEmpty": true,
"staticLegend": {"colorizeRows": true,
"heightRatio": 0,
"opacity": 0,
"orientationThreshold": 0,
"show": true,
"valueAxis": "string",
"widthRatio": 0
},
"suffix": "string",
"timeFormat": "string",
"type": "line-plus-single-stat",
"xColumn": "string",
"xTickStart": 0,
"xTickStep": 0,
"xTotalTicks": 0,
"yColumn": "string",
"yTickStart": 0,
"yTickStep": 0,
"yTotalTicks": 0
}
}

列出仪表板的所有标签

授权：

TokenAuthentication

路径参数

dashboardID

必需

字符串

仪表板 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
default

Content type

application/json

{"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"next": "http://example.com",
"prev": "http://example.com",
"self": "http://example.com"
}
}

向仪表板添加标签

授权：

TokenAuthentication

路径参数

dashboardID

必需

字符串

仪表板 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

要添加的标签

labelID

必填

字符串

标签ID。指定要附加的标签。

响应

请求示例

Payload

Content type

application/json

{"labelID": "string"
}

响应示例

201
default

Content type

application/json

{"label": {"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
},
"links": {"next": "http://example.com",
"prev": "http://example.com",
"self": "http://example.com"
}
}

从仪表板中删除标签

授权：

TokenAuthentication

路径参数

dashboardID 必需	字符串仪表板 ID。
labelID 必填	字符串要删除的标签的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

404
default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

列出所有仪表板成员

授权：

TokenAuthentication

路径参数

dashboardID

必需

字符串

仪表板 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"links": {"self": "/api/v2/users/1"
},
"name": "string",
"status": "active",
"role": "member"
}
]
}

将成员添加到仪表板

授权：

TokenAuthentication

路径参数

dashboardID

必需

字符串

仪表板 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

用户添加为成员

id 必需	字符串要添加到资源的用户ID。
姓名	字符串要添加到资源中的用户姓名。

响应

请求示例

Payload

Content type

application/json

{"id": "string",
"name": "string"
}

响应示例

201
default

Content type

application/json

{"id": "string",
"links": {"self": "/api/v2/users/1"
},
"name": "string",
"status": "active",
"role": "member"
}

从仪表板中移除成员

授权：

TokenAuthentication

路径参数

dashboardID 必需	字符串仪表板 ID。
用户ID 必需	字符串要移除的成员的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

列出所有仪表板拥有者

授权：

TokenAuthentication

路径参数

dashboardID

必需

字符串

仪表板 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"links": {"self": "/api/v2/users/1"
},
"name": "string",
"status": "active",
"role": "owner"
}
]
}

将所有者添加到仪表板

授权：

TokenAuthentication

路径参数

dashboardID

必需

字符串

仪表板 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

用户添加为所有者

id 必需	字符串要添加到资源的用户ID。
姓名	字符串要添加到资源中的用户姓名。

响应

请求示例

Payload

Content type

application/json

{"id": "string",
"name": "string"
}

响应示例

201
default

Content type

application/json

{"id": "string",
"links": {"self": "/api/v2/users/1"
},
"name": "string",
"status": "active",
"role": "owner"
}

从仪表板中移除一个所有者

授权：

TokenAuthentication

路径参数

dashboardID 必需	字符串仪表板 ID。
用户ID 必需	字符串要移除的所有者的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

数据库资源计划系统

InfluxDB 1.x 数据模型包括 databases 和 retention policies。InfluxDB 2.x 用 buckets 替代了数据库和保留策略。为了在 InfluxDB 2.x 中支持 InfluxDB 1.x 查询和写入模式，数据库和保留策略通过数据库和保留策略 (DBRP) 映射服务映射到 buckets。DBRP 映射服务使用在 1.x 兼容 API 请求中指定的数据库和保留策略来将操作路由到一个 bucket。

Database and retention policy mapping

列出数据库保留策略映射

列出数据库保留策略 (DBRP) 映射。

Database and retention policy mapping

授权：

TokenAuthentication

查询参数

bucketID	string 一个桶ID。仅返回属于指定桶的DBRP映射。
数据库	字符串一个数据库。只有返回属于1.x数据库的DBRP映射。
默认	布尔值指定默认的过滤
id	string 一个 DBPR 映射 ID。仅返回指定的 DBRP 映射。
组织	字符串一个组织名称。仅返回指定组织的DBRP映射。
orgID	字符串组织 ID。仅返回指定组织的 DBRP 映射。
rp	字符串一个保留策略。指定要过滤的1.x保留策略。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
400
401
500
default

Content type

application/json

{"content": [{"bucketID": "4d4d9d5b61dee751",
"database": "example_database_1",
"default": true,
"id": "0a3cbb5dd526a000",
"orgID": "bea7ea952287f70d",
"retention_policy": "autogen"
},
{"bucketID": "4d4d9d5b61dee751",
"database": "example_database_2",
"default": false,
"id": "0a3cbcde20e38000",
"orgID": "bea7ea952287f70d",
"retention_policy": "example_retention_policy"
}
]
}

添加数据库保留策略映射

创建一个数据库保留策略 (DBRP) 映射并返回该映射。

使用此端点将 InfluxDB 1.x API 兼容性添加到您的 InfluxDB Cloud 或 InfluxDB OSS 2.x 存储桶中。您的存储桶必须包含 DBRP 映射才能使用 InfluxDB 1.x API 进行查询和写入。

Database and retention policy mapping

授权：

TokenAuthentication

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

要添加的数据库保留策略映射。

请注意，retention_policy 是请求体中的必需参数。 retention_policy 的值可以是任何任意的 string 名称或值，默认值通常设置为 autogen。 retention_policy 的值不是一个 retention_policy

bucketID 必填	字符串一个桶 ID。用于标识作为翻译目标的桶。
数据库必需	字符串一个数据库名称。标识InfluxDB v1数据库。
默认	布尔值设置为 `true` 以将此 DBRP 映射用作数据库的默认保留策略（由 `database` 属性的值指定）。
组织	字符串一个组织名称。标识拥有该映射的组织。
orgID	string 一个组织 ID。标识拥有该映射的组织。
保留策略必填	字符串一个保留策略名称。确定 InfluxDB v1 保留策略的映射。

响应

请求示例

Payload
cURL: create a database retention policy mapping

Content type

application/json

{"bucketID": "string",
"database": "string",
"default": true,
"org": "string",
"orgID": "string",
"retention_policy": "string"
}

响应示例

Content type

application/json

{"bucketID": "4d4d9d5b61dee751",
"database": "example_database",
"default": true,
"id": "0a3cbb5dd526a000",
"orgID": "bea7ea952287f70d",
"retention_policy": "autogen"
}

删除数据库保留策略

删除指定的数据库保留策略（DBRP）映射。

Database and retention policy mapping

授权：

TokenAuthentication

路径参数

dbrpID

必填

字符串

一个 DBRP 映射 ID。仅返回指定的 DBRP 映射。

查询参数

org	string 一个组织名称。指定拥有DBRP映射的组织。
orgID	字符串一个组织的 ID。指定拥有 DBRP 映射的组织。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

400
401
404
500
default

Content type

application/json

查询参数包含无效值。

{"code": "invalid",
"message": "invalid ID"
}

检索数据库保留策略映射

检索指定的保留策略 (DBRP) 映射。

Database and retention policy mapping

授权：

TokenAuthentication

路径参数

dbrpID

必填

字符串

一个 DBRP 映射 ID。指定 DBRP 映射。

查询参数

org	string 一个组织名称。指定拥有DBRP映射的组织。
orgID	字符串一个组织的 ID。指定拥有 DBRP 映射的组织。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

Content type

application/json

{"content": {"bucketID": "4d4d9d5b61dee751",
"database": "example_database_1",
"default": true,
"id": "0a3cbb5dd526a000",
"orgID": "bea7ea952287f70d",
"retention_policy": "autogen"
}
}

更新数据库保留策略映射

授权：

TokenAuthentication

路径参数

dbrpID

必填

字符串

一个 DBRP 映射 ID。指定 DBRP 映射。

查询参数

org	string 一个组织名称。指定拥有DBRP映射的组织。
orgID	字符串一个组织的 ID。指定拥有 DBRP 映射的组织。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

更新数据库保留策略 (DBRP) 映射并返回该映射。

使用此端点修改 保留策略 (retention_policy 属性) 的 DBRP 映射。

Database and retention policy mapping

默认	布尔值设置为 `true` 以将此 DBRP 映射用作数据库的默认保留策略（由 `database` 属性的值指定）。要移除默认映射，请设置为 `false`。
retention_policy	string 一个 retention policy 名称。标识 InfluxDB v1 保留策略映射。

响应

请求示例

Payload
cURL: Update a DBRP mapping

Content type

application/json

{"default": true,
"retention_policy": "string"
}

响应示例

Content type

application/json

{"content": {"bucketID": "4d4d9d5b61dee751",
"database": "example_database",
"default": false,
"id": "0a3cbb5dd526a000",
"orgID": "bea7ea952287f70d",
"retention_policy": "example_retention_policy"
}
}

删除

从InfluxDB桶中删除数据。

删除数据

从存储桶中删除数据。

使用此端点在指定时间范围内从存储桶中删除点。

InfluxDB云

当你发送删除请求时，会执行以下操作：
1. Validates the request and queues the delete.
2. If queued, responds with success (HTTP 2xx status code); error otherwise.
3. Handles the delete asynchronously and reaches eventual consistency.

为了确保 InfluxDB Cloud 按照您请求的顺序处理写入和删除，请在发送下一个请求之前等待成功响应（HTTP 2xx 状态码）。

因为写入和删除是异步的，当您收到响应时，您的更改可能尚不可读。

InfluxDB OSS

Validates the request, handles the delete synchronously, and then responds with success or failure.

所需权限

write-buckets or write-bucket BUCKET_ID.

BUCKET_ID 是目标桶的ID。

速率限制（使用InfluxDB Cloud）

write 速率限制适用。有关更多信息，请参见 limits and adjustable quotas。

Delete data
Learn how to use delete predicate syntax.
Learn how InfluxDB handles deleted tags and deleted fields.

授权：

TokenAuthentication

查询参数

桶	字符串桶名称或ID。指定要删除数据的桶。如果同时传递 `bucket` 和 `bucketID`，`bucketID` 优先。
bucketID	string 一个桶的ID。指定要删除数据的桶。如果同时传递 `bucket` 和 `bucketID`，`bucketID` 将优先考虑。
org	string 组织名称或ID。 InfluxDB Cloud 不使用 `org` 参数或 `orgID` 参数。删除与授权（API令牌）关联的组织中的存储桶数据。 InfluxDB OSS 要求必须使用 `org` 参数或 `orgID` 参数。从指定组织中的存储桶删除数据。如果同时传递 `orgID` 和 `org`，则两者都必须有效。
orgID	string 组织 ID。 InfluxDB Cloud 不使用 `org` 参数或 `orgID` 参数。从与授权（API 令牌）相关联的组织中的桶中删除数据。 InfluxDB OSS 需要 `org` 参数或 `orgID` 参数。从指定组织的桶中删除数据。如果同时传递 `orgID` 和 `org`，它们必须都是有效的。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

时间范围参数和一个可选的 删除谓词表达式。

要选择在指定时间范围内删除的点，请在请求主体的 删除谓词表达式 的 predicate 属性中传递一个。如果不传递 predicate，InfluxDB 将删除指定时间范围内所有带有时间戳的数据。

Delete data
Learn how to use delete predicate syntax.

谓词	字符串在删除谓词语法中的表达式。
开始必填	字符串 <date-time> 一个时间戳（RFC3339 日期/时间格式）。删除的最早时间。
停止必需	字符串 <日期-时间> 一个时间戳（RFC3339 日期/时间格式）。可删除的最晚时间。

响应

请求示例

Payload
cURL

Content type

application/json

{"predicate": "tag1=\"value1\" and (tag2=\"value2\" and tag3!=\"value3\")",
"start": "2019-08-24T14:15:22Z",
"stop": "2019-08-24T14:15:22Z"
}

响应示例

400
401
404
500
default

Content type

application/json

{"code": "invalid",
"message": "failed to decode request body: organization not found"
}

可调用脚本

在 InfluxDB 中存储、管理和执行脚本。
脚本存储您的自定义 Flux 脚本并提供一个可调用的
端点，该端点接受运行时参数。
在脚本中，您可以指定自定义运行时参数
(params)——例如，params.myparameter。
一旦您创建了脚本，InfluxDB 将为您的组织生成一个
/api/v2/scripts/SCRIPT_ID/invoke 端点。
您可以从 API 请求和任务运行该脚本，为每次运行定义参数值。
当脚本运行时，InfluxDB 会用您定义的运行时参数值替换脚本中的 params 引用。

使用 /api/v2/scripts 端点来创建和管理脚本。参阅相关指南以了解如何定义参数和执行脚本。

Invoke custom scripts from API requests.
Create a task that references a script

脚本列表

列出 scripts.

Invoke custom scripts

授权：

TokenAuthentication

查询参数

限制	整数 [ 0 .. 500 ] 默认: 100 返回的脚本的最大数量。默认值是 `100`。
名称	字符串脚本名称。列出具有指定名称的脚本。
偏移量	整数 >= 0 分页的偏移量。要跳过的记录数。有关分页参数的更多信息，请参见分页。

响应

请求示例

cURL: retrieves the first 100 scripts.

curl --request GET "INFLUX_URL/api/v2/scripts?limit=100&offset=0" \
  --header "Authorization: Token INFLUX_API_TOKEN" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json"

响应示例

200
400
401
500
default

Content type

application/json

{"scripts": [{"createdAt": "2022-07-17T23:49:45.731237Z",
"description": "find the last point from Sample Bucket",
"id": "09afa3b220fe4000",
"language": "flux",
"name": "getLastPointFromSampleBucket",
"orgID": "bea7ea952287f70d",
"script": "from(bucket: SampleBucket) |> range(start: -7d) |> limit(n:1)",
"updatedAt": "2022-07-17T23:49:45.731237Z"
},
{"createdAt": "2022-07-17T23:43:26.660308Z",
"description": "getLastPoint finds the last point in a bucket",
"id": "09afa23ff13e4000",
"language": "flux",
"name": "getLastPoint",
"orgID": "bea7ea952287f70d",
"script": "from(bucket: params.mybucket) |> range(start: -7d) |> limit(n:1)",
"updatedAt": "2022-07-17T23:43:26.660308Z"
}
]
}

创建脚本

创建一个可调用脚本并返回该脚本。

授权：

TokenAuthentication

请求体模式: application/json

创建脚本。

描述必需	字符串脚本描述。脚本的描述。
语言必需	字符串 (ScriptLanguage) 枚举: "flux" "sql"
名称必需	字符串脚本名称。名称在组织内必须唯一。
脚本必填	字符串要执行的脚本。

响应

请求示例

Payload
cURL

Content type

application/json

{"description": "string",
"language": "flux",
"name": "string",
"script": "string"
}

响应示例

Content type

application/json

{"createdAt": "2022-07-17T23:43:26.660308Z",
"description": "getLastPoint finds the last point in a bucket",
"id": "09afa23ff13e4000",
"language": "flux",
"name": "getLastPoint",
"orgID": "bea7ea952287f70d",
"script": "from(bucket: params.mybucket) |> range(start: -7d) |> limit(n:1)",
"updatedAt": "2022-07-17T23:43:26.660308Z"
}

删除一个脚本

删除一个 script 及所有相关记录。

限制

You can delete only one script per request.
If the script ID you provide doesn't exist for the organization, InfluxDB responds with an HTTP 204 status code.

Invoke custom scripts

授权：

TokenAuthentication

路径参数

scriptID

必需

字符串

一个脚本ID。
删除指定的脚本。

响应

请求示例

cURL

curl -X 'DELETE' \
  "https://cloud2.influxdata.com/api/v2/scripts/SCRIPT_ID" \
  --header "Authorization: Token INFLUX_TOKEN" \
  --header 'Accept: application/json'

响应示例

401
500
default

Content type

application/json

{"code": "unauthorized",
"message": "unauthorized access"
}

获取脚本

检索一个 script。

Invoke custom scripts

授权：

TokenAuthentication

路径参数

脚本ID

必填

字符串

一个脚本的ID。检索指定的脚本。

响应

响应示例

200
401
404
500
default

Content type

application/json

{"createdAt": "2022-07-17T23:49:45.731237Z",
"description": "getLastPoint finds the last point in a bucket",
"id": "09afa3b220fe4000",
"language": "flux",
"name": "getLastPoint",
"orgID": "bea7ea952287f70d",
"script": "from(bucket: my-bucket) |> range(start: -7d) |> limit(n:1)",
"updatedAt": "2022-07-17T23:49:45.731237Z"
}

更新脚本

更新可调用的脚本。

使用此端点来修改脚本属性的值（description 和 script）。

要更新脚本，请传递一个包含更新后的键值对的对象。

限制

If you send an empty request body, the script will neither update nor store an empty script, but InfluxDB will respond with an HTTP 200 status code.

Invoke custom scripts

授权：

TokenAuthentication

路径参数

scriptID

必需

字符串

脚本 ID。
更新指定的脚本。

请求体模式: application/json

一个包含要应用的更新脚本属性的对象。

描述	字符串脚本的描述。
脚本	字符串要执行的脚本。

响应

请求示例

Payload
cURL

Content type

application/json

{"description": "string",
"script": "string"
}

响应示例

200
401
404
500
default

Content type

application/json

{"createdAt": "2022-07-17T23:49:45.731237Z",
"description": "get last point from new bucket",
"id": "09afa3b220fe4000",
"language": "flux",
"name": "getLastPoint",
"orgID": "bea7ea952287f70d",
"script": "from(bucket: newBucket) |> range(start: -7d) |> limit(n:1)",
"updatedAt": "2022-07-19T22:27:23.185436Z"
}

调用脚本

运行脚本并返回结果。当脚本运行时，InfluxDB 在脚本中引用的 params 键将被请求体中传递的 params 键值替换——例如：

以下示例脚本包含一个 mybucket 参数 :

"script": "from(bucket: params.mybucket)
            |> range(start: -7d)
            |> limit(n:1)"

以下示例 POST /api/v2/scripts/SCRIPT_ID/invoke 请求正文传递了 mybucket 参数的一个值：

{
  "params": {
    "mybucket": "air_sensor"
  }
}

Invoke custom scripts

授权：

TokenAuthentication

路径参数

scriptID

必填

字符串

一个脚本 ID。

运行指定的脚本。

请求体模式: application/json

对象

脚本参数。 params 包含将值映射到 params.keys 的键值对在脚本中。当你使用 params 调用脚本时，InfluxDB 会将值作为调用参数传递给脚本。

响应

请求示例

Payload
cURL

Content type

application/json

{"params": { }
}

响应示例

Content type

text/csv

,result,table,_start,_stop,_time,_value,_field,_measurement,host
,_result,0,2019-10-30T01:28:02.52716421Z,2022-07-26T01:28:02.52716421Z,2020-01-01T00:00:00Z,72.01,used_percent,mem,host2

查找脚本参数。

分析一个脚本并确定所需的参数。 params 中引用的所有键都会被找到并返回一个键的列表。如果可能的话，从上下文中确定值的类型，那么类型也会被返回——例如：

以下示例脚本包含一个 mybucket 参数 :

"script": "from(bucket: params.mybucket)
            |> range(start: -7d)
            |> limit(n:1)"

使用 GET /api/v2/scripts/SCRIPT_ID/params 请求参数返回以下内容：

{
  "params": {
    "mybucket": "string"
  }
}

返回参数的类型名称将是以下之一：

any
bool
duration
float
int
string
time
uint

类型名称 any 用于当参数的类型不能从上下文中确定，或者类型被确定为结构类型，例如数组或记录。

Invoke custom scripts

授权：

TokenAuthentication

路径参数

scriptID

必填

字符串

一个脚本ID。要分析参数的脚本。

响应

请求示例

cURL

curl --request GET "https://cloud2.influxdata.com/api/v2/scripts/SCRIPT_ID/params" \
          --header "Authorization: Token INFLUX_TOKEN"

响应示例

200
401
404
500
default

Content type

application/json

{"params": {"mybucket": "string"
}
}

遗留授权

列出所有遗留的授权

授权：

TokenAuthentication

查询参数

authID	字符串授权 ID。返回指定的旧版授权。
组织	字符串组织名称。仅返回属于指定的组织的遗留授权。
orgID	字符串一个组织 ID。仅返回属于指定的组织的遗留授权。
token	字符串一个授权名称令牌。仅返回具有指定名称的遗留授权。
用户	字符串用户名。仅返回作用域限于指定用户的旧版授权。
用户ID	字符串用户ID。仅返回特定用户范围内的遗留授权。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
default

Content type

application/json

{"authorizations": [{"description": "string",
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "/api/v2/authorizations/1",
"user": "/api/v2/users/12"
},
"org": "string",
"orgID": "string",
"permissions": [{"action": "read",
"resource": {"id": "string",
"name": "string",
"org": "string",
"orgID": "string",
"type": "authorizations"
}
}
],
"token": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"user": "string",
"userID": "string"
}
],
"links": {"next": "http://example.com",
"prev": "http://example.com",
"self": "http://example.com"
}
}

创建遗留授权

创建一个遗留授权并返回遗留授权。

所需权限

write-users USER_ID if you pass the userID property in the request body.

USER_ID 是您想要限制授权的用户的 ID。

授权：

TokenAuthentication

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

创建的遗留授权。

描述	字符串这是令牌的描述。
orgID 必填	字符串组织ID。标识授权所涉及的组织。
必需	对象的数组 (Permission) 非空提供对组织资源的`read`和`write`访问权限的权限列表。授权必须至少包含一个权限。
状态	字符串默认: "active" 枚举: "active" "inactive" 令牌的状态。如果 `inactive`，InfluxDB 将拒绝使用该令牌的请求。
token	string 您为授权提供的名称。
用户ID	字符串用户的ID。标识授权范围内的用户。

响应

请求示例

Payload

Content type

application/json

{"description": "string",
"status": "active",
"orgID": "string",
"permissions": [{"action": "read",
"resource": {"id": "string",
"name": "string",
"org": "string",
"orgID": "string",
"type": "authorizations"
}
}
],
"token": "string",
"userID": "string"
}

响应示例

201
400
401
default

Content type

application/json

{"description": "string",
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "/api/v2/authorizations/1",
"user": "/api/v2/users/12"
},
"org": "string",
"orgID": "string",
"permissions": [{"action": "read",
"resource": {"id": "string",
"name": "string",
"org": "string",
"orgID": "string",
"type": "authorizations"
}
}
],
"token": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"user": "string",
"userID": "string"
}

删除遗留授权

授权：

TokenAuthentication

路径参数

authID

必需

字符串

要删除的旧版授权的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

检索遗留授权

授权：

TokenAuthentication

路径参数

authID

必填

字符串

要获取的旧授权的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
default

Content type

application/json

{"description": "string",
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "/api/v2/authorizations/1",
"user": "/api/v2/users/12"
},
"org": "string",
"orgID": "string",
"permissions": [{"action": "read",
"resource": {"id": "string",
"name": "string",
"org": "string",
"orgID": "string",
"type": "authorizations"
}
}
],
"token": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"user": "string",
"userID": "string"
}

更新遗留授权为激活或不激活

授权：

TokenAuthentication

路径参数

authID

必填

字符串

要更新的旧版授权的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

遗留授权以更新

描述	字符串这是令牌的描述。
状态	字符串默认: "active" 枚举: "active" "inactive" 令牌的状态。如果 `inactive`，InfluxDB 将拒绝使用该令牌的请求。

响应

请求示例

Payload

Content type

application/json

{"description": "string",
"status": "active"
}

响应示例

200
default

Content type

application/json

{"description": "string",
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "/api/v2/authorizations/1",
"user": "/api/v2/users/12"
},
"org": "string",
"orgID": "string",
"permissions": [{"action": "read",
"resource": {"id": "string",
"name": "string",
"org": "string",
"orgID": "string",
"type": "authorizations"
}
}
],
"token": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"user": "string",
"userID": "string"
}

设置遗留授权密码

授权：

TokenAuthentication

路径参数

authID

必填

字符串

要更新的旧版授权的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

新密码

密码

必填

字符串

响应

请求示例

Payload

Content type

application/json

{"password": "string"
}

响应示例

default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

遗留查询

使用1.x兼容API查询

使用 InfluxQL 查询 InfluxDB。

授权：

TokenAuthentication

查询参数

db 必需	字符串要查询数据的数据库。这映射到一个 InfluxDB bucket。更多信息，请参见数据库和保留策略映射。
纪元	字符串枚举： "ns" "u" "µ" "ms" "s" "m" "h" Unix 时间戳精度。将时间戳格式化为 unix (纪元) 时间戳以指定的精度，而不是具有纳秒精度的 RFC3339 时间戳。
p	string 用于验证请求的 InfluxDB 1.x 密码。
q 必需	字符串要执行的InfluxQL查询。要执行多个查询，请用分号 (`;`) 分隔查询。
rp	字符串要查询数据的保留策略。这映射到一个 InfluxDB bucket。更多信息，请参见数据库和保留策略映射。
u	string 用来验证请求的 InfluxDB 1.x 用户名。

头部参数

接受	字符串默认: application/json 枚举: "application/json" "application/csv" "text/csv" "application/x-msgpack" 客户端可以理解的媒体类型。注意: 使用 `application/csv` 时，查询结果包含 unix 时间戳而不是 RFC3339 时间戳。
接收编码	字符串默认: 身份枚举: "gzip" "身份" 客户端可以理解的内容编码（通常是一种压缩算法）。
内容类型	字符串值： "application/json"
Zap-Trace-Span	字符串示例： baggage,[object Object],span_id,1,trace_id,1 OpenTracing span 上下文

响应

响应示例

200
default

Content type

No sample

旧版写入

以V1兼容格式将时间序列数据写入InfluxDB

授权：

TokenAuthentication

查询参数

db 必填	字符串要写入的存储桶。如果不存在，InfluxDB将创建一个默认保留策略为3天的存储桶。
p	string 用于验证请求的 InfluxDB 1.x 密码。
精度	字符串写入精度。
rp	字符串保留策略名称。
u	string 用来验证请求的 InfluxDB 1.x 用户名。

头部参数

内容编码	字符串默认: identity 枚举: "gzip" "identity" 当出现时，它的值向数据库指示压缩已应用于线协议主体。
Zap-Trace-Span	字符串示例： baggage,[object Object],span_id,1,trace_id,1 OpenTracing span 上下文

请求体架构: text/plain

行协议主体

string

响应

响应示例

400
401
403
413
default

Content type

application/json

{"code": "internal error",
"err": "string",
"line": 0,
"message": "string",
"op": "string"
}

限制

检索组织的限制

授权：

TokenAuthentication

路径参数

orgID

必填

字符串

组织的ID。

响应

响应示例

200
default

Content type

application/json

{"limits": {"bucket": {"maxBuckets": 0,
"maxRetentionDuration": 0
},
"check": {"maxChecks": 0
},
"dashboard": {"maxDashboards": 0
},
"features": {"allowDelete": true
},
"notificationEndpoint": {"blockedNotificationEndpoints": "http,pagerduty"
},
"notificationRule": {"blockedNotificationRules": "http,pagerduty",
"maxNotifications": 0
},
"orgID": "string",
"rate": {"cardinality": 0,
"concurrentDeleteRequests": 0,
"concurrentReadRequests": 0,
"concurrentWriteRequests": 0,
"deleteRequestsPerSecond": 0,
"queryTime": 0,
"readKBs": 0,
"writeKBs": 0
},
"stack": {"enabled": true
},
"task": {"maxTasks": 0
},
"timeout": {"queryUnconditionalTimeoutSeconds": 0,
"queryidleWriteTimeoutSeconds": 0
}
},
"links": {"next": "http://example.com",
"prev": "http://example.com",
"self": "http://example.com"
}
}

通知端点

列出所有通知端点

授权：

TokenAuthentication

查询参数

限制	整数 [ 1 .. 100 ] 默认: 20 限制返回的记录数量。默认值是 `20`。
偏移量	整数 >= 0 分页的偏移量。要跳过的记录数。有关分页参数的更多信息，请参见分页。
orgID 必填	字符串仅显示属于特定组织ID的通知端点。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
default

Content type

application/json

{"links": {"next": "http://example.com",
"prev": "http://example.com",
"self": "http://example.com"
},
"notificationEndpoints": [{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"labels": "/api/v2/notificationEndpoints/1/labels",
"members": "/api/v2/notificationEndpoints/1/members",
"owners": "/api/v2/notificationEndpoints/1/owners",
"self": "/api/v2/notificationEndpoints/1"
},
"name": "string",
"orgID": "string",
"status": "active",
"type": "slack",
"updatedAt": "2019-08-24T14:15:22Z",
"userID": "string",
"token": "string",
"url": "string"
}
]
}

添加通知端点

授权：

TokenAuthentication

请求体模式: application/json

通知端点以创建

authMethod 必需	字符串枚举： "none" "basic" "bearer"
内容模板	字符串
描述	字符串通知端点的可选描述。
	对象自定义头部。
身份证	字符串
	数组对象（标签）
方法必需	字符串枚举： "POST" "GET" "PUT"
名称必需	字符串
组织编号	字符串
密码	字符串
状态	字符串默认: "active" 枚举: "active" "inactive" 端点的状态。
令牌	字符串
类型必需	字符串 (NotificationEndpointType) http PostNotificationEndpoint NotificationEndpoint slack pagerduty http telegram
网址必填	字符串
用户ID	字符串
用户名	字符串

响应

请求示例

Payload

Content type

application/json

Example

{"description": "string",
"id": "string",
"labels": [{"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"name": "string",
"orgID": "string",
"status": "active",
"type": "http",
"userID": "string",
"authMethod": "none",
"contentTemplate": "string",
"headers": {"property1": "string",
"property2": "string"
},
"method": "POST",
"password": "string",
"token": "string",
"url": "string",
"username": "string"
}

响应示例

201
default

Content type

application/json

Example

{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"labels": "/api/v2/notificationEndpoints/1/labels",
"members": "/api/v2/notificationEndpoints/1/members",
"owners": "/api/v2/notificationEndpoints/1/owners",
"self": "/api/v2/notificationEndpoints/1"
},
"name": "string",
"orgID": "string",
"status": "active",
"type": "http",
"updatedAt": "2019-08-24T14:15:22Z",
"userID": "string",
"authMethod": "none",
"contentTemplate": "string",
"headers": {"property1": "string",
"property2": "string"
},
"method": "POST",
"password": "string",
"token": "string",
"url": "string",
"username": "string"
}

删除通知端点

授权：

TokenAuthentication

路径参数

endpointID

必需

字符串

通知端点的 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

404
default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

获取通知端点

授权：

TokenAuthentication

路径参数

endpointID

必需

字符串

通知端点的 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
default

Content type

application/json

Example

{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"labels": "/api/v2/notificationEndpoints/1/labels",
"members": "/api/v2/notificationEndpoints/1/members",
"owners": "/api/v2/notificationEndpoints/1/owners",
"self": "/api/v2/notificationEndpoints/1"
},
"name": "string",
"orgID": "string",
"status": "active",
"type": "http",
"updatedAt": "2019-08-24T14:15:22Z",
"userID": "string",
"authMethod": "none",
"contentTemplate": "string",
"headers": {"property1": "string",
"property2": "string"
},
"method": "POST",
"password": "string",
"token": "string",
"url": "string",
"username": "string"
}

更新通知端点

授权：

TokenAuthentication

路径参数

endpointID

必需

字符串

通知端点的 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

检查更新以应用

描述	字符串
名称	字符串
状态	字符串枚举： "active" "inactive"

响应

请求示例

Payload

Content type

application/json

{"description": "string",
"name": "string",
"status": "active"
}

响应示例

200
404
default

Content type

application/json

Example

{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"labels": "/api/v2/notificationEndpoints/1/labels",
"members": "/api/v2/notificationEndpoints/1/members",
"owners": "/api/v2/notificationEndpoints/1/owners",
"self": "/api/v2/notificationEndpoints/1"
},
"name": "string",
"orgID": "string",
"status": "active",
"type": "http",
"updatedAt": "2019-08-24T14:15:22Z",
"userID": "string",
"authMethod": "none",
"contentTemplate": "string",
"headers": {"property1": "string",
"property2": "string"
},
"method": "POST",
"password": "string",
"token": "string",
"url": "string",
"username": "string"
}

更新通知端点

授权：

TokenAuthentication

路径参数

endpointID

必需

字符串

通知端点的 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

一个新的通知端点来替换现有的端点

authMethod 必需	字符串枚举： "none" "basic" "bearer"
内容模板	字符串
描述	字符串通知端点的可选描述。
	对象自定义头部。
身份证	字符串
	数组对象（标签）
方法必需	字符串枚举： "POST" "GET" "PUT"
名称必需	字符串
组织编号	字符串
密码	字符串
状态	字符串默认: "active" 枚举: "active" "inactive" 端点的状态。
令牌	字符串
类型必需	字符串 (NotificationEndpointType) http PostNotificationEndpoint NotificationEndpoint slack pagerduty http telegram
网址必填	字符串
用户ID	字符串
用户名	字符串

响应

请求示例

Payload

Content type

application/json

Example

{"description": "string",
"id": "string",
"labels": [{"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"name": "string",
"orgID": "string",
"status": "active",
"type": "http",
"userID": "string",
"authMethod": "none",
"contentTemplate": "string",
"headers": {"property1": "string",
"property2": "string"
},
"method": "POST",
"password": "string",
"token": "string",
"url": "string",
"username": "string"
}

响应示例

200
404
default

Content type

application/json

Example

{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"labels": "/api/v2/notificationEndpoints/1/labels",
"members": "/api/v2/notificationEndpoints/1/members",
"owners": "/api/v2/notificationEndpoints/1/owners",
"self": "/api/v2/notificationEndpoints/1"
},
"name": "string",
"orgID": "string",
"status": "active",
"type": "http",
"updatedAt": "2019-08-24T14:15:22Z",
"userID": "string",
"authMethod": "none",
"contentTemplate": "string",
"headers": {"property1": "string",
"property2": "string"
},
"method": "POST",
"password": "string",
"token": "string",
"url": "string",
"username": "string"
}

列出所有通知端点的标签

授权：

TokenAuthentication

路径参数

endpointID

必需

字符串

通知端点的 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
default

Content type

application/json

{"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"next": "http://example.com",
"prev": "http://example.com",
"self": "http://example.com"
}
}

为通知端点添加标签

授权：

TokenAuthentication

路径参数

endpointID

必需

字符串

通知端点的 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

要添加的标签

labelID

必填

字符串

标签ID。指定要附加的标签。

响应

请求示例

Payload

Content type

application/json

{"labelID": "string"
}

响应示例

201
default

Content type

application/json

{"label": {"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
},
"links": {"next": "http://example.com",
"prev": "http://example.com",
"self": "http://example.com"
}
}

从通知端点删除标签

授权：

TokenAuthentication

路径参数

endpointID 必需	字符串通知端点的 ID。
labelID 必填	字符串要删除的标签的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

404
default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

通知规则

列出所有通知规则

授权：

TokenAuthentication

查询参数

checkID	字符串仅显示属于特定检查 ID 的通知。
限制	整数 [ 1 .. 100 ] 默认: 20 限制返回的记录数量。默认值是 `20`。
偏移量	整数 >= 0 分页的偏移量。要跳过的记录数。有关分页参数的更多信息，请参见分页。
orgID 必填	字符串仅显示属于特定组织ID的通知规则。
标签	字符串^[a-zA-Z0-9_]+:[a-zA-Z0-9_]+$ 示例: tag=env:prod 仅返回“将匹配”包含提供的标签键值对的状态的通知规则。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
default

Content type

application/json

{"links": {"next": "http://example.com",
"prev": "http://example.com",
"self": "http://example.com"
},
"notificationRules": [{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"endpointID": "string",
"every": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"lastRunError": "string",
"lastRunStatus": "failed",
"latestCompleted": "2019-08-24T14:15:22Z",
"limit": 0,
"limitEvery": 0,
"links": {"labels": "/api/v2/notificationRules/1/labels",
"members": "/api/v2/notificationRules/1/members",
"owners": "/api/v2/notificationRules/1/owners",
"query": "/api/v2/notificationRules/1/query",
"self": "/api/v2/notificationRules/1"
},
"name": "string",
"offset": "string",
"orgID": "string",
"ownerID": "string",
"runbookLink": "string",
"sleepUntil": "string",
"status": "active",
"statusRules": [{"count": 0,
"currentLevel": "UNKNOWN",
"period": "string",
"previousLevel": "UNKNOWN"
}
],
"tagRules": [{"key": "string",
"operator": "equal",
"value": "string"
}
],
"taskID": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"channel": "string",
"messageTemplate": "string",
"type": "slack"
}
]
}

添加通知规则

授权：

TokenAuthentication

请求体模式: application/json

创建通知规则

描述	字符串通知规则的可选描述。
端点ID 必需	字符串
每个	字符串通知重复间隔。
	数组对象（标签）
限制	整数每秒钟最多通知我次。如果设置了，limitEvery不能为空。
限制每次	整数不要在每秒内通知我超过次。如果设置，限制不能为空。
名称必需	字符串描述通知规则的人类可读名称。
offset	string 在执行检查之前，延迟计划后的持续时间。
orgID 必填	string 拥有此通知规则的组织的ID。
运行手册链接	字符串
睡眠直到	字符串
状态必填	字符串 (TaskStatusType) 枚举： "active" "inactive" `inactive` 取消计划的运行并阻止手动运行任务。
必填	数组对象 (StatusRule) 非空通知规则试图匹配的状态规则列表。
	数组对象 (TagRule) 通知规则尝试匹配的标签规则列表。
任务ID	字符串与此通知规则相关联的任务的ID。
类型必填	字符串 http PostNotificationRule NotificationRule telegram smtp slack pagerduty http
网址	字符串

响应

请求示例

Payload

Content type

application/json

Example

{"description": "string",
"endpointID": "string",
"every": "string",
"labels": [{"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"limit": 0,
"limitEvery": 0,
"name": "string",
"offset": "string",
"orgID": "string",
"runbookLink": "string",
"sleepUntil": "string",
"status": "active",
"statusRules": [{"count": 0,
"currentLevel": "UNKNOWN",
"period": "string",
"previousLevel": "UNKNOWN"
}
],
"tagRules": [{"key": "string",
"operator": "equal",
"value": "string"
}
],
"taskID": "string",
"type": "http",
"url": "string"
}

响应示例

201
default

Content type

application/json

Example

{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"endpointID": "string",
"every": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"lastRunError": "string",
"lastRunStatus": "failed",
"latestCompleted": "2019-08-24T14:15:22Z",
"limit": 0,
"limitEvery": 0,
"links": {"labels": "/api/v2/notificationRules/1/labels",
"members": "/api/v2/notificationRules/1/members",
"owners": "/api/v2/notificationRules/1/owners",
"query": "/api/v2/notificationRules/1/query",
"self": "/api/v2/notificationRules/1"
},
"name": "string",
"offset": "string",
"orgID": "string",
"ownerID": "string",
"runbookLink": "string",
"sleepUntil": "string",
"status": "active",
"statusRules": [{"count": 0,
"currentLevel": "UNKNOWN",
"period": "string",
"previousLevel": "UNKNOWN"
}
],
"tagRules": [{"key": "string",
"operator": "equal",
"value": "string"
}
],
"taskID": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"type": "http",
"url": "string"
}

删除通知规则

授权：

TokenAuthentication

路径参数

规则ID

必需

字符串

通知规则ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

404
default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

检索通知规则

授权：

TokenAuthentication

路径参数

规则ID

必需

字符串

通知规则ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
default

Content type

application/json

Example

{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"endpointID": "string",
"every": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"lastRunError": "string",
"lastRunStatus": "failed",
"latestCompleted": "2019-08-24T14:15:22Z",
"limit": 0,
"limitEvery": 0,
"links": {"labels": "/api/v2/notificationRules/1/labels",
"members": "/api/v2/notificationRules/1/members",
"owners": "/api/v2/notificationRules/1/owners",
"query": "/api/v2/notificationRules/1/query",
"self": "/api/v2/notificationRules/1"
},
"name": "string",
"offset": "string",
"orgID": "string",
"ownerID": "string",
"runbookLink": "string",
"sleepUntil": "string",
"status": "active",
"statusRules": [{"count": 0,
"currentLevel": "UNKNOWN",
"period": "string",
"previousLevel": "UNKNOWN"
}
],
"tagRules": [{"key": "string",
"operator": "equal",
"value": "string"
}
],
"taskID": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"type": "http",
"url": "string"
}

更新通知规则

授权：

TokenAuthentication

路径参数

规则ID

必需

字符串

通知规则ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

通知规则更新以应用

描述	字符串
名称	字符串
状态	字符串枚举： "active" "inactive"

响应

请求示例

Payload

Content type

application/json

{"description": "string",
"name": "string",
"status": "active"
}

响应示例

200
404
default

Content type

application/json

Example

{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"endpointID": "string",
"every": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"lastRunError": "string",
"lastRunStatus": "failed",
"latestCompleted": "2019-08-24T14:15:22Z",
"limit": 0,
"limitEvery": 0,
"links": {"labels": "/api/v2/notificationRules/1/labels",
"members": "/api/v2/notificationRules/1/members",
"owners": "/api/v2/notificationRules/1/owners",
"query": "/api/v2/notificationRules/1/query",
"self": "/api/v2/notificationRules/1"
},
"name": "string",
"offset": "string",
"orgID": "string",
"ownerID": "string",
"runbookLink": "string",
"sleepUntil": "string",
"status": "active",
"statusRules": [{"count": 0,
"currentLevel": "UNKNOWN",
"period": "string",
"previousLevel": "UNKNOWN"
}
],
"tagRules": [{"key": "string",
"operator": "equal",
"value": "string"
}
],
"taskID": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"type": "http",
"url": "string"
}

更新通知规则

授权：

TokenAuthentication

路径参数

规则ID

必需

字符串

通知规则ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

通知规则更新以应用

描述	字符串通知规则的可选描述。
端点ID 必需	字符串
每个	字符串通知重复间隔。
	数组对象（标签）
限制	整数每秒钟最多通知我次。如果设置了，limitEvery不能为空。
限制每次	整数不要在每秒内通知我超过次。如果设置，限制不能为空。
名称必需	字符串描述通知规则的人类可读名称。
offset	string 在执行检查之前，延迟计划后的持续时间。
orgID 必填	string 拥有此通知规则的组织的ID。
运行手册链接	字符串
睡眠直到	字符串
状态必填	字符串 (TaskStatusType) 枚举： "active" "inactive" `inactive` 取消计划的运行并阻止手动运行任务。
必填	数组对象 (StatusRule) 非空通知规则试图匹配的状态规则列表。
	数组对象 (TagRule) 通知规则尝试匹配的标签规则列表。
任务ID	字符串与此通知规则相关联的任务的ID。
类型必填	字符串 http PostNotificationRule NotificationRule telegram smtp slack pagerduty http
网址	字符串

响应

请求示例

Payload

Content type

application/json

Example

{"description": "string",
"endpointID": "string",
"every": "string",
"labels": [{"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"limit": 0,
"limitEvery": 0,
"name": "string",
"offset": "string",
"orgID": "string",
"runbookLink": "string",
"sleepUntil": "string",
"status": "active",
"statusRules": [{"count": 0,
"currentLevel": "UNKNOWN",
"period": "string",
"previousLevel": "UNKNOWN"
}
],
"tagRules": [{"key": "string",
"operator": "equal",
"value": "string"
}
],
"taskID": "string",
"type": "http",
"url": "string"
}

响应示例

200
404
default

Content type

application/json

Example

{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"endpointID": "string",
"every": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"lastRunError": "string",
"lastRunStatus": "failed",
"latestCompleted": "2019-08-24T14:15:22Z",
"limit": 0,
"limitEvery": 0,
"links": {"labels": "/api/v2/notificationRules/1/labels",
"members": "/api/v2/notificationRules/1/members",
"owners": "/api/v2/notificationRules/1/owners",
"query": "/api/v2/notificationRules/1/query",
"self": "/api/v2/notificationRules/1"
},
"name": "string",
"offset": "string",
"orgID": "string",
"ownerID": "string",
"runbookLink": "string",
"sleepUntil": "string",
"status": "active",
"statusRules": [{"count": 0,
"currentLevel": "UNKNOWN",
"period": "string",
"previousLevel": "UNKNOWN"
}
],
"tagRules": [{"key": "string",
"operator": "equal",
"value": "string"
}
],
"taskID": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"type": "http",
"url": "string"
}

列出所有用于通知规则的标签

授权：

TokenAuthentication

路径参数

规则ID

必需

字符串

通知规则ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
default

Content type

application/json

{"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"next": "http://example.com",
"prev": "http://example.com",
"self": "http://example.com"
}
}

为通知规则添加标签

授权：

TokenAuthentication

路径参数

规则ID

必需

字符串

通知规则ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

要添加的标签

labelID

必填

字符串

标签ID。指定要附加的标签。

响应

请求示例

Payload

Content type

application/json

{"labelID": "string"
}

响应示例

201
default

Content type

application/json

{"label": {"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
},
"links": {"next": "http://example.com",
"prev": "http://example.com",
"self": "http://example.com"
}
}

从通知规则中删除标签

授权：

TokenAuthentication

路径参数

labelID 必填	字符串要删除的标签的ID。
规则ID 必需	字符串通知规则ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

404
default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

组织

管理你的 organization。一个组织是一个用户组的工作空间。组织可以用来在 InfluxDB 中分隔不同的环境、项目、团队或用户。

使用 /api/v2/orgs 端点查看和管理组织。

列出组织

列出 organizations。

要限制返回的组织，可以在请求中传递查询参数。如果未传递查询参数，InfluxDB 将返回所有组织，直到默认的 limit。

InfluxDB云

Only returns the organization that owns the token passed in the request.

View organizations

授权：

TokenAuthentication

查询参数

降序	布尔值默认: false
限制	整数 [ 1 .. 100 ] 默认: 20 限制返回的记录数量。默认值是 `20`。
偏移量	整数 >= 0 分页的偏移量。要跳过的记录数。有关分页参数的更多信息，请参见分页。
org	string 一个组织名称。只返回指定的组织。
orgID	字符串组织 ID。仅返回指定的组织。
用户ID	字符串用户ID。仅返回指定用户为成员或所有者的组织。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

Content type

application/json

{"links": {"self": "/api/v2/orgs"
},
"orgs": [{"createdAt": "2022-07-17T23:00:30.778487Z",
"description": "Example InfluxDB organization",
"id": "INFLUX_ORG_ID",
"links": {"buckets": "/api/v2/buckets?org=INFLUX_ORG",
"dashboards": "/api/v2/dashboards?org=INFLUX_ORG",
"labels": "/api/v2/orgs/INFLUX_ORG_ID/labels",
"logs": "/api/v2/orgs/INFLUX_ORG_ID/logs",
"members": "/api/v2/orgs/INFLUX_ORG_ID/members",
"owners": "/api/v2/orgs/INFLUX_ORG_ID/owners",
"secrets": "/api/v2/orgs/INFLUX_ORG_ID/secrets",
"self": "/api/v2/orgs/INFLUX_ORG_ID",
"tasks": "/api/v2/tasks?org=InfluxData"
},
"name": "INFLUX_ORG",
"updatedAt": "2022-07-17T23:00:30.778487Z"
}
]
}

创建一个组织

创建一个 organization 并返回新创建的组织。

InfluxDB云

Doesn't allow you to use this endpoint to create organizations.

Manage organizations

授权：

TokenAuthentication

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

要创建的组织。

描述	字符串组织的描述。
名称必需	字符串组织的名称。

响应

请求示例

Payload
cURL

Content type

application/json

{"description": "string",
"name": "string"
}

响应示例

Content type

application/json

{"createdAt": "2022-08-24T23:05:52.881317Z",
"description": "",
"id": "INFLUX_ORG_ID",
"links": {"buckets": "/api/v2/buckets?org=INFLUX_ORG",
"dashboards": "/api/v2/dashboards?org=INFLUX_ORG",
"labels": "/api/v2/orgs/INFLUX_ORG_ID/labels",
"logs": "/api/v2/orgs/INFLUX_ORG_ID/logs",
"members": "/api/v2/orgs/INFLUX_ORG_ID/members",
"owners": "/api/v2/orgs/INFLUX_ORG_ID/owners",
"secrets": "/api/v2/orgs/INFLUX_ORG_ID/secrets",
"self": "/api/v2/orgs/INFLUX_ORG_ID",
"tasks": "/api/v2/tasks?org=INFLUX_ORG"
},
"name": "INFLUX_ORG",
"updatedAt": "2022-08-24T23:05:52.881318Z"
}

删除组织

删除一个组织。

从 InfluxDB Cloud 删除组织是不可逆的。一旦删除，与该组织相关的所有数据都将被移除。

InfluxDB云

当你发送删除请求时，会执行以下操作：
1. Validates the request and queues the delete.
2. Returns an HTTP 204 status code if queued; error otherwise.
3. Handles the delete asynchronously.

InfluxDB OSS

Validates the request, handles the delete synchronously, and then responds with success or failure.

限制

Only one organization can be deleted per request.

Delete organizations

授权：

TokenAuthentication

路径参数

orgID

必填

字符串

要删除的组织的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

400
401
404
500
default

Content type

application/json

{"code": "invalid",
"message": "failed to decode request body: organization not found"
}

获取组织

检索一个组织。

使用此端点检索特定组织的信息。

View organizations

授权：

TokenAuthentication

路径参数

orgID

必填

字符串

要检索的组织的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
401
404
500
default

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"defaultStorageType": "tsm",
"description": "string",
"id": "string",
"links": {"buckets": "/api/v2/buckets?org=myorg",
"dashboards": "/api/v2/dashboards?org=myorg",
"labels": "/api/v2/orgs/1/labels",
"members": "/api/v2/orgs/1/members",
"owners": "/api/v2/orgs/1/owners",
"secrets": "/api/v2/orgs/1/secrets",
"self": "/api/v2/orgs/1",
"tasks": "/api/v2/tasks?org=myorg"
},
"name": "string",
"status": "active",
"updatedAt": "2019-08-24T14:15:22Z"
}

更新组织

更新组织。

使用此端点更新组织的属性 (name, description)。

更新组织名称会影响所有引用该组织名称的资源，包括以下内容：

Queries
Dashboards
Tasks
Telegraf configurations
Templates

如果您更改了组织名称，请确保在这些资源中也更新组织名称。

Update an organization

授权：

TokenAuthentication

路径参数

orgID

必填

string

要更新的组织的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

需要应用的组织更新。

描述	字符串组织的描述。
名称	字符串组织的名称。

响应

请求示例

Payload

Content type

application/json

{"description": "string",
"name": "string"
}

响应示例

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"defaultStorageType": "tsm",
"description": "string",
"id": "string",
"links": {"buckets": "/api/v2/buckets?org=myorg",
"dashboards": "/api/v2/dashboards?org=myorg",
"labels": "/api/v2/orgs/1/labels",
"members": "/api/v2/orgs/1/members",
"owners": "/api/v2/orgs/1/owners",
"secrets": "/api/v2/orgs/1/secrets",
"self": "/api/v2/orgs/1",
"tasks": "/api/v2/tasks?org=myorg"
},
"name": "string",
"status": "active",
"updatedAt": "2019-08-24T14:15:22Z"
}

列出组织的所有成员

列出所有属于一个组织的用户。

InfluxDB users 有权访问 InfluxDB。

成员是组织内的用户。

InfluxDB云

Doesn't use owner and member roles. Use /api/v2/authorizations to assign user permissions.

限制

Member permissions are separate from API token permissions.
Member permissions are used in the context of the InfluxDB UI.

所需权限

read-orgs INFLUX_ORG_ID

INFLUX_ORG_ID 是您想要检索成员的组织的ID。

授权：

TokenAuthentication

路径参数

orgID

必需

字符串

要检索用户的组织的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

Content type

application/json

{"links": {"self": "/api/v2/orgs/055aa4783aa38398/members"
},
"users": [{"id": "791df274afd48a83",
"links": {"self": "/api/v2/users/791df274afd48a83"
},
"name": "example_user_1",
"role": "member",
"status": "active"
},
{"id": "09cfb87051cbe000",
"links": {"self": "/api/v2/users/09cfb87051cbe000"
},
"name": "example_user_2",
"role": "owner",
"status": "active"
}
]
}

将成员添加到组织

将用户添加到组织。

InfluxDB users 有权访问 InfluxDB。

成员是组织内的用户。

InfluxDB云

Doesn't use owner and member roles. Use /api/v2/authorizations to assign user permissions.

限制

Member permissions are separate from API token permissions.
Member permissions are used in the context of the InfluxDB UI.

所需权限

write-orgs INFLUX_ORG_ID

INFLUX_ORG_ID 是您想要添加成员的组织的ID。

授权：

TokenAuthentication

路径参数

orgID

必填

字符串

组织的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

要添加到组织的用户。

id 必需	字符串要添加到资源的用户ID。
姓名	字符串要添加到资源中的用户姓名。

响应

请求示例

Payload
cURL

Content type

application/json

{"id": "string",
"name": "string"
}

响应示例

Content type

application/json

{"id": "09cfb87051cbe000",
"links": {"self": "/api/v2/users/09cfb87051cbe000"
},
"name": "example_user_1",
"role": "member",
"status": "active"
}

从组织中移除成员

从组织中移除成员。

使用此端点来删除用户在组织中的成员权限。删除成员权限将从组织中移除用户的 read 和 write 权限。

InfluxDB云

Doesn't use owner and member roles. Use /api/v2/authorizations to assign user permissions.

限制

Member permissions are separate from API token permissions.
Member permissions are used in the context of the InfluxDB UI.

所需权限

write-orgs INFLUX_ORG_ID

INFLUX_ORG_ID 是您要移除所有者的组织的ID。

Manage members

授权：

TokenAuthentication

路径参数

orgID 必填	string 要从中移除用户的组织的ID。
用户ID 必需	字符串要移除的用户的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

401
404
500
default

Content type

application/json

{"code": "unauthorized",
"message": "unauthorized access"
}

列出组织的所有拥有者

列出一个组织的所有拥有者。

InfluxDB云

Doesn't use owner and member roles. Use /api/v2/authorizations to assign user permissions.

所需权限

read-orgs INFLUX_ORG_ID

INFLUX_ORG_ID 是您想要检索其所有者列表的组织的ID。

授权：

TokenAuthentication

路径参数

orgID

必填

字符串

用于列出所有者的组织ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
404
default

Content type

application/json

{"links": {"self": "/api/v2/orgs/055aa4783aa38398/owners"
},
"users": [{"id": "09cfb87051cbe000",
"links": {"self": "/api/v2/users/09cfb87051cbe000"
},
"name": "example_user_2",
"role": "owner",
"status": "active"
}
]
}

向组织添加所有者

向组织添加所有者。

使用此端点将组织 owner 角色分配给用户。

InfluxDB云

Doesn't use owner and member roles. Use /api/v2/authorizations to assign user permissions.

所需权限

write-orgs INFLUX_ORG_ID

INFLUX_ORG_ID 是您希望为其添加所有者的组织的ID。

Authorizations

授权：

TokenAuthentication

路径参数

orgID

必需

字符串

您想要添加所有者的组织的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

要添加为组织所有者的用户。

id 必需	字符串要添加到资源的用户ID。
姓名	字符串要添加到资源中的用户姓名。

响应

请求示例

Payload
cURL

Content type

application/json

{"id": "09cfb87051cbe000",
"links": {"self": "/api/v2/users/09cfb87051cbe000"
},
"name": "example_user_1",
"role": "owner",
"status": "active"
}

响应示例

Content type

application/json

{"id": "string",
"links": {"self": "/api/v2/users/1"
},
"name": "string",
"status": "active",
"role": "owner"
}

从组织中移除一个所有者

从组织中移除一个 owner。

组织拥有者有权限删除组织并移除组织中用户和成员的权限。

InfluxDB云

Doesn't use owner and member roles. Use /api/v2/authorizations to assign user permissions.

限制

Owner permissions are separate from API token permissions.
Owner permissions are used in the context of the InfluxDB UI.

所需权限

write-orgs INFLUX_ORG_ID

INFLUX_ORG_ID 是您想要移除所有者的组织的ID。

Authorizations

授权：

TokenAuthentication

路径参数

orgID 必需	字符串要从中移除所有者的组织的ID。
用户ID 必需	字符串要移除的用户的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

401
404
500
default

Content type

application/json

{"code": "unauthorized",
"message": "unauthorized access"
}

平Ping

获取实例状态

检索实例的状态和InfluxDB版本。

使用这个端点来监测 InfluxDB 实例的正常运行时间。响应返回一个 HTTP 204 状态码，以告知您该实例可用。

Influx ping

授权：

TokenAuthentication

响应

获取实例状态

返回实例的状态和InfluxDB版本。

使用这个端点来监测 InfluxDB 实例的正常运行时间。响应返回一个 HTTP 204 状态码，以告知您该实例可用。

Influx ping

授权：

TokenAuthentication

响应

查询

检索数据，分析查询，并获得查询建议。

查询数据

从存储桶中检索数据。

使用此端点发送Flux查询请求并从桶中检索数据。

速率限制（使用InfluxDB Cloud）

read 限制适用。有关更多信息，请参见限制和可调配额。

授权：

TokenAuthentication

查询参数

组织	字符串组织名称或ID。 InfluxDB Cloud 不使用 `org` 参数或 `orgID` 参数。查询与授权（API令牌）关联的组织中的存储桶。 InfluxDB OSS 需要使用 `org` 参数或 `orgID` 参数。查询指定组织中的存储桶。
orgID	string 组织 ID. InfluxDB Cloud 不使用 `org` 参数或 `orgID` 参数. 查询与授权（API 令牌）关联的组织中的存储桶. InfluxDB OSS 需要 `org` 参数或 `orgID` 参数. 查询指定组织中的存储桶.

头部参数

接收编码	字符串默认: 身份枚举: "gzip" "身份" 客户端可以理解的内容编码（通常是一种压缩算法）。
内容类型	字符串枚举： "application/json" "application/vnd.flux"
Zap-Trace-Span	字符串示例： baggage,[object Object],span_id,1,trace_id,1 OpenTracing span 上下文

请求体模式:
application/json
application/json
application/vnd.flux

要执行的Flux查询或规范

	对象 (Dialect) 表格数据输出选项。默认输出为注释的 CSV，包含标题。有关表格数据方言的更多信息，请参见W3表格数据元数据词汇。
	对象 (文件) 表示来自单个文件的源
现在	字符串 <日期-时间> 指定在查询中应报告的时间作为 `now`。默认是服务器的 `now` 时间。
	对象在查询执行期间作为参数传递的键值对。要在查询中使用参数，请传递一个 `query`，其中包含 `params` 引用（以点表示法）--例如： `query: "from(bucket: params.mybucket)\ \|> range(start: params.rangeStart) \|> limit(n:1)"` 并传递 `params` 和键值对--例如： `params: { "mybucket": "environment", "rangeStart": "-30d" }` 在查询执行期间，InfluxDB 会将 `params` 传递给您的脚本并替换对应的值。限制如果使用 `params`，则不能使用 `extern`。
查询必需	字符串要执行的查询脚本。
类型	字符串值： "flux" 查询的类型。必须是 "flux"。

响应

请求示例

Payload
cURL

Content type

{"dialect": {"annotations": ["group"
],
"commentPrefix": "#",
"dateTimeFormat": "RFC3339",
"delimiter": ",",
"header": true
},
"extern": {"body": [{"text": "string",
"type": "string"
}
],
"imports": [{"as": {"name": "string",
"type": "string"
},
"path": {"type": "string",
"value": "string"
},
"type": "string"
}
],
"name": "string",
"package": {"name": {"name": "string",
"type": "string"
},
"type": "string"
},
"type": "string"
},
"now": "2019-08-24T14:15:22Z",
"params": { },
"query": "string",
"type": "flux"
}

响应示例

Content type

application/csv

result,table,_start,_stop,_time,region,host,_value
mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:00Z,east,A,15.43
mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:20Z,east,B,59.25
mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:40Z,east,C,52.62

分析一个 Flux 查询

分析一个 Flux 查询的语法错误并返回错误列表。

在以下示例查询中， from() 缺少属性键。

```json
{ "query": "from(: \"iot_center\")\
            |> range(start: -90d)\
            |> filter(fn: (r) => r._measurement == \"environment\")",
  "type": "flux"
}
```

如果您在请求中传递这个到 /api/v2/analyze 端点，InfluxDB 将返回一个 errors 列表，其中包含缺失键的错误对象。

限制

该端点不验证查询中的值——例如：
- 以下示例查询的语法正确，但包含一个不正确的 from() 属性键：
```
{ "query": "from(foo: \"iot_center\")\
           |> range(start: -90d)\
           |> filter(fn: (r) => r._measurement == \"environment\")",
 "type": "flux"
}
```
  如果你在请求中传递这个到 /api/v2/analyze 端点，InfluxDB 会返回一个空的 errors 列表。

授权：

TokenAuthentication

头部参数

内容类型	字符串值： "application/json"
Zap-Trace-Span	字符串示例： baggage,[object Object],span_id,1,trace_id,1 OpenTracing span 上下文

请求体模式: application/json

用于分析的Flux查询

	对象 (Dialect) 表格数据输出选项。默认输出为注释的 CSV，包含标题。有关表格数据方言的更多信息，请参见W3表格数据元数据词汇。
	对象 (文件) 表示来自单个文件的源
现在	字符串 <日期-时间> 指定在查询中应报告的时间作为 `now`。默认是服务器的 `now` 时间。
	对象在查询执行期间作为参数传递的键值对。要在查询中使用参数，请传递一个 `query`，其中包含 `params` 引用（以点表示法）--例如： `query: "from(bucket: params.mybucket)\ \|> range(start: params.rangeStart) \|> limit(n:1)"` 并传递 `params` 和键值对--例如： `params: { "mybucket": "environment", "rangeStart": "-30d" }` 在查询执行期间，InfluxDB 会将 `params` 传递给您的脚本并替换对应的值。限制如果使用 `params`，则不能使用 `extern`。
查询必需	字符串要执行的查询脚本。
类型	字符串值： "flux" 查询的类型。必须是 "flux"。

响应

请求示例

Payload
cURL: Analyze a Flux query

Content type

application/json

{"dialect": {"annotations": ["group"
],
"commentPrefix": "#",
"dateTimeFormat": "RFC3339",
"delimiter": ",",
"header": true
},
"extern": {"body": [{"text": "string",
"type": "string"
}
],
"imports": [{"as": {"name": "string",
"type": "string"
},
"path": {"type": "string",
"value": "string"
},
"type": "string"
}
],
"name": "string",
"package": {"name": {"name": "string",
"type": "string"
},
"type": "string"
},
"type": "string"
},
"now": "2019-08-24T14:15:22Z",
"params": { },
"query": "string",
"type": "flux"
}

响应示例

200
400
default

Content type

application/json

如果Flux查询缺少属性键，则返回错误对象。

以下示例查询缺少 bucket 属性键：

{
  "query": "from(: \"iot_center\")\
  ...
}

{"errors": [{"character": 0,
"column": 6,
"line": 1,
"message": "missing property key"
}
]
}

生成查询抽象语法树 (AST)

分析一个 Flux 查询并返回一个完整的包源抽象语法树 (AST) 用于该查询。

使用此端点进行深入查询分析，例如调试意外的查询结果。

A Flux 查询 AST 提供了一个语义化的、树状的表示，并包含有关查询的上下文信息。AST 说明了查询是如何分布到不同组件进行执行的。

限制

该端点不验证查询中的值——例如：

以下示例 Flux 查询具有正确的语法，但包含一个不正确的 from() 属性键：

 from(foo: "iot_center")
     |> range(start: -90d)
     |> filter(fn: (r) => r._measurement == "environment")

以下示例 JSON 显示了如何在请求体中传递查询：

 from(foo: "iot_center")
 |> range(start: -90d)
 |> filter(fn: (r) => r._measurement == "environment")

以下代码示例演示如何将查询作为JSON传递在请求体中：

 { "query": "from(foo: \"iot_center\")\
                 |> range(start: -90d)\
                 |> filter(fn: (r) => r._measurement == \"environment\")"
 }

将此传递给 /api/v2/query/ast 将返回一个成功的响应，包含生成的 AST。

授权：

TokenAuthentication

头部参数

内容类型	字符串值： "application/json"
Zap-Trace-Span	字符串示例： baggage,[object Object],span_id,1,trace_id,1 OpenTracing span 上下文

请求体模式: application/json

要分析的Flux查询。

query

必填

string

要分析的 Flux 查询脚本。

响应

请求示例

Payload
cURL: Analyze and generate AST for the query

Content type

application/json

{"query": "string"
}

响应示例

200
400
default

Content type

application/json

{"ast": {"files": [{"body": [{"expression": {"argument": {"argument": {"arguments": [{"location": {"end": {"column": 25,
"line": 1
},
"source": "bucket: \"example-bucket\"",
"start": {"column": 6,
"line": 1
}
},
"properties": [{"key": {"location": {"end": {"column": 12,
"line": 1
},
"source": "bucket",
"start": {"column": 6,
"line": 1
}
},
"name": "bucket",
"type": "Identifier"
},
"location": {"end": {"column": 25,
"line": 1
},
"source": "bucket: \"example-bucket\"",
"start": {"column": 6,
"line": 1
}
},
"type": "Property",
"value": {"location": {"end": {"column": 25,
"line": 1
},
"source": "\"example-bucket\"",
"start": {"column": 14,
"line": 1
}
},
"type": "StringLiteral",
"value": "example-bucket"
}
}
],
"type": "ObjectExpression"
}
],
"callee": {"location": {"end": {"column": 5,
"line": 1
},
"source": "from",
"start": {"column": 1,
"line": 1
}
},
"name": "from",
"type": "Identifier"
},
"location": {"end": {"column": 26,
"line": 1
},
"source": "from(bucket: \"example-bucket\")",
"start": {"column": 1,
"line": 1
}
},
"type": "CallExpression"
},
"call": {"arguments": [{"location": {"end": {"column": 46,
"line": 1
},
"source": "start: -5m",
"start": {"column": 36,
"line": 1
}
},
"properties": [{"key": {"location": {"end": {"column": 41,
"line": 1
},
"source": "start",
"start": {"column": 36,
"line": 1
}
},
"name": "start",
"type": "Identifier"
},
"location": {"end": {"column": 46,
"line": 1
},
"source": "start: -5m",
"start": {"column": 36,
"line": 1
}
},
"type": "Property",
"value": {"argument": {"location": {"end": {"column": 46,
"line": 1
},
"source": "5m",
"start": {"column": 44,
"line": 1
}
},
"type": "DurationLiteral",
"values": [{"magnitude": 5,
"unit": "m"
}
]
},
"location": {"end": {"column": 46,
"line": 1
},
"source": "-5m",
"start": {"column": 43,
"line": 1
}
},
"operator": "-",
"type": "UnaryExpression"
}
}
],
"type": "ObjectExpression"
}
],
"callee": {"location": {"end": {"column": 35,
"line": 1
},
"source": "range",
"start": {"column": 30,
"line": 1
}
},
"name": "range",
"type": "Identifier"
},
"location": {"end": {"column": 47,
"line": 1
},
"source": "range(start: -5m)",
"start": {"column": 30,
"line": 1
}
},
"type": "CallExpression"
},
"location": {"end": {"column": 47,
"line": 1
},
"source": "from(bucket: \"example-bucket\") |> range(start: -5m)",
"start": {"column": 1,
"line": 1
}
},
"type": "PipeExpression"
},
"call": {"arguments": [{"location": {"end": {"column": 108,
"line": 1
},
"source": "fn: (r) => r._measurement == \"example-measurement\"",
"start": {"column": 58,
"line": 1
}
},
"properties": [{"key": {"location": {"end": {"column": 60,
"line": 1
},
"source": "fn",
"start": {"column": 58,
"line": 1
}
},
"name": "fn",
"type": "Identifier"
},
"location": {"end": {"column": 108,
"line": 1
},
"source": "fn: (r) => r._measurement == \"example-measurement\"",
"start": {"column": 58,
"line": 1
}
},
"type": "Property",
"value": {"body": {"left": {"location": {"end": {"column": 83,
"line": 1
},
"source": "r._measurement",
"start": {"column": 69,
"line": 1
}
},
"object": {"location": {"end": {"column": 70,
"line": 1
},
"source": "r",
"start": {"column": 69,
"line": 1
}
},
"name": "r",
"type": "Identifier"
},
"property": {"location": {"end": {"column": 83,
"line": 1
},
"source": "_measurement",
"start": {"column": 71,
"line": 1
}
},
"name": "_measurement",
"type": "Identifier"
},
"type": "MemberExpression"
},
"location": {"end": {"column": 108,
"line": 1
},
"source": "r._measurement == \"example-measurement\"",
"start": {"column": 69,
"line": 1
}
},
"operator": "==",
"right": {"location": {"end": {"column": 108,
"line": 1
},
"source": "\"example-measurement\"",
"start": {"column": 87,
"line": 1
}
},
"type": "StringLiteral",
"value": "example-measurement"
},
"type": "BinaryExpression"
},
"location": {"end": {"column": 108,
"line": 1
},
"source": "(r) => r._measurement == \"example-measurement\"",
"start": {"column": 62,
"line": 1
}
},
"params": [{"key": {"location": {"end": {"column": 64,
"line": 1
},
"source": "r",
"start": {"column": 63,
"line": 1
}
},
"name": "r",
"type": "Identifier"
},
"location": {"end": {"column": 64,
"line": 1
},
"source": "r",
"start": {"column": 63,
"line": 1
}
},
"type": "Property",
"value": null
}
],
"type": "FunctionExpression"
}
}
],
"type": "ObjectExpression"
}
],
"callee": {"location": {"end": {"column": 57,
"line": 1
},
"source": "filter",
"start": {"column": 51,
"line": 1
}
},
"name": "filter",
"type": "Identifier"
},
"location": {"end": {"column": 109,
"line": 1
},
"source": "filter(fn: (r) => r._measurement == \"example-measurement\")",
"start": {"column": 51,
"line": 1
}
},
"type": "CallExpression"
},
"location": {"end": {"column": 109,
"line": 1
},
"source": "from(bucket: \"example-bucket\") |> range(start: -5m) |> filter(fn: (r) => r._measurement == \"example-measurement\")",
"start": {"column": 1,
"line": 1
}
},
"type": "PipeExpression"
},
"location": {"end": {"column": 109,
"line": 1
},
"source": "from(bucket: \"example-bucket\") |> range(start: -5m) |> filter(fn: (r) => r._measurement == \"example-measurement\")",
"start": {"column": 1,
"line": 1
}
},
"type": "ExpressionStatement"
}
],
"imports": null,
"location": {"end": {"column": 109,
"line": 1
},
"source": "from(bucket: \"example-bucket\") |> range(start: -5m) |> filter(fn: (r) => r._measurement == \"example-measurement\")",
"start": {"column": 1,
"line": 1
}
},
"metadata": "parser-type=rust",
"package": null,
"type": "File"
}
],
"package": "main",
"type": "Package"
}
}

列表 Flux 查询建议

列出 Flux 查询建议。每个建议包含一个 Flux function 名称和参数。

使用此端点检索在InfluxDB Flux查询构建器中使用的Flux查询建议列表。

限制

编写查询时，避免使用由此端点暴露的 _functionName() 辅助函数。辅助函数名称以一个下划线 (_) 开头，并不意味着可以直接在查询中使用——例如：
- To sort on a column and keep the top n records, use the top(n, columns=["_value"], tables=<-) function instead of the _sortLimit helper function. top uses _sortLimit.

List of all Flux functions

授权：

TokenAuthentication

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

请求示例

cURL

curl --request GET "INFLUX_URL/api/v2/query/suggestions" \
  --header "Accept: application/json" \
  --header "Authorization: Token INFLUX_API_TOKEN"

响应示例

200
301
default

Content type

application/json

{"funcs": [{"name": "_fillEmpty",
"params": {"createEmpty": "bool",
"tables": "stream"
}
},
{"name": "_highestOrLowest",
"params": {"_sortLimit": "function",
"column": "invalid",
"groupColumns": "array",
"n": "invalid",
"reducer": "function",
"tables": "stream"
}
},
{"name": "_hourSelection",
"params": {"location": "object",
"start": "int",
"stop": "int",
"tables": "stream",
"timeColumn": "string"
}
},
{"name": "_sortLimit",
"params": {"columns": "array",
"desc": "bool",
"n": "int",
"tables": "stream"
}
},
{"name": "_window",
"params": {"createEmpty": "bool",
"every": "duration",
"location": "object",
"offset": "duration",
"period": "duration",
"startColumn": "string",
"stopColumn": "string",
"tables": "stream",
"timeColumn": "string"
}
},
{"name": "aggregateWindow",
"params": {"column": "invalid",
"createEmpty": "bool",
"every": "duration",
"fn": "function",
"location": "object",
"offset": "duration",
"period": "duration",
"tables": "stream",
"timeDst": "string",
"timeSrc": "string"
}
},
{"name": "bool",
"params": {"v": "invalid"
}
},
{"name": "bottom",
"params": {"columns": "array",
"n": "int",
"tables": "stream"
}
},
{"name": "buckets",
"params": {"host": "string",
"org": "string",
"orgID": "string",
"token": "string"
}
},
{"name": "bytes",
"params": {"v": "invalid"
}
},
{"name": "cardinality",
"params": {"bucket": "string",
"bucketID": "string",
"host": "string",
"org": "string",
"orgID": "string",
"predicate": "function",
"start": "invalid",
"stop": "invalid",
"token": "string"
}
},
{"name": "chandeMomentumOscillator",
"params": {"columns": "array",
"n": "int",
"tables": "stream"
}
},
{"name": "columns",
"params": {"column": "string",
"tables": "stream"
}
},
{"name": "contains",
"params": {"set": "array",
"value": "invalid"
}
},
{"name": "count",
"params": {"column": "string",
"tables": "stream"
}
},
{"name": "cov",
"params": {"on": "array",
"pearsonr": "bool",
"x": "invalid",
"y": "invalid"
}
},
{"name": "covariance",
"params": {"columns": "array",
"pearsonr": "bool",
"tables": "stream",
"valueDst": "string"
}
},
{"name": "cumulativeSum",
"params": {"columns": "array",
"tables": "stream"
}
},
{"name": "derivative",
"params": {"columns": "array",
"initialZero": "bool",
"nonNegative": "bool",
"tables": "stream",
"timeColumn": "string",
"unit": "duration"
}
},
{"name": "die",
"params": {"msg": "string"
}
},
{"name": "difference",
"params": {"columns": "array",
"initialZero": "bool",
"keepFirst": "bool",
"nonNegative": "bool",
"tables": "stream"
}
},
{"name": "display",
"params": {"v": "invalid"
}
},
{"name": "distinct",
"params": {"column": "string",
"tables": "stream"
}
},
{"name": "doubleEMA",
"params": {"n": "int",
"tables": "stream"
}
},
{"name": "drop",
"params": {"columns": "array",
"fn": "function",
"tables": "stream"
}
},
{"name": "duplicate",
"params": {"as": "string",
"column": "string",
"tables": "stream"
}
},
{"name": "duration",
"params": {"v": "invalid"
}
},
{"name": "elapsed",
"params": {"columnName": "string",
"tables": "stream",
"timeColumn": "string",
"unit": "duration"
}
},
{"name": "exponentialMovingAverage",
"params": {"n": "int",
"tables": "stream"
}
},
{"name": "fill",
"params": {"column": "string",
"tables": "stream",
"usePrevious": "bool",
"value": "invalid"
}
},
{"name": "filter",
"params": {"fn": "function",
"onEmpty": "string",
"tables": "stream"
}
},
{"name": "findColumn",
"params": {"column": "string",
"fn": "function",
"tables": "stream"
}
},
{"name": "findRecord",
"params": {"fn": "function",
"idx": "int",
"tables": "stream"
}
},
{"name": "first",
"params": {"column": "string",
"tables": "stream"
}
},
{"name": "float",
"params": {"v": "invalid"
}
},
{"name": "from",
"params": {"bucket": "string",
"bucketID": "string",
"host": "string",
"org": "string",
"orgID": "string",
"token": "string"
}
},
{"name": "getColumn",
"params": {"column": "string"
}
},
{"name": "getRecord",
"params": {"idx": "int"
}
},
{"name": "group",
"params": {"columns": "array",
"mode": "string",
"tables": "stream"
}
},
{"name": "highestAverage",
"params": {"column": "string",
"groupColumns": "array",
"n": "int",
"tables": "stream"
}
},
{"name": "highestCurrent",
"params": {"column": "string",
"groupColumns": "array",
"n": "int",
"tables": "stream"
}
},
{"name": "highestMax",
"params": {"column": "string",
"groupColumns": "array",
"n": "int",
"tables": "stream"
}
},
{"name": "histogram",
"params": {"bins": "array",
"column": "string",
"countColumn": "string",
"normalize": "bool",
"tables": "stream",
"upperBoundColumn": "string"
}
},
{"name": "histogramQuantile",
"params": {"countColumn": "string",
"minValue": "float",
"quantile": "float",
"tables": "stream",
"upperBoundColumn": "string",
"valueColumn": "string"
}
},
{"name": "holtWinters",
"params": {"column": "string",
"interval": "duration",
"n": "int",
"seasonality": "int",
"tables": "stream",
"timeColumn": "string",
"withFit": "bool"
}
},
{"name": "hourSelection",
"params": {"location": "object",
"start": "int",
"stop": "int",
"tables": "stream",
"timeColumn": "string"
}
},
{"name": "increase",
"params": {"columns": "array",
"tables": "stream"
}
},
{"name": "int",
"params": {"v": "invalid"
}
},
{"name": "integral",
"params": {"column": "string",
"interpolate": "string",
"tables": "stream",
"timeColumn": "string",
"unit": "duration"
}
},
{"name": "join",
"params": {"method": "string",
"on": "array",
"tables": "invalid"
}
},
{"name": "kaufmansAMA",
"params": {"column": "string",
"n": "int",
"tables": "stream"
}
},
{"name": "kaufmansER",
"params": {"n": "int",
"tables": "stream"
}
},
{"name": "keep",
"params": {"columns": "array",
"fn": "function",
"tables": "stream"
}
},
{"name": "keyValues",
"params": {"keyColumns": "array",
"tables": "stream"
}
},
{"name": "keys",
"params": {"column": "string",
"tables": "stream"
}
},
{"name": "last",
"params": {"column": "string",
"tables": "stream"
}
},
{"name": "length",
"params": {"arr": "array"
}
},
{"name": "limit",
"params": {"n": "int",
"offset": "int",
"tables": "stream"
}
},
{"name": "linearBins",
"params": {"count": "int",
"infinity": "bool",
"start": "float",
"width": "float"
}
},
{"name": "logarithmicBins",
"params": {"count": "int",
"factor": "float",
"infinity": "bool",
"start": "float"
}
},
{"name": "lowestAverage",
"params": {"column": "string",
"groupColumns": "array",
"n": "int",
"tables": "stream"
}
},
{"name": "lowestCurrent",
"params": {"column": "string",
"groupColumns": "array",
"n": "int",
"tables": "stream"
}
},
{"name": "lowestMin",
"params": {"column": "string",
"groupColumns": "array",
"n": "int",
"tables": "stream"
}
},
{"name": "map",
"params": {"fn": "function",
"mergeKey": "bool",
"tables": "stream"
}
},
{"name": "max",
"params": {"column": "string",
"tables": "stream"
}
},
{"name": "mean",
"params": {"column": "string",
"tables": "stream"
}
},
{"name": "median",
"params": {"column": "string",
"compression": "float",
"method": "string",
"tables": "stream"
}
},
{"name": "min",
"params": {"column": "string",
"tables": "stream"
}
},
{"name": "mode",
"params": {"column": "string",
"tables": "stream"
}
},
{"name": "movingAverage",
"params": {"n": "int",
"tables": "stream"
}
},
{"name": "now",
"params": { }
},
{"name": "pearsonr",
"params": {"on": "array",
"x": "invalid",
"y": "invalid"
}
},
{"name": "pivot",
"params": {"columnKey": "array",
"rowKey": "array",
"tables": "stream",
"valueColumn": "string"
}
},
{"name": "quantile",
"params": {"column": "string",
"compression": "float",
"method": "string",
"q": "float",
"tables": "stream"
}
},
{"name": "range",
"params": {"start": "invalid",
"stop": "invalid",
"tables": "stream"
}
},
{"name": "reduce",
"params": {"fn": "function",
"identity": "invalid",
"tables": "stream"
}
},
{"name": "relativeStrengthIndex",
"params": {"columns": "array",
"n": "int",
"tables": "stream"
}
},
{"name": "rename",
"params": {"columns": "invalid",
"fn": "function",
"tables": "stream"
}
},
{"name": "sample",
"params": {"column": "string",
"n": "int",
"pos": "int",
"tables": "stream"
}
},
{"name": "set",
"params": {"key": "string",
"tables": "stream",
"value": "string"
}
},
{"name": "skew",
"params": {"column": "string",
"tables": "stream"
}
},
{"name": "sort",
"params": {"columns": "array",
"desc": "bool",
"tables": "stream"
}
},
{"name": "spread",
"params": {"column": "string",
"tables": "stream"
}
},
{"name": "stateCount",
"params": {"column": "string",
"fn": "function",
"tables": "stream"
}
},
{"name": "stateDuration",
"params": {"column": "string",
"fn": "function",
"tables": "stream",
"timeColumn": "string",
"unit": "duration"
}
},
{"name": "stateTracking",
"params": {"countColumn": "string",
"durationColumn": "string",
"durationUnit": "duration",
"fn": "function",
"tables": "stream",
"timeColumn": "string"
}
},
{"name": "stddev",
"params": {"column": "string",
"mode": "string",
"tables": "stream"
}
},
{"name": "string",
"params": {"v": "invalid"
}
},
{"name": "sum",
"params": {"column": "string",
"tables": "stream"
}
},
{"name": "tableFind",
"params": {"fn": "function",
"tables": "stream"
}
},
{"name": "tail",
"params": {"n": "int",
"offset": "int",
"tables": "stream"
}
},
{"name": "time",
"params": {"v": "invalid"
}
},
{"name": "timeShift",
"params": {"columns": "array",
"duration": "duration",
"tables": "stream"
}
},
{"name": "timeWeightedAvg",
"params": {"tables": "stream",
"unit": "duration"
}
},
{"name": "timedMovingAverage",
"params": {"column": "string",
"every": "duration",
"period": "duration",
"tables": "stream"
}
},
{"name": "to",
"params": {"bucket": "string",
"bucketID": "string",
"fieldFn": "function",
"host": "string",
"measurementColumn": "string",
"org": "string",
"orgID": "string",
"tables": "stream",
"tagColumns": "array",
"timeColumn": "string",
"token": "string"
}
},
{"name": "toBool",
"params": {"tables": "stream"
}
},
{"name": "toFloat",
"params": {"tables": "stream"
}
},
{"name": "toInt",
"params": {"tables": "stream"
}
},
{"name": "toString",
"params": {"tables": "stream"
}
},
{"name": "toTime",
"params": {"tables": "stream"
}
},
{"name": "toUInt",
"params": {"tables": "stream"
}
},
{"name": "today",
"params": { }
},
{"name": "top",
"params": {"columns": "array",
"n": "int",
"tables": "stream"
}
},
{"name": "tripleEMA",
"params": {"n": "int",
"tables": "stream"
}
},
{"name": "tripleExponentialDerivative",
"params": {"n": "int",
"tables": "stream"
}
},
{"name": "truncateTimeColumn",
"params": {"tables": "stream",
"timeColumn": "invalid",
"unit": "duration"
}
},
{"name": "uint",
"params": {"v": "invalid"
}
},
{"name": "union",
"params": {"tables": "array"
}
},
{"name": "unique",
"params": {"column": "string",
"tables": "stream"
}
},
{"name": "wideTo",
"params": {"bucket": "string",
"bucketID": "string",
"host": "string",
"org": "string",
"orgID": "string",
"tables": "stream",
"token": "string"
}
},
{"name": "window",
"params": {"createEmpty": "bool",
"every": "duration",
"location": "object",
"offset": "duration",
"period": "duration",
"startColumn": "string",
"stopColumn": "string",
"tables": "stream",
"timeColumn": "string"
}
},
{"name": "yield",
"params": {"name": "string",
"tables": "stream"
}
}
]
}

检索一个分支建议的查询建议

检索包含请求函数名称和参数的查询建议。

使用此接口传递一个分枝建议（一个 Flux 函数名称），并获取请求函数的参数。

限制

使用 /api/v2/query/suggestions/{name} （没有尾部斜杠）。 /api/v2/query/suggestions/{name}/ （注意尾部斜杠）会导致 HTTP 301 Moved Permanently 状态。
函数 name 必须存在并且拼写正确。

List of all Flux functions

授权：

TokenAuthentication

路径参数

名称

必填

字符串

一个 Flux 函数名称。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

请求示例

cURL

curl --request GET "INFLUX_URL/api/v2/query/suggestions/sum/" \
  --header "Accept: application/json" \
  --header "Authorization: Token INFLUX_API_TOKEN"

响应示例

200
500

Content type

application/json

{"name": "sum",
"params": {"column": "string",
"tables": "stream"
}
}

资源

列出所有已知资源

授权：

TokenAuthentication

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
default

Content type

application/json

["string"
]

路由

列出所有顶级路由

检索 InfluxDB API 的所有顶级路由。

限制

Only returns top level routes--for example, the response contains "tasks":"/api/v2/tasks", and doesn't contain resource-specific routes for tasks (/api/v2/tasks/TASK_ID/...).

授权：

TokenAuthentication

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200

Content type

application/json

{"authorizations": "http://example.com",
"buckets": "http://example.com",
"dashboards": "http://example.com",
"external": {"statusFeed": "http://example.com"
},
"flags": "http://example.com",
"me": "http://example.com",
"orgs": "http://example.com",
"query": {"analyze": "http://example.com",
"ast": "http://example.com",
"self": "http://example.com",
"suggestions": "http://example.com"
},
"setup": "http://example.com",
"signin": "http://example.com",
"signout": "http://example.com",
"sources": "http://example.com",
"system": {"debug": "http://example.com",
"health": "http://example.com",
"metrics": "http://example.com"
},
"tasks": "http://example.com",
"telegrafs": "http://example.com",
"users": "http://example.com",
"variables": "http://example.com",
"write": "http://example.com"
}

规则

检索通知规则查询

授权：

TokenAuthentication

路径参数

规则ID

必需

字符串

通知规则ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
400
404
default

Content type

application/json

{"flux": "string"
}

秘密

列出一个组织的所有秘密密钥

授权：

TokenAuthentication

路径参数

orgID

必需

字符串

组织ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
default

Content type

application/json

{"secrets": ["string"
],
"links": {"org": "string",
"self": "string"
}
}

在组织中更新机密

授权：

TokenAuthentication

路径参数

orgID

必需

字符串

组织ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

秘密密钥值对以更新/添加

属性名称*

字符串

响应

请求示例

Payload

Content type

application/json

{"apikey": "abc123xyz"
}

响应示例

default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

从组织中删除一个秘密

授权：

TokenAuthentication

路径参数

orgID 必需	字符串组织ID。
secretID 必填	字符串密钥 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

从组织中删除秘密已弃用

授权：

TokenAuthentication

路径参数

orgID

必需

字符串

组织ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

删除的密钥

密钥

字符串的数组

响应

请求示例

Payload

Content type

application/json

{"secrets": ["string"
]
}

响应示例

default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

设置

获取设置状态

检查是否允许设置。如果未创建默认用户、组织或存储桶，则返回 true。

授权：

TokenAuthentication

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200

Content type

application/json

{"allowed": true
}

创建一个初始用户、组织和存储桶

发布一个入职请求以创建初始用户、组织和存储桶。

授权：

TokenAuthentication

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

创建来源

桶必需	字符串
	对象 (限制) 这些是类似于在quartz中配置的组织限制。
组织必需	字符串
密码	字符串
保留周期小时	整数已弃用
保留期限（秒）	整数
用户名必需	字符串

响应

请求示例

Payload

Content type

application/json

{"bucket": "string",
"limit": {"bucket": {"maxBuckets": 0,
"maxRetentionDuration": 0
},
"check": {"maxChecks": 0
},
"dashboard": {"maxDashboards": 0
},
"features": {"allowDelete": true
},
"notificationEndpoint": {"blockedNotificationEndpoints": "http,pagerduty"
},
"notificationRule": {"blockedNotificationRules": "http,pagerduty",
"maxNotifications": 0
},
"orgID": "string",
"rate": {"cardinality": 0,
"concurrentDeleteRequests": 0,
"concurrentReadRequests": 0,
"concurrentWriteRequests": 0,
"deleteRequestsPerSecond": 0,
"queryTime": 0,
"readKBs": 0,
"writeKBs": 0
},
"stack": {"enabled": true
},
"task": {"maxTasks": 0
},
"timeout": {"queryUnconditionalTimeoutSeconds": 0,
"queryidleWriteTimeoutSeconds": 0
}
},
"org": "string",
"password": "string",
"retentionPeriodHrs": 0,
"retentionPeriodSeconds": 0,
"username": "string"
}

响应示例

201
default

Content type

application/json

{"auth": {"description": "string",
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "/api/v2/authorizations/1",
"user": "/api/v2/users/12"
},
"org": "string",
"orgID": "string",
"permissions": [{"action": "read",
"resource": {"id": "string",
"name": "string",
"org": "string",
"orgID": "string",
"type": "authorizations"
}
}
],
"token": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"user": "string",
"userID": "string"
},
"bucket": {"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"labels": "/api/v2/buckets/1/labels",
"members": "/api/v2/buckets/1/members",
"org": "/api/v2/orgs/2",
"owners": "/api/v2/buckets/1/owners",
"self": "/api/v2/buckets/1",
"write": "/api/v2/write?org=2&bucket=1"
},
"name": "string",
"orgID": "string",
"retentionRules": [{"everySeconds": 86400,
"shardGroupDurationSeconds": 0,
"type": "expire"
}
],
"rp": "string",
"schemaType": "implicit",
"type": "user",
"updatedAt": "2019-08-24T14:15:22Z"
},
"org": {"createdAt": "2019-08-24T14:15:22Z",
"defaultStorageType": "tsm",
"description": "string",
"id": "string",
"links": {"buckets": "/api/v2/buckets?org=myorg",
"dashboards": "/api/v2/dashboards?org=myorg",
"labels": "/api/v2/orgs/1/labels",
"members": "/api/v2/orgs/1/members",
"owners": "/api/v2/orgs/1/owners",
"secrets": "/api/v2/orgs/1/secrets",
"self": "/api/v2/orgs/1",
"tasks": "/api/v2/tasks?org=myorg"
},
"name": "string",
"status": "active",
"updatedAt": "2019-08-24T14:15:22Z"
},
"user": {"id": "string",
"links": {"self": "/api/v2/users/1"
},
"name": "string",
"status": "active"
}
}

创建一个新的用户、组织和存储桶

发布一个入职请求以创建新用户、组织和桶。

授权：

TokenAuthentication

请求体模式: application/json

创建来源

桶必需	字符串
	对象 (限制) 这些是类似于 quartz 中配置的组织限制。
组织必需	字符串
密码	字符串
保留期小时	整数已弃用
保留时间（秒）	整数
用户名必需	字符串

响应

请求示例

Payload

Content type

application/json

{"bucket": "string",
"limit": {"bucket": {"maxBuckets": 0,
"maxRetentionDuration": 0
},
"check": {"maxChecks": 0
},
"dashboard": {"maxDashboards": 0
},
"features": {"allowDelete": true
},
"notificationEndpoint": {"blockedNotificationEndpoints": "http,pagerduty"
},
"notificationRule": {"blockedNotificationRules": "http,pagerduty",
"maxNotifications": 0
},
"orgID": "string",
"rate": {"cardinality": 0,
"concurrentDeleteRequests": 0,
"concurrentReadRequests": 0,
"concurrentWriteRequests": 0,
"deleteRequestsPerSecond": 0,
"queryTime": 0,
"readKBs": 0,
"writeKBs": 0
},
"stack": {"enabled": true
},
"task": {"maxTasks": 0
},
"timeout": {"queryUnconditionalTimeoutSeconds": 0,
"queryidleWriteTimeoutSeconds": 0
}
},
"org": "string",
"password": "string",
"retentionPeriodHrs": 0,
"retentionPeriodSeconds": 0,
"username": "string"
}

响应示例

201
default

Content type

application/json

{"auth": {"description": "string",
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "/api/v2/authorizations/1",
"user": "/api/v2/users/12"
},
"org": "string",
"orgID": "string",
"permissions": [{"action": "read",
"resource": {"id": "string",
"name": "string",
"org": "string",
"orgID": "string",
"type": "authorizations"
}
}
],
"token": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"user": "string",
"userID": "string"
},
"bucket": {"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"labels": "/api/v2/buckets/1/labels",
"members": "/api/v2/buckets/1/members",
"org": "/api/v2/orgs/2",
"owners": "/api/v2/buckets/1/owners",
"self": "/api/v2/buckets/1",
"write": "/api/v2/write?org=2&bucket=1"
},
"name": "string",
"orgID": "string",
"retentionRules": [{"everySeconds": 86400,
"shardGroupDurationSeconds": 0,
"type": "expire"
}
],
"rp": "string",
"schemaType": "implicit",
"type": "user",
"updatedAt": "2019-08-24T14:15:22Z"
},
"org": {"createdAt": "2019-08-24T14:15:22Z",
"defaultStorageType": "tsm",
"description": "string",
"id": "string",
"links": {"buckets": "/api/v2/buckets?org=myorg",
"dashboards": "/api/v2/dashboards?org=myorg",
"labels": "/api/v2/orgs/1/labels",
"members": "/api/v2/orgs/1/members",
"owners": "/api/v2/orgs/1/owners",
"secrets": "/api/v2/orgs/1/secrets",
"self": "/api/v2/orgs/1",
"tasks": "/api/v2/tasks?org=myorg"
},
"name": "string",
"status": "active",
"updatedAt": "2019-08-24T14:15:22Z"
},
"user": {"id": "string",
"links": {"self": "/api/v2/users/1"
},
"name": "string",
"status": "active"
}
}

登出

过期用户会话

使由会话 cookie 指定的用户会话过期。

使用此端点使用户会话失效，该会话是在用户通过InfluxDB开发者控制台（UI）或POST /api/v2/signin端点进行身份验证时生成的。

例如，POST /api/v2/signout 端点代表以下三步过程中的第三步用于验证用户，检索user资源，然后使会话失效：

Send a request with the user's Basic authentication credentials to the POST /api/v2/signin endpoint to create a user session and generate a session cookie.
Send a request to the GET /api/v2/me endpoint, passing the stored session cookie from step 1 to retrieve user information.
Send a request to the POST /api/v2/signout endpoint, passing the stored session cookie to expire the session.

请参阅请求示例中的完整示例。

InfluxDB仅将用户会话存储在内存中。如果用户没有注销，则用户会话将在十分钟内自动过期或在InfluxDB实例重启期间过期。

要了解更多关于HTTP请求中的cookie，请参阅 Mozilla Developer Network (MDN) Web Docs, HTTP cookies。

Signin

授权：

TokenAuthentication

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

请求示例

cURL: sign in a user, verify the user session, and then end the session

# The following example shows how to use cURL and the InfluxDB API
# to do the following:
# 1. Sign in a user with a username and password.
# 2. Check that the user session exists for the user.
# 3. Sign out the user to expire the session.
# 4. Check that the session is no longer active.

# 1. Send a request to `POST /api/v2/signin` to sign in the user.
#    In your request, pass the following:
#
#      - `--user` option with basic authentication credentials.
#      - `-c` option with a file path where cURL will write cookies.

      curl --request POST \
        -c ./cookie-file.tmp \
        "$INFLUX_URL/api/v2/signin" \
        --user "${INFLUX_USER_NAME}:${INFLUX_USER_PASSWORD}"

# 2. To check that a user session exists for the user in step 1,
#    send a request to `GET /api/v2/me`.
#    In your request, pass the `-b` option with the session cookie file path from step 1.

      curl --request GET \
        -b ./cookie-file.tmp \
        "$INFLUX_URL/api/v2/me"

#    InfluxDB responds with the `user` resource.

# 3. Send a request to `POST /api/v2/signout` to expire the user session.
#    In your request, pass the `-b` option with the session cookie file path from step 1.

      curl --request POST \
        -b ./cookie-file.tmp \
        "$INFLUX_URL/api/v2/signout"

#     If the user session is successfully expired, InfluxDB responds with
      an HTTP `204` status code.

# 4. To check that the user session is expired, call `GET /api/v2/me` again,
#    passing the `-b` option with the cookie file path.

      curl --request GET \
        -b ./cookie-file.tmp \
        "$INFLUX_URL/api/v2/me"

#    If the user session is expired, InfluxDB responds with an HTTP `401` status code.

响应示例

401
default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

任务

处理和分析您的数据，使用 tasks 在 InfluxDB 任务引擎中。使用 /api/v2/tasks 接口调度和管理任务、重试任务运行以及检索运行日志。

要配置任务，请提供脚本和运行任务的计划。有关示例，请参见如何使用 POST /api/v2/tasks 端点创建任务。

属性

A task 对象包含关于 InfluxDB 任务资源的信息。

下表定义了在该对象中出现的属性：

authorizationID	字符串授权 ID。指定任务与查询引擎通信时使用的授权。要查找授权 ID，请使用 `GET /api/v2/authorizations` endpoint 列出授权。
创建时间	字符串 <日期-时间>
cron	字符串一个Cron 表达式，定义任务运行的时间表。InfluxDB在评估Cron表达式时使用系统时间。
描述	字符串任务的描述。
每	字符串 <duration> 任务运行的间隔（duration literal）。 `every` 还决定了任务首次运行的时间，这取决于指定的时间。
flux	字符串任务执行的 Flux 脚本。限制如果使用 `flux` 属性，将无法使用 `scriptID` 和 `scriptParameters` 属性。
编号必填	字符串
	数组对象（标签）
上次运行错误	字符串
最后运行状态	字符串枚举: "失败" "成功" "已取消"
latestCompleted	字符串 <日期-时间> 最新计划和完成运行的时间戳（RFC3339 日期/时间格式）。
	对象
名称必填	字符串任务的名称。
偏移量	字符串 <持续时间> 在预定时间经过后，延迟执行任务的持续时间。 `0` 移除偏移量。
组织	字符串一个组织名称。指定拥有该任务的组织。
orgID 必需	字符串一个组织 ID。指定拥有该任务的组织。
ownerID	string 一个用户 ID。指定任务的所有者。要查找用户 ID，您可以使用`GET /api/v2/users` 接口来列出用户。
scriptID	字符串脚本 ID。指定任务执行的可调用脚本。限制如果使用 `scriptID` 属性，则不能使用 `flux` 属性。相关指南创建一个引用脚本的任务
scriptParameters	object 脚本中 `params` 的键值对。定义传递给由 `scriptID` 指定的脚本的调用参数值。在运行任务时，InfluxDB 使用您提供的参数执行脚本。限制要使用 `scriptParameters`，您必须提供 `scriptID`。如果您使用 `scriptID` 和 `scriptParameters` 属性，您不能使用 `flux` 属性。
状态	字符串 (TaskStatusType) 枚举： "active" "inactive" `inactive` 取消计划运行并防止手动运行任务。
更新时间	字符串 <日期-时间>

{"authorizationID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"cron": "string",
"description": "string",
"every": "string",
"flux": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"lastRunError": "string",
"lastRunStatus": "failed",
"latestCompleted": "2019-08-24T14:15:22Z",
"links": {"labels": "/api/v2/tasks/1/labels",
"logs": "/api/v2/tasks/1/logs",
"members": "/api/v2/tasks/1/members",
"owners": "/api/v2/tasks/1/owners",
"runs": "/api/v2/tasks/1/runs",
"self": "/api/v2/tasks/1"
},
"name": "string",
"offset": "string",
"org": "string",
"orgID": "string",
"ownerID": "string",
"scriptID": "string",
"scriptParameters": { },
"status": "active",
"updatedAt": "2019-08-24T14:15:22Z"
}

列出所有任务

检索任务的列表。

要限制返回的任务，请在请求中传递查询参数。如果没有传递查询参数，InfluxDB将返回所有任务，直到默认的 limit。

授权：

TokenAuthentication

查询参数

之后	字符串 A task ID. 仅返回在指定任务之后创建的任务。
限制	整数 [ -1 .. 500 ] 默认值: 100 示例: limit=-1 - 返回所有任务，无需分页。 limit=50 - 最多返回50个任务。要返回的最大任务数量。默认值为`100`。最小值为`1`，最大值为`500`。为了减少负载大小，请结合`type=basic`和`limit`（请参见请求示例）。有关`basic`响应的更多信息，请参见`type`参数。
名称	字符串一个任务名称。仅返回具有指定名称的任务。不同的任务可能具有相同的名称。
偏移量	整数 >= 0 默认: 0 要跳过的记录数。
组织	字符串一个组织名称。仅返回由指定组织拥有的任务。
orgID	string 一个组织 ID。仅返回指定组织拥有的任务。
scriptID	字符串 A script ID. 只返回使用指定可调用脚本的任务。
sortBy	字符串值： "name" 排序字段。仅支持 `name`。指定用于排序列表中记录的字段。
状态	字符串枚举： "active" "inactive" A task 状态。只返回具有指定状态（`active` 或 `inactive`）的任务。
类型	字符串默认: "" 枚举: "basic" "system" 一种任务类型 (`basic` 或 `system`)。默认是 `system`。指定响应中任务的详细程度。默认 (`system`) 响应包含所有任务的元数据属性。若要减小响应大小，传递 `basic` 以省略某些任务属性 (`flux`, `createdAt`, `updatedAt`)。
用户	字符串 A 用户 ID. 仅返回由指定用户拥有的任务。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

请求示例

cURL: all tasks, basic output

curl INFLUX_URL/api/v2/tasks/?limit=-1&type=basic \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Token INFLUX_API_TOKEN'

响应示例

200
401
500
default

Content type

application/json

Example

一个示例响应正文用于 ?type=basic 参数。 type=basic 在响应中省略了一些任务字段 (createdAt 和 updatedAt) 以及字段值 (org, flux)。

{"links": {"self": "/api/v2/tasks?limit=100"
},
"tasks": [{"every": "30m",
"flux": "",
"id": "09956cbb6d378000",
"labels": [ ],
"lastRunStatus": "success",
"latestCompleted": "2022-06-30T15:00:00Z",
"links": {"labels": "/api/v2/tasks/09956cbb6d378000/labels",
"logs": "/api/v2/tasks/09956cbb6d378000/logs",
"members": "/api/v2/tasks/09956cbb6d378000/members",
"owners": "/api/v2/tasks/09956cbb6d378000/owners",
"runs": "/api/v2/tasks/09956cbb6d378000/runs",
"self": "/api/v2/tasks/09956cbb6d378000"
},
"name": "task1",
"org": "",
"orgID": "48c88459ee424a04",
"ownerID": "0772396d1f411000",
"status": "active"
}
]
}

创建任务

创建一个 task 并返回该任务。

使用此端点创建一个运行 Flux 脚本的计划任务。

InfluxDB云

您可以使用 flux 或 scriptID 来提供任务脚本。

flux：一串“原始”的 Flux，包含任务选项和脚本——例如：

{
  "flux": "option task = {name: \"CPU Total 1 Hour New\", every: 1h}\
  from(bucket: \"telegraf\")
    |> range(start: -1h)
    |> filter(fn: (r) => (r._measurement == \"cpu\"))
    |> filter(fn: (r) =>\n\t\t(r._field == \"usage_system\"))
    |> filter(fn: (r) => (r.cpu == \"cpu-total\"))
    |> aggregateWindow(every: 1h, fn: max)
    |> to(bucket: \"cpu_usage_user_total_1h\", org: \"INFLUX_ORG\")",
  "status": "active",
  "description": "This task downsamples CPU data every hour"
}

scriptID：要运行的可调用脚本的ID。使用 scriptID 时，要传递任务选项，将选项作为请求体中的属性传递——例如：

{
  "name": "CPU Total 1 Hour New",
  "description": "This task downsamples CPU data every hour",
  "every": "1h",
  "scriptID": "SCRIPT_ID",
  "scriptParameters":
    {
      "rangeStart": "-1h",
      "bucket": "telegraf",
      "filterField": "cpu-total"
    }
  }

限制：

You can't use flux and scriptID for the same task.

授权：

TokenAuthentication

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

创建任务

cron	字符串一个 Cron 表达式，定义任务运行的时间表。InfluxDB 的 cron 运行基于系统时间。
描述	字符串任务的描述。
每个	字符串任务运行的时间间隔 (duration literal)。 `every` 还决定了任务首次运行的时间，这取决于指定的时间。
flux	字符串任务运行的Flux脚本。限制如果使用`flux`属性，则不能使用`scriptID`和`scriptParameters`属性。
名称	字符串任务的名称
偏移量	字符串 <持续时间> 在预定时间经过后，延迟执行任务的持续时间。 `0` 移除偏移量。
org	string 拥有该任务的组织的名称。
orgID	string 拥有该任务的组织的ID。
脚本ID	字符串任务运行的脚本的ID。限制如果使用 `scriptID` 属性，则不能使用 `flux` 属性。
scriptParameters	对象在任务运行期间传递给脚本（通过 `scriptID` 引用）的参数键值对。限制 `scriptParameters` 需要 `scriptID`。如果使用 `scriptID` 和 `scriptParameters` 属性，则不能使用 `flux` 属性。
状态	字符串 (TaskStatusType) 枚举： "active" "inactive" `inactive` 取消计划运行并防止手动运行任务。

响应

请求示例

Payload
cURL: create a Flux script task
cURL: create a Flux script reference task

Content type

application/json

{"cron": "string",
"description": "string",
"every": "string",
"flux": "string",
"name": "string",
"offset": "string",
"org": "string",
"orgID": "string",
"scriptID": "string",
"scriptParameters": { },
"status": "active"
}

响应示例

201
400
401
500
default

Content type

application/json

{"authorizationID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"cron": "string",
"description": "string",
"every": "string",
"flux": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"lastRunError": "string",
"lastRunStatus": "failed",
"latestCompleted": "2019-08-24T14:15:22Z",
"links": {"labels": "/api/v2/tasks/1/labels",
"logs": "/api/v2/tasks/1/logs",
"members": "/api/v2/tasks/1/members",
"owners": "/api/v2/tasks/1/owners",
"runs": "/api/v2/tasks/1/runs",
"self": "/api/v2/tasks/1"
},
"name": "string",
"offset": "string",
"org": "string",
"orgID": "string",
"ownerID": "string",
"scriptID": "string",
"scriptParameters": { },
"status": "active",
"updatedAt": "2019-08-24T14:15:22Z"
}

删除一个任务

删除一个 task 和相关记录。

使用此端点删除任务及所有相关记录（任务运行、日志和标签）。一旦任务被删除，InfluxDB 将取消该任务的所有计划运行。

如果您想要禁用一个任务而不是删除它，请将任务状态更新为 inactive。

授权：

TokenAuthentication

路径参数

任务ID

必填

字符串

A task ID. Specifies the task to delete.

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

400
401
404
500
default

Content type

application/json

{"code": "invalid",
"message": "failed to decode request body: organization not found"
}

检索一个任务

检索一个任务。

授权：

TokenAuthentication

路径参数

任务ID

必需

字符串

一个任务 ID。指定要检索的任务。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

Content type

application/json

{"authorizationID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"cron": "string",
"description": "string",
"every": "string",
"flux": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"lastRunError": "string",
"lastRunStatus": "failed",
"latestCompleted": "2019-08-24T14:15:22Z",
"links": {"labels": "/api/v2/tasks/1/labels",
"logs": "/api/v2/tasks/1/logs",
"members": "/api/v2/tasks/1/members",
"owners": "/api/v2/tasks/1/owners",
"runs": "/api/v2/tasks/1/runs",
"self": "/api/v2/tasks/1"
},
"name": "string",
"offset": "string",
"org": "string",
"orgID": "string",
"ownerID": "string",
"scriptID": "string",
"scriptParameters": { },
"status": "active",
"updatedAt": "2019-08-24T14:15:22Z"
}

更新一个任务

更新一个 task，然后取消所有计划好的任务运行。

使用此端点来设置、修改或清除任务属性--例如： cron、 name、 flux、 status。一旦 InfluxDB 应用更新，它将取消该任务之前计划的所有运行。

要更新一个任务，传递一个包含更新后的键值对的对象。要激活或停用一个任务，设置 status 属性。 "status": "inactive" 取消已调度的运行并防止手动运行该任务。

InfluxDB云

使用 flux 或 scriptID 来提供任务脚本。

flux：一串“原始”的 Flux，包含任务选项和脚本——例如：

{
  "flux": "option task = {name: \"CPU Total 1 Hour New\", every: 1h}\
  from(bucket: \"telegraf\")
    |> range(start: -1h)
    |> filter(fn: (r) => (r._measurement == \"cpu\"))
    |> filter(fn: (r) =>\n\t\t(r._field == \"usage_system\"))
    |> filter(fn: (r) => (r.cpu == \"cpu-total\"))
    |> aggregateWindow(every: 1h, fn: max)
    |> to(bucket: \"cpu_usage_user_total_1h\", org: \"INFLUX_ORG\")",
  "status": "active",
  "description": "This task downsamples CPU data every hour"
}

scriptID：要运行的可调用脚本的ID。使用 scriptID 时，要传递任务选项，将选项作为请求体中的属性传递——例如：

{
  "name": "CPU Total 1 Hour New",
  "description": "This task downsamples CPU data every hour",
  "every": "1h",
  "scriptID": "SCRIPT_ID",
  "scriptParameters":
    {
      "rangeStart": "-1h",
      "bucket": "telegraf",
      "filterField": "cpu-total"
    }
  }

限制：

You can't use flux and scriptID for the same task.

授权：

TokenAuthentication

路径参数

任务ID

必需

字符串

一个任务 ID。指定要更新的任务。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

要应用的任务更新。

定时任务	字符串更新flux脚本中的'cron'选项。
描述	字符串更新任务的描述。
每个	字符串更新flux脚本中的'every'选项。
flux	string 更新任务运行的Flux脚本。
名称	字符串更新flux脚本中的'名称'选项。
offset	string 更新flux脚本中的'offset'选项。
脚本ID	字符串更新任务的 'scriptID'。
scriptParameters	object 更新任务的 'scriptParameters'。
状态	字符串 (TaskStatusType) 枚举： "active" "inactive" `inactive` 取消计划运行并防止手动运行任务。

响应

请求示例

Payload

Content type

application/json

{"cron": "string",
"description": "string",
"every": "string",
"flux": "string",
"name": "string",
"offset": "string",
"scriptID": "string",
"scriptParameters": { },
"status": "active"
}

响应示例

Content type

application/json

{"authorizationID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"cron": "string",
"description": "string",
"every": "string",
"flux": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"lastRunError": "string",
"lastRunStatus": "failed",
"latestCompleted": "2019-08-24T14:15:22Z",
"links": {"labels": "/api/v2/tasks/1/labels",
"logs": "/api/v2/tasks/1/logs",
"members": "/api/v2/tasks/1/members",
"owners": "/api/v2/tasks/1/owners",
"runs": "/api/v2/tasks/1/runs",
"self": "/api/v2/tasks/1"
},
"name": "string",
"offset": "string",
"org": "string",
"orgID": "string",
"ownerID": "string",
"scriptID": "string",
"scriptParameters": { },
"status": "active",
"updatedAt": "2019-08-24T14:15:22Z"
}

列出任务标签

检索任务的所有标签列表。

标签可以用于分组和过滤任务。

授权：

TokenAuthentication

路径参数

任务ID

必填

字符串

用于检索标签的任务的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

Content type

application/json

{"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"next": "http://example.com",
"prev": "http://example.com",
"self": "http://example.com"
}
}

给任务添加标签

为任务添加标签。

使用此端点添加一个标签，以便您可以在InfluxDB UI中筛选任务。

授权：

TokenAuthentication

路径参数

任务ID

必填

字符串

要标记的任务ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

一个包含 labelID 的对象，用于添加到任务中。

labelID

必填

字符串

标签ID。指定要附加的标签。

响应

请求示例

Payload

Content type

application/json

{"labelID": "string"
}

响应示例

Content type

application/json

{"label": {"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
},
"links": {"next": "http://example.com",
"prev": "http://example.com",
"self": "http://example.com"
}
}

从任务中删除标签

从任务中删除标签。

授权：

TokenAuthentication

路径参数

labelID 必填	字符串要删除的标签的ID。
任务ID 必需	字符串要从中删除标签的任务的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

400
401
404
500
default

Content type

application/json

{"code": "invalid",
"message": "failed to decode request body: organization not found"
}

检索任务的所有日志

检索所有任务的日志列表。

当一个InfluxDB任务运行时，在任务历史中创建一个“运行”记录。与每次运行相关的日志提供相关的日志消息、时间戳和运行尝试的退出状态。

使用此端点仅检索任务的日志事件，而不包含额外的任务元数据。

授权：

TokenAuthentication

路径参数

任务ID

必填

字符串

任务的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

Content type

application/json

Example

{"events": [{"message": "Started task from script: \"option task = {name: \\\"test task\\\", every: 3d, offset: 0s}\"",
"runID": "09a946fc3167d000",
"time": "2022-07-13T07:06:54.198167Z"
},
{"message": "Completed(failed)",
"runID": "09a946fc3167d000",
"time": "2022-07-13T07:07:13.104037Z"
},
{"message": "error exhausting result iterator: error in query specification while starting program: this Flux script returns no streaming data. Consider adding a \"yield\" or invoking streaming functions directly, without performing an assignment",
"runID": "09a946fc3167d000",
"time": "2022-07-13T08:24:37.115323Z"
}
]
}

列出所有任务成员已弃用

已弃用: 任务不使用 owner 和 member 角色。使用 /api/v2/authorizations 来分配用户权限。

列出所有对指定的任务具有 member 角色的用户。

授权：

TokenAuthentication

路径参数

任务ID

必填

字符串

任务的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"links": {"self": "/api/v2/users/1"
},
"name": "string",
"status": "active",
"role": "member"
}
]
}

向任务添加成员已弃用

已弃用: 任务不使用 owner 和 member 角色。使用 /api/v2/authorizations 来分配用户权限。

将用户添加到任务的成员中并返回该成员。

授权：

TokenAuthentication

路径参数

任务ID

必填

字符串

任务的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

一个用户作为任务的成员添加。

id 必需	字符串要添加到资源的用户ID。
姓名	字符串要添加到资源中的用户姓名。

响应

请求示例

Payload

Content type

application/json

{"id": "string",
"name": "string"
}

响应示例

201
default

Content type

application/json

{"id": "string",
"links": {"self": "/api/v2/users/1"
},
"name": "string",
"status": "active",
"role": "member"
}

从任务中移除成员已弃用

已弃用: 任务不使用 owner 和 member 角色。使用 /api/v2/authorizations 来分配用户权限。

从任务中移除一个成员。

授权：

TokenAuthentication

路径参数

任务ID 必填	字符串任务的ID。
用户ID 必需	字符串要移除的成员的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

列出任务的所有拥有者已弃用

已弃用: 任务不使用 owner 和 member 角色。使用 /api/v2/authorizations 来分配用户权限。

检索对任务具有所有者权限的所有用户。

授权：

TokenAuthentication

路径参数

taskID

必需

字符串

要检索所有者的任务ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
401
422
500
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"links": {"self": "/api/v2/users/1"
},
"name": "string",
"status": "active",
"role": "owner"
}
]
}

为任务添加所有者不推荐使用

已弃用: 任务不使用 owner 和 member 角色。使用 /api/v2/authorizations 来分配用户权限。

将任务 owner 角色分配给用户。

使用此端点为任务创建一个 资源拥有者。 资源拥有者 是对于特定资源具有 role: owner 的用户。

授权：

TokenAuthentication

路径参数

任务ID

必填

字符串

任务的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

一个用户被添加为任务的拥有者。

id 必需	字符串要添加到资源的用户ID。
姓名	字符串要添加到资源中的用户姓名。

响应

请求示例

Payload

Content type

application/json

{"id": "string",
"name": "string"
}

响应示例

201
401
422
500
default

Content type

application/json

{"id": "0772396d1f411000",
"links": {"logs": "/api/v2/users/0772396d1f411000/logs",
"self": "/api/v2/users/0772396d1f411000"
},
"name": "USER_NAME",
"role": "owner",
"status": "active"
}

从任务中移除所有者已弃用

已弃用: 任务不使用 owner 和 member 角色。使用 /api/v2/authorizations 来分配用户权限。

授权：

TokenAuthentication

路径参数

任务ID 必填	字符串任务的ID。
用户ID 必需	字符串要移除的所有者的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

列出任务的运行

检索一个任务的运行列表。

要限制返回的任务运行，您需要在请求中传递查询参数。如果未传递查询参数，InfluxDB 将返回所有任务运行，直到默认的 limit。

授权：

TokenAuthentication

路径参数

任务ID

必填

字符串

获取运行的任务ID。
仅返回该任务的运行。

查询参数

之后	字符串一个任务运行ID。仅返回在此运行之后创建的运行。
afterTime	字符串 <日期-时间> 一个时间戳（RFC3339 日期/时间格式）。仅返回在此时间之后调度的运行。
beforeTime	字符串 <日期-时间> 一个时间戳（RFC3339日期/时间格式）。仅返回在此时间之前计划的运行。
限制	整数 [ 1 .. 500 ] 默认: 100 限制返回的任务运行数量。默认值是 `100`。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
401
500
default

Content type

application/json

{"links": {"next": "http://example.com",
"prev": "http://example.com",
"self": "http://example.com"
},
"runs": [{"finishedAt": "2006-01-02T15:04:05.999999999Z07:00",
"flux": "string",
"id": "string",
"links": {"retry": "/api/v2/tasks/1/runs/1/retry",
"self": "/api/v2/tasks/1/runs/1",
"task": "/api/v2/tasks/1"
},
"log": [{"message": "Halt and catch fire",
"runID": "string",
"time": "2006-01-02T15:04:05.999999999Z07:00"
}
],
"requestedAt": "2006-01-02T15:04:05.999999999Z07:00",
"scheduledFor": "2019-08-24T14:15:22Z",
"startedAt": "2006-01-02T15:04:05.999999999Z07:00",
"status": "scheduled",
"taskID": "string"
}
]
}

开始任务运行，覆盖计划

安排任务立即开始运行，忽略计划中的运行。

使用此端点手动启动任务运行。计划的运行将继续按计划进行。这可能会导致任务并发运行。

要重试之前的运行（并避免创建新的运行），使用POST /api/v2/tasks/{taskID}/runs/{runID}/retry端点。

授权：

TokenAuthentication

路径参数

任务ID

必需

字符串

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

scheduledFor

字符串或空值 <日期-时间>

运行的时间 RFC3339 日期/时间格式用于 now 选项。默认是服务器现在的时间。

响应

请求示例

Payload

Content type

application/json

{"scheduledFor": "2019-08-24T14:15:22Z"
}

响应示例

201
401
500
default

Content type

application/json

{"finishedAt": "2006-01-02T15:04:05.999999999Z07:00",
"flux": "string",
"id": "string",
"links": {"retry": "/api/v2/tasks/1/runs/1/retry",
"self": "/api/v2/tasks/1/runs/1",
"task": "/api/v2/tasks/1"
},
"log": [{"message": "Halt and catch fire",
"runID": "string",
"time": "2006-01-02T15:04:05.999999999Z07:00"
}
],
"requestedAt": "2006-01-02T15:04:05.999999999Z07:00",
"scheduledFor": "2019-08-24T14:15:22Z",
"startedAt": "2006-01-02T15:04:05.999999999Z07:00",
"status": "scheduled",
"taskID": "string"
}

取消正在运行的任务

取消正在运行的 task。

使用此端点与 InfluxDB OSS 取消正在运行的任务。

InfluxDB云

Doesn't support this operation.

授权：

TokenAuthentication

路径参数

runID 必填	字符串要取消的任务运行的ID。
taskID 必填	字符串要取消的任务的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

Content type

application/json

{"code": "invalid",
"message": "failed to decode request body: organization not found"
}

为任务检索一个运行。

检索特定的任务的运行。

使用此端点检索特定任务运行的详细信息和日志。

授权：

TokenAuthentication

路径参数

runID 必填	字符串要检索的运行的ID。
任务ID 必填	字符串要检索运行的任务的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

Content type

application/json

{"finishedAt": "2022-07-18T14:46:07.308254Z",
"id": "09b070dadaa7d000",
"links": {"logs": "/api/v2/tasks/0996e56b2f378000/runs/09b070dadaa7d000/logs",
"retry": "/api/v2/tasks/0996e56b2f378000/runs/09b070dadaa7d000/retry",
"self": "/api/v2/tasks/0996e56b2f378000/runs/09b070dadaa7d000",
"task": "/api/v2/tasks/0996e56b2f378000"
},
"log": [{"message": "Started task from script: \"option task = {name: \\\"task1\\\", every: 30m} from(bucket: \\\"iot_center\\\") |> range(start: -90d) |> filter(fn: (r) => r._measurement == \\\"environment\\\") |> aggregateWindow(every: 1h, fn: mean)\"",
"runID": "09b070dadaa7d000",
"time": "2022-07-18T14:46:07.101231Z"
},
{"message": "Completed(success)",
"runID": "09b070dadaa7d000",
"time": "2022-07-18T14:46:07.242859Z"
}
],
"requestedAt": "2022-07-18T14:46:06Z",
"scheduledFor": "2022-07-18T14:46:06Z",
"startedAt": "2022-07-18T14:46:07.16222Z",
"status": "success",
"taskID": "0996e56b2f378000"
}

检索运行的所有日志

检索任务运行的所有日志。日志是带有 runID、time 和 message 属性的运行事件列表。

使用此端点来帮助分析任务表现并排除失败的任务运行。

授权：

TokenAuthentication

路径参数

runID 必填	字符串要获取日志的运行 ID。
taskID 必需	字符串获取日志的任务ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

Content type

application/json

Example

{"events": [{"message": "Started task from script: \"option task = {name: \\\"test task\\\", every: 3d, offset: 0s}\"",
"runID": "09a946fc3167d000",
"time": "2022-07-13T07:06:54.198167Z"
},
{"message": "Completed(failed)",
"runID": "09a946fc3167d000",
"time": "2022-07-13T07:07:13.104037Z"
},
{"message": "error exhausting result iterator: error in query specification while starting program: this Flux script returns no streaming data. Consider adding a \"yield\" or invoking streaming functions directly, without performing an assignment",
"runID": "09a946fc3167d000",
"time": "2022-07-13T08:24:37.115323Z"
}
]
}

重试任务运行

将任务运行排队以重试，并返回计划的运行。

要手动启动一个新的任务运行，请使用 POST /api/v2/tasks/{taskID}/runs 端点。

限制

The task must be active (status: "active").

授权：

TokenAuthentication

路径参数

运行ID 必填	字符串 A task run ID. 指定要重试的任务运行。要查找任务运行ID，请使用 `GET /api/v2/tasks/{taskID}/runs` endpoint 列出任务运行。
任务ID 必需	字符串一个任务 ID。指定要重试的任务。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式： application/json; charset=utf-8

object

响应

请求示例

Payload

Content type

application/json; charset=utf-8

{ }

响应示例

Content type

application/json

{"id": "09d60ffe08738000",
"links": {"logs": "/api/v2/tasks/09a776832f381000/runs/09d60ffe08738000/logs",
"retry": "/api/v2/tasks/09a776832f381000/runs/09d60ffe08738000/retry",
"self": "/api/v2/tasks/09a776832f381000/runs/09d60ffe08738000",
"task": "/api/v2/tasks/09a776832f381000"
},
"requestedAt": "2022-08-16T20:05:11.84145Z",
"scheduledFor": "2022-08-15T00:00:00Z",
"status": "scheduled",
"taskID": "09a776832f381000"
}

Telegraf 插件

列出所有Telegraf插件

授权：

TokenAuthentication

查询参数

类型	字符串所需插件的类型。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
default

Content type

application/json

{"os": "string",
"plugins": [{"config": "string",
"description": "string",
"name": "string",
"type": "string"
}
],
"version": "string"
}

电报

列出所有 Telegraf 配置

授权：

TokenAuthentication

查询参数

orgID

string

Telegraf 配置所属的组织 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
default

Content type

application/json

{"configurations": [{"config": "string",
"description": "string",
"metadata": {"buckets": ["string"
]
},
"name": "string",
"orgID": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"labels": "/api/v2/telegrafs/1/labels",
"members": "/api/v2/telegrafs/1/members",
"owners": "/api/v2/telegrafs/1/owners",
"self": "/api/v2/telegrafs/1"
}
}
]
}

创建一个 Telegraf 配置

授权：

TokenAuthentication

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

创建Telegraf配置

配置	字符串
描述	字符串
	对象
名称	字符串
组织编号	字符串
	对象的数组

响应

请求示例

Payload

Content type

application/json

{"config": "string",
"description": "string",
"metadata": {"buckets": ["string"
]
},
"name": "string",
"orgID": "string",
"plugins": [{"alias": "string",
"config": "string",
"description": "string",
"name": "string",
"type": "string"
}
]
}

响应示例

201
default

Content type

application/json

{"config": "string",
"description": "string",
"metadata": {"buckets": ["string"
]
},
"name": "string",
"orgID": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"labels": "/api/v2/telegrafs/1/labels",
"members": "/api/v2/telegrafs/1/members",
"owners": "/api/v2/telegrafs/1/owners",
"self": "/api/v2/telegrafs/1"
}
}

删除 Telegraf 配置

授权：

TokenAuthentication

路径参数

telegrafID

必填

字符串

Telegraf 配置 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

获取Telegraf配置

授权：

TokenAuthentication

路径参数

telegrafID

必填

字符串

Telegraf 配置 ID。

头部参数

接受	字符串默认: application/toml 枚举: "application/toml" "application/json" "application/octet-stream"
Zap-Trace-Span	字符串示例： baggage,[object Object],span_id,1,trace_id,1 OpenTracing span 上下文

响应

响应示例

200
default

Content type

{"config": "string",
"description": "string",
"metadata": {"buckets": ["string"
]
},
"name": "string",
"orgID": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"labels": "/api/v2/telegrafs/1/labels",
"members": "/api/v2/telegrafs/1/members",
"owners": "/api/v2/telegrafs/1/owners",
"self": "/api/v2/telegrafs/1"
}
}

更新Telegraf配置

授权：

TokenAuthentication

路径参数

telegrafID

必填

字符串

Telegraf 配置 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

Telegraf 配置更新以应用

配置	字符串
描述	字符串
	对象
名称	字符串
组织编号	字符串
	对象的数组

响应

请求示例

Payload

Content type

application/json

{"config": "string",
"description": "string",
"metadata": {"buckets": ["string"
]
},
"name": "string",
"orgID": "string",
"plugins": [{"alias": "string",
"config": "string",
"description": "string",
"name": "string",
"type": "string"
}
]
}

响应示例

200
default

Content type

application/json

{"config": "string",
"description": "string",
"metadata": {"buckets": ["string"
]
},
"name": "string",
"orgID": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"labels": "/api/v2/telegrafs/1/labels",
"members": "/api/v2/telegrafs/1/members",
"owners": "/api/v2/telegrafs/1/owners",
"self": "/api/v2/telegrafs/1"
}
}

列出所有Telegraf配置的标签

授权：

TokenAuthentication

路径参数

telegrafID

必填

字符串

Telegraf 配置 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
default

Content type

application/json

{"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"next": "http://example.com",
"prev": "http://example.com",
"self": "http://example.com"
}
}

将标签添加到Telegraf配置中

授权：

TokenAuthentication

路径参数

telegrafID

必填

字符串

Telegraf 配置 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

要添加的标签

labelID

必填

字符串

标签ID。指定要附加的标签。

响应

请求示例

Payload

Content type

application/json

{"labelID": "string"
}

响应示例

201
default

Content type

application/json

{"label": {"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
},
"links": {"next": "http://example.com",
"prev": "http://example.com",
"self": "http://example.com"
}
}

从Telegraf配置中删除标签

授权：

TokenAuthentication

路径参数

标签ID 必需	字符串标签的ID。
telegrafID 必填	字符串 Telegraf 配置 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

404
default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

列出所有具有成员权限的用户，适用于 Telegraf 配置

授权：

TokenAuthentication

路径参数

telegrafID

必填

字符串

Telegraf 配置 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"links": {"self": "/api/v2/users/1"
},
"name": "string",
"status": "active",
"role": "member"
}
]
}

向Telegraf配置添加成员

授权：

TokenAuthentication

路径参数

telegrafID

必填

字符串

Telegraf 配置 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

用户添加为成员

id 必需	字符串要添加到资源的用户ID。
姓名	字符串要添加到资源中的用户姓名。

响应

请求示例

Payload

Content type

application/json

{"id": "string",
"name": "string"
}

响应示例

201
default

Content type

application/json

{"id": "string",
"links": {"self": "/api/v2/users/1"
},
"name": "string",
"status": "active",
"role": "member"
}

从Telegraf配置中移除成员

授权：

TokenAuthentication

路径参数

telegrafID 必填	字符串 Telegraf 配置 ID。
用户ID 必需	字符串要移除的成员的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

列出所有Telegraf配置的拥有者

授权：

TokenAuthentication

路径参数

telegrafID

必填

字符串

Telegraf 配置 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"links": {"self": "/api/v2/users/1"
},
"name": "string",
"status": "active",
"role": "owner"
}
]
}

将所有者添加到Telegraf配置

授权：

TokenAuthentication

路径参数

telegrafID

必填

字符串

Telegraf 配置 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

用户添加为所有者

id 必需	字符串要添加到资源的用户ID。
姓名	字符串要添加到资源中的用户姓名。

响应

请求示例

Payload

Content type

application/json

{"id": "string",
"name": "string"
}

响应示例

201
default

Content type

application/json

{"id": "string",
"links": {"self": "/api/v2/users/1"
},
"name": "string",
"status": "active",
"role": "owner"
}

从Telegraf配置中移除一个所有者

授权：

TokenAuthentication

路径参数

telegrafID 必填	字符串 Telegraf 配置 ID。
用户ID 必需	字符串要移除的所有者的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

模板

导出并应用 InfluxDB 模板。管理堆栈的模板化 InfluxDB 资源。

InfluxDB 模板是资源的预打包配置。使用 InfluxDB 模板来配置一个新的 InfluxDB 实例，备份您的仪表板配置，或共享您的配置。

使用 /api/v2/templates 端点来导出模板和应用模板。

InfluxDB 堆栈 是有状态的 InfluxDB 模板，让你能够随着时间的推移添加、更新和删除已安装的模板资源，避免在多次应用相同或相似模板时重复资源，并对 InfluxDB OSS 或 InfluxDB Cloud 的分布式实例应用更改。

使用 /api/v2/stacks 接口来管理已安装的模板资源。

列出已安装的堆栈

列出已安装的 InfluxDB 堆栈。

要限制响应中的堆栈，请在您的请求中传递查询参数。如果未传递查询参数，InfluxDB 将返回该组织的所有已安装堆栈。

View InfluxDB stacks.

授权：

TokenAuthentication

查询参数

名称	字符串示例： name=project-stack-0 - 查找具有事件名称的堆栈一个堆栈名称。查找具有此名称的 `events` 并返回堆栈。可重复。要过滤多个堆栈名称，重复此参数并使用每个名称，例如： `INFLUX_URL/api/v2/stacks?&orgID=INFLUX_ORG_ID&name=project-stack-0&name=project-stack-1`
orgID 必填	字符串一个组织ID。仅返回指定的 organization 所拥有的堆栈。 InfluxDB Cloud 不需要这个参数； InfluxDB 仅返回API令牌允许访问的资源。
stackID	字符串示例： stackID=09bd87cd33be3000 - 查找具有该ID的堆栈一个堆栈ID。只返回指定的堆栈。可重复。要过滤多个堆栈ID，对每个ID重复该参数——例如： `INFLUX_URL/api/v2/stacks?&orgID=INFLUX_ORG_ID&stackID=09bd87cd33be3000&stackID=09bef35081fe3000`

响应

响应示例

200
400
401
500
default

Content type

application/json

{"stacks": [{"createdAt": "2019-08-24T14:15:22Z",
"events": [{"description": "string",
"eventType": "string",
"name": "string",
"resources": [{"apiVersion": "string",
"associations": [{"kind": "Bucket",
"metaName": "string"
}
],
"kind": "Bucket",
"links": {"self": "string"
},
"resourceID": "string",
"templateMetaName": "string"
}
],
"sources": ["string"
],
"updatedAt": "2019-08-24T14:15:22Z",
"urls": ["string"
]
}
],
"id": "string",
"orgID": "string"
}
]
}

创建一个堆栈

创建或初始化一个栈。

使用此端点来手动初始化一个新的堆栈，带有以下可选信息：

Stack name
Stack description
URLs for template manifest files

要在应用模板时自动创建一个堆栈，请使用 /api/v2/templates/apply endpoint。

所需权限

write permission for the organization

授权：

TokenAuthentication

请求体模式: application/json

要创建的堆栈。

描述	字符串
名称	字符串
组织编号	字符串
网址	字符串的数组

响应

请求示例

Payload

Content type

application/json

{"description": "string",
"name": "string",
"orgID": "string",
"urls": ["string"
]
}

响应示例

201
401
422
500
default

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"events": [{"description": "string",
"eventType": "string",
"name": "string",
"resources": [{"apiVersion": "string",
"associations": [{"kind": "Bucket",
"metaName": "string"
}
],
"kind": "Bucket",
"links": {"self": "string"
},
"resourceID": "string",
"templateMetaName": "string"
}
],
"sources": ["string"
],
"updatedAt": "2019-08-24T14:15:22Z",
"urls": ["string"
]
}
],
"id": "string",
"orgID": "string"
}

删除堆栈及相关资源

授权：

TokenAuthentication

路径参数

stack_id

必填

字符串

堆栈的标识符。

查询参数

orgID

必需

字符串

组织的标识符。

响应

响应示例

default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

获取一个堆栈

授权：

TokenAuthentication

路径参数

stack_id

必填

字符串

堆栈的标识符。

响应

响应示例

200
default

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"events": [{"description": "string",
"eventType": "string",
"name": "string",
"resources": [{"apiVersion": "string",
"associations": [{"kind": "Bucket",
"metaName": "string"
}
],
"kind": "Bucket",
"links": {"self": "string"
},
"resourceID": "string",
"templateMetaName": "string"
}
],
"sources": ["string"
],
"updatedAt": "2019-08-24T14:15:22Z",
"urls": ["string"
]
}
],
"id": "string",
"orgID": "string"
}

更新堆栈

授权：

TokenAuthentication

路径参数

stack_id

必填

字符串

堆栈的标识符。

请求体模式: application/json

要更新的栈。

	对象的数组
描述	字符串或空
名称	字符串或空值
模板网址	字符串或null的数组

响应

请求示例

Payload

Content type

application/json

{"additionalResources": [{"kind": "string",
"resourceID": "string",
"templateMetaName": "string"
}
],
"description": "string",
"name": "string",
"templateURLs": ["string"
]
}

响应示例

200
default

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"events": [{"description": "string",
"eventType": "string",
"name": "string",
"resources": [{"apiVersion": "string",
"associations": [{"kind": "Bucket",
"metaName": "string"
}
],
"kind": "Bucket",
"links": {"self": "string"
},
"resourceID": "string",
"templateMetaName": "string"
}
],
"sources": ["string"
],
"updatedAt": "2019-08-24T14:15:22Z",
"urls": ["string"
]
}
],
"id": "string",
"orgID": "string"
}

卸载一个栈

授权：

TokenAuthentication

路径参数

stack_id

必填

字符串

堆栈的标识符。

响应

响应示例

200
default

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"events": [{"description": "string",
"eventType": "string",
"name": "string",
"resources": [{"apiVersion": "string",
"associations": [{"kind": "Bucket",
"metaName": "string"
}
],
"kind": "Bucket",
"links": {"self": "string"
},
"resourceID": "string",
"templateMetaName": "string"
}
],
"sources": ["string"
],
"updatedAt": "2019-08-24T14:15:22Z",
"urls": ["string"
]
}
],
"id": "string",
"orgID": "string"
}

应用或干运行模板

应用模板以创建或更新一个 stack 的 InfluxDB resources。响应包含更改的差异和堆栈 ID。

使用此端点将 InfluxDB 模板安装到组织中。提供模板 URL 或模板对象作为您的请求。要自定义安装哪些模板资源，请使用 actions 参数。

默认情况下，当您应用一个模板时，InfluxDB 会安装该模板以创建和更新堆栈资源，然后生成更改的差异。如果您在请求主体中传递 dryRun: true，InfluxDB 将验证模板并生成资源差异，但不会对您的实例进行任何更改。

模板的自定义值

一些模板可能包含环境引用用于自定义元数据。要为环境引用提供自定义值，请在请求正文中传递envRefs 属性。有关更多信息和示例，请参见如何定义环境引用。
某些模板可能包含使用secrets的查询。为了提供自定义秘密值，请在请求体中传递secrets属性。不要在模板中公开秘密值。有关更多信息，请参见如何在安装模板时传递秘密。

所需权限

write permissions for resource types in the template.

速率限制（使用InfluxDB Cloud）

Adjustable service quotas apply. For more information, see limits and adjustable quotas.

授权：

TokenAuthentication

请求主体模式:
application/json
application/json
application/x-jsonnet
text/yml

应用模板的参数。

	对象或对象的数组一个`action`对象的列表。操作让您自定义InfluxDB如何在请求中应用模板。您可以使用以下操作来防止创建或更新资源：一个`skipKind`操作跳过指定`kind`的模板资源。一个`skipResource`操作跳过具有指定`metadata.name`和`kind`的模板资源。
dryRun	boolean 仅对请求中传递的模板进行干运行。验证模板并生成资源差异和摘要。不安装模板或对InfluxDB实例进行更改。
	对象一个包含键值对的对象，这些键值对映射到模板中的环境引用。模板中的环境引用是具有 `envRef.key` 属性的 `envRef` 对象。在应用模板时，如果要替换自定义环境引用值，请将 `envRefs` 与 `envRef.key` 和值一起传递。当您应用模板时，InfluxDB 会将模板中的 `envRef` 对象替换为您在 `envRefs` 参数中提供的值。有关更多示例，请参见如何定义环境引用。以下模板字段可能使用环境引用： `metadata.name` `spec.endpointName` `spec.associations.name` 有关在模板字段中包含环境引用的更多信息，请参见如何包括用户定义的资源名称。
orgID	string 组织 ID。 InfluxDB 将模板应用于该组织。该组织拥有模板创建的所有资源。要找到您的组织，请参阅如何查看组织。
	数组对象模板文件的 URL 列表。要应用位于 URL 的模板清单文件，请将 `remotes` 传递一个包含该 URL 的数组。
	对象一个包含映射到查询中的机密的键值对的对象。查询可以引用存储在 InfluxDB 中的机密--例如，以下 Flux 脚本检索 `POSTGRES_USERNAME` 和 `POSTGRES_PASSWORD` 机密，然后使用它们连接到 PostgreSQL 数据库： `import "sql" import "influxdata/influxdb/secrets" username = secrets.get(key: "POSTGRES_USERNAME") password = secrets.get(key: "POSTGRES_PASSWORD") sql.from( driverName: "postgres", dataSourceName: "postgresql://${username}:${password}@localhost:5432", query: "SELECT * FROM example_table", )` 要在您的 `/api/v2/templates/apply` 请求中定义机密值，传递 `机密` 参数，包含键值对--例如： `{ ... "secrets": { "POSTGRES_USERNAME": "pguser", "POSTGRES_PASSWORD": "foo" } ... }` InfluxDB 将键值对存储为机密，您可以通过 `secrets.get()` 访问它们。一旦存储，您无法在 InfluxDB 中查看机密值。相关指南如何在安装模板时传递机密
stackID	string 要更新的堆栈的ID。要将模板应用于组织中的现有堆栈，请使用`stackID`参数。如果您在未提供堆栈ID的情况下应用模板， InfluxDB将初始化一个新堆栈并包含所有新资源。要查找堆栈ID，请使用InfluxDB `/api/v2/stacks` API端点列出堆栈。相关指南堆栈查看堆栈
	对象要应用的模板对象。模板对象具有一个 `contents` 属性包含一个 InfluxDB 资源配置的数组。传递 `template` 仅应用一个模板对象。如果使用 `template`，则不能使用 `templates` 参数。如果要应用多个模板对象，请改用 `templates`。
	对象的数组要应用的模板对象列表。模板对象具有一个 `contents` 属性，其中包含 InfluxDB 资源配置的数组。使用 `templates` 参数可以应用多个模板对象。如果使用 `templates`，则不能使用 `template` 参数。

响应

请求示例

Payload
cURL: Dry run with a remote template
cURL: Apply with secret values
cURL: Apply template objects with environment references

Content type

Example

{"actions": [{"action": "skipKind",
"properties": {"kind": "Bucket"
}
},
{"action": "skipKind",
"properties": {"kind": "Task"
}
}
],
"orgID": "INFLUX_ORG_ID",
"templates": [{"contents": [{"[object Object]": null
}
]
}
]
}

响应示例

200
201
422
500
default

Content type

application/json

{"diff": {"buckets": [{"id": "string",
"kind": "Bucket",
"new": {"description": "string",
"name": "string",
"retentionRules": [{"everySeconds": 86400,
"shardGroupDurationSeconds": 0,
"type": "expire"
}
]
},
"old": {"description": "string",
"name": "string",
"retentionRules": [{"everySeconds": 86400,
"shardGroupDurationSeconds": 0,
"type": "expire"
}
]
},
"stateStatus": "string",
"templateMetaName": "string"
}
],
"checks": [{"id": "string",
"kind": "Bucket",
"new": {"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"lastRunError": "string",
"lastRunStatus": "failed",
"latestCompleted": "2019-08-24T14:15:22Z",
"links": {"labels": "/api/v2/checks/1/labels",
"members": "/api/v2/checks/1/members",
"owners": "/api/v2/checks/1/owners",
"query": "/api/v2/checks/1/query",
"self": "/api/v2/checks/1"
},
"name": "string",
"orgID": "string",
"ownerID": "string",
"query": {"builderConfig": {"aggregateWindow": {"fillValues": true,
"period": "string"
},
"buckets": ["string"
],
"functions": [{"name": "string"
}
],
"tags": [{"aggregateFunctionType": "filter",
"key": "string",
"values": [null
]
}
]
},
"editMode": "builder",
"name": "string",
"text": "string"
},
"status": "active",
"taskID": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"every": "string",
"level": "UNKNOWN",
"offset": "string",
"reportZero": true,
"staleTime": "string",
"statusMessageTemplate": "string",
"tags": [{"key": "string",
"value": "string"
}
],
"timeSince": "string",
"type": "deadman"
},
"old": {"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"lastRunError": "string",
"lastRunStatus": "failed",
"latestCompleted": "2019-08-24T14:15:22Z",
"links": {"labels": "/api/v2/checks/1/labels",
"members": "/api/v2/checks/1/members",
"owners": "/api/v2/checks/1/owners",
"query": "/api/v2/checks/1/query",
"self": "/api/v2/checks/1"
},
"name": "string",
"orgID": "string",
"ownerID": "string",
"query": {"builderConfig": {"aggregateWindow": {"fillValues": true,
"period": "string"
},
"buckets": ["string"
],
"functions": [{"name": "string"
}
],
"tags": [{"aggregateFunctionType": "filter",
"key": "string",
"values": [null
]
}
]
},
"editMode": "builder",
"name": "string",
"text": "string"
},
"status": "active",
"taskID": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"every": "string",
"level": "UNKNOWN",
"offset": "string",
"reportZero": true,
"staleTime": "string",
"statusMessageTemplate": "string",
"tags": [{"key": "string",
"value": "string"
}
],
"timeSince": "string",
"type": "deadman"
},
"stateStatus": "string",
"templateMetaName": "string"
}
],
"dashboards": [{"id": "string",
"kind": "Bucket",
"new": {"charts": [{"height": 0,
"properties": {"adaptiveZoomHide": true,
"axes": {"x": {"base": null,
"bounds": [ ],
"label": null,
"prefix": null,
"scale": null,
"suffix": null
},
"y": {"base": null,
"bounds": [ ],
"label": null,
"prefix": null,
"scale": null,
"suffix": null
}
},
"colors": [{"hex": null,
"id": null,
"name": null,
"type": null,
"value": null
}
],
"decimalPlaces": {"digits": 0,
"isEnforced": true
},
"generateXAxisTicks": ["string"
],
"generateYAxisTicks": ["string"
],
"hoverDimension": "auto",
"legendColorizeRows": true,
"legendHide": true,
"legendOpacity": 0,
"legendOrientationThreshold": 0,
"note": "string",
"position": "overlaid",
"prefix": "string",
"queries": [{"builderConfig": null,
"editMode": null,
"name": null,
"text": null
}
],
"shadeBelow": true,
"shape": "chronograf-v2",
"showNoteWhenEmpty": true,
"staticLegend": {"colorizeRows": true,
"heightRatio": 0,
"opacity": 0,
"orientationThreshold": 0,
"show": true,
"valueAxis": "string",
"widthRatio": 0
},
"suffix": "string",
"timeFormat": "string",
"type": "line-plus-single-stat",
"xColumn": "string",
"xTickStart": 0,
"xTickStep": 0,
"xTotalTicks": 0,
"yColumn": "string",
"yTickStart": 0,
"yTickStep": 0,
"yTotalTicks": 0
},
"width": 0,
"xPos": 0,
"yPos": 0
}
],
"description": "string",
"name": "string"
},
"old": {"charts": [{"height": 0,
"properties": {"adaptiveZoomHide": true,
"axes": {"x": {"base": null,
"bounds": [ ],
"label": null,
"prefix": null,
"scale": null,
"suffix": null
},
"y": {"base": null,
"bounds": [ ],
"label": null,
"prefix": null,
"scale": null,
"suffix": null
}
},
"colors": [{"hex": null,
"id": null,
"name": null,
"type": null,
"value": null
}
],
"decimalPlaces": {"digits": 0,
"isEnforced": true
},
"generateXAxisTicks": ["string"
],
"generateYAxisTicks": ["string"
],
"hoverDimension": "auto",
"legendColorizeRows": true,
"legendHide": true,
"legendOpacity": 0,
"legendOrientationThreshold": 0,
"note": "string",
"position": "overlaid",
"prefix": "string",
"queries": [{"builderConfig": null,
"editMode": null,
"name": null,
"text": null
}
],
"shadeBelow": true,
"shape": "chronograf-v2",
"showNoteWhenEmpty": true,
"staticLegend": {"colorizeRows": true,
"heightRatio": 0,
"opacity": 0,
"orientationThreshold": 0,
"show": true,
"valueAxis": "string",
"widthRatio": 0
},
"suffix": "string",
"timeFormat": "string",
"type": "line-plus-single-stat",
"xColumn": "string",
"xTickStart": 0,
"xTickStep": 0,
"xTotalTicks": 0,
"yColumn": "string",
"yTickStart": 0,
"yTickStep": 0,
"yTotalTicks": 0
},
"width": 0,
"xPos": 0,
"yPos": 0
}
],
"description": "string",
"name": "string"
},
"stateStatus": "string",
"templateMetaName": "string"
}
],
"labelMappings": [{"labelID": "string",
"labelName": "string",
"labelTemplateMetaName": "string",
"resourceID": "string",
"resourceName": "string",
"resourceTemplateMetaName": "string",
"resourceType": "string",
"status": "string"
}
],
"labels": [{"id": "string",
"kind": "Bucket",
"new": {"color": "string",
"description": "string",
"name": "string"
},
"old": {"color": "string",
"description": "string",
"name": "string"
},
"stateStatus": "string",
"templateMetaName": "string"
}
],
"notificationEndpoints": [{"id": "string",
"kind": "Bucket",
"new": {"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"labels": "/api/v2/notificationEndpoints/1/labels",
"members": "/api/v2/notificationEndpoints/1/members",
"owners": "/api/v2/notificationEndpoints/1/owners",
"self": "/api/v2/notificationEndpoints/1"
},
"name": "string",
"orgID": "string",
"status": "active",
"type": "slack",
"updatedAt": "2019-08-24T14:15:22Z",
"userID": "string",
"token": "string",
"url": "string"
},
"old": {"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"labels": "/api/v2/notificationEndpoints/1/labels",
"members": "/api/v2/notificationEndpoints/1/members",
"owners": "/api/v2/notificationEndpoints/1/owners",
"self": "/api/v2/notificationEndpoints/1"
},
"name": "string",
"orgID": "string",
"status": "active",
"type": "slack",
"updatedAt": "2019-08-24T14:15:22Z",
"userID": "string",
"token": "string",
"url": "string"
},
"stateStatus": "string",
"templateMetaName": "string"
}
],
"notificationRules": [{"id": "string",
"kind": "Bucket",
"new": {"description": "string",
"endpointID": "string",
"endpointName": "string",
"endpointType": "string",
"every": "string",
"messageTemplate": "string",
"name": "string",
"offset": "string",
"status": "string",
"statusRules": [{"currentLevel": "string",
"previousLevel": "string"
}
],
"tagRules": [{"key": "string",
"operator": "string",
"value": "string"
}
]
},
"old": {"description": "string",
"endpointID": "string",
"endpointName": "string",
"endpointType": "string",
"every": "string",
"messageTemplate": "string",
"name": "string",
"offset": "string",
"status": "string",
"statusRules": [{"currentLevel": "string",
"previousLevel": "string"
}
],
"tagRules": [{"key": "string",
"operator": "string",
"value": "string"
}
]
},
"stateStatus": "string",
"templateMetaName": "string"
}
],
"tasks": [{"id": "string",
"kind": "Bucket",
"new": {"cron": "string",
"description": "string",
"every": "string",
"name": "string",
"offset": "string",
"query": "string",
"status": "string"
},
"old": {"cron": "string",
"description": "string",
"every": "string",
"name": "string",
"offset": "string",
"query": "string",
"status": "string"
},
"stateStatus": "string",
"templateMetaName": "string"
}
],
"telegrafConfigs": [{"id": "string",
"kind": "Bucket",
"new": {"config": "string",
"description": "string",
"metadata": {"buckets": ["string"
]
},
"name": "string",
"orgID": "string"
},
"old": {"config": "string",
"description": "string",
"metadata": {"buckets": ["string"
]
},
"name": "string",
"orgID": "string"
},
"stateStatus": "string",
"templateMetaName": "string"
}
],
"variables": [{"id": "string",
"kind": "Bucket",
"new": {"args": {"type": "query",
"values": {"language": "string",
"query": "string"
}
},
"description": "string",
"name": "string"
},
"old": {"args": {"type": "query",
"values": {"language": "string",
"query": "string"
}
},
"description": "string",
"name": "string"
},
"stateStatus": "string",
"templateMetaName": "string"
}
]
},
"errors": [{"fields": ["string"
],
"indexes": [0
],
"kind": "Bucket",
"reason": "string"
}
],
"sources": ["string"
],
"stackID": "string",
"summary": {"buckets": [{"description": "string",
"envReferences": [{"defaultValue": "string",
"envRefKey": "string",
"resourceField": "string",
"value": "string"
}
],
"id": "string",
"kind": "Bucket",
"labelAssociations": [{"envReferences": [{"defaultValue": "string",
"envRefKey": "string",
"resourceField": "string",
"value": "string"
}
],
"id": "string",
"kind": "Bucket",
"name": "string",
"orgID": "string",
"properties": {"color": "string",
"description": "string"
},
"templateMetaName": "string"
}
],
"name": "string",
"orgID": "string",
"retentionPeriod": 0,
"templateMetaName": "string"
}
],
"checks": [{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"lastRunError": "string",
"lastRunStatus": "failed",
"latestCompleted": "2019-08-24T14:15:22Z",
"links": {"labels": "/api/v2/checks/1/labels",
"members": "/api/v2/checks/1/members",
"owners": "/api/v2/checks/1/owners",
"query": "/api/v2/checks/1/query",
"self": "/api/v2/checks/1"
},
"name": "string",
"orgID": "string",
"ownerID": "string",
"query": {"builderConfig": {"aggregateWindow": {"fillValues": true,
"period": "string"
},
"buckets": ["string"
],
"functions": [{"name": "string"
}
],
"tags": [{"aggregateFunctionType": "filter",
"key": "string",
"values": ["string"
]
}
]
},
"editMode": "builder",
"name": "string",
"text": "string"
},
"status": "active",
"taskID": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"every": "string",
"level": "UNKNOWN",
"offset": "string",
"reportZero": true,
"staleTime": "string",
"statusMessageTemplate": "string",
"tags": [{"key": "string",
"value": "string"
}
],
"timeSince": "string",
"type": "deadman",
"envReferences": [{"defaultValue": "string",
"envRefKey": "string",
"resourceField": "string",
"value": "string"
}
],
"kind": "Bucket",
"labelAssociations": [{"envReferences": [{"defaultValue": "string",
"envRefKey": "string",
"resourceField": "string",
"value": "string"
}
],
"id": "string",
"kind": "Bucket",
"name": "string",
"orgID": "string",
"properties": {"color": "string",
"description": "string"
},
"templateMetaName": "string"
}
],
"templateMetaName": "string"
}
],
"dashboards": [{"charts": [{"height": 0,
"properties": {"adaptiveZoomHide": true,
"axes": {"x": {"base": "",
"bounds": [null
],
"label": "string",
"prefix": "string",
"scale": "log",
"suffix": "string"
},
"y": {"base": "",
"bounds": [null
],
"label": "string",
"prefix": "string",
"scale": "log",
"suffix": "string"
}
},
"colors": [{"hex": "strings",
"id": "string",
"name": "string",
"type": "min",
"value": 0
}
],
"decimalPlaces": {"digits": 0,
"isEnforced": true
},
"generateXAxisTicks": ["string"
],
"generateYAxisTicks": ["string"
],
"hoverDimension": "auto",
"legendColorizeRows": true,
"legendHide": true,
"legendOpacity": 0,
"legendOrientationThreshold": 0,
"note": "string",
"position": "overlaid",
"prefix": "string",
"queries": [{"builderConfig": {"aggregateWindow": { },
"buckets": [ ],
"functions": [ ],
"tags": [ ]
},
"editMode": "builder",
"name": "string",
"text": "string"
}
],
"shadeBelow": true,
"shape": "chronograf-v2",
"showNoteWhenEmpty": true,
"staticLegend": {"colorizeRows": true,
"heightRatio": 0,
"opacity": 0,
"orientationThreshold": 0,
"show": true,
"valueAxis": "string",
"widthRatio": 0
},
"suffix": "string",
"timeFormat": "string",
"type": "line-plus-single-stat",
"xColumn": "string",
"xTickStart": 0,
"xTickStep": 0,
"xTotalTicks": 0,
"yColumn": "string",
"yTickStart": 0,
"yTickStep": 0,
"yTotalTicks": 0
},
"width": 0,
"xPos": 0,
"yPos": 0
}
],
"description": "string",
"envReferences": [{"defaultValue": "string",
"envRefKey": "string",
"resourceField": "string",
"value": "string"
}
],
"id": "string",
"kind": "Bucket",
"labelAssociations": [{"envReferences": [{"defaultValue": "string",
"envRefKey": "string",
"resourceField": "string",
"value": "string"
}
],
"id": "string",
"kind": "Bucket",
"name": "string",
"orgID": "string",
"properties": {"color": "string",
"description": "string"
},
"templateMetaName": "string"
}
],
"name": "string",
"orgID": "string",
"templateMetaName": "string"
}
],
"labelMappings": [{"labelID": "string",
"labelName": "string",
"labelTemplateMetaName": "string",
"resourceID": "string",
"resourceName": "string",
"resourceTemplateMetaName": "string",
"resourceType": "string",
"status": "string"
}
],
"labels": [{"envReferences": [{"defaultValue": "string",
"envRefKey": "string",
"resourceField": "string",
"value": "string"
}
],
"id": "string",
"kind": "Bucket",
"name": "string",
"orgID": "string",
"properties": {"color": "string",
"description": "string"
},
"templateMetaName": "string"
}
],
"missingEnvRefs": ["string"
],
"missingSecrets": ["string"
],
"notificationEndpoints": [{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"labels": "/api/v2/notificationEndpoints/1/labels",
"members": "/api/v2/notificationEndpoints/1/members",
"owners": "/api/v2/notificationEndpoints/1/owners",
"self": "/api/v2/notificationEndpoints/1"
},
"name": "string",
"orgID": "string",
"status": "active",
"type": "slack",
"updatedAt": "2019-08-24T14:15:22Z",
"userID": "string",
"token": "string",
"url": "string",
"envReferences": [{"defaultValue": "string",
"envRefKey": "string",
"resourceField": "string",
"value": "string"
}
],
"kind": "Bucket",
"labelAssociations": [{"envReferences": [{"defaultValue": "string",
"envRefKey": "string",
"resourceField": "string",
"value": "string"
}
],
"id": "string",
"kind": "Bucket",
"name": "string",
"orgID": "string",
"properties": {"color": "string",
"description": "string"
},
"templateMetaName": "string"
}
],
"templateMetaName": "string"
}
],
"notificationRules": [{"description": "string",
"endpointID": "string",
"endpointTemplateMetaName": "string",
"endpointType": "string",
"envReferences": [{"defaultValue": "string",
"envRefKey": "string",
"resourceField": "string",
"value": "string"
}
],
"every": "string",
"kind": "Bucket",
"labelAssociations": [{"envReferences": [{"defaultValue": "string",
"envRefKey": "string",
"resourceField": "string",
"value": "string"
}
],
"id": "string",
"kind": "Bucket",
"name": "string",
"orgID": "string",
"properties": {"color": "string",
"description": "string"
},
"templateMetaName": "string"
}
],
"messageTemplate": "string",
"name": "string",
"offset": "string",
"status": "string",
"statusRules": [{"currentLevel": "string",
"previousLevel": "string"
}
],
"tagRules": [{"key": "string",
"operator": "string",
"value": "string"
}
],
"templateMetaName": "string"
}
],
"tasks": [{"cron": "string",
"description": "string",
"envReferences": [{"defaultValue": "string",
"envRefKey": "string",
"resourceField": "string",
"value": "string"
}
],
"every": "string",
"id": "string",
"kind": "Bucket",
"name": "string",
"offset": "string",
"query": "string",
"status": "string",
"templateMetaName": "string"
}
],
"telegrafConfigs": [{"config": "string",
"description": "string",
"metadata": {"buckets": ["string"
]
},
"name": "string",
"orgID": "string",
"envReferences": [{"defaultValue": "string",
"envRefKey": "string",
"resourceField": "string",
"value": "string"
}
],
"kind": "Bucket",
"labelAssociations": [{"envReferences": [{"defaultValue": "string",
"envRefKey": "string",
"resourceField": "string",
"value": "string"
}
],
"id": "string",
"kind": "Bucket",
"name": "string",
"orgID": "string",
"properties": {"color": "string",
"description": "string"
},
"templateMetaName": "string"
}
],
"templateMetaName": "string"
}
],
"variables": [{"arguments": {"type": "query",
"values": {"language": "string",
"query": "string"
}
},
"description": "string",
"envReferences": [{"defaultValue": "string",
"envRefKey": "string",
"resourceField": "string",
"value": "string"
}
],
"id": "string",
"kind": "Bucket",
"labelAssociations": [{"envReferences": [{"defaultValue": "string",
"envRefKey": "string",
"resourceField": "string",
"value": "string"
}
],
"id": "string",
"kind": "Bucket",
"name": "string",
"orgID": "string",
"properties": {"color": "string",
"description": "string"
},
"templateMetaName": "string"
}
],
"name": "string",
"orgID": "string",
"templateMetaName": "string"
}
]
}
}

导出新模板

授权：

TokenAuthentication

请求体模式: application/json

将资源导出为InfluxDB模板。

One of

	对象的数组
	对象的数组
堆栈ID	字符串

响应

请求示例

Payload

Content type

application/json

Example

{"orgIDs": [{"orgID": "string",
"resourceFilters": {"byLabel": ["string"
],
"byResourceKind": ["Bucket"
]
}
}
],
"resources": [{"id": "string",
"kind": "Bucket",
"name": "string"
}
],
"stackID": "string"
}

响应示例

200
default

Content type

[{"apiVersion": "influxdata.com/v2alpha1",
"kind": "Bucket",
"metadata": {"name": "string"
},
"spec": { }
}
]

使用

获取一个组织的使用情况

授权：

TokenAuthentication

路径参数

orgID

必填

字符串

组织的ID。

查询参数

原始	布尔值默认: false 返回原始使用数据
开始必填	整数包含在结果中的最早时间。有关时间戳的更多信息，请参见使用 Flux 操作时间戳。
停止	整数要包含在结果中的最新时间。有关时间戳的更多信息，请参见使用 Flux 操作时间戳。

响应

响应示例

default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

用户

检索特定用户。

InfluxDB Cloud 允许您邀请和与您组织中的多个用户协作。要邀请和移除您组织中的用户，请使用 InfluxDB Cloud 用户界面 (UI)；您不能使用 InfluxDB API 来管理 InfluxDB Cloud 中的用户。一旦用户被添加到您的组织，您可以使用 GET /api/v2/users 和 GET /api/v2/users/USER_ID API 端点来查看特定成员。

带有授权的用户会话

可选地，您可以将授权（及其API令牌）范围限定为某个用户。如果用户使用用户名和密码登录，创建一个 用户会话，该会话携带所有用户授权所授予的权限。要创建用户会话，请使用 POST /api/v2/signin 端点。

Manage users

获取当前已认证的用户

授权：

TokenAuthentication

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
401
500
default

Content type

application/json

{"id": "string",
"links": {"self": "/api/v2/users/1"
},
"name": "string",
"status": "active"
}

更新密码

更新已登录的 user 的密码。

此端点代表以下三步过程中的第三步，让具有用户会话的用户更新他们的密码：

Pass the user's Basic authentication credentials to the POST /api/v2/signin endpoint to create a user session and generate a session cookie.
From the response in the first step, extract the session cookie (Set-Cookie) header.
Pass the following in a request to the PUT /api/v2/me/password endpoint:
- 第二步的 Set-Cookie 头
- 包含用户基本身份验证凭据的Authorization Basic头
- {"password": "NEW_PASSWORD"} 在请求体中

InfluxDB云

Doesn't let you manage user passwords through the API. Use the InfluxDB Cloud user interface (UI) to update your password.

Signin
Signout
Users

授权：

BasicAuthentication

cookie 参数

influxdb-oss-session

必需

字符串

示例: influxdb-oss-session=influxdb-oss-session=19aaaZZZGOvP2GGryXVT2qYftlFKu3bIopurM6AGFow1yF1abhtOlbHfsc-d8gozZFC_6WxmlQIAwLMW5xs523w==

用户会话 cookie，与使用 Basic authentication credentials 登录的 user 相关。

管理用户

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

新密码。

密码

必填

字符串

响应

请求示例

Payload

Content type

application/json

{"password": "string"
}

响应示例

401
default

Content type

application/json

{"code": "unauthorized",
"message": "unauthorized access"
}

列出用户

列出 users。

要限制返回哪些用户，请在请求中传递查询参数。

InfluxDB云

InfluxDB Cloud doesn't allow listing all users through the API. Use the InfluxDB Cloud user interface (UI) to manage account information.

InfluxDB Cloud所需的权限

操作	所需权限	限制
列出所有用户	操作员令牌	仅供InfluxData内部使用
列出特定用户	`read-users` 或 `read-user USER_ID`

USER_ID 是您想要检索的用户的ID。

Manage users

授权：

TokenAuthentication

查询参数

id	字符串一个用户ID。仅列出指定的用户。
名称	字符串用户名称。仅列出指定的用户。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
401
422
500
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"links": {"self": "/api/v2/users/1"
},
"name": "string",
"status": "active"
}
]
}

创建用户

(仅供InfluxData内部使用)

创建并返回一个 user，可以访问 InfluxDB。

InfluxDB云

InfluxDB Cloud Doesn't let you manage users through the API. Use the InfluxDB Cloud user interface (UI) to manage account information.

InfluxDB Cloud所需的权限

操作	所需权限	限制
创建用户	操作员令牌	仅限InfluxData内部使用

Manage users

授权：

TokenAuthentication

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

在请求体中，提供用户。

名称必需	字符串
组织 ID	字符串
角色	字符串枚举: "owner" "member"
状态	字符串默认: "active" 枚举: "active" "inactive" 如果为非活动状态，则用户处于非活动状态。

响应

请求示例

Payload

Content type

application/json

{"name": "string",
"org_id": "string",
"role": "owner",
"status": "active"
}

响应示例

201
401
422
500
default

Content type

application/json

{"id": "string",
"links": {"self": "/api/v2/users/1"
},
"name": "string",
"status": "active"
}

删除用户

(仅供InfluxData内部使用)

删除一个 user。

出于安全考虑，一旦从组织中删除一个InfluxDB用户账户，该用户（及其令牌）将无法重新激活。

InfluxDB云

Doesn't let you manage users through the API. Use the InfluxDB Cloud user interface (UI) to manage account information.

所需权限

操作	所需权限	限制
删除用户	操作员令牌	仅供InfluxData内部使用

Manage users

授权：

TokenAuthentication

路径参数

用户ID

必填

字符串

一个用户ID。

删除指定的用户。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

400
401
404
500
default

Content type

application/json

{"code": "invalid",
"message": "failed to decode request body: organization not found"
}

检索一个用户

获取一个 user。

Manage users

授权：

TokenAuthentication

路径参数

用户ID

必填

字符串

用户ID。检索指定的用户。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
default

Content type

application/json

{"id": "string",
"links": {"self": "/api/v2/users/1"
},
"name": "string",
"status": "active"
}

更新用户

(仅供InfluxData内部使用)

更新一个 user 并返回该用户。

InfluxDB云

Doesn't let you manage users through the API. Use the InfluxDB Cloud user interface (UI) to manage account information.

InfluxDB Cloud所需的权限

操作	所需权限	限制
更新用户	操作员令牌	仅供InfluxData内部使用

Manage users

授权：

TokenAuthentication

路径参数

用户ID

必填

字符串

用户ID。更新指定的用户。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

用户更新以应用。

名称必需	字符串
组织 ID	字符串
角色	字符串枚举: "owner" "member"
状态	字符串默认: "active" 枚举: "active" "inactive" 如果未激活，用户处于非活跃状态。

响应

请求示例

Payload

Content type

application/json

{"name": "string",
"org_id": "string",
"role": "owner",
"status": "active"
}

响应示例

Content type

application/json

{"id": "string",
"links": {"self": "/api/v2/users/1"
},
"name": "string",
"status": "active"
}

更新密码

更新用户密码。

InfluxDB云

Doesn't allow you to manage user passwords through the API. Use the InfluxDB Cloud user interface (UI) to update a password.

授权：

TokenAuthentication

路径参数

用户ID

必需

字符串

要设置密码的用户的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

为用户设置的新密码。

密码

必填

字符串

响应

请求示例

Payload
cURL: use HTTP POST to update the user password

Content type

application/json

{"password": "string"
}

响应示例

400
default

Content type

application/json

{"code": "invalid",
"message": "passwords cannot be changed through the InfluxDB Cloud API"
}

更新密码

更新用户密码。

使用此端点让用户通过基本身份验证凭据进行身份验证并设置新密码。

InfluxDB云

Doesn't allow you to manage user passwords through the API. Use the InfluxDB Cloud user interface (UI) to update a password.

授权：

BasicAuthentication

路径参数

用户ID

必需

字符串

要设置密码的用户的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

为用户设置的新密码。

密码

必填

字符串

响应

请求示例

Payload
cURL: use Basic auth to update the user password

Content type

application/json

{"password": "string"
}

响应示例

400
default

Content type

application/json

{"code": "invalid",
"message": "passwords cannot be changed through the InfluxDB Cloud API"
}

变量

列出所有变量

授权：

TokenAuthentication

查询参数

org	string 组织的名称。
组织ID	字符串组织的标识符。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
400
default

Content type

application/json

{"variables": [{"arguments": {"type": "constant",
"values": ["howdy",
"hello",
"hi",
"yo",
"oy"
]
},
"id": "1221432",
"name": ":ok:",
"selected": ["hello"
]
},
{"arguments": {"type": "map",
"values": {"a": "fdjaklfdjkldsfjlkjdsa",
"b": "dfaksjfkljekfajekdljfas",
"c": "fdjksajfdkfeawfeea"
}
},
"id": "1221432",
"name": ":ok:",
"selected": ["c"
]
},
{"arguments": {"language": "flux",
"query": "from(bucket: \"foo\") |> showMeasurements()",
"type": "query"
},
"id": "1221432",
"name": ":ok:",
"selected": ["host"
]
}
]
}

创建一个变量

授权：

TokenAuthentication

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

要创建的变量

必需	QueryVariableProperties (object) or ConstantVariableProperties (object) or MapVariableProperties (object) (VariableProperties)
创建时间	字符串 <日期-时间>
描述	字符串
	数组对象（标签）
名称必需	字符串
组织ID 必填	字符串
选中	字符串的数组
排序顺序	整数
更新时间	字符串 <日期-时间>

响应

请求示例

Payload

Content type

application/json

{"arguments": {"type": "query",
"values": {"language": "string",
"query": "string"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"labels": [{"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"name": "string",
"orgID": "string",
"selected": ["string"
],
"sort_order": 0,
"updatedAt": "2019-08-24T14:15:22Z"
}

响应示例

201
default

Content type

application/json

{"arguments": {"type": "query",
"values": {"language": "string",
"query": "string"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"labels": "http://example.com",
"org": "http://example.com",
"self": "http://example.com"
},
"name": "string",
"orgID": "string",
"selected": ["string"
],
"sort_order": 0,
"updatedAt": "2019-08-24T14:15:22Z"
}

删除变量

授权：

TokenAuthentication

路径参数

variableID

必需

字符串

变量ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

获取一个变量

授权：

TokenAuthentication

路径参数

variableID

必需

字符串

变量ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
404
default

Content type

application/json

{"arguments": {"type": "query",
"values": {"language": "string",
"query": "string"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"labels": "http://example.com",
"org": "http://example.com",
"self": "http://example.com"
},
"name": "string",
"orgID": "string",
"selected": ["string"
],
"sort_order": 0,
"updatedAt": "2019-08-24T14:15:22Z"
}

更新变量

授权：

TokenAuthentication

路径参数

variableID

必需

字符串

变量ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

要应用的变量更新

必需	QueryVariableProperties (object) or ConstantVariableProperties (object) or MapVariableProperties (object) (VariableProperties)
创建时间	字符串 <日期-时间>
描述	字符串
	数组对象（标签）
名称必需	字符串
组织ID 必填	字符串
选中	字符串的数组
排序顺序	整数
更新时间	字符串 <日期-时间>

响应

请求示例

Payload

Content type

application/json

{"arguments": {"type": "query",
"values": {"language": "string",
"query": "string"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"labels": [{"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"name": "string",
"orgID": "string",
"selected": ["string"
],
"sort_order": 0,
"updatedAt": "2019-08-24T14:15:22Z"
}

响应示例

200
default

Content type

application/json

{"arguments": {"type": "query",
"values": {"language": "string",
"query": "string"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"labels": "http://example.com",
"org": "http://example.com",
"self": "http://example.com"
},
"name": "string",
"orgID": "string",
"selected": ["string"
],
"sort_order": 0,
"updatedAt": "2019-08-24T14:15:22Z"
}

替换变量

授权：

TokenAuthentication

路径参数

variableID

必需

字符串

变量ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

要替换的变量

必需	QueryVariableProperties (object) or ConstantVariableProperties (object) or MapVariableProperties (object) (VariableProperties)
创建时间	字符串 <日期-时间>
描述	字符串
	数组对象（标签）
名称必需	字符串
组织ID 必填	字符串
选中	字符串的数组
排序顺序	整数
更新时间	字符串 <日期-时间>

响应

请求示例

Payload

Content type

application/json

{"arguments": {"type": "query",
"values": {"language": "string",
"query": "string"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"labels": [{"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"name": "string",
"orgID": "string",
"selected": ["string"
],
"sort_order": 0,
"updatedAt": "2019-08-24T14:15:22Z"
}

响应示例

200
default

Content type

application/json

{"arguments": {"type": "query",
"values": {"language": "string",
"query": "string"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"labels": "http://example.com",
"org": "http://example.com",
"self": "http://example.com"
},
"name": "string",
"orgID": "string",
"selected": ["string"
],
"sort_order": 0,
"updatedAt": "2019-08-24T14:15:22Z"
}

列出变量的所有标签

授权：

TokenAuthentication

路径参数

variableID

必需

字符串

变量ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
default

Content type

application/json

{"labels": [{"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"next": "http://example.com",
"prev": "http://example.com",
"self": "http://example.com"
}
}

为变量添加标签

授权：

TokenAuthentication

路径参数

variableID

必需

字符串

变量ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

要添加的标签

labelID

必填

字符串

标签ID。指定要附加的标签。

响应

请求示例

Payload

Content type

application/json

{"labelID": "string"
}

响应示例

201
default

Content type

application/json

{"label": {"id": "string",
"name": "string",
"orgID": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
},
"links": {"next": "http://example.com",
"prev": "http://example.com",
"self": "http://example.com"
}
}

从变量中删除标签

授权：

TokenAuthentication

路径参数

标签ID 必需	字符串要删除的标签ID。
variableID 必需	字符串变量ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

404
default

Content type

application/json

{"code": "internal error",
"err": "string",
"message": "string",
"op": "string"
}

视图

获取单元格的视图

授权：

TokenAuthentication

路径参数

单元格ID 必需	字符串单元格的ID。
dashboardID 必需	字符串仪表板 ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

响应

响应示例

200
404
default

Content type

application/json

{"id": "string",
"links": {"self": "string"
},
"name": "string",
"properties": {"adaptiveZoomHide": true,
"axes": {"x": {"base": "",
"bounds": ["string"
],
"label": "string",
"prefix": "string",
"scale": "log",
"suffix": "string"
},
"y": {"base": "",
"bounds": ["string"
],
"label": "string",
"prefix": "string",
"scale": "log",
"suffix": "string"
}
},
"colors": [{"hex": "strings",
"id": "string",
"name": "string",
"type": "min",
"value": 0
}
],
"decimalPlaces": {"digits": 0,
"isEnforced": true
},
"generateXAxisTicks": ["string"
],
"generateYAxisTicks": ["string"
],
"hoverDimension": "auto",
"legendColorizeRows": true,
"legendHide": true,
"legendOpacity": 0,
"legendOrientationThreshold": 0,
"note": "string",
"position": "overlaid",
"prefix": "string",
"queries": [{"builderConfig": {"aggregateWindow": {"fillValues": true,
"period": "string"
},
"buckets": ["string"
],
"functions": [{"name": "string"
}
],
"tags": [{"aggregateFunctionType": "filter",
"key": "string",
"values": ["string"
]
}
]
},
"editMode": "builder",
"name": "string",
"text": "string"
}
],
"shadeBelow": true,
"shape": "chronograf-v2",
"showNoteWhenEmpty": true,
"staticLegend": {"colorizeRows": true,
"heightRatio": 0,
"opacity": 0,
"orientationThreshold": 0,
"show": true,
"valueAxis": "string",
"widthRatio": 0
},
"suffix": "string",
"timeFormat": "string",
"type": "line-plus-single-stat",
"xColumn": "string",
"xTickStart": 0,
"xTickStep": 0,
"xTotalTicks": 0,
"yColumn": "string",
"yTickStart": 0,
"yTickStep": 0,
"yTotalTicks": 0
}
}

更新单元格的视图

授权：

TokenAuthentication

路径参数

cellID 必填	字符串要更新的单元格的ID。
dashboardID 必填	字符串要更新的仪表板的ID。

头部参数

Zap-Trace-Span

字符串

示例： baggage,[object Object],span_id,1,trace_id,1

OpenTracing span 上下文

请求体模式: application/json

名称

必需

字符串

必需

LinePlusSingleStatProperties (object) 或 XYViewProperties (object) 或 SingleStatViewProperties (object) 或 HistogramViewProperties (object) 或 GaugeViewProperties (object) 或 TableViewProperties (object) 或 SimpleTableViewProperties (object) 或 MarkdownViewProperties (object) 或 CheckViewProperties (object) 或 ScatterViewProperties (object) 或 HeatmapViewProperties (object) 或 MosaicViewProperties (object) 或 BandViewProperties (object) 或 GeoViewProperties (object) (ViewProperties)

响应

请求示例

Payload

Content type

application/json

{"name": "string",
"properties": {"adaptiveZoomHide": true,
"axes": {"x": {"base": "",
"bounds": ["string"
],
"label": "string",
"prefix": "string",
"scale": "log",
"suffix": "string"
},
"y": {"base": "",
"bounds": ["string"
],
"label": "string",
"prefix": "string",
"scale": "log",
"suffix": "string"
}
},
"colors": [{"hex": "strings",
"id": "string",
"name": "string",
"type": "min",
"value": 0
}
],
"decimalPlaces": {"digits": 0,
"isEnforced": true
},
"generateXAxisTicks": ["string"
],
"generateYAxisTicks": ["string"
],
"hoverDimension": "auto",
"legendColorizeRows": true,
"legendHide": true,
"legendOpacity": 0,
"legendOrientationThreshold": 0,
"note": "string",
"position": "overlaid",
"prefix": "string",
"queries": [{"builderConfig": {"aggregateWindow": {"fillValues": true,
"period": "string"
},
"buckets": ["string"
],
"functions": [{"name": "string"
}
],
"tags": [{"aggregateFunctionType": "filter",
"key": "string",
"values": ["string"
]
}
]
},
"editMode": "builder",
"name": "string",
"text": "string"
}
],
"shadeBelow": true,
"shape": "chronograf-v2",
"showNoteWhenEmpty": true,
"staticLegend": {"colorizeRows": true,
"heightRatio": 0,
"opacity": 0,
"orientationThreshold": 0,
"show": true,
"valueAxis": "string",
"widthRatio": 0
},
"suffix": "string",
"timeFormat": "string",
"type": "line-plus-single-stat",
"xColumn": "string",
"xTickStart": 0,
"xTickStep": 0,
"xTotalTicks": 0,
"yColumn": "string",
"yTickStart": 0,
"yTickStep": 0,
"yTotalTicks": 0
}
}

响应示例

200
404
default

Content type

application/json

{"id": "string",
"links": {"self": "string"
},
"name": "string",
"properties": {"adaptiveZoomHide": true,
"axes": {"x": {"base": "",
"bounds": ["string"
],
"label": "string",
"prefix": "string",
"scale": "log",
"suffix": "string"
},
"y": {"base": "",
"bounds": ["string"
],
"label": "string",
"prefix": "string",
"scale": "log",
"suffix": "string"
}
},
"colors": [{"hex": "strings",
"id": "string",
"name": "string",
"type": "min",
"value": 0
}
],
"decimalPlaces": {"digits": 0,
"isEnforced": true
},
"generateXAxisTicks": ["string"
],
"generateYAxisTicks": ["string"
],
"hoverDimension": "auto",
"legendColorizeRows": true,
"legendHide": true,
"legendOpacity": 0,
"legendOrientationThreshold": 0,
"note": "string",
"position": "overlaid",
"prefix": "string",
"queries": [{"builderConfig": {"aggregateWindow": {"fillValues": true,
"period": "string"
},
"buckets": ["string"
],
"functions": [{"name": "string"
}
],
"tags": [{"aggregateFunctionType": "filter",
"key": "string",
"values": ["string"
]
}
]
},
"editMode": "builder",
"name": "string",
"text": "string"
}
],
"shadeBelow": true,
"shape": "chronograf-v2",
"showNoteWhenEmpty": true,
"staticLegend": {"colorizeRows": true,
"heightRatio": 0,
"opacity": 0,
"orientationThreshold": 0,
"show": true,
"valueAxis": "string",
"widthRatio": 0
},
"suffix": "string",
"timeFormat": "string",
"type": "line-plus-single-stat",
"xColumn": "string",
"xTickStart": 0,
"xTickStep": 0,
"xTotalTicks": 0,
"yColumn": "string",
"yTickStart": 0,
"yTickStep": 0,
"yTotalTicks": 0
}
}

写

将时间序列数据写入 buckets。

写入数据

将数据写入存储桶。

使用此端点以行协议格式将数据发送到InfluxDB。

InfluxDB云

在发送写请求时执行以下操作：
1. Validates the request and queues the write.
2. If queued, responds with success (HTTP 2xx status code); error otherwise.
3. Handles the delete asynchronously and reaches eventual consistency.
为了确保 InfluxDB Cloud 按照您请求的顺序处理写入和删除，请在发送下一个请求之前等待成功响应（HTTP 2xx 状态码）。
因为写入和删除是异步的，当您收到响应时，您的更改可能尚不可读。

InfluxDB OSS

Validates the request and handles the write synchronously.
If all points were written successfully, responds with HTTP 2xx status code; otherwise, returns the first line that failed.

所需权限

write-buckets 或 write-bucket BUCKET_ID。
BUCKET_ID 是目标桶的ID。

速率限制（使用InfluxDB Cloud）

write 速率限制适用。有关更多信息，请参见 limits and adjustable quotas。

授权：

TokenAuthentication

查询参数

桶必需	字符串一个桶的名称或ID。 InfluxDB将所有批处理中的点写入指定的桶。
组织必需	字符串组织名称或ID。 InfluxDB Cloud 不使用 `org` 参数或 `orgID` 参数。将数据写入与授权（API令牌）相关联的组织中的桶。 InfluxDB OSS 要求使用 `org` 参数或 `orgID` 参数。如果同时传递 `orgID` 和 `org`，它们必须都是有效的。将数据写入指定组织中的桶。
orgID	字符串组织 ID。 InfluxDB Cloud 不使用 `org` 参数或 `orgID` 参数。将数据写入与授权（API 令牌）关联的组织中的桶。 InfluxDB OSS 需要 `org` 参数或 `orgID` 参数中的任意一个。如果同时传递 `orgID` 和 `org`，两者都必须有效。将数据写入指定组织中的桶。
精度	字符串 (WritePrecision) 枚举: "ms" "s" "us" "ns" 线协议批次中 unix 时间戳的精度。

头部参数

接受	字符串默认：application/json 值："application/json" 客户端可以理解的内容类型。仅在失败时写入返回响应体——例如，因格式问题或配额限制。 InfluxDB Cloud 对于格式和限制错误，仅返回 `application/json`。对于某些配额限制错误，仅返回 `text/html`。 InfluxDB OSS 对于格式和限制错误，仅返回 `application/json`。相关指南解决数据写入问题
内容编码	字符串默认: identity 枚举: "gzip" "identity" 应用于请求有效负载的行协议的压缩。要发送gzip有效负载，请传递 `Content-Encoding: gzip` 头部。
内容长度	整数发送到 InfluxDB 的实体主体的大小，以字节为单位。如果长度大于 `max body` 配置选项，服务器将响应状态代码 `413`。
内容类型	字符串默认: text/plain; charset=utf-8 枚举: "text/plain" "text/plain; charset=utf-8" 请求体中数据的格式。要发送行协议有效负载，请传递 `Content-Type: text/plain; charset=utf-8`。
Zap-Trace-Span	字符串示例： baggage,[object Object],span_id,1,trace_id,1 OpenTracing span 上下文

请求体架构: text/plain

在请求体中，以行协议格式提供数据。

要发送压缩数据，请执行以下操作：

Use gzip to compress the line protocol data.
In your request, send the compressed data and the Content-Encoding: gzip header.

Best practices for optimizing writes

string <byte>

响应

请求示例

Payload

Content type

text/plain

airSensors,sensor_id=TLM0201 temperature=73.97038159354763,humidity=35.23103248356096,co=0.48445310567793615 1630424257000000000
airSensors,sensor_id=TLM0202 temperature=75.30007505999716,humidity=35.651929918691714,co=0.5141876544505826 1630424257000000000

响应示例

Content type

application/json

Example

{"code": "invalid",
"message": "partial write error (2 written): unable to parse 'air_sensor,service=S1,sensor=L1 temperature=\"90.5\",humidity=70.0 1632850122': schema: field type for field \"temperature\" not permitted by schema; got String but expected Float"
}

	对象 (Dialect) 表格数据输出选项。默认输出为注释的 CSV，包含标题。有关表格数据方言的更多信息，请参见W3表格数据元数据词汇。
	对象 (文件) 表示来自单个文件的源
现在	字符串 <日期-时间> 指定在查询中应报告的时间作为 `now`。默认是服务器的 `now` 时间。
	对象在查询执行期间作为参数传递的键值对。要在查询中使用参数，请传递一个 `query`，其中包含 `params` 引用（以点表示法）--例如： `query: "from(bucket: params.mybucket)\ \|> range(start: params.rangeStart) \|> limit(n:1)"` 并传递 `params` 和键值对--例如： `params: { "mybucket": "environment", "rangeStart": "-30d" }` 在查询执行期间，InfluxDB 会将 `params` 传递给您的脚本并替换对应的值。限制如果使用 `params`，则不能使用 `extern`。
查询必需	字符串要执行的查询脚本。
类型	字符串值： "flux" 查询的类型。必须是 "flux"。

桶必需	字符串一个桶的名称或ID。 InfluxDB将所有批处理中的点写入指定的桶。
组织必需	字符串组织名称或ID。 InfluxDB Cloud 不使用 `org` 参数或 `orgID` 参数。将数据写入与授权（API令牌）相关联的组织中的桶。 InfluxDB OSS 要求使用 `org` 参数或 `orgID` 参数。如果同时传递 `orgID` 和 `org`，它们必须都是有效的。将数据写入指定组织中的桶。
orgID	字符串组织 ID。 InfluxDB Cloud 不使用 `org` 参数或 `orgID` 参数。将数据写入与授权（API 令牌）关联的组织中的桶。 InfluxDB OSS 需要 `org` 参数或 `orgID` 参数中的任意一个。如果同时传递 `orgID` 和 `org`，两者都必须有效。将数据写入指定组织中的桶。
精度	字符串 (WritePrecision) 枚举: "ms" "s" "us" "ns" 线协议批次中 unix 时间戳的精度。

InfluxDB 云 API 服务 (2.x)

快速入门

认证

基本认证

基本认证方案

语法

示例

使用cURL编码凭据

使用Flux编码凭证

使用JavaScript编码凭据

令牌认证

语法

示例

使用令牌认证与cURL

相关端点

相关指南

支持的操作

标题

分页

限制

响应代码

数据输入/输出端点

删除数据

InfluxDB云

InfluxDB OSS

所需权限

速率限制（使用InfluxDB Cloud）

相关指南

授权：

查询参数

InfluxDB Cloud

InfluxDB OSS

InfluxDB Cloud

InfluxDB OSS

头部参数

请求体模式: application/json

相关指南

响应

InfluxDB云

InfluxDB OSS

InfluxDB OSS

请求示例

响应示例

查询数据

速率限制（使用InfluxDB Cloud）

相关指南

授权：

查询参数

InfluxDB Cloud

InfluxDB OSS

InfluxDB Cloud

InfluxDB OSS

头部参数

请求体模式:application/jsonapplication/jsonapplication/vnd.flux

限制

响应

InfluxDB OSS

InfluxDB 云：

InfluxDB OSS:

请求示例

响应示例

脚本列表

相关指南

授权：

查询参数

响应

请求示例

响应示例

获取脚本

相关指南

授权：

路径参数

响应

响应示例

调用脚本

相关指南

授权：

路径参数

请求体模式: application/json

响应

请求体模式:
application/json
application/json
application/vnd.flux