Skip to main content

Retrieve all S3 buckets for all SVMs

Contributors
PDFs

GET /protocols/s3/buckets

Introduced In: 9.7

Retrieves all S3 buckets for all SVMs. Note that in order to retrieve S3 bucket policy conditions, the 'fields' option should be set to '**'.

  • vserver object-store-server bucket show

  • vserver object-store-server bucket policy statement show

  • vserver object-store-server bucket policy-statement-condition show

  • vserver object-store-server bucket lifecycle-management-rule show

Learn more

Parameters

Name Type In Required Description

uuid

string

query

False

Filter by uuid

comment

string

query

False

Filter by comment

  • maxLength: 256

  • minLength: 0

policy.statements.resources

string

query

False

Filter by policy.statements.resources

  • Introduced in: 9.8

policy.statements.conditions.operator

string

query

False

Filter by policy.statements.conditions.operator

  • Introduced in: 9.8

policy.statements.conditions.source_ips

string

query

False

Filter by policy.statements.conditions.source_ips

  • Introduced in: 9.8

policy.statements.conditions.delimiters

string

query

False

Filter by policy.statements.conditions.delimiters

  • Introduced in: 9.8

policy.statements.conditions.max_keys

integer

query

False

Filter by policy.statements.conditions.max_keys

  • Introduced in: 9.8

policy.statements.conditions.prefixes

string

query

False

Filter by policy.statements.conditions.prefixes

  • Introduced in: 9.8

policy.statements.conditions.usernames

string

query

False

Filter by policy.statements.conditions.usernames

  • Introduced in: 9.8

policy.statements.effect

string

query

False

Filter by policy.statements.effect

  • Introduced in: 9.8

policy.statements.principals

string

query

False

Filter by policy.statements.principals

  • Introduced in: 9.8

policy.statements.sid

string

query

False

Filter by policy.statements.sid

  • Introduced in: 9.8

  • maxLength: 256

  • minLength: 0

policy.statements.actions

string

query

False

Filter by policy.statements.actions

  • Introduced in: 9.8

lifecycle_management.rules.svm.uuid

string

query

False

Filter by lifecycle_management.rules.svm.uuid

  • Introduced in: 9.14

lifecycle_management.rules.svm.name

string

query

False

Filter by lifecycle_management.rules.svm.name

  • Introduced in: 9.14

lifecycle_management.rules.non_current_version_expiration.new_non_current_versions

integer

query

False

Filter by lifecycle_management.rules.non_current_version_expiration.new_non_current_versions

  • Introduced in: 9.13

lifecycle_management.rules.non_current_version_expiration.non_current_days

integer

query

False

Filter by lifecycle_management.rules.non_current_version_expiration.non_current_days

  • Introduced in: 9.13

lifecycle_management.rules.uuid

string

query

False

Filter by lifecycle_management.rules.uuid

  • Introduced in: 9.14

lifecycle_management.rules.bucket_name

string

query

False

Filter by lifecycle_management.rules.bucket_name

  • Introduced in: 9.14

  • maxLength: 63

  • minLength: 3

lifecycle_management.rules.enabled

boolean

query

False

Filter by lifecycle_management.rules.enabled

  • Introduced in: 9.13

lifecycle_management.rules.abort_incomplete_multipart_upload.after_initiation_days

integer

query

False

Filter by lifecycle_management.rules.abort_incomplete_multipart_upload.after_initiation_days

  • Introduced in: 9.13

lifecycle_management.rules.name

string

query

False

Filter by lifecycle_management.rules.name

  • Introduced in: 9.13

  • maxLength: 256

  • minLength: 0

lifecycle_management.rules.expiration.object_age_days

integer

query

False

Filter by lifecycle_management.rules.expiration.object_age_days

  • Introduced in: 9.13

lifecycle_management.rules.expiration.expired_object_delete_marker

boolean

query

False

Filter by lifecycle_management.rules.expiration.expired_object_delete_marker

  • Introduced in: 9.13

lifecycle_management.rules.expiration.object_expiry_date

string

query

False

Filter by lifecycle_management.rules.expiration.object_expiry_date

  • Introduced in: 9.13

lifecycle_management.rules.object_filter.size_greater_than

integer

query

False

Filter by lifecycle_management.rules.object_filter.size_greater_than

  • Introduced in: 9.13

lifecycle_management.rules.object_filter.prefix

string

query

False

Filter by lifecycle_management.rules.object_filter.prefix

  • Introduced in: 9.13

lifecycle_management.rules.object_filter.size_less_than

integer

query

False

Filter by lifecycle_management.rules.object_filter.size_less_than

  • Introduced in: 9.13

lifecycle_management.rules.object_filter.tags

string

query

False

Filter by lifecycle_management.rules.object_filter.tags

  • Introduced in: 9.13

qos_policy.uuid

string

query

False

Filter by qos_policy.uuid

  • Introduced in: 9.8

qos_policy.max_throughput_mbps

integer

query

False

Filter by qos_policy.max_throughput_mbps

  • Introduced in: 9.8

  • Max value: 4194303

  • Min value: 0

qos_policy.name

string

query

False

Filter by qos_policy.name

  • Introduced in: 9.8

qos_policy.min_throughput_iops

integer

