完整文档索引见 llms.txt。在页面 URL 后附加 .md 即可获取 Markdown 版本；本页的 Markdown 版本可在此获取。

变量

变量相关操作

获取变量

获取实例中的变量。

GET/variables

请求参数

参数	位置	类型	必填	说明
limit	query	number	否	最多返回的数据项数量。 默认值：100
cursor	query	string	否	将 cursor 参数设为上次请求响应中的 nextCursor 属性，以进行分页。使用默认值时，获取集合的第一页。更多信息，请参阅分页说明。
projectId	query	string	否
state	query	string	否	可选值：empty

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问

响应结构：200 · application/json

字段	类型	必填	说明
data	array	是	展开字段 字段 类型 必填 说明 data.[]id string 是 只读。 data.[]key string 是 data.[]value string 是 data.[]type string 是 只读。 data.[]project object 是 展开字段 字段 类型 必填 说明 data.[]project.id string 是 只读。 data.[]project.name string 是 data.[]project.type string 是 可选值：personal, team 只读。 data.[]project.icon object 是 项目图标；项目没有图标时为 null data.[]project.description string 是 data.[]project.customTelemetryTags array 是 data.[]project.creatorId string 是 data.[]project.createdAt string 是 只读。 data.[]project.updatedAt string 是 只读。
nextCursor	string	是

下载完整 OpenAPI 定义（JSON）

创建变量

在实例中创建变量。

POST/variables

请求参数

参数	位置	类型	必填	说明
Idempotency-Key	header	string	否	此 POST 请求的安全重试键。使用 1 到 128 个可见 ASCII 字符。相同的键配合相同的请求，会返回首次成功的响应。使用此键发送不同请求时返回 422。首次请求仍在处理时重试，会返回 409。

请求体

application/json

字段	类型	必填	说明
id	string	否	只读。
key	string	是
value	string	是
type	string	否	只读。
projectId	string	否

响应

状态码	说明
201	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
409	冲突
415	不支持的媒体类型。
422	无法处理的实体

下载完整 OpenAPI 定义（JSON）

更新变量

更新实例中的变量。

PUT/variables/{id}

请求参数

参数	位置	类型	必填	说明
id	path	string	是	变量的 ID。

请求体

application/json

字段	类型	必填	说明
id	string	否	只读。
key	string	是
value	string	是
type	string	否	只读。
projectId	string	否

响应

状态码	说明
204	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。
415	不支持的媒体类型。

下载完整 OpenAPI 定义（JSON）

删除变量

从实例中删除变量。

DELETE/variables/{id}

请求参数

参数	位置	类型	必填	说明
id	path	string	是	变量的 ID。

响应

状态码	说明
204	操作成功。
401	未授权
403	禁止访问
404	未找到指定资源。

下载完整 OpenAPI 定义（JSON）