跳转到主要内容
POST
查询值班表列表

限制说明

使用说明

  • 按创建时间从新到旧排序。query 对值班表名称或描述做子串匹配。
  • is_my_team 为 true 时只保留调用者所在团队的值班表,可用 team_ids 进一步收窄;team_ids 与调用者所在团队没有交集,或调用者不属于任何团队时,返回空列表。is_my_manage 为 true 时保留调用者创建的值班表,以及调用者所在团队的值班表(可用 team_ids 收窄,不属于调用者的团队 ID 会被忽略)。两者不能同时为 true。
  • 不传 start/end 时只返回已保存的配置(layers、schedule_layers、cur_oncall、next_oncall 为 null)。两者都传时计算 layers、schedule_layers、final_schedule、cur_oncall 和 next_oncall;本接口中 layer_schedules 始终为 null。
  • start 和 end 为 10 位 Unix 秒级时间戳;end 必须晚于 start,且相差不超过 45 天。只传 end 不传 start 会被拒绝。
  • 无法编辑值班表的调用者(非账户所有者或管理员、非创建者、非其团队成员)读到的 notify.im 值以及各 webhook 的 token、verify_token、sign_secret 均为空字符串。

授权

app_key
string
query
必填

在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集,请妥善保管。

请求体

application/json

值班表列表过滤条件。limit 默认 10,最大 100;p 默认 1。is_my_team 与 is_my_manage 不能同时为 true。

query
string

对值班表名称或描述做子串匹配。

p
integer
默认值:1

页码(从 1 开始)。

limit
integer
默认值:10

每页条数。默认 10;超过 100 按 100 处理。

必填范围: x <= 100
is_my_team
boolean

只返回调用者所在团队的值班表。team_ids 与调用者所在团队没有交集,或调用者不属于任何团队时,返回空列表。

is_my_manage
boolean

只返回调用者所在团队的值班表以及调用者创建的值班表。team_ids 只收窄团队部分,不属于调用者的团队 ID 会被忽略。

team_ids
integer<int64>[]

只返回这些团队的值班表。设置 is_my_team 或 is_my_manage 时只保留调用者所在的团队。

start
integer<int64>

窗口开始时间,10 位 Unix 秒。与 end 同时传入时计算分层和班次。

end
integer<int64>

窗口结束时间,10 位 Unix 秒,晚于 start 且相差不超过 45 天。只传 end 不传 start 会被拒绝。

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse。

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

值班表列表响应。