query

False

Filter by qos_policy.min_throughput_iops

  • Introduced in: 9.8

  • Max value: 2147483647

  • Min value: 0

qos_policy.max_throughput_iops

integer

query

False

Filter by qos_policy.max_throughput_iops

  • Introduced in: 9.8

  • Max value: 2147483647

  • Min value: 0

qos_policy.min_throughput_mbps

integer

query

False

Filter by qos_policy.min_throughput_mbps

  • Introduced in: 9.8

  • Max value: 4194303

  • Min value: 0

role

string

query

False

Filter by role

  • Introduced in: 9.10

audit_event_selector.permission

string

query

False

Filter by audit_event_selector.permission

  • Introduced in: 9.10

audit_event_selector.access

string

query

False

Filter by audit_event_selector.access

  • Introduced in: 9.10

versioning_state

string

query

False

Filter by versioning_state

  • Introduced in: 9.11

volume.uuid

string

query

False

Filter by volume.uuid

volume.name

string

query

False

Filter by volume.name

size

integer

query

False

Filter by size

  • Max value: 62672162783232000

  • Min value: 199229440

type

string

query

False

Filter by type

  • Introduced in: 9.12

allowed

boolean

query

False

Filter by allowed

  • Introduced in: 9.12

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

encryption.enabled

boolean

query

False

Filter by encryption.enabled

retention.default_period

string

query

False

Filter by retention.default_period

  • Introduced in: 9.14

retention.mode

string

query

False

Filter by retention.mode

  • Introduced in: 9.14

name

string

query

False

Filter by name

  • maxLength: 63

  • minLength: 3

protection_status.is_protected

boolean

query

False

Filter by protection_status.is_protected

  • Introduced in: 9.10

protection_status.destination.is_ontap

boolean

query

False

Filter by protection_status.destination.is_ontap

  • Introduced in: 9.10

protection_status.destination.is_external_cloud

boolean

query

False

Filter by protection_status.destination.is_external_cloud

  • Introduced in: 9.12

protection_status.destination.is_cloud

boolean

query

False

Filter by protection_status.destination.is_cloud

  • Introduced in: 9.10

nas_path

string

query

False

Filter by nas_path

  • Introduced in: 9.12

logical_used_size

integer

query

False

Filter by logical_used_size

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Max value: 120

  • Min value: 0

  • Default value: 1

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

collection_links

num_records

integer

Number of records

records

array[s3_bucket]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "aggregates": [
        {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "name": "aggr1",
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        }
      ],
      "audit_event_selector": {
        "access": "string",
        "permission": "string"
      },
      "comment": "S3 bucket.",
      "constituents_per_aggregate": 4,
      "lifecycle_management": {
        "rules": [
          {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "abort_incomplete_multipart_upload": {
              "_links": {
                "self": {
                  "href": "/api/resourcelink"
                }
              }
            },
            "bucket_name": "bucket1",
            "expiration": {
              "_links": {
                "self": {
                  "href": "/api/resourcelink"
                }
              },
              "object_age_days": 100,
              "object_expiry_date": "2039-09-22 20:00:00 -0400"
            },
            "name": "string",
            "non_current_version_expiration": {
              "_links": {
                "self": {
                  "href": "/api/resourcelink"
                }
              }
            },
            "object_filter": {
              "_links": {
                "self": {
                  "href": "/api/resourcelink"
                }
              },
              "prefix": "/logs",
              "size_greater_than": 10240,
              "size_less_than": 10485760,
              "tags": [
                "project1=projA",
                "project2=projB"
              ]
            },
            "svm": {
              "_links": {
                "self": {
                  "href": "/api/resourcelink"
                }
              },
              "name": "svm1",
              "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
            },
            "uuid": "414b29a1-3b26-11e9-bd58-0050568ea055"
          }
        ]
      },
      "logical_used_size": 0,
      "name": "bucket1",
      "nas_path": "/",
      "policy": {
        "statements": [
          {
            "actions": [
              "GetObject",
              "PutObject",
              "DeleteObject",
              "ListBucket"
            ],
            "conditions": [
              {
                "delimiters": [
                  "/"
                ],
                "max_keys": [
                  1000
                ],
                "operator": "ip_address",
                "prefixes": [
                  "pref"
                ],
                "source_ips": [
                  "1.1.1.1",
                  "1.2.2.0/24"
                ],
                "usernames": [
                  "user1"
                ]
              }
            ],
            "effect": "allow",
            "principals": [
              "user1",
              "group/grp1",
              "nasgroup/group1"
            ],
            "resources": [
              "bucket1",
              "bucket1/*"
            ],
            "sid": "FullAccessToUser1"
          }
        ]
      },
      "qos_policy": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "max_throughput_iops": 10000,
        "max_throughput_mbps": 500,
        "min_throughput_iops": 2000,
        "min_throughput_mbps": 500,
        "name": "performance",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "retention": {
        "default_period": "P10Y",
        "mode": "governance"
      },
      "role": "string",
      "size": 1677721600,
      "storage_service_level": "value",
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "type": "s3",
      "uuid": "414b29a1-3b26-11e9-bd58-0050568ea055",
      "versioning_state": "enabled",
      "volume": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "volume1",
        "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
      }
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string