Retrieve an S3 group configuration
Accesses the configuration details of an S3 group's storage virtual machine (SVM). This helps you understand the current setup and manage storage resources effectively.
HTTP method and endpoint
GET /protocols/s3/services/{svm.uuid}/groups
Introduced in
ONTAP 9.8
Usage notes
Retrieves the S3 group's SVM configuration.
Related ONTAP commands
-
vserver object-store-server group show
Learn more
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
users.name |
string |
query |
False |
Filter by users.name
|
name |
string |
query |
False |
Filter by name
|
comment |
string |
query |
False |
Filter by comment
|
policies.name |
string |
query |
False |
Filter by policies.name
|
id |
integer |
query |
False |
Filter by id |
svm.name |
string |
query |
False |
Filter by svm.name |
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_group] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"records": [
{
"comment": "Admin group",
"id": 5,
"name": "Admin-Group",
"policies": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "Policy1"
}
],
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"users": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "user-1"
}
]
}
]
}
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 |
_links
| Name | Type | Description |
|---|---|---|
self |
policies
| Name | Type | Description |
|---|---|---|
_links |
||
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 "-". |
svm
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the SVM. |
uuid |
string |
The unique identifier of the SVM. |
users
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
Specifies the name of the user. A user name length can range from 1 to 64 characters and can only contain the following combination of characters 0-9, A-Z, a-z, "_", "+", "=", ",", ".","@", and "-". |
s3_group
This is a container for S3 user groups.
| Name | Type | Description |
|---|---|---|
comment |
string |
Can contain any additional information about the group being created or modified. |
id |
integer |
Specifies a unique group ID used to identify a particular group. This parameter should not be specified in the POST method. A group ID is automatically generated and it is retrieved using the GET method. Group id is SVM scoped. |
name |
string |
Specifies the name of the group. A group 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 "-". |
policies |
array[policies] |
Specifies a list of policies that are attached to the group. The wildcard character "*" is a valid value for specifying all policies. |
svm |
||
users |
array[users] |
Specifies the list of users who belong to the group. |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
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. |