方法路径摘要认证
GET/v1/admin/plugin-providersList third-party DNS / SMS / ICP provider plugins with their installation contract results登录会话
POST/v1/admin/plugin-providers/{plugin_id}/{action}Run the installation contract, enable or disable a provider plugin登录会话

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

接口详情

GET /v1/admin/plugin-providers

List third-party DNS / SMS / ICP provider plugins with their installation contract results

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

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

说明(契约原文)

Platform administrators with plugin_installations.read (or platform.admin). A provider plugin appears once its installation is enabled here and the license service serves its declaration (plugin_provider/<plugin id>). usable is true only while it is active, its contract passed for the current version and it is enabled.

响应

listPluginProviders 响应
状态码说明
200Provider plugins.

字段:items: array<PluginProvider>

401认证失败或会话已失效。
403当前身份没有执行该操作的权限。
503A required dependency is unavailable.

失败时怎么办

  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。
  • 503 依赖暂不可用:稍后用原 Idempotency-Key 重试。

↑ 回到列表

POST /v1/admin/plugin-providers/{plugin_id}/{action}

Run the installation contract, enable or disable a provider plugin

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

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

说明(契约原文)

Platform administrators with plugin_installations.manage (or platform.admin). contract runs the cdnca.provider/v1 contract cases against the plugin sandbox and records the report; enable requires a passed contract for the current version (409 plugin_provider_contract_not_passed otherwise, also refused by the database). A payment plugin (high_risk) is a high-risk permission: enable needs risk_acknowledged (422 plugin_provider_risk_not_acknowledged) and an MFA step-up proof issued for the installation tenant with audience/action plugin.provider.enable_payment (403 plugin_provider_step_up_required); the proof is bound to the plugin declaration when consumed. Audited as plugin.provider.contract / enable / disable (refusals included).

参数

actOnPluginProvider 参数
名称位置类型必填说明
plugin_idpathstring是—
actionpathany是—

请求体

application/json · 必填:否

actOnPluginProvider 请求体
名称类型必填说明
risk_acknowledgedboolean否—
step_up_tokenstring否—

响应

actOnPluginProvider 响应
状态码说明
200The provider plugin after the action.

字段:plugin_id: string version: string base_url: string(uri) kinds: array<any> status: any contract_status: any contract_version?: string contract_checked_at?: string(date-time) contract_report?: object enabled: boolean usable: boolean updated_at: string(date-time) high_risk?: boolean risk_notice?: string tenant_id?: string(uuid) payment_confirmed_at?: string(date-time)

401认证失败或会话已失效。
403当前身份没有执行该操作的权限。
404请求的资源不存在。
409请求的状态与已有资源或幂等记录冲突。
422plugin_provider_risk_not_acknowledged (payment plugin enable without the acknowledged risk notice).
503A required dependency is unavailable.

失败时怎么办

  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。
  • 404 资源不存在或不属于当前租户。
  • 409 先回读资源当前状态;同一操作重试保持原 Idempotency-Key 和原请求内容。
  • 503 依赖暂不可用:稍后用原 Idempotency-Key 重试。

↑ 回到列表