Endpoint

/v2/portal/spokes/

GET

List the relationship status and configuration for all spoke portals on the current cluster.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "v2_portal_spokes",
  "type": "object",
  "properties": {
    "entries": {
      "type": "array",
      "items": {
        "description": "List of spoke portals",
        "type": "object",
        "properties": {
          "id": {
            "description": "Spoke portal ID",
            "type": "number"
          },
          "type": {
            "type": "string",
            "enum": [
              "PORTAL_READ_ONLY",
              "PORTAL_READ_WRITE",
              "PORTAL_PAUSED",
              "PORTAL_SUSPENDED"
            ],
            "description": "Type of the spoke portal (read-only or read-write):\n * `PORTAL_PAUSED` - PORTAL_PAUSED,\n * `PORTAL_READ_ONLY` - PORTAL_READ_ONLY,\n * `PORTAL_READ_WRITE` - PORTAL_READ_WRITE,\n * `PORTAL_SUSPENDED` - PORTAL_SUSPENDED"
          },
          "state": {
            "type": "string",
            "enum": [
              "PENDING",
              "ACCEPTED",
              "QUIESCING",
              "PAUSING",
              "DELETING"
            ],
            "description": "State of the spoke portal:\n * `ACCEPTED` - A portal that is in an active relationship.,\n * `DELETING` - A portal in the process of synchronizing outstanding changes before deletion.,\n * `PAUSING` - A portal closing spoke client state and synchronizing outstanding changes before it becomes paused.,\n * `PENDING` - A portal not yet in an active relationship.,\n * `QUIESCING` - A portal synchronizing outstanding changes before it becomes read-only."
          },
          "status": {
            "type": "string",
            "enum": [
              "INACTIVE",
              "ACTIVE",
              "DEGRADED",
              "DISCONNECTED"
            ],
            "description": "Status of the portal:\n * `ACTIVE` - A fully connected portal ready for use.,\n * `DEGRADED` - A portal whose quorum is missing a cluster other than this relationship's peer.,\n * `DISCONNECTED` - A portal whose quorum is missing this relationship's own peer.,\n * `INACTIVE` - A portal that is not ready for use."
          },
          "hub_hosts": {
            "type": "array",
            "items": {
              "description": "IP addresses and TCP ports of nodes in the remote cluster",
              "type": "object",
              "properties": {
                "address": {
                  "description": "address",
                  "type": "string"
                },
                "port": {
                  "description": "port",
                  "type": "number"
                }
              }
            }
          },
          "hub_id": {
            "description": "Corresponding remote hub portal ID",
            "type": "number"
          },
          "hub_cluster_uuid": {
            "description": "UUID of the cluster with the hub portal",
            "type": "string"
          },
          "hub_cluster_name": {
            "description": "Name of the cluster with the hub portal",
            "type": "string"
          },
          "filesystem_uuid": {
            "description": "UUID of the filesystem caching data from the hub portal",
            "type": "string"
          },
          "roots": {
            "type": "array",
            "items": {
              "description": "Map of spoke root directories to hub root directories",
              "type": "object",
              "properties": {
                "local_root": {
                  "description": "Local spoke root directory file ID",
                  "type": "string"
                },
                "remote_root": {
                  "description": "Remote hub root directory file ID",
                  "type": "string"
                },
                "authorized": {
                  "description": "Whether the spoke portal is authorized to access the remote root",
                  "type": "boolean"
                }
              }
            }
          }
        }
      }
    }
  }
}

POST

Create a spoke portal in the current cluster and propose a relationship between this spoke portal and a hub portal on another cluster.

Parameters

This resource has no parameters.

Request

Schema

{
  "description": "v2_portal_create_request",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "PORTAL_READ_ONLY",
        "PORTAL_READ_WRITE",
        "PORTAL_PAUSED",
        "PORTAL_SUSPENDED"
      ],
      "description": "Whether to create a read-only or read-write spoke portal:\n * `PORTAL_PAUSED` - PORTAL_PAUSED,\n * `PORTAL_READ_ONLY` - PORTAL_READ_ONLY,\n * `PORTAL_READ_WRITE` - PORTAL_READ_WRITE,\n * `PORTAL_SUSPENDED` - PORTAL_SUSPENDED"
    },
    "hub_hosts": {
      "type": "array",
      "items": {
        "description": "IP addresses and TCP ports of nodes in the remote cluster",
        "type": "object",
        "properties": {
          "address": {
            "description": "address",
            "type": "string"
          },
          "port": {
            "description": "port",
            "type": "number"
          }
        }
      }
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "v2_portal_spoke",
  "type": "object",
  "properties": {
    "id": {
      "description": "Spoke portal ID",
      "type": "number"
    },
    "type": {
      "type": "string",
      "enum": [
        "PORTAL_READ_ONLY",
        "PORTAL_READ_WRITE",
        "PORTAL_PAUSED",
        "PORTAL_SUSPENDED"
      ],
      "description": "Type of the spoke portal (read-only or read-write):\n * `PORTAL_PAUSED` - PORTAL_PAUSED,\n * `PORTAL_READ_ONLY` - PORTAL_READ_ONLY,\n * `PORTAL_READ_WRITE` - PORTAL_READ_WRITE,\n * `PORTAL_SUSPENDED` - PORTAL_SUSPENDED"
    },
    "state": {
      "type": "string",
      "enum": [
        "PENDING",
        "ACCEPTED",
        "QUIESCING",
        "PAUSING",
        "DELETING"
      ],
      "description": "State of the spoke portal:\n * `ACCEPTED` - A portal that is in an active relationship.,\n * `DELETING` - A portal in the process of synchronizing outstanding changes before deletion.,\n * `PAUSING` - A portal closing spoke client state and synchronizing outstanding changes before it becomes paused.,\n * `PENDING` - A portal not yet in an active relationship.,\n * `QUIESCING` - A portal synchronizing outstanding changes before it becomes read-only."
    },
    "status": {
      "type": "string",
      "enum": [
        "INACTIVE",
        "ACTIVE",
        "DEGRADED",
        "DISCONNECTED"
      ],
      "description": "Status of the portal:\n * `ACTIVE` - A fully connected portal ready for use.,\n * `DEGRADED` - A portal whose quorum is missing a cluster other than this relationship's peer.,\n * `DISCONNECTED` - A portal whose quorum is missing this relationship's own peer.,\n * `INACTIVE` - A portal that is not ready for use."
    },
    "hub_hosts": {
      "type": "array",
      "items": {
        "description": "IP addresses and TCP ports of nodes in the remote cluster",
        "type": "object",
        "properties": {
          "address": {
            "description": "address",
            "type": "string"
          },
          "port": {
            "description": "port",
            "type": "number"
          }
        }
      }
    },
    "hub_id": {
      "description": "Corresponding remote hub portal ID",
      "type": "number"
    },
    "hub_cluster_uuid": {
      "description": "UUID of the cluster with the hub portal",
      "type": "string"
    },
    "hub_cluster_name": {
      "description": "Name of the cluster with the hub portal",
      "type": "string"
    },
    "filesystem_uuid": {
      "description": "UUID of the filesystem caching data from the hub portal",
      "type": "string"
    },
    "roots": {
      "type": "array",
      "items": {
        "description": "Map of spoke root directories to hub root directories",
        "type": "object",
        "properties": {
          "local_root": {
            "description": "Local spoke root directory file ID",
            "type": "string"
          },
          "remote_root": {
            "description": "Remote hub root directory file ID",
            "type": "string"
          },
          "authorized": {
            "description": "Whether the spoke portal is authorized to access the remote root",
            "type": "boolean"
          }
        }
      }
    }
  }
}