接口详情
GET /v1/admin/cname-allocations
List CNAME allocation authority in a selected tenant scope
- operationId
adminListCnameAllocations- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin
参数
adminListCnameAllocations 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
scope_id | query | string(uuid) | 是 | — |
|---|
limit | query | integer | 否 | — |
|---|
cursor | query | string(uuid) | 否 | — |
|---|
X-Request-ID | header | string | 否 | — |
|---|
响应
adminListCnameAllocations 响应| 状态码 | 说明 |
|---|
200 | Stable CNAME allocation page. 字段:items: array<Allocation> next_cursor?: string(uuid) |
|---|
400 | Invalid canonical query. |
|---|
401 | Authentication is required. |
|---|
403 | Permission is required. |
|---|
404 | The scope-bound authority was not found. |
|---|
405 | Only GET is supported. |
|---|
408 | The bounded read timed out. |
|---|
503 | The authority reader is unavailable. |
|---|
失败时怎么办
400 按字段说明修正参数或请求体再发;不要原样重试。401 检查凭据格式、是否过期或被轮换。403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。404 资源不存在或不属于当前租户。503 依赖暂不可用:稍后用原 Idempotency-Key 重试。
↑ 回到列表
GET /v1/admin/cname-allocations/diagnose
Diagnose CNAME authority for one site in a selected tenant scope
- operationId
adminDiagnoseCnameAllocation- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin
参数
adminDiagnoseCnameAllocation 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
scope_id | query | string(uuid) | 是 | — |
|---|
site_id | query | string(uuid) | 是 | — |
|---|
domain | query | string | 否 | — |
|---|
hostname | query | string | 否 | — |
|---|
X-Request-ID | header | string | 否 | — |
|---|
响应
adminDiagnoseCnameAllocation 响应| 状态码 | 说明 |
|---|
200 | Repeatable-read CNAME authority diagnosis. 字段:site_id: string(uuid) mode?: string: site / package owner_id?: string(uuid) allocation_id?: string(uuid) binding_allocation_id?: string(uuid) lkg_allocation_id?: string(uuid) provider_id?: string(uuid) zone_id?: string(uuid) domain?: string hostname?: string state?: string: pending / failed / done ready: boolean reason_codes: array<string> |
|---|
400 | Invalid canonical query. |
|---|
401 | Authentication is required. |
|---|
403 | Permission is required. |
|---|
404 | The scope-bound authority was not found. |
|---|
405 | Only GET is supported. |
|---|
408 | The bounded read timed out. |
|---|
503 | The authority reader is unavailable. |
|---|
失败时怎么办
400 按字段说明修正参数或请求体再发;不要原样重试。401 检查凭据格式、是否过期或被轮换。403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。404 资源不存在或不属于当前租户。503 依赖暂不可用:稍后用原 Idempotency-Key 重试。
↑ 回到列表
GET /v1/admin/cname-allocations/{allocation_id}
Get one CNAME allocation in a selected tenant scope
- operationId
adminGetCnameAllocation- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin
参数
adminGetCnameAllocation 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
scope_id | query | string(uuid) | 是 | — |
|---|
allocation_id | path | string(uuid) | 是 | — |
|---|
X-Request-ID | header | string | 否 | — |
|---|
响应
adminGetCnameAllocation 响应| 状态码 | 说明 |
|---|
200 | One scope-bound CNAME allocation. 字段:id: string(uuid) mode: string: site / package owner_id: string(uuid) provider_id: string(uuid) zone_id: string(uuid) domain: string hostname: string explicit_hostname: boolean state: string: pending / failed / done failure_code?: string job_id: string(uuid) generation: integer(int64) current_revision: integer(int64) lkg_revision?: integer(int64) created_at: string(date-time) updated_at: string(date-time) |
|---|
400 | Invalid canonical query. |
|---|
401 | Authentication is required. |
|---|
403 | Permission is required. |
|---|
404 | The scope-bound authority was not found. |
|---|
405 | Only GET is supported. |
|---|
408 | The bounded read timed out. |
|---|
503 | The authority reader is unavailable. |
|---|
失败时怎么办
400 按字段说明修正参数或请求体再发;不要原样重试。401 检查凭据格式、是否过期或被轮换。403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。404 资源不存在或不属于当前租户。503 依赖暂不可用:稍后用原 Idempotency-Key 重试。
↑ 回到列表