object-portal/bridges/ Preview

Endpoint

/v1/object-portal/bridges/

GET

Lists every bridge on the cluster with its configuration, in filesystem UUID order. A new bridge is listed as soon as it is created, shortly before it can be used. A cluster with no bridges returns an empty list. The list is not paged. Credentials are never returned.

Important
This preview REST API is under development. Its functionality or backwards compatibility can change without notice.

Parameters

This resource has no parameters.

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_object_bridges",
  "type": "object",
  "properties": {
    "entries": {
      "type": "array",
      "items": {
        "description": "Every bridge on the cluster, in filesystem id order.",
        "type": "object",
        "properties": {
          "filesystem_uuid": {
            "description": "The bridge's filesystem UUID.",
            "type": "string"
          },
          "mount_path": {
            "description": "Absolute path of the bridge's directory on the cluster, without a trailing slash.",
            "type": "string"
          },
          "bucket_uri": {
            "description": "Full URI of the bridge's bucket.",
            "type": "string"
          },
          "key_prefix": {
            "description": "The prefix of the object names the bridge covers. Absent when the bridge covers the whole bucket.",
            "type": "string"
          },
          "delimiter": {
            "description": "The character in object names that separates directories.",
            "type": "string"
          },
          "key_vault_hostname": {
            "description": "Azure Key Vault hostname the bridge fetches SAS tokens from. Absent unless the bucket is reached through a key vault.",
            "type": "string"
          },
          "notification_queue_url": {
            "description": "The SQS queue URL the cluster reads to learn of changes made in the bucket. Absent when the bridge has none.",
            "type": "string"
          },
          "protocol_access": {
            "type": "string",
            "enum": [
              "READ_WRITE_EXPORT",
              "READ_ONLY",
              "FROZEN"
            ],
            "description": "How clients can change files on the bridge, and whether it is a Frozen bridge; see the create request's field.:\n * `FROZEN` - BRIDGE_PROTOCOL_FROZEN,\n * `READ_ONLY` - BRIDGE_PROTOCOL_READ_ONLY,\n * `READ_WRITE_EXPORT` - BRIDGE_PROTOCOL_READ_WRITE_EXPORT"
          },
          "metadata_import": {
            "type": "string",
            "enum": [
              "OFF",
              "AUTO"
            ],
            "description": "Whether files take their metadata from what a file-copy tool stored on each object; see the create request's field.:\n * `AUTO` - BRIDGE_METADATA_IMPORT_AUTO,\n * `OFF` - BRIDGE_METADATA_IMPORT_OFF"
          },
          "allow_archived_metadata_changes": {
            "description": "Whether clients can change the metadata and named streams of a FROZEN bridge's file that is frozen, offline or restoring; see the create request's field. False on any other bridge.",
            "type": "boolean"
          }
        }
      }
    }
  }
}

POST

Creates a bridge filesystem rooted at the given external bucket prefix. Requires a license whose `object_bridges` level permits the requested mode or, on a Qumulo-managed Azure cluster, a `key_vault_hostname` naming the cluster's own key vault, an arrangement Qumulo operations sets up. Without either the call returns HTTP 404; a license that permits only READ_ONLY bridges refuses a READ_WRITE_EXPORT one with HTTP 403. A FROZEN bridge requires a Qumulo-managed Azure cluster and a `key_vault_hostname` naming the cluster's own key vault, and is refused with HTTP 400 otherwise. A bucket that holds one of the cluster's own object stores, or a Qumulo account's managed container reached through the cluster's vault, is refused with HTTP 409. A FROZEN bridge requires a container that holds no objects under its `key_prefix`, and is refused with HTTP 409 otherwise. A cluster that already holds `fs_bridge_max_count` bridges refuses the create with HTTP 409, and while the `fs_api_file_id_omit_fs_id` tunable is set every create is refused with HTTP 412. A READ_WRITE_EXPORT bridge over an AWS S3 bucket requires `notification_queue_url`, and the create is refused with HTTP 400 without it. `allow_archived_metadata_changes` on a bridge that is not FROZEN is refused with HTTP 400. On Azure, the create is refused with HTTP 400 when the storage account has no change feed, when the bridge's credentials can't read it, or when the cluster can't confirm it can read it. The bridge sends no credentials of its own, or SAS tokens when `key_vault_hostname` names a vault.