Skip to main content

Retrieve the S3 server configuration for all SVMs

Contributors
PDFs

GET /protocols/s3/services

Introduced In: 9.7

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

Expensive properties

There is an added computational cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the fields query parameter. See Requesting specific fields to learn more.

  • statistics.*

  • metric.*

  • vserver object-store-server show

Learn more

Parameters

Name Type In Required Description

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

is_http_enabled

boolean

query

False

Filter by is_http_enabled

  • Introduced in: 9.8

metric.duration

string

query

False

Filter by metric.duration

  • Introduced in: 9.8

metric.throughput.total

integer

query

False

Filter by metric.throughput.total

  • Introduced in: 9.8

metric.throughput.write

integer

query

False

Filter by metric.throughput.write

  • Introduced in: 9.8

metric.throughput.read

integer

query

False

Filter by metric.throughput.read

  • Introduced in: 9.8

metric.status

string

query

False

Filter by metric.status

  • Introduced in: 9.8

metric.iops.write

integer

query

False

Filter by metric.iops.write

  • Introduced in: 9.8

metric.iops.read

integer

query

False

Filter by metric.iops.read

  • Introduced in: 9.8

metric.iops.other

integer

query

False

Filter by metric.iops.other

  • Introduced in: 9.8

metric.iops.total

integer

query

False

Filter by metric.iops.total

  • Introduced in: 9.8

metric.timestamp

string

query

False

Filter by metric.timestamp

  • Introduced in: 9.8

metric.latency.write

integer

query

False

Filter by metric.latency.write

  • Introduced in: 9.8

metric.latency.read

integer

query

False

Filter by metric.latency.read

  • Introduced in: 9.8

metric.latency.other

integer

query

False

Filter by metric.latency.other

  • Introduced in: 9.8

metric.latency.total

integer

query

False

Filter by metric.latency.total

  • Introduced in: 9.8

port

integer

query

False

Filter by port

  • Introduced in: 9.8

  • Max value: 65535

  • Min value: 1

users.comment

string

query

False

Filter by users.comment

  • maxLength: 256

  • minLength: 0

users.key_expiry_time

string

query

False

Filter by users.key_expiry_time

  • Introduced in: 9.14

users.access_key

string

query

False

Filter by users.access_key

users.svm.uuid

string

query

False

Filter by users.svm.uuid

users.svm.name

string

query

False

Filter by users.svm.name

users.name

string

query

False

Filter by users.name

  • maxLength: 64

  • minLength: 1

users.key_time_to_live

string

query

False

Filter by users.key_time_to_live

  • Introduced in: 9.14

buckets.uuid

string

query

False

Filter by buckets.uuid

buckets.comment

string

query

False

Filter by buckets.comment

  • maxLength: 256

  • minLength: 0

buckets.policy.statements.resources

string

query

False

Filter by buckets.policy.statements.resources

  • Introduced in: 9.8

buckets.policy.statements.conditions.operator

string

query

False

Filter by buckets.policy.statements.conditions.operator

  • Introduced in: 9.8

buckets.policy.statements.conditions.source_ips

string

query

False

Filter by buckets.policy.statements.conditions.source_ips

  • Introduced in: 9.8

buckets.policy.statements.conditions.delimiters

string

query

False

Filter by buckets.policy.statements.conditions.delimiters

  • Introduced in: 9.8

buckets.policy.statements.conditions.max_keys

integer

query

False

Filter by buckets.policy.statements.conditions.max_keys

  • Introduced in: 9.8

buckets.policy.statements.conditions.prefixes

string

query

False

Filter by buckets.policy.statements.conditions.prefixes

  • Introduced in: 9.8

buckets.policy.statements.conditions.usernames

string

query

False

Filter by buckets.policy.statements.conditions.usernames

  • Introduced in: 9.8

buckets.policy.statements.effect

string

query

False

Filter by buckets.policy.statements.effect

  • Introduced in: 9.8

buckets.policy.statements.principals

string

query

False

Filter by buckets.policy.statements.principals

  • Introduced in: 9.8

buckets.policy.statements.sid

string

query

False

Filter by buckets.policy.statements.sid

  • Introduced in: 9.8

  • maxLength: 256

  • minLength: 0

buckets.policy.statements.actions

string

query

False

Filter by buckets.policy.statements.actions

  • Introduced in: 9.8

buckets.lifecycle_management.rules.svm.uuid

string

query

False

Filter by buckets.lifecycle_management.rules.svm.uuid

  • Introduced in: 9.14

buckets.lifecycle_management.rules.svm.name

string

query

False

Filter by buckets.lifecycle_management.rules.svm.name

  • Introduced in: 9.14

buckets.lifecycle_management.rules.non_current_version_expiration.new_non_current_versions

integer

query

False

Filter by buckets.lifecycle_management.rules.non_current_version_expiration.new_non_current_versions

  • Introduced in: 9.13

