方法路径摘要认证
GET/v1/certificate-ordersList certificate orders登录会话
POST/v1/certificate-ordersQueue a pending certificate order登录会话

契约文件:api/openapi/v1/dns-acme.yaml

接口详情

GET /v1/certificate-orders

List certificate orders

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

全部需要:certificates.read

响应

listCertificateOrders 响应
状态码说明
200Orders visible in the authenticated scope.

字段:items: array<CertificateOrder>

401Authentication is required.
403The active role lacks the required permission.

失败时怎么办

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

↑ 回到列表

POST /v1/certificate-orders

Queue a pending certificate order

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

全部需要:certificates.manage

说明(契约原文)

Wildcards require dns-01 and a provider in the same tenant scope. A 202 response only persists a tenant-scoped pending intent and its audit event; it does not claim CA acceptance. Reusing an Idempotency-Key with a different scope, domain set, challenge, provider, or auto-renew value returns a conflict. HTTP-01 forbids dns_provider_id; DNS-01 requires a verified same-tenant provider. Entitlement authorization is a separate fail-closed server composition requirement and is not implied by RBAC.

参数

createCertificateOrder 参数
名称位置类型必填说明
Idempotency-Keyheaderstring是—

请求体

application/json · 必填:是

createCertificateOrder 请求体
名称类型必填说明
target_scope_idstring(uuid)否—
dns_provider_idstring(uuid)否—
domainsarray<string>是—
challenge_typestring: http-01 / dns-01是—
auto_renewboolean是—
issuerstring: lets_encrypt / zerossl / google_trust否The CA. Omitted uses the requesting user's default issuer, then the platform default. The resolved CA is frozen on the order and its renewals; a CA without platform EAB credentials is refused with 409 certificate_issuer_unavailable. An order for the same domain set that is still pending, validating or issuing refuses the new order with 409 certificate_order_in_flight.
namestring否Names the order and the certificate it issues; trimmed.
remarkstring否Copied to the issued certificate; trimmed

响应

createCertificateOrder 响应
状态码说明
202Pending intent stored without external side effects.

字段:id: string(uuid) scope_id: string(uuid) dns_provider_id?: string(uuid) domains: array<string> challenge_type: string: http-01 / dns-01 status: string: pending / validating / issuing / issued / deploying / active / renewal_due / failed / revoked auto_renew: boolean issuer?: string: lets_encrypt / zerossl / google_trust name?: string remark?: string renewal_of_order_id?: string(uuid) not_after?: string(date-time) failure_code?: string issued_asset_id?: string(uuid) issued_version_id?: string(uuid) issued_at?: string(date-time) version: integer(int64) created_at: string(date-time) updated_at: string(date-time)

400Invalid request or structurally invalid DNS/certificate data.
401Authentication is required.
403The active role lacks the required permission.
404Resource absent or hidden by tenant isolation.
409Duplicate, referenced, stale, or conflicting idempotent request.

失败时怎么办

  • 400 按字段说明修正参数或请求体再发;不要原样重试。
  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。
  • 404 资源不存在或不属于当前租户。
  • 409 先回读资源当前状态;同一操作重试保持原 Idempotency-Key 和原请求内容。

↑ 回到列表