Skip to main content
A newer release of this product is available.

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

certificate.uuid

string

query

False

Filter by certificate.uuid

  • Introduced in: 9.8

certificate.name

string

query

False

Filter by certificate.name

  • Introduced in: 9.8

comment

string

query

False

Filter by comment

  • maxLength: 256

  • minLength: 0

default_unix_user

string

query

False

Filter by default_unix_user

  • Introduced in: 9.12

users.svm.uuid

string

query

False

Filter by users.svm.uuid

users.svm.name

string

query

False

Filter by users.svm.name

users.access_key

string

query

False

Filter by users.access_key

users.name

string

query

False

Filter by users.name

  • maxLength: 64

  • minLength: 1

users.comment

string

query

False

Filter by users.comment

  • maxLength: 256

  • minLength: 0

statistics.latency_raw.read

integer

query

False

Filter by statistics.latency_raw.read

  • Introduced in: 9.8

statistics.latency_raw.other

integer

query

False

Filter by statistics.latency_raw.other

  • Introduced in: 9.8

statistics.latency_raw.write

integer

query

False

Filter by statistics.latency_raw.write

  • Introduced in: 9.8

statistics.latency_raw.total

integer

query

False

Filter by statistics.latency_raw.total

  • Introduced in: 9.8

statistics.iops_raw.read

integer

query

False

Filter by statistics.iops_raw.read

  • Introduced in: 9.8

statistics.iops_raw.other

integer

query

False

Filter by statistics.iops_raw.other

  • Introduced in: 9.8

statistics.iops_raw.write

integer

query

False

Filter by statistics.iops_raw.write

  • Introduced in: 9.8

statistics.iops_raw.total

integer

query

False

Filter by statistics.iops_raw.total

  • Introduced in: 9.8

statistics.status

string

query

False

Filter by statistics.status

  • Introduced in: 9.8

statistics.timestamp

string

query

False

Filter by statistics.timestamp

  • Introduced in: 9.8

statistics.throughput_raw.total

integer

query

False

Filter by statistics.throughput_raw.total

  • Introduced in: 9.8

statistics.throughput_raw.write

integer

query

False

Filter by statistics.throughput_raw.write

  • Introduced in: 9.8

statistics.throughput_raw.read

integer

query

False

Filter by statistics.throughput_raw.read

  • Introduced in: 9.8

buckets.qos_policy.name

string

query

False

Filter by buckets.qos_policy.name

  • Introduced in: 9.8

buckets.qos_policy.min_throughput_mbps

integer

query

False

Filter by buckets.qos_policy.min_throughput_mbps

  • 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

buckets.qos_policy.max_throughput_mbps

integer

query

False

Filter by buckets.qos_policy.max_throughput_mbps

  • Introduced in: 9.8

buckets.qos_policy.uuid

string

query

False

Filter by buckets.qos_policy.uuid

  • Introduced in: 9.8

buckets.qos_policy.max_throughput_iops

integer

query

False

Filter by buckets.qos_policy.max_throughput_iops

  • Introduced in: 9.8

buckets.nas_path

string

query

False

Filter by buckets.nas_path

  • Introduced in: 9.12

buckets.uuid

string

query

False

Filter by buckets.uuid

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_age_days

integer

query

False

Filter by buckets.lifecycle_management.rules.expiration.object_age_days

  • 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_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.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.name

string

query

False

Filter by buckets.lifecycle_management.rules.name

  • 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.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.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.enabled

boolean

query

False

Filter by buckets.lifecycle_management.rules.enabled

  • Introduced in: 9.13

buckets.role

string

query

False

Filter by buckets.role

  • Introduced in: 9.10

buckets.name

string

query

False

Filter by buckets.name

  • maxLength: 63

  • minLength: 3

buckets.policy.statements.sid

string

query

False

Filter by buckets.policy.statements.sid

  • Introduced in: 9.8

buckets.policy.statements.principals

string

query

False

Filter by buckets.policy.statements.principals

  • 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.conditions.max_keys

integer

query

False

Filter by buckets.policy.statements.conditions.max_keys

  • 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.prefixes

string

query

False

Filter by buckets.policy.statements.conditions.prefixes

  • 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.operator

string

query

False

Filter by buckets.policy.statements.conditions.operator

  • Introduced in: 9.8

buckets.policy.statements.effect

string

query

False

Filter by buckets.policy.statements.effect

  • Introduced in: 9.8

buckets.policy.statements.actions

string

query

False

Filter by buckets.policy.statements.actions

  • Introduced in: 9.8

buckets.policy.statements.resources

string

query

False

Filter by buckets.policy.statements.resources

  • Introduced in: 9.8

buckets.type

string

query

False

Filter by buckets.type

  • Introduced in: 9.12

buckets.volume.uuid

string

query

False

Filter by buckets.volume.uuid

buckets.volume.name

string

query

False

Filter by buckets.volume.name

buckets.comment

string

query

False

Filter by buckets.comment

  • maxLength: 256

  • minLength: 0

buckets.versioning_state

string

query

False

Filter by buckets.versioning_state

  • Introduced in: 9.11

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.protection_status.destination.is_ontap

boolean

query

False