buckets.lifecycle_management.rules.non_current_version_expiration.non_current_days

integer

query

False

Filter by buckets.lifecycle_management.rules.non_current_version_expiration.non_current_days

  • Introduced in: 9.13

buckets.lifecycle_management.rules.uuid

string

query

False

Filter by buckets.lifecycle_management.rules.uuid

  • Introduced in: 9.14

buckets.lifecycle_management.rules.bucket_name

string

query

False

Filter by buckets.lifecycle_management.rules.bucket_name

  • Introduced in: 9.14

  • maxLength: 63

  • minLength: 3

buckets.lifecycle_management.rules.enabled

boolean

query

False

Filter by buckets.lifecycle_management.rules.enabled

  • Introduced in: 9.13

buckets.lifecycle_management.rules.abort_incomplete_multipart_upload.after_initiation_days

integer

query

False

Filter by buckets.lifecycle_management.rules.abort_incomplete_multipart_upload.after_initiation_days

  • Introduced in: 9.13

buckets.lifecycle_management.rules.name

string

query

False

Filter by buckets.lifecycle_management.rules.name

  • Introduced in: 9.13

  • maxLength: 256

  • minLength: 0

buckets.lifecycle_management.rules.expiration.object_age_days

integer

query

False

Filter by buckets.lifecycle_management.rules.expiration.object_age_days

  • Introduced in: 9.13

buckets.lifecycle_management.rules.expiration.expired_object_delete_marker

boolean

query

False

Filter by buckets.lifecycle_management.rules.expiration.expired_object_delete_marker

  • Introduced in: 9.13

buckets.lifecycle_management.rules.expiration.object_expiry_date

string

query

False

Filter by buckets.lifecycle_management.rules.expiration.object_expiry_date

  • Introduced in: 9.13

buckets.lifecycle_management.rules.object_filter.size_greater_than

integer

query

False

Filter by buckets.lifecycle_management.rules.object_filter.size_greater_than

  • Introduced in: 9.13

buckets.lifecycle_management.rules.object_filter.prefix

string

query

False

Filter by buckets.lifecycle_management.rules.object_filter.prefix

  • Introduced in: 9.13

buckets.lifecycle_management.rules.object_filter.size_less_than

integer

query

False

Filter by buckets.lifecycle_management.rules.object_filter.size_less_than

  • Introduced in: 9.13

buckets.lifecycle_management.rules.object_filter.tags

string

query

False

Filter by buckets.lifecycle_management.rules.object_filter.tags

  • Introduced in: 9.13

buckets.qos_policy.uuid

string

query

False

Filter by buckets.qos_policy.uuid

  • Introduced in: 9.8

buckets.qos_policy.max_throughput_mbps

integer

query

False

Filter by buckets.qos_policy.max_throughput_mbps

  • Introduced in: 9.8

  • Max value: 4194303

  • Min value: 0

buckets.qos_policy.name

string

query

False

Filter by buckets.qos_policy.name

  • Introduced in: 9.8

buckets.qos_policy.min_throughput_iops

integer

query

False

Filter by buckets.qos_policy.min_throughput_iops

  • Introduced in: 9.8

  • Max value: 2147483647

  • Min value: 0

buckets.qos_policy.max_throughput_iops

integer

query

False

Filter by buckets.qos_policy.max_throughput_iops

  • Introduced in: 9.8

  • Max value: 2147483647

  • Min value: 0

buckets.qos_policy.min_throughput_mbps

integer

query

False

Filter by buckets.qos_policy.min_throughput_mbps

  • Introduced in: 9.8

  • Max value: 4194303

  • Min value: 0

buckets.role

string

query

False

Filter by buckets.role

  • Introduced in: 9.10

buckets.audit_event_selector.permission

string

query

False

Filter by buckets.audit_event_selector.permission

  • Introduced in: 9.10

buckets.audit_event_selector.access

string

query

False

Filter by buckets.audit_event_selector.access

  • Introduced in: 9.10

buckets.versioning_state

string

query

False

Filter by buckets.versioning_state

  • Introduced in: 9.11

buckets.volume.uuid

string

query

False

Filter by buckets.volume.uuid

buckets.volume.name

string

query

False

Filter by buckets.volume.name

buckets.size

integer

query

False

Filter by buckets.size

  • Max value: 62672162783232000

  • Min value: 199229440

buckets.type

string

query

False

Filter by buckets.type

  • Introduced in: 9.12

buckets.allowed

boolean

query

False

Filter by buckets.allowed

  • Introduced in: 9.12

buckets.svm.uuid

string

query

False

Filter by buckets.svm.uuid

buckets.svm.name

string

query

False

Filter by buckets.svm.name

buckets.encryption.enabled

boolean

query

False

Filter by buckets.encryption.enabled