コンテンツにスキップ
Authrim

Read backup operation progress

GET
/api/admin/tenant-backups/{operationId}
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/tenant-backups/example \
  --header 'Authorization: Bearer <token>'

Requires admin:backups:read. The authenticated tenant determines the operation scope. Internal cursors, keys and lease data are omitted. Responses are not cacheable.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
operationId
required
string
/^[A-Za-z0-9_.:-]{1,256}$/

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Read backup operation progress

Media type application/json
object
id
required
string
kind
required
string
Allowed values: export import
state
required
string
Allowed values: queued running waiting ready completed failed cancelling cancelled
phase
required
string
revision
required
integer
createdAt
required
integer
updatedAt
required
integer
lastErrorCode
required
string
nullable
failureReason
string
nullable
selection
required
object
publication
required
object
expiresAt
required
integer
downloadAvailable
required
boolean
key
additional properties
adminMapping
required

Mapping status for a restore that includes Admin data. The digest is exposed only after the mapping is frozen.

object
revision
required
integer
state
required
string
Allowed values: open frozen
sourceCount
required
integer
mappedCount
required
integer
complete
required
boolean
digest
required
string
nullable /^[a-f0-9]{64}$/
key
additional properties
discard
required

Import cleanup that discards the restored tenant: whether it does, and while it is stopped, why (for example the legal holds that keep it from deleting anything).

object
decision
required
string
nullable
Allowed values: none discard
blocker
required
object
kind
required
string
Allowed values: legal_hold blocked_rows schema_changed
detail
required
object
key
additional properties
key
additional properties
progress
required
object
registered
required
integer
materialized
required
integer
nonEmpty
required
integer
executionBatches
required
integer
bytes
required
integer
rows
required
integer
key
additional properties
preview
required

Secret-free sealed restore summary. Present only while explicit restore approval is required.

object
key
additional properties
Example 
{
  "kind": "export",
  "state": "queued",
  "adminMapping": {
    "state": "open"
  },
  "discard": {
    "decision": "none",
    "blocker": {
      "kind": "legal_hold"
    }
  }
}

400

Section titled “400 ”

The request was rejected. No key material is returned.

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

403

Section titled “403 ”

The request was rejected. No key material is returned.

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

404

Section titled “404 ”

The request was rejected. No key material is returned.

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

409

Section titled “409 ”

The request was rejected. No key material is returned.

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

503

Section titled “503 ”

The request was rejected. No key material is returned.

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