抢先体验仅限邀请,SDK 尚未发布。申请邀请
跳到正文
文档

api 和 open

lyrelog api 以你的登录身份调用任意控制台 API 路由;lyrelog open 在控制台中打开对应的页面。

api

lyrelog api 以你的登录身份调用控制台 API 的任意路由,类似 gh api。其他命令还没有封装的操作,都可以用它完成。

lyrelog api <method> <path>
  • 方法为 GET、POST、PUT、PATCH 或 DELETE。
  • 路径可以省略 /api:projects/{project} 就是 /api/projects/{project}。只需给出路径。服务器地址取自 --url 或 LYRELOG_URL。
  • {project} 会被替换为当前项目的 id(默认项目,或 -p 指定的项目)。
lyrelog api GET /api/me
{"admin":false,"organizations":[{"id":4,"name":"Alex Rivera","role":"owner","plan":"free","plan_until":null}],"user":{"id":10,"email":"alex@example.com","name":"Alex Rivera"}}
lyrelog api GET projects/{project}/regions -F from=1763500000000
lyrelog api PATCH projects/{project} --data '{"retention_days":30}'
lyrelog api POST projects/{project}/views --data @view.json
参数作用
-F、--fieldkey=value。在 GET 上是查询参数;在 POST、PUT 和 PATCH 上是 JSON 请求体的一个字段(数字、true、false 和 null 按原类型发送)。需要多个时重复该参数。
-d、--data原样发送的请求体:JSON、用 @file 读取文件,或用 @- 读取 stdin。不能与 -F 同时使用。

响应按原样输出。在终端中,JSON 会缩进并着色。没有响应体时会输出状态码(JSON 模式下为 {"status":204})。 失败时使用与所有命令相同的退出码;在 JSON 模式下,错误以 JSON 形式输出到 stderr。

这些是控制台自己使用的路由,这里不提供文档。如果需要有文档、可供脚本读取事件的 API,请使用读取 API。

open

lyrelog open 在浏览器中打开当前项目的某个控制台页面。

lyrelog open errors
lyrelog open person gc-2e427d7b
lyrelog open settings --print
https://app.lyrelog.com/p/e8bc11c6e22f/settings
页面打开的内容
(无)Explorer
eventsExplorer
errorsErrors 页面
sessionsSessions 页面
people项目的用户
insightsInsights 页面
releasesReleases 页面
keysAPI keys 页面
settingsProject settings
projects所有项目
usage用量和套餐
account你的账户
organization你的组织
person <id>单个用户的页面
event <id>Explorer,搜索某个事件
参数作用
--print输出地址,而不是打开它

通过 SSH 运行,或无法打开浏览器时,它会输出地址。在 JSON 模式下(供 agent 或脚本使用),它不会打开任何东西,而是输出 {"url":"..."}。

本页目录