コンテンツにスキップ
Authrim

Preview a server-owned D1 capacity plan.

POST
/api/admin/platform/control-plane/capacity/preview
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/platform/control-plane/capacity/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "profile": "minimum", "scope": "shared_pool", "tenantId": "example" }'

Calculates the exact D1 databases, data roles, residency partitions, migrations, and Worker scripts that one capacity profile would add. Resource names and binding names are generated by Control and cannot be supplied by the administrator. This endpoint does not mutate state.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
profile
required
string
Allowed values: minimum recommended extra_headroom
scope
required
string
Allowed values: shared_pool tenant_exclusive
tenantId
required

Required for tenant_exclusive and null for shared_pool.

string | null
<= 128 characters
key
additional properties

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Server-owned capacity preview.

Media type application/json
object
preview
required
object
profile
required
string
Allowed values: minimum recommended extra_headroom
scope
required
string
Allowed values: shared_pool tenant_exclusive
tenantId
required
string | null
<= 128 characters
dryRun
required
boolean
available
required
boolean
reasonCode
required
string | null
Allowed values: capacity_profile_unavailable environment_d1_limit
capacityUnitsAdded
required
integer
d1DatabasesAdded
required
integer
projectedEnvironmentD1Count
required
integer
targets
required
Array<object>
object
unitKey
required
string
unitIndex
required
integer
>= 1
workerScripts
required
Array<string>
>= 1 items unique items
operationId
required
string
environmentId
required
string
dataRole
required
string
Allowed values: tenant_core/default tenant_core/users tenant_pii lookup
residencyPolicyId
required
string
residencyPartition
required
string
lookupCapacityDomainId
required

Explicit Lookup capacity-sharing boundary. Non-null only when dataRole is lookup.

string | null
<= 128 characters
logicalShardId
required
string
databaseName
required
string
bindingRef
required
string
readReplicationMode
required
string
Allowed values: enabled disabled
migrationStreamId
required
string
Allowed values: core-d1 pii-d1 lookup-d1
key
additional properties
key
additional properties
key
additional properties
Example 
{
  "preview": {
    "profile": "minimum",
    "scope": "shared_pool",
    "dryRun": true,
    "reasonCode": "capacity_profile_unavailable",
    "targets": [
      {
        "dataRole": "tenant_core/default",
        "readReplicationMode": "enabled",
        "migrationStreamId": "core-d1"
      }
    ]
  }
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

409

Section titled “409 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

503

Section titled “503 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}