List a page of Docker Availability operations

GET

/api/docker/availability/{id}/operations/page

curl --request GET \
  --url 'https://gateway.example.com/api/docker/availability/550e8400-e29b-41d4-a716-446655440000/operations/page?page=1&limit=50' \
  --header 'Authorization: Bearer <token>'

• Your Gateway instance

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Example

550e8400-e29b-41d4-a716-446655440000

Query Parameters

page

integer

default: 1 >= 1

limit

integer

default: 50 >= 1 <= 100

Responses

200

Paginated Docker Availability operation history

Media typeapplication/json

object

data

required

Array<object>

object

id

required

string format: uuid

policyId

required

string format: uuid

type

required

string

Allowed values: enable scale rollout heal disable stale_cleanup failback

status

required

string

Allowed values: pending running waiting completed failed cleanup_pending cancelled

phase

required

string

Allowed values: queued locking validating selecting_nodes preparing_images preparing_dependencies starting checking_health activating_routes draining stopping cleaning_up finalizing done

targetGeneration

required

integer

>= 1

idempotencyKey

required

string

requestedPolicy

required

object

key

additional properties

progress

required

object

message

string

completedPlacementIds

Array<string>

activePlacementId

string format: uuid

totalPlacements

integer

completedPlacements

integer

leaseOwner

required

string | null

leaseHeartbeatAt

required

string | null

leaseExpiresAt

required

string | null

retryOfOperationId

required

string | null format: uuid

retryAttempts

required

integer

nextAttemptAt

required

string | null

errorCode

required

string | null

errorMessage

required

string | null

createdById

required

string | null format: uuid

createdAt

required

string | null

startedAt

required

string | null

updatedAt

required

string | null

completedAt

required

string | null

nextPage

required

integer | null

Example

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Example resource",
      "createdAt": "2024-01-01T12:00:00.000Z",
      "updatedAt": "2024-01-01T12:30:00.000Z"
    }
  ]
}

400

Bad request

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "details": [
    {
      "path": [
        "name"
      ],
      "message": "Required"
    }
  ]
}

401

Authentication required

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNAUTHORIZED",
  "message": "Authentication required"
}

403

Forbidden

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "FORBIDDEN",
  "message": "Insufficient permissions"
}

404

Not found

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "NOT_FOUND",
  "message": "Resource not found"
}

409

Conflict

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "CONFLICT",
  "message": "Resource already exists"
}

422

Unprocessable entity

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNPROCESSABLE_ENTITY",
  "message": "Request could not be processed"
}

500

Internal server error

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error"
}