Retrieve the S3 policies in an SVM configuration
Retrieves the S3 policies configured in an SVM to review the existing policy setup for object store operations.
HTTP method and endpoint
GET /protocols/s3/services/{svm.uuid}/policies
Introduced in
ONTAP 9.8
Usage notes
Retrieves the S3 policies SVM configuration.
Related ONTAP commands
-
vserver object-store-server policy show
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
name |
string |
query |
False |
Filter by name
|
svm.name |
string |
query |
False |
Filter by svm.name |
comment |
string |
query |
False |
Filter by comment
|
statements.index |
integer |
query |
False |
Filter by statements.index |
statements.resources |
string |
query |
False |
Filter by statements.resources |
statements.sid |
string |
query |
False |
Filter by statements.sid
|
statements.actions |
string |
query |
False |
Filter by statements.actions |
statements.effect |
string |
query |
False |
Filter by statements.effect |
read-only |
boolean |
query |
False |
Filter by read-only |
svm.uuid |
string |
path |
True |
UUID of the SVM to which this object belongs. |
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.
|
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.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
| Name | Type | Description |
|---|---|---|
_links |
||
num_records |
integer |
Number of records |
records |
array[s3_policy] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"comment": "S3 policy.",
"name": "Policy1",
"statements": [
{
"actions": [
"*"
],
"effect": "allow",
"index": 0,
"resources": [
"bucket1",
"bucket1/*"
],
"sid": "FullAccessToBucket1"
}
],
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
}
}
]
}
Error
Status: Default, Error
| Name | Type | Description |
|---|---|---|
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 |
collection_links
| Name | Type | Description |
|---|---|---|
next |
||
self |
s3_policy_statement
Specifies information about a single access policy statement.
| Name | Type | Description |
|---|---|---|
actions |
array[string] |
For each resource, S3 supports a set of operations. The resource operations allowed or denied are identified by an action list:
|
effect |
string |
Specifies whether access is allowed or denied. If access (to allow) is not granted explicitly to a resource, access is implicitly denied. Access can also be denied explicitly to a resource, in order to make sure that a user cannot access it, even if a different policy grants access. |
index |
integer |
Specifies a unique statement index used to identify a particular statement. This parameter should not be specified in the POST method. A statement index is automatically generated. It is not retrieved in the GET method. |
resources |
array[string] |
|
sid |
string |
Specifies the statement identifier which contains additional information about the statement. |
_links
| Name | Type | Description |
|---|---|---|
self |
svm
SVM, applies only to SVM-scoped objects.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the SVM. This field cannot be specified in a PATCH method. |
uuid |
string |
The unique identifier of the SVM. This field cannot be specified in a PATCH method. |
s3_policy
An S3 policy is an object. It defines resource (bucket, folder or object) permissions. These policies get evaluated when an object store user user makes a request. Permissions in the policies determine whether the request is allowed or denied.
| Name | Type | Description |
|---|---|---|
comment |
string |
Can contain any additional information about the S3 policy. |
name |
string |
Specifies the name of the policy. A policy name length can range from 1 to 128 characters and can only contain the following combination of characters 0-9, A-Z, a-z, "_", "+", "=", ",", ".","@", and "-". It cannot be specified in a PATCH method. |
read-only |
boolean |
Specifies whether or not the s3 policy is read only. This parameter should not be specified in the POST method. |
statements |
array[s3_policy_statement] |
Specifies the policy statements. |
svm |
SVM, applies only to SVM-scoped objects. |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
returned_error
| Name | Type | Description |
|---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |