cdnca

开放接口

/v1/admin/inbox

4 个接口

← 全部分组 · 第一次调用？先看教程：认证、权限、请求与响应、常见失败

方法路径摘要认证
GET/v1/admin/inboxList the platform administrator's messages, newest first登录会话
POST/v1/admin/inbox/read-allMark all the caller's messages read (audited admin.inbox.read_all); read messages older than 180 days are pruned登录会话
GET/v1/admin/inbox/unread-countUnread message count for the header badge登录会话
POST/v1/admin/inbox/{message_id}/readMark one message read登录会话

契约文件：api/openapi/v1/control.yaml

接口详情

GET /v1/admin/inbox

List the platform administrator's messages, newest first

operationId
listAdminInbox
认证
  • 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。
所需权限

契约没有单独标注权限码，权限要求见下方说明与 403 响应。

说明（契约原文）

Platform operations events addressed to the caller (node offline/recovered, ACME HTTP-01 epoch drift, staff ticket events). Every platform-scope session reads only its own messages. params holds the event's public template values; the console renders the text per language.

参数

listAdminInbox 参数
名称位置类型必填说明
unreadquerystring: true否—
page_sizequeryinteger否—
cursorquerystring否—

响应

listAdminInbox 响应
状态码说明
200One page.

字段：items: array<object> unread: integer total: integer next_cursor: string unread_only: boolean page_size: integer

401认证失败或会话已失效。
403当前身份没有执行该操作的权限。

失败时怎么办

  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。

↑ 回到列表

POST /v1/admin/inbox/read-all

Mark all the caller's messages read (audited admin.inbox.read_all); read messages older than 180 days are pruned

operationId
markAllAdminInboxMessagesRead
认证
  • 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。
所需权限

契约没有单独标注权限码，权限要求见下方说明与 403 响应。

响应

markAllAdminInboxMessagesRead 响应
状态码说明
200Number of messages marked.

字段：marked: integer

↑ 回到列表

GET /v1/admin/inbox/unread-count

Unread message count for the header badge

operationId
getAdminInboxUnreadCount
认证
  • 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。
所需权限

契约没有单独标注权限码，权限要求见下方说明与 403 响应。

响应

getAdminInboxUnreadCount 响应
状态码说明
200Count.

字段：unread: integer

401认证失败或会话已失效。

失败时怎么办

  • 401 检查凭据格式、是否过期或被轮换。

↑ 回到列表

POST /v1/admin/inbox/{message_id}/read

Mark one message read

operationId
markAdminInboxMessageRead
认证
  • 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。
所需权限

契约没有单独标注权限码，权限要求见下方说明与 403 响应。

参数

markAdminInboxMessageRead 参数
名称位置类型必填说明
message_idpathstring(uuid)是—

响应

markAdminInboxMessageRead 响应
状态码说明
204Read.
404admin_inbox_message_not_found (not the caller's message).

失败时怎么办

  • 404 资源不存在或不属于当前租户。

↑ 回到列表