2.4. GET Service ostor-limits

2.4.1. Description

Lists information about limits on operations and bandwidth for the specified user or bucket.

2.4.2. Requests

2.4.2.1. Syntax

GET /?ostor-limits&emailAddress=<value> HTTP/1.1
Host: s3.amazonaws.com
Date: <date>
Authorization: <authorization_string>
GET /?ostor-limits&bucket=<value> HTTP/1.1
Host: s3.amazonaws.com
Date: <date>
Authorization: <authorization_string>

2.4.2.2. Parameters

Parameter Description Required
emailAddress

User email address.

Type: string.

Default value: none.

Yes*
id

User ID.

Type: string.

Default value: none.

Yes*
bucket

Bucket name.

Type: string.

Default value: none.

Yes*

* Only one of the required parameters can be set in a single request.

2.4.2.3. Headers

This implementation uses only common request headers.

2.4.3. Responses

2.4.3.1. Headers

This implementation uses only common response headers.

2.4.3.2. Body

A JSON dictionary with information about limits for a user or bucket in the following format:

{
"ops:default" : "<default_limit_value_in_ops/sec>",
"ops:get" : "<get_ops_limit_value_in_ops/sec>",
"ops:put" : "<put_ops_limit_value_in_ops/sec>",
"ops:list" : "<list_ops_limit_value_in_ops/sec>",
"ops:delete" : "<delete_ops_limit_value_in_ops/sec>",
"bandwidth:out" : "<bandwidth_limit_value_in_kb/sec>",
}

Note

0 means “unlimited”.

2.4.3.3. Errors

Returns Error Code 400, if multiple parameters are set at once.

Note

The limits are disabled by default. If limits for a user/bucket requested are disabled, an error will be returned. Use PUT ostor-limits to enable limits.

2.4.4. Examples

2.4.4.1. Sample Request #1

Returns information about limits for the user with the email user1@email.com.

GET /?ostor-users&emailAddress=user1@email.com HTTP/1.1
Host: s3.amazonaws.com
Date: Thu, 07 Apr 2016 14:08:55 GMT
Authorization: <authorization_string>

2.4.4.2. Sample Response #1

HTTP/1.1 200 OK
Transfer-encoding : chunked
Server : nginx/1.8.1
Connection: closed
x-amz-request-id : 80000000000000030005c8caec96d65b
Date : Thu, 07 Apr 2016 14:08:56 GMT
Content-type : application/json

{
"ops:default" : "0.50",
"ops:get" : "0.50",
"ops:put" : "0.50",
"ops:list" : "0.50",
"ops:delete" : "0.50",
"bandwidth:out" : "0"
}

2.4.4.3. Sample Request #2

Returns information about limits for the bucket bucket-1.

GET /?ostor-limits&bucket=bucket-1 HTTP/1.1
Host: s3.amazonaws.com
Date: Wed, 30 Apr 2016 22:32:00 GMT
Authorization: <authorization_string>

2.4.4.4. Sample Response #2

HTTP/1.1 200 OK
Transfer-encoding : chunked
Server : nginx/1.8.1
Connection : closed
x-amz-request-id : 80000000000000030003c6b538eedd95
Date: Wed, 30 Apr 2016 22:32:00 GMT
Content-type : application/json
{
"ops:default" : "0",
"ops:get" : "0",
"ops:put" : "0",
"ops:list" : "0",
"ops:delete" : "0",
"bandwidth:out" : "3.33"
}