Retrieve the mount task status Run in API Explorer

GET /v1/cloud-storage/mount-tasks

This operation retrieves the status of a task responsible for mounting or unmounting topics. It provides details on the task’s type (mount or unmount), its current state, and the topics involved.

Responses

  • 200 application/json

    OK

    Hide response attribute Show response attribute object
    • tasks array[object]
      Hide tasks attributes Show tasks attributes object
      • id integer(int32)

        Unique identifier for this mount task.

      • state string
        • STATE_PLANNED: Planned: The mount task has been created and is awaiting further actions.
        • STATE_PREPARING: Preparing: The mount task is gathering resources and preparing for execution.
        • STATE_PREPARED: Prepared: All preparations are complete, and the mount task is ready to be executed.
        • STATE_EXECUTING: Executing: The mount task is actively transferring or transforming data.
        • STATE_EXECUTED: Executed: The core mount task actions are complete, but the mount task has not yet cut over or finalized.
        • STATE_CUT_OVER: Cut Over: The mount task has reached a critical point where ownership is transferred or final adjustments are made.
        • STATE_FINISHED: Finished: The mount task has been successfully completed, and no further actions are required.
        • STATE_CANCELING: Canceling: The mount task is in the process of being canceled, and rollback or cleanup actions may be in progress.
        • STATE_CANCELLED: Cancelled: The mount task has been fully canceled, and no further actions will be taken.

        Values are STATE_PLANNED, STATE_PREPARING, STATE_PREPARED, STATE_EXECUTING, STATE_EXECUTED, STATE_CUT_OVER, STATE_FINISHED, STATE_CANCELING, or STATE_CANCELLED.

      • topics array[object]

        List of topics that are being mounted or unmounted.

        Hide topics attributes Show topics attributes object
        • source_topic_reference string

          The topic reference in the object storage bucket. This field is only set for tasks of type MOUNT.

        • topic_reference string

          The topic reference within the current cluster, which may be either a simple topic name or a full reference in the form: cluster-uuid/topic-name/revision.

      • type string
        • TYPE_MOUNT: Mount represents the process of making topics available in a cluster by loading them from object storage.
        • TYPE_UNMOUNT: Unmount represents the process of offloading topics back to object storage.

        Values are TYPE_MOUNT or TYPE_UNMOUNT.

  • 401 application/json

    Unauthenticated.

    Hide response attributes Show response attributes object
    • code string(int32)

      RPC status code, as described here.

      Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.

    • details array[object]

      A list of messages that carries the error details.

      Details of the error.

      Details of the error.

      One of:
    • message string

      Detailed error message. No compatibility guarantees are given for the text contained in this message.

  • 404 application/json

    Not Found

    Hide response attributes Show response attributes object
    • code string(int32)

      RPC status code, as described here.

      Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.

    • details array[object]

      A list of messages that carries the error details.

      Details of the error.

      Details of the error.

      One of:
    • message string

      Detailed error message. No compatibility guarantees are given for the text contained in this message.

  • 500 application/json

    Internal Server Error. Reach out to support.

    Hide response attributes Show response attributes object
    • code string(int32)

      RPC status code, as described here.

      Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.

    • details array[object]

      A list of messages that carries the error details.

      Details of the error.

      Details of the error.

      One of:
    • message string

      Detailed error message. No compatibility guarantees are given for the text contained in this message.

  • default application/json

    An unexpected error response.

    Hide response attributes Show response attributes object
    • code string(int32)

      RPC status code, as described here.

      Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.

    • details array[object]

      A list of messages that carries the error details.

      Details of the error.

      Details of the error.

      One of:
    • message string

      Detailed error message. No compatibility guarantees are given for the text contained in this message.

GET /v1/cloud-storage/mount-tasks
curl \
 --request GET 'https://{dataplane_api_subdomain}.cloud.redpanda.com/v1/cloud-storage/mount-tasks' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "tasks": [
    {
      "id": 42,
      "state": "STATE_PLANNED",
      "topics": [
        {
          "source_topic_reference": "string",
          "topic_reference": "string"
        }
      ],
      "type": "TYPE_MOUNT"
    }
  ]
}
Response examples (401)
{
  "code": "OK",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.BadRequest",
      "field_violations": [
        {
          "description": "string",
          "field": "string"
        }
      ]
    }
  ],
  "message": "string"
}
Response examples (404)
{
  "code": "OK",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.BadRequest",
      "field_violations": [
        {
          "description": "string",
          "field": "string"
        }
      ]
    }
  ],
  "message": "string"
}
Response examples (500)
{
  "code": "OK",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.BadRequest",
      "field_violations": [
        {
          "description": "string",
          "field": "string"
        }
      ]
    }
  ],
  "message": "string"
}
Response examples (default)
{
  "code": "OK",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.BadRequest",
      "field_violations": [
        {
          "description": "string",
          "field": "string"
        }
      ]
    }
  ],
  "message": "string"
}