object_cluster_list.md

object_cluster_list

List and filter on Object Storage Clusters.

• Minimum Required Fields
• Examples
• Parameters
• Return Values

Minimum Required Fields

Field	Type	Required	Description
api_token	str	Required	The Linode account personal access token. It is necessary to run the module. It can be exposed by the environment variable LINODE_API_TOKEN instead. See details in Usage.

Examples

- name: List all of the object storage clusters for the current Linode Account
  linode.cloud.object_cluster_list: {}

- name: Resolve all object storage clusters for the current Linode Account
  linode.cloud.object_cluster_list:
    filters:
      - name: region
        values: us-east

Parameters

Field	Type	Required	Description
order	str	Optional	The order to list object storage clusters in. (Choices: desc, asc; Default: asc)
order_by	str	Optional	The attribute to order object storage clusters by.
filters (sub-options)	list	Optional	A list of filters to apply to the resulting object storage clusters.
count	int	Optional	The number of results to return. If undefined, all results will be returned.

filters

Field	Type	Required	Description
name	str	Required	The name of the field to filter on. Valid filterable attributes can be found here: https://www.linode.com/docs/api/object-storage/#clusters-list__responses
values	list	Required	A list of values to allow for this field. Fields will pass this filter if at least one of these values matches.

Return Values

• clusters - The returned object storage clusters.

  • Sample Response:

    [
      {
        "domain": "us-east-1.linodeobjects.com",
        "id": "us-east-1",
        "region": "us-east",
        "static_site_domain": "website-us-east-1.linodeobjects.com",
        "status": "available"
      }
    ]

  • See the Linode API response documentation for a list of returned fields