Operation details
GET /v1/cname-allocations
List CNAME allocation authority in the active tenant scope
- operationId
listCnameAllocations- Auth
- Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
- Required permissions
All of：dns.read
Parameters
listCnameAllocations Parameters| Name | In | Type | Required | Description |
|---|
limit | query | integer | No | — |
|---|
cursor | query | string(uuid) | No | — |
|---|
X-Request-ID | header | string | No | — |
|---|
Responses
listCnameAllocations Responses| Status | Description |
|---|
200 | Stable CNAME allocation page. Fields：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. |
|---|
What to do on failure
400 Fix the parameters or body per the field list; do not retry unchanged.401 Check the credential format and whether it expired or was rotated.403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.404 The resource does not exist or belongs to another tenant.503 A dependency is unavailable: retry later with the original Idempotency-Key.
↑ Back to list
GET /v1/cname-allocations/diagnose
Diagnose CNAME authority for one site in the active tenant scope
- operationId
diagnoseCnameAllocation- Auth
- Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
- Required permissions
All of：dns.read
Parameters
diagnoseCnameAllocation Parameters| Name | In | Type | Required | Description |
|---|
site_id | query | string(uuid) | Yes | — |
|---|
domain | query | string | No | — |
|---|
hostname | query | string | No | — |
|---|
X-Request-ID | header | string | No | — |
|---|
Responses
diagnoseCnameAllocation Responses| Status | Description |
|---|
200 | Repeatable-read CNAME authority diagnosis. Fields：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. |
|---|
What to do on failure
400 Fix the parameters or body per the field list; do not retry unchanged.401 Check the credential format and whether it expired or was rotated.403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.404 The resource does not exist or belongs to another tenant.503 A dependency is unavailable: retry later with the original Idempotency-Key.
↑ Back to list
GET /v1/cname-allocations/{allocation_id}
Get one CNAME allocation in the active tenant scope
- operationId
getCnameAllocation- Auth
- Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
- Required permissions
All of：dns.read
Parameters
getCnameAllocation Parameters| Name | In | Type | Required | Description |
|---|
allocation_id | path | string(uuid) | Yes | — |
|---|
X-Request-ID | header | string | No | — |
|---|
Responses
getCnameAllocation Responses| Status | Description |
|---|
200 | One scope-bound CNAME allocation. Fields：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. |
|---|
What to do on failure
400 Fix the parameters or body per the field list; do not retry unchanged.401 Check the credential format and whether it expired or was rotated.403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.404 The resource does not exist or belongs to another tenant.503 A dependency is unavailable: retry later with the original Idempotency-Key.
↑ Back to list