Endpoint

/v3/replication/object-relationships/status/

GET

List statuses for all existing object replication relationships.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "type": "array",
  "items": {
    "description": "api_object_relationship_status_v3",
    "type": "object",
    "properties": {
      "id": {
        "description": "Unique identifier of the replication relationship",
        "type": "string"
      },
      "direction": {
        "type": "string",
        "enum": [
          "COPY_TO_OBJECT",
          "COPY_FROM_OBJECT"
        ],
        "description": "The object relationship can either copy data to or from the object store:\n * `COPY_FROM_OBJECT` - COPY_FROM_OBJECT,\n * `COPY_TO_OBJECT` - COPY_TO_OBJECT"
      },
      "local_directory_id": {
        "description": "File ID of the qumulo directory",
        "type": "string"
      },
      "local_directory_path": {
        "description": "Path of the qumulo directory. Path is empty if directory no longer exists",
        "type": "string"
      },
      "object_store_address": {
        "description": "S3-compatible server address",
        "type": "string"
      },
      "port": {
        "description": "HTTPS port to use when communicating with the object store",
        "type": "number"
      },
      "ca_certificate": {
        "description": "Public certificate of the certificate authority to trust for connections to the object store, in PEM format. If empty, the built-in trusted public CAs are used.",
        "type": "string"
      },
      "bucket": {
        "description": "Bucket in the object store to use",
        "type": "string"
      },
      "bucket_style": {
        "type": "string",
        "enum": [
          "BUCKET_STYLE_PATH",
          "BUCKET_STYLE_VIRTUAL_HOSTED"
        ],
        "description": "Addressing style for requests to the bucket. BUCKET_STYLE_PATH indicates path-style addressing while BUCKET_STYLE_VIRTUAL_HOSTED indicates virtual hosted-style.:\n * `BUCKET_STYLE_PATH` - BUCKET_STYLE_PATH,\n * `BUCKET_STYLE_VIRTUAL_HOSTED` - BUCKET_STYLE_VIRTUAL_HOSTED"
      },
      "object_folder": {
        "description": "Folder in the object store bucket to use",
        "type": "string"
      },
      "region": {
        "description": "Region the bucket is located in",
        "type": "string"
      },
      "access_key_id": {
        "description": "Access key ID to use when communicating with the object store",
        "type": "string"
      },
      "state": {
        "type": "string",
        "enum": [
          "REPLICATION_NOT_RUNNING",
          "REPLICATION_RUNNING"
        ],
        "description": "Current state of the replication:\n * `REPLICATION_NOT_RUNNING` - REPLICATION_NOT_RUNNING,\n * `REPLICATION_RUNNING` - REPLICATION_RUNNING"
      },
      "last_job": {
        "description": "Details about last replication attempt. This may be null if replication has not finished",
        "type": "object",
        "properties": {
          "start_time": {
            "description": "The time that replication started, encoded as RFC 3339",
            "type": "string"
          },
          "end_time": {
            "description": "The time that replication ended, encoded as RFC 3339",
            "type": "string"
          },
          "error": {
            "description": "The error message of last replication job. This may be empty if replication succeeded",
            "type": "string"
          }
        }
      },
      "current_job": {
        "description": "Details about the current replication. This may be null if replication is not running",
        "type": "object",
        "properties": {
          "start_time": {
            "description": "The time that replication started, encoded as RFC 3339",
            "type": "string"
          },
          "estimated_end_time": {
            "description": "The estimated time that replication will complete, encoded as RFC3339. This may be null if estimate is being calculated",
            "type": "string"
          }
        }
      }
    }
  }
}