Filter by buckets.protection_status.destination.is_ontap

  • Introduced in: 9.10

buckets.protection_status.destination.is_external_cloud

boolean

query

False

Filter by buckets.protection_status.destination.is_external_cloud

  • Introduced in: 9.12

buckets.protection_status.destination.is_cloud

boolean

query

False

Filter by buckets.protection_status.destination.is_cloud

  • Introduced in: 9.10

buckets.protection_status.is_protected

boolean

query

False

Filter by buckets.protection_status.is_protected

  • Introduced in: 9.10

buckets.encryption.enabled

boolean

query

False

Filter by buckets.encryption.enabled

buckets.svm.uuid

string

query

False

Filter by buckets.svm.uuid

buckets.svm.name

string

query

False

Filter by buckets.svm.name

buckets.logical_used_size

integer

query

False

Filter by buckets.logical_used_size

buckets.size

integer

query

False

Filter by buckets.size

  • Max value: 70368744177664

  • Min value: 83886080

buckets.allowed

boolean

query

False

Filter by buckets.allowed

  • Introduced in: 9.12

is_http_enabled

boolean

query

False

Filter by is_http_enabled

  • Introduced in: 9.8

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

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.timestamp

string

query

False

Filter by metric.timestamp

  • 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.write

integer

query

False

Filter by metric.iops.write

  • Introduced in: 9.8

metric.iops.total

integer

query

False

Filter by metric.iops.total

  • 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.write

integer

query

False

Filter by metric.latency.write

  • Introduced in: 9.8

metric.latency.total

integer

query

False

Filter by metric.latency.total

  • Introduced in: 9.8

is_https_enabled

boolean

query

False

Filter by is_https_enabled

  • Introduced in: 9.8

name

string

query

False

Filter by name

  • maxLength: 253

  • minLength: 1

enabled

boolean

query

False

Filter by enabled

secure_port

integer

query

False

Filter by secure_port

  • Introduced in: 9.8

port

integer

query

False

Filter by port

  • Introduced in: 9.8

default_win_user

string

query

False

Filter by default_win_user

  • Introduced in: 9.12

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_service]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "buckets": [
        {
          "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"
                    }
                  }
                },
                "expiration": {
                  "_links": {
                    "self": {
                      "href": "/api/resourcelink"
                    }
                  },
                  "object_expiry_date": "string"
                },
                "name": "string",
                "non_current_version_expiration": {
                  "_links": {
                    "self": {
                      "href": "/api/resourcelink"
                    }
                  }
                },
                "object_filter": {
                  "_links": {
                    "self": {
                      "href": "/api/resourcelink"
                    }
                  },
                  "prefix": "/logs",
                  "size_greater_than": 10485760,
                  "size_less_than": 10240,
                  "tags": [
                    "project1=projA",
                    "project2=projB"
                  ]
                }
              }
            ]
          },
          "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"
                ],
                "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"
          },
          "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"
          }
        }
      ],
      "certificate": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "cert1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "comment": "S3 server",
      "default_unix_user": "string",
      "default_win_user": "string",
      "metric": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "duration": "PT15S",
        "iops": {
          "read": 200,
          "total": 1000,
          "write": 100
        },
        "latency": {
          "read": 200,
          "total": 1000,
          "write": 100
        },
        "status": "ok",
        "throughput": {
          "read": 200,
          "total": 1000,
          "write": 100
        },
        "timestamp": "2017-01-25 06:20:13 -0500"
      },
      "name": "Server-1",
      "statistics": {
        "iops_raw": {
          "read": 200,
          "total": 1000,
          "write": 100
        },
        "latency_raw": {
          "read": 200,
          "total": 1000,
          "write": 100
        },
        "status": "ok",
        "throughput_raw": {
          "read": 200,
          "total": 1000,
          "write": 100
        },
        "timestamp": "2017-01-25 06:20:13 -0500"
      },
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "users": [
        {
          "access_key": "Pz3SB54G2B_6dsXQPrA5HrTPcf478qoAW6_Xx6qyqZ948AgZ_7YfCf_9nO87YoZmskxx3cq41U2JAH2M3_fs321B4rkzS3a_oC5_8u7D8j_45N8OsBCBPWGD_1d_ccfq",
          "comment": "S3 user",
          "name": "user-1",
          "svm": {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "svm1",
            "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
          }
        }
      ]
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

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
Name Type Description

next

href

self

href
Name Type Description

self

href

_links

Name Type Description

self

href

aggregates

Name Type Description

_links

_links

name

string

uuid

string

audit_event_selector

Audit event selector allows you to specify access and permission types to audit.

Name Type Description

access

string

Specifies read and write access types.

permission

string

Specifies allow and deny permission types.

encryption

Name Type Description

enabled

boolean

Specifies whether encryption is enabled on the bucket. By default, encryption is disabled on a bucket.

abort_incomplete_multipart_upload

Specifies a way to perform abort_incomplete_multipart_upload action on filtered objects within a bucket.

Name Type Description

_links

_links

after_initiation_days

integer

Number of days of initiation after which uploads can be aborted.

expiration

Specifies a way to perform expiration action on filtered objects within a bucket.

Name