cdnca

API reference

/v1/admin/package-resource-options

1 operations

← All groups · First call? Read the tutorial: auth, permissions, requests and responses, common failures

MethodPathSummaryAuth
GET/v1/admin/package-resource-optionsList named resources available to the current platform package catalogSession

Contract file：api/control-package-resources.openapi.yaml

Operation details

GET /v1/admin/package-resource-options

List named resources available to the current platform package catalog

operationId
listPackageResourceOptions
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：packages.manage

Description (from the contract)

Requires packages.manage in the authenticated platform scope. No query parameters are accepted, including target_scope_id. Returns the internal UUIDs used by ProductSpec, not the numeric display IDs from the region-management API. Only this platform's regions and non-deleted line groups are returned in stable sort order. A line group's legacy region string must match exactly one current region by name or canonical UUID. A null line-group region_id means this mapping is missing or ambiguous and must not be selected. Create and update require the selected region and main/optional backup groups to exist in this platform and match the region, checked and locked inside the write transaction. Unknown legacy values remain readable but must be explicitly corrected before writing. An active reseller tenant gets the platform's regions and CNAME domains and only the platform line groups granted to it. Completed idempotent writes retain their original receipts after live authorization.

Responses

listPackageResourceOptions Responses
StatusDescription
200Scoped resource options; empty arrays mean no available resources.

Fields：cname_domains: array<string> regions: array<object> node_groups: array<object>

400Stable error code; callers must render localized messages.
401Stable error code; callers must render localized messages.
403Stable error code; callers must render localized messages.
500Stable error code; callers must render localized messages.
503Stable error code; callers must render localized messages.

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.
  • 500 Outcome unknown: read back by ID or list first, then decide whether to retry with the original Idempotency-Key.
  • 503 A dependency is unavailable: retry later with the original Idempotency-Key.

↑ Back to list