cdnca

开放接口

/v1/admin/system-mail-settings

2 个接口

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

方法路径摘要认证
GET/v1/admin/system-mail-settingsRead platform mail settings登录会话
PUT/v1/admin/system-mail-settingsUpdate platform mail settings登录会话

契约文件：api/control-system-mail-settings.openapi.yaml

接口详情

GET /v1/admin/system-mail-settings

Read platform mail settings

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

全部需要：system_configuration.read

响应

getPlatformSystemMailSettings 响应
状态码说明
200Current mail settings

字段：schema: const cdnca.platform-system-mail-settings/v1 revision: integer updated_at?: string(date-time) value: Settings mail_secret_configured?: boolean mail_secret_provider?: string: aliyun / sendgrid mail_secret_fingerprint?: string

401Unauthenticated
403Permission denied
500Unexpected internal failure
503Settings storage or policy is unavailable

失败时怎么办

  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。
  • 500 结果未知：先按资源 ID 或列表回读确认，再决定是否用原 Idempotency-Key 重试。
  • 503 依赖暂不可用：稍后用原 Idempotency-Key 重试。

↑ 回到列表

PUT /v1/admin/system-mail-settings

Update platform mail settings

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

全部需要：system_configuration.manage

说明（契约原文）

Persists configuration only. Runtime settings are applied at process startup when the notification runtime is enabled; saving does not enable or reload a provider.

参数

updatePlatformSystemMailSettings 参数
名称位置类型必填说明
If-Matchheaderstring是—
Idempotency-Keyheaderstring是—
X-Request-IDheaderstring是—

请求体

application/json · 必填：是

updatePlatformSystemMailSettings 请求体
名称类型必填说明
mail_secretstring否Official mail service credential (DirectMail AccessKeySecret or SendGrid API key) for value.mail_provider. Omitted keeps the stored one; required when choosing an official provider whose credential is not stored.
valueobject是—

响应

updatePlatformSystemMailSettings 响应
状态码说明
200Saved mail settings

字段：schema: const cdnca.platform-system-mail-settings/v1 revision: integer updated_at?: string(date-time) value: Settings mail_secret_configured?: boolean mail_secret_provider?: string: aliyun / sendgrid mail_secret_fingerprint?: string

400Validation error
401Unauthenticated
403Permission denied
409Revision or idempotency conflict
500Unexpected internal failure
503Settings storage or policy is unavailable

失败时怎么办

  • 400 按字段说明修正参数或请求体再发；不要原样重试。
  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。
  • 409 先回读资源当前状态；同一操作重试保持原 Idempotency-Key 和原请求内容。
  • 500 结果未知：先按资源 ID 或列表回读确认，再决定是否用原 Idempotency-Key 重试。
  • 503 依赖暂不可用：稍后用原 Idempotency-Key 重试。

↑ 回到列表