Skip to content

Latest commit

 

History

History
72 lines (57 loc) · 3.94 KB

object_storage_quota_list.md

File metadata and controls

72 lines (57 loc) · 3.94 KB

object_storage_quota_list

List and filter on Object Storage Quotas.

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 Object Storage Quotas for the current account
  linode.cloud.object_storage_quotas:
    filters:
      - name: s3_endpoint
        values:
          - es-mad-1.linodeobjects.com

Parameters

Field Type Required Description
order str Optional The order to list Object Storage Quotas in. (Choices: desc, asc; Default: asc)
order_by str Optional The attribute to order Object Storage Quotas by.
filters (sub-options) list Optional A list of filters to apply to the resulting Object Storage Quotas.
count int Optional The number of Object Storage Quotas 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 fields can be found here.
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

  • object_storage_quotas - The returned Object Storage Quotas.

    • Sample Response: 
      [
        {
            "description": "Maximum number of buckets this customer is allowed to have on this endpoint",
            "endpoint_type": "E1",
            "quota_id": "obj-buckets-es-mad-1.linodeobjects.com",
            "quota_limit": 1000,
            "quota_name": "Number of Buckets",
            "resource_metric": "bucket",
            "s3_endpoint": "es-mad-1.linodeobjects.com"
        },
        {
            "description": "Maximum number of bytes this customer is allowed to have on this endpoint",
            "endpoint_type": "E1",
            "quota_id": "obj-bytes-es-mad-1.linodeobjects.com",
            "quota_limit": 109951162777600,
            "quota_name": "Total Capacity",
            "resource_metric": "byte",
            "s3_endpoint": "es-mad-1.linodeobjects.com"
        }
]
    • See the Linode API response documentation for a list of returned fields