clusters
Creates, updates, deletes, gets or lists a clusters resource.
Overview
| Name | clusters |
| Type | Resource |
| Id | linode.object_storage.clusters |
Fields
The following fields are returned by SELECT queries:
- get
- list
The requested Cluster.
| Name | Datatype | Description |
|---|---|---|
id | string | The unique ID for this cluster. (example: us-east-1) |
domain | string | The base URL for this cluster, used for connecting with third-party clients. (example: us-east-1.linodeobjects.com) |
region | string | The region where this cluster is located. (example: us-east) |
static_site_domain | string | The base URL for this cluster used when hosting static sites. (example: website-us-east-1.linodeobjects.com) |
status | string | This cluster's status. (available, unavailable) (example: available) |
A paginated list of available clusters.
| Name | Datatype | Description |
|---|---|---|
id | string | The unique ID for this cluster. (example: us-east-1) |
domain | string | The base URL for this cluster, used for connecting with third-party clients. (example: us-east-1.linodeobjects.com) |
region | string | The region where this cluster is located. (example: us-east) |
static_site_domain | string | The base URL for this cluster used when hosting static sites. (example: website-us-east-1.linodeobjects.com) |
status | string | This cluster's status. (available, unavailable) (example: available) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | clusterId | Deprecated Returns a single Object Storage cluster. > 📘 > > This displays deprecated clusterId values that represent regions used with older versions of the API. It's maintained for backward compatibility. Run Get a region instead.Learn more... | |
list | select | Deprecated Returns a paginated list of available Object Storage legacy clusters. > 📘 > > This displays deprecated clusterId values that represent regions used with older versions of the API. It's maintained for backward compatibility. Run Get a region instead.Learn more... |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
clusterId | string | Identifies a cluster where this bucket lives. For backward compatibility with Object Storage in this API. > 📘 > > You can use the applicable regionId, for example us-west, in place of the clusterId, for example, us-west-1. Run List regions to see all regions. |
SELECT examples
- get
- list
Deprecated Returns a single Object Storage cluster.
> 📘
>
> This displays deprecated clusterId values that represent regions used with older versions of the API. It's maintained for backward compatibility. Run Get a region instead.
Learn more...
SELECT
id,
domain,
region,
static_site_domain,
status
FROM linode.object_storage.clusters
WHERE clusterId = '{{ clusterId }}' -- required
;
Deprecated Returns a paginated list of available Object Storage legacy clusters.
> 📘
>
> This displays deprecated clusterId values that represent regions used with older versions of the API. It's maintained for backward compatibility. Run Get a region instead.
Learn more...
SELECT
id,
domain,
region,
static_site_domain,
status
FROM linode.object_storage.clusters
;