Skip to content

Latest commit

 

History

History
57 lines (43 loc) · 2.46 KB

object_cluster_info.md

File metadata and controls

57 lines (43 loc) · 2.46 KB

object_cluster_info

Get info about a Linode Object Storage Cluster.

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: Get info about clusters in us-east
  linode.cloud.object_cluster_info:
    region: us-east
- name: Get info about the cluster with id us-east-1
  linode.cloud.object_cluster_info:
    id: us-east-1

Parameters

Field Type Required Description
id str Optional The unique id given to the clusters.
region str Optional The region the clusters are in.
domain str Optional The domain of the clusters.
static_site_domain str Optional The static-site domain of the clusters.

Return Values

  • clusters - The Object Storage clusters in JSON serialized form.

    • 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