接口详情
列出平台范围插件安装的授权状态(平台)
- operationId
listPlatformPluginInstallations- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
契约没有单独标注权限码,权限要求见下方说明与 403 响应。
参数
listPlatformPluginInstallations 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 是 | — |
|---|
limit | query | integer | 否 | — |
|---|
cursor | query | string | 否 | — |
|---|
status | query | string: pending_confirmation / authorized / installing / enabled / disabled / upgrade_failed_lkg_preserved / uninstalled | 否 | — |
|---|
plugin_id | query | string | 否 | — |
|---|
响应
listPlatformPluginInstallations 响应| 状态码 | 说明 |
|---|
200 | Stable keyset page 字段:items: array<PluginInstallation> next_cursor?: string |
|---|
400 | Stable localized-client error envelope |
|---|
401 | Stable localized-client error envelope |
|---|
403 | Stable localized-client error envelope |
|---|
502 | Stable localized-client error envelope |
|---|
失败时怎么办
400 按字段说明修正参数或请求体再发;不要原样重试。401 检查凭据格式、是否过期或被轮换。403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。
↑ 回到列表
读取一条平台范围插件安装授权(平台)
- operationId
getPlatformPluginInstallation- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
契约没有单独标注权限码,权限要求见下方说明与 403 响应。
参数
getPlatformPluginInstallation 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
authorization_id | path | string(uuid) | 是 | — |
|---|
X-Request-ID | header | string | 是 | — |
|---|
响应
getPlatformPluginInstallation 响应| 状态码 | 说明 |
|---|
200 | Plugin installation authorization state 字段:schema: const cdnca.control.plugin-installation/v1 tenant_scope_id: string(uuid) authorization_id: string(uuid) installation_id: string(uuid) verification_id: string(uuid) plugin_id: string resource_scope: string: platform / tenant entrypoint_type: string: theme / rule_pack / external_https / ui_page version: string manifest_sha256: string configuration_schema_sha256: string manifest_scopes: array<string> approved_scopes: array<string> sensitive_scopes: array<string> new_scopes: array<string> status: string: pending_confirmation / authorized / installing / enabled / disabled / upgrade_failed_lkg_preserved / uninstalled revision: integer identity_generation: integer lkg_verification_id: string(uuid) | null lkg_version: string | null stable_reason_code: string | null updated_at: string(date-time) authorization_status?: string: pending_confirmation / authorized / enabled / disabled paused_by?: string: installation / operator / service paused_reason?: string available_upgrade?: PluginInstallationAvailableUpgrade managed_by?: string: platform / tenant targets?: object |
|---|
401 | Stable localized-client error envelope |
|---|
403 | Stable localized-client error envelope |
|---|
404 | Stable localized-client error envelope |
|---|
502 | Stable localized-client error envelope |
|---|
失败时怎么办
401 检查凭据格式、是否过期或被轮换。403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。404 资源不存在或不属于当前租户。
↑ 回到列表
主控平台管理员确认安装:主题、规则包装在平台;页面插件、外部服务须指定装给哪些租户(全部租户/指定租户),确认后这些租户直接可用
- operationId
confirmPlatformPluginInstallation- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
契约没有单独标注权限码,权限要求见下方说明与 403 响应。
参数
confirmPlatformPluginInstallation 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
authorization_id | path | string(uuid) | 是 | — |
|---|
If-Match | header | string | 是 | — |
|---|
Idempotency-Key | header | string | 是 | — |
|---|
X-Request-ID | header | string | 是 | — |
|---|
请求体
application/json · 必填:是
confirmPlatformPluginInstallation 请求体| 名称 | 类型 | 必填 | 说明 |
|---|
verification_id | string(uuid) | 是 | — |
|---|
approved_scopes | array<string> | 是 | — |
|---|
sensitive_permissions_confirmed | boolean | 是 | — |
|---|
new_permissions_confirmed | boolean | 是 | — |
|---|
targets | PluginInstallationTargets | 否 | Platform confirmation of a tenant plugin only (required there, refused elsewhere). |
|---|
响应
confirmPlatformPluginInstallation 响应| 状态码 | 说明 |
|---|
200 | Durable mutation snapshot; replay returns the original snapshot 字段:installation: PluginInstallation |
|---|
400 | Stable localized-client error envelope |
|---|
401 | Stable localized-client error envelope |
|---|
403 | Stable localized-client error envelope |
|---|
404 | Stable localized-client error envelope |
|---|
409 | Stable localized-client error envelope |
|---|
422 | Stable localized-client error envelope |
|---|
502 | Stable localized-client error envelope |
|---|
503 | Stable localized-client error envelope |
|---|
失败时怎么办
400 按字段说明修正参数或请求体再发;不要原样重试。401 检查凭据格式、是否过期或被轮换。403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。404 资源不存在或不属于当前租户。409 先回读资源当前状态;同一操作重试保持原 Idempotency-Key 和原请求内容。503 依赖暂不可用:稍后用原 Idempotency-Key 重试。
↑ 回到列表
不经授权服务,保护性停用已安装插件(平台)
- operationId
disablePlatformPluginInstallation- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
契约没有单独标注权限码,权限要求见下方说明与 403 响应。
参数
disablePlatformPluginInstallation 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
authorization_id | path | string(uuid) | 是 | — |
|---|
If-Match | header | string | 是 | — |
|---|
Idempotency-Key | header | string | 是 | — |
|---|
X-Request-ID | header | string | 是 | — |
|---|
请求体
application/json · 必填:是
响应
disablePlatformPluginInstallation 响应| 状态码 | 说明 |
|---|
200 | Durable mutation snapshot; replay returns the original snapshot 字段:installation: PluginInstallation |
|---|
400 | Stable localized-client error envelope |
|---|
401 | Stable localized-client error envelope |
|---|
403 | Stable localized-client error envelope |
|---|
404 | Stable localized-client error envelope |
|---|
409 | Stable localized-client error envelope |
|---|
502 | Stable localized-client error envelope |
|---|
503 | Stable localized-client error envelope |
|---|
失败时怎么办
400 按字段说明修正参数或请求体再发;不要原样重试。401 检查凭据格式、是否过期或被轮换。403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。404 资源不存在或不属于当前租户。409 先回读资源当前状态;同一操作重试保持原 Idempotency-Key 和原请求内容。503 依赖暂不可用:稍后用原 Idempotency-Key 重试。
↑ 回到列表
恢复本主控自行暂停的插件(平台)
- operationId
resumePlatformPluginInstallation- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
契约没有单独标注权限码,权限要求见下方说明与 403 响应。
说明(契约原文)
Same as the tenant resume, in the platform scope of the session: requires plugin_installations.platform.manage, If-Match and Idempotency-Key, reads the signed license snapshot first, and only resumes a pause of this controller (paused_by=installation). A platform pause returns 409 plugin_installation_platform_paused and an unreachable license service 503; the plugin then stays paused.
参数
resumePlatformPluginInstallation 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
authorization_id | path | string(uuid) | 是 | — |
|---|
If-Match | header | string | 是 | — |
|---|
Idempotency-Key | header | string | 是 | — |
|---|
X-Request-ID | header | string | 是 | — |
|---|
请求体
application/json · 必填:是
响应
resumePlatformPluginInstallation 响应| 状态码 | 说明 |
|---|
200 | Durable mutation snapshot; replay returns the original snapshot 字段:installation: PluginInstallation |
|---|
400 | Stable localized-client error envelope |
|---|
401 | Stable localized-client error envelope |
|---|
403 | Stable localized-client error envelope |
|---|
404 | Stable localized-client error envelope |
|---|
409 | Stable localized-client error envelope |
|---|
422 | Stable localized-client error envelope |
|---|
502 | Stable localized-client error envelope |
|---|
503 | Stable localized-client error envelope |
|---|
失败时怎么办
400 按字段说明修正参数或请求体再发;不要原样重试。401 检查凭据格式、是否过期或被轮换。403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。404 资源不存在或不属于当前租户。409 先回读资源当前状态;同一操作重试保持原 Idempotency-Key 和原请求内容。503 依赖暂不可用:稍后用原 Idempotency-Key 重试。
↑ 回到列表
改租户插件装给哪些租户(全部租户/指定租户);If-Match 是 targets.revision
- operationId
updatePlatformPluginInstallationTargets- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
契约没有单独标注权限码,权限要求见下方说明与 403 响应。
参数
updatePlatformPluginInstallationTargets 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
authorization_id | path | string(uuid) | 是 | — |
|---|
If-Match | header | string | 是 | — |
|---|
Idempotency-Key | header | string | 是 | — |
|---|
X-Request-ID | header | string | 是 | — |
|---|
请求体
application/json · 必填:是
updatePlatformPluginInstallationTargets 请求体| 名称 | 类型 | 必填 | 说明 |
|---|
all_tenants | boolean | 是 | — |
|---|
tenant_scope_ids | array<string(uuid)> | 是 | — |
|---|
响应
updatePlatformPluginInstallationTargets 响应| 状态码 | 说明 |
|---|
200 | Durable mutation snapshot; replay returns the original snapshot 字段:installation: PluginInstallation |
|---|
400 | Stable localized-client error envelope |
|---|
401 | Stable localized-client error envelope |
|---|
403 | Stable localized-client error envelope |
|---|
404 | Stable localized-client error envelope |
|---|
409 | Stable localized-client error envelope |
|---|
422 | Stable localized-client error envelope |
|---|
502 | Stable localized-client error envelope |
|---|
503 | Stable localized-client error envelope |
|---|
失败时怎么办
400 按字段说明修正参数或请求体再发;不要原样重试。401 检查凭据格式、是否过期或被轮换。403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。404 资源不存在或不属于当前租户。409 先回读资源当前状态;同一操作重试保持原 Idempotency-Key 和原请求内容。503 依赖暂不可用:稍后用原 Idempotency-Key 重试。
↑ 回到列表
吊销本地插件身份并记录保护性卸载(平台)
- operationId
uninstallPlatformPluginInstallation- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
契约没有单独标注权限码,权限要求见下方说明与 403 响应。
参数
uninstallPlatformPluginInstallation 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
authorization_id | path | string(uuid) | 是 | — |
|---|
If-Match | header | string | 是 | — |
|---|
Idempotency-Key | header | string | 是 | — |
|---|
X-Request-ID | header | string | 是 | — |
|---|
请求体
application/json · 必填:是
uninstallPlatformPluginInstallation 请求体| 名称 | 类型 | 必填 | 说明 |
|---|
reason | string | 是 | — |
|---|
响应
uninstallPlatformPluginInstallation 响应| 状态码 | 说明 |
|---|
200 | Durable mutation snapshot; replay returns the original snapshot 字段:installation: PluginInstallation |
|---|
400 | Stable localized-client error envelope |
|---|
401 | Stable localized-client error envelope |
|---|
403 | Stable localized-client error envelope |
|---|
404 | Stable localized-client error envelope |
|---|
409 | Stable localized-client error envelope |
|---|
502 | Stable localized-client error envelope |
|---|
503 | Stable localized-client error envelope |
|---|
失败时怎么办
400 按字段说明修正参数或请求体再发;不要原样重试。401 检查凭据格式、是否过期或被轮换。403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。404 资源不存在或不属于当前租户。409 先回读资源当前状态;同一操作重试保持原 Idempotency-Key 和原请求内容。503 依赖暂不可用:稍后用原 Idempotency-Key 重试。
↑ 回到列表
批准兼容的插件升级及新声明的权限(平台)
- operationId
upgradePlatformPluginInstallation- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
契约没有单独标注权限码,权限要求见下方说明与 403 响应。
参数
upgradePlatformPluginInstallation 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
authorization_id | path | string(uuid) | 是 | — |
|---|
If-Match | header | string | 是 | — |
|---|
Idempotency-Key | header | string | 是 | — |
|---|
X-Request-ID | header | string | 是 | — |
|---|
请求体
application/json · 必填:是
upgradePlatformPluginInstallation 请求体| 名称 | 类型 | 必填 | 说明 |
|---|
verification_id | string(uuid) | 是 | — |
|---|
approved_scopes | array<string> | 是 | — |
|---|
sensitive_permissions_confirmed | boolean | 是 | — |
|---|
new_permissions_confirmed | boolean | 是 | — |
|---|
targets | PluginInstallationTargets | 否 | Platform confirmation of a tenant plugin only (required there, refused elsewhere). |
|---|
响应
upgradePlatformPluginInstallation 响应| 状态码 | 说明 |
|---|
200 | Durable mutation snapshot; replay returns the original snapshot 字段:installation: PluginInstallation |
|---|
400 | Stable localized-client error envelope |
|---|
401 | Stable localized-client error envelope |
|---|
403 | Stable localized-client error envelope |
|---|
404 | Stable localized-client error envelope |
|---|
409 | Stable localized-client error envelope |
|---|
422 | Stable localized-client error envelope |
|---|
502 | Stable localized-client error envelope |
|---|
503 | Stable localized-client error envelope |
|---|
失败时怎么办
400 按字段说明修正参数或请求体再发;不要原样重试。401 检查凭据格式、是否过期或被轮换。403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。404 资源不存在或不属于当前租户。409 先回读资源当前状态;同一操作重试保持原 Idempotency-Key 和原请求内容。503 依赖暂不可用:稍后用原 Idempotency-Key 重试。
↑ 回到列表