Region¶

Tip

Region is an internal name. In the UI and elsewhere, this is Availability Zone.

Location

Node

Region

List All Regions¶

GET /api/admin/locations/{location_id}/regions

Schema

regions: Array
- id: Integer
- name: String
- active: Boolean
- fill_to: Integer
- volume_backend: String - local or nfs
- nfs_remote_host: String - IP Address of NFS server when connecting from the node
- nfs_remote_path: String - path to nfs volume on remote server. the volume name will be appended to this, so dont add trailing slash.
- nfs_controller_ip: String - IP Address of NFS Server when connecting from the controller
- offline_window: Integer - In seconds, how long do we wait after the last heartbeat before consider this node offline?
- failure_count: Integer - How many times do we attempt to connect back to the node to verify it's really offline before migrating it's containers to other nodes
- loki_endpoint: String
- loki_retries: String
- loki_batch_size: String
- loki_client_id: Integer
- metric_client_id: Integer
- maintenance_summary: Object
  - nodes_total: Integer
  - nodes_in_maintenance: Integer
  - nodes_quiesced: Integer - in maintenance with no background work running
  - nodes_with_warnings: Integer - see maintenance_status.warnings on the node
  - nodes: Array - nodes in maintenance only
    - id: Integer
    - label: String
    - held_by: Array - controller, node, or both
    - since: DateTime | null
- pending_agent_syncs: Object - agent writes that failed and are queued to be re-sent once the node is back
  - pending: Integer
  - dead: Integer - gave up retrying
  - oldest_at: DateTime | null - first failure of the oldest pending one
- created_at: DateTime
- updated_at: DateTime

View Region¶

GET /api/admin/locations/{location_id}/regions/{id}

Schema

regions: Object
- id: Integer
- name: String
- active: Boolean
- fill_to: Integer
- volume_backend: String - local or nfs
- nfs_remote_host: String - IP Address of NFS server when connecting from the node
- nfs_remote_path: String - path to nfs volume on remote server. the volume name will be appended to this, so dont add trailing slash.
- nfs_controller_ip: String - IP Address of NFS Server when connecting from the controller
- offline_window: Integer - In seconds, how long do we wait after the last heartbeat before consider this node offline?
- failure_count: Integer - How many times do we attempt to connect back to the node to verify it's really offline before migrating it's containers to other nodes
- loki_endpoint: String
- loki_retries: String
- loki_batch_size: String
- loki_client_id: Integer
- metric_client_id: Integer
- maintenance_summary: Object
  - nodes_total: Integer
  - nodes_in_maintenance: Integer
  - nodes_quiesced: Integer - in maintenance with no background work running
  - nodes_with_warnings: Integer - see maintenance_status.warnings on the node
  - nodes: Array - nodes in maintenance only
    - id: Integer
    - label: String
    - held_by: Array - controller, node, or both
    - since: DateTime | null
- pending_agent_syncs: Object - agent writes that failed and are queued to be re-sent once the node is back
  - pending: Integer
  - dead: Integer - gave up retrying
  - oldest_at: DateTime | null - first failure of the oldest pending one
- created_at: DateTime
- updated_at: DateTime

Update Region¶

PATCH /api/admin/locations/{location_id}/regions/{id}

Warning

Note: You may not update the name of an existing region. In a future update we will make that change possible.

Schema

regions: Array
- active: Boolean
- fill_to: Integer
- volume_backend: String - local or nfs
- nfs_remote_host: String - IP Address of NFS server when connecting from the node
- nfs_remote_path: String - path to nfs volume on remote server. the volume name will be appended to this, so dont add trailing slash.
- nfs_controller_ip: String - IP Address of NFS Server when connecting from the controller
- offline_window: Integer - In seconds, how long do we wait after the last heartbeat before consider this node offline?
- failure_count: Integer - How many times do we attempt to connect back to the node to verify it's really offline before migrating it's containers to other nodes
- loki_endpoint: String
- loki_retries: String
- loki_batch_size: String
- loki_client_id: Integer
- metric_client_id: Integer

Create Region¶

POST /api/admin/locations/{location_id}/regions

Schema

regions: Object
- name: String
- active: Boolean
- fill_to: Integer
- volume_backend: String - local or nfs
- nfs_remote_host: String - IP Address of NFS server when connecting from the node
- nfs_remote_path: String - path to nfs volume on remote server. the volume name will be appended to this, so dont add trailing slash.
- nfs_controller_ip: String - IP Address of NFS Server when connecting from the controller
- offline_window: Integer - In seconds, how long do we wait after the last heartbeat before consider this node offline?
- failure_count: Integer - How many times do we attempt to connect back to the node to verify it's really offline before migrating it's containers to other nodes
- loki_endpoint: String
- loki_retries: String
- loki_batch_size: String
- loki_client_id: Integer
- metric_client_id: Integer

Delete Region¶

DELETE /api/admin/locations/{location_id}/regions/{id}