Chapter 1. Ceph Object Gateway administrative API

1.1. Prerequisites

A running Red Hat Ceph Storage cluster.
A RESTful client.

1.2. Administration operations

An administrative Application Programming Interface (API) request will be done on a URI that starts with the configurable 'admin' resource entry point. Authorization for the administrative API duplicates the S3 authorization mechanism. Some operations require that the user holds special administrative capabilities. The response entity type, either XML or JSON, might be specified as the 'format' option in the request and defaults to JSON if not specified.

Example

PUT /admin/user?caps&format=json HTTP/1.1
Host: FULLY_QUALIFIED_DOMAIN_NAME
Content-Type: text/plain
Authorization: AUTHORIZATION_TOKEN

usage=read

1.3. Administration authentication requests

Amazon’s S3 service uses the access key and a hash of the request header and the secret key to authenticate the request. It has the benefit of providing an authenticated request, especially large uploads, without SSL overhead.

Most use cases for the S3 API involve using open source S3 clients such as the AmazonS3Client in the Amazon SDK for Java or Python Boto. These libraries do not support the Ceph Object Gateway Admin API. You can subclass and extend these libraries to support the Ceph Admin API. Alternatively, you can create a unique Gateway client.

Creating an execute() method

The CephAdminAPI example class in this section illustrates how to create an execute() method that can take request parameters, authenticate the request, call the Ceph Admin API and receive a response.

The CephAdminAPI class example is not supported or intended for commercial use. It is for illustrative purposes only.

Calling the Ceph Object Gateway

The client code contains five calls to the Ceph Object Gateway to demonstrate CRUD operations:

Create a User
Get a User
Modify a User
Create a Subuser
Delete a User

To use this example, get the httpcomponents-client-4.5.3 Apache HTTP components. You can download it for example here: http://hc.apache.org/downloads.cgi. Then unzip the tar file, navigate to its lib directory and copy the contents to the /jre/lib/ext directory of the JAVA_HOME directory, or a custom classpath.

As you examine the CephAdminAPI class example, notice that the execute() method takes an HTTP method, a request path, an optional subresource, null if not specified, and a map of parameters. To execute with subresources, for example, subuser, and key, you will need to specify the subresource as an argument in the execute() method.

The example method:

Builds a URI.
Builds an HTTP header string.
Instantiates an HTTP request, for example, PUT, POST, GET, DELETE.
Adds the Date header to the HTTP header string and the request header.
Adds the Authorization header to the HTTP request header.
Instantiates an HTTP client and passes it the instantiated HTTP request.
Makes a request.
Returns a response.

Building the header string

Building the header string is the portion of the process that involves Amazon’s S3 authentication procedure. Specifically, the example method does the following:

Adds a request type, for example, PUT, POST, GET, DELETE.
Adds the date.
Adds the requestPath.

The request type should be upper case with no leading or trailing white space. If you do not trim white space, authentication will fail. The date MUST be expressed in GMT, or authentication will fail.

The exemplary method does not have any other headers. The Amazon S3 authentication procedure sorts x-amz headers lexicographically. So if you are adding x-amz headers, be sure to add them lexicographically.

Once you have built the header string, the next step is to instantiate an HTTP request and pass it the URI. The examplary method uses PUT for creating a user and subuser, GET for getting a user, POST for modifying a user and DELETE for deleting a user.

Once you instantiate a request, add the Date header followed by the Authorization header. Amazon’s S3 authentication uses the standard Authorization header, and has the following structure:

Authorization: AWS ACCESS_KEY:HASH_OF_HEADER_AND_SECRET

The CephAdminAPI example class has a base64Sha1Hmac() method, which takes the header string and the secret key for the admin user, and returns a SHA1 HMAC as a base-64 encoded string. Each execute() call will invoke the same line of code to build the Authorization header:

httpRequest.addHeader("Authorization", "AWS " + this.getAccessKey() + ":" + base64Sha1Hmac(headerString.toString(), this.getSecretKey()));

The following CephAdminAPI example class requires you to pass the access key, secret key and an endpoint to the constructor. The class provides accessor methods to change them at runtime.

Example

import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.time.OffsetDateTime;
import java.time.format.DateTimeFormatter;
import java.time.ZoneId;

import org.apache.http.HttpEntity;
import org.apache.http.NameValuePair;
import org.apache.http.Header;
import org.apache.http.client.entity.UrlEncodedFormEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpRequestBase;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.client.methods.HttpPut;
import org.apache.http.client.methods.HttpDelete;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.message.BasicNameValuePair;
import org.apache.http.util.EntityUtils;
import org.apache.http.client.utils.URIBuilder;

import java.util.Base64;
import java.util.Base64.Encoder;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import javax.crypto.spec.SecretKeySpec;
import javax.crypto.Mac;

import java.util.Map;
import java.util.Iterator;
import java.util.Set;
import java.util.Map.Entry;

public class CephAdminAPI {

	/*
	 * Each call must specify an access key, secret key, endpoint and format.
	 */
	String accessKey;
	String secretKey;
	String endpoint;
	String scheme = "http"; //http only.
	int port = 80;

	/*
	 * A constructor that takes an access key, secret key, endpoint and format.
	 */
	public CephAdminAPI(String accessKey, String secretKey, String endpoint){
		this.accessKey = accessKey;
		this.secretKey = secretKey;
		this.endpoint = endpoint;
	}

	/*
	 * Accessor methods for access key, secret key, endpoint and format.
	 */
	public String getEndpoint(){
		return this.endpoint;
	}

	public void setEndpoint(String endpoint){
		this.endpoint = endpoint;
	}

	public String getAccessKey(){
		return this.accessKey;
	}

	public void setAccessKey(String accessKey){
		this.accessKey = accessKey;
	}

	public String getSecretKey(){
		return this.secretKey;
	}

	public void setSecretKey(String secretKey){
		this.secretKey = secretKey;
	}

	/*
	 * Takes an HTTP Method, a resource and a map of arguments and
	 * returns a CloseableHTTPResponse.
	 */
	public CloseableHttpResponse execute(String HTTPMethod, String resource,
                                        String subresource, Map arguments) {

		String httpMethod = HTTPMethod;
		String requestPath = resource;
		StringBuffer request = new StringBuffer();
		StringBuffer headerString = new StringBuffer();
		HttpRequestBase httpRequest;
		CloseableHttpClient httpclient;
		URI uri;
		CloseableHttpResponse httpResponse = null;

		try {

			uri = new URIBuilder()
				.setScheme(this.scheme)
				.setHost(this.getEndpoint())
				.setPath(requestPath)
				.setPort(this.port)
				.build();


			if (subresource != null){
				uri = new URIBuilder(uri)
					.setCustomQuery(subresource)
					.build();
			}


			for (Iterator iter = arguments.entrySet().iterator();
			iter.hasNext();) {
				Entry entry = (Entry)iter.next();
				uri = new URIBuilder(uri)
					.setParameter(entry.getKey().toString(),
                                 entry.getValue().toString())
					.build();

			}

			request.append(uri);

			headerString.append(HTTPMethod.toUpperCase().trim() + "\n\n\n");

			OffsetDateTime dateTime = OffsetDateTime.now(ZoneId.of("GMT"));
			DateTimeFormatter formatter = DateTimeFormatter.RFC_1123_DATE_TIME;
			String date = dateTime.format(formatter);

			headerString.append(date + "\n");
			headerString.append(requestPath);

			if (HTTPMethod.equalsIgnoreCase("PUT")){
				httpRequest = new HttpPut(uri);
			} else if (HTTPMethod.equalsIgnoreCase("POST")){
				httpRequest = new HttpPost(uri);
			} else if (HTTPMethod.equalsIgnoreCase("GET")){
				httpRequest = new HttpGet(uri);
			} else if (HTTPMethod.equalsIgnoreCase("DELETE")){
				httpRequest = new HttpDelete(uri);
			} else {
				System.err.println("The HTTP Method must be PUT,
				POST, GET or DELETE.");
				throw new IOException();
			}

			httpRequest.addHeader("Date", date);
			httpRequest.addHeader("Authorization", "AWS " + this.getAccessKey()
			+ ":" + base64Sha1Hmac(headerString.toString(),
			this.getSecretKey()));

			httpclient = HttpClients.createDefault();
			httpResponse = httpclient.execute(httpRequest);

		} 	catch  (URISyntaxException e){
			System.err.println("The URI is not formatted properly.");
			e.printStackTrace();
		}  catch (IOException e){
			System.err.println("There was an error making the request.");
			e.printStackTrace();
		}
			return httpResponse;
	}

	/*
	 * Takes a uri and a secret key and returns a base64-encoded
	 * SHA-1 HMAC.
	 */
	public String base64Sha1Hmac(String uri, String secretKey) {
		try {

			byte[] keyBytes = secretKey.getBytes("UTF-8");
			SecretKeySpec signingKey = new SecretKeySpec(keyBytes, "HmacSHA1");

			Mac mac = Mac.getInstance("HmacSHA1");
			mac.init(signingKey);

			byte[] rawHmac = mac.doFinal(uri.getBytes("UTF-8"));

			Encoder base64 = Base64.getEncoder();
			return base64.encodeToString(rawHmac);

		} catch (Exception e) {
			throw new RuntimeException(e);
		}
	}

}

The subsequent CephAdminAPIClient example illustrates how to instantiate the CephAdminAPI class, build a map of request parameters, and use the execute() method to create, get, update and delete a user.

Example

import java.io.IOException;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.HttpEntity;
import org.apache.http.util.EntityUtils;
import java.util.*;


public class CephAdminAPIClient {

	public static void main (String[] args){

		CephAdminAPI adminApi = new CephAdminAPI ("FFC6ZQ6EMIF64194158N",
		                            "Xac39eCAhlTGcCAUreuwe1ZuH5oVQFa51lbEMVoT",
		                            "ceph-client");

		/*
		 * Create a user
		 */
		Map requestArgs = new HashMap();
		requestArgs.put("access", "usage=read, write; users=read, write");
		requestArgs.put("display-name", "New User");
		requestArgs.put("email", "new-user@email.com");
		requestArgs.put("format", "json");
		requestArgs.put("uid", "new-user");

		CloseableHttpResponse response =
			adminApi.execute("PUT", "/admin/user", null, requestArgs);

		System.out.println(response.getStatusLine());
		HttpEntity entity = response.getEntity();

		try {
			System.out.println("\nResponse Content is: "
				+ EntityUtils.toString(entity, "UTF-8") + "\n");
			response.close();
		} catch (IOException e){
			System.err.println ("Encountered an I/O exception.");
			e.printStackTrace();
		}

		/*
		 * Get a user
		 */
		requestArgs = new HashMap();
		requestArgs.put("format", "json");
		requestArgs.put("uid", "new-user");

		response = adminApi.execute("GET", "/admin/user", null, requestArgs);

		System.out.println(response.getStatusLine());
		entity = response.getEntity();

		try {
			System.out.println("\nResponse Content is: "
				+ EntityUtils.toString(entity, "UTF-8") + "\n");
			response.close();
		} catch (IOException e){
			System.err.println ("Encountered an I/O exception.");
			e.printStackTrace();
		}

		/*
		 * Modify a user
		 */
		requestArgs = new HashMap();
		requestArgs.put("display-name", "John Doe");
		requestArgs.put("email", "johndoe@email.com");
		requestArgs.put("format", "json");
		requestArgs.put("uid", "new-user");
		requestArgs.put("max-buckets", "100");

		response = adminApi.execute("POST", "/admin/user", null, requestArgs);

		System.out.println(response.getStatusLine());
		entity = response.getEntity();

		try {
			System.out.println("\nResponse Content is: "
				+ EntityUtils.toString(entity, "UTF-8") + "\n");
			response.close();
		} catch (IOException e){
			System.err.println ("Encountered an I/O exception.");
			e.printStackTrace();
		}


		/*
		 * Create a subuser
		 */
		requestArgs = new HashMap();
		requestArgs.put("format", "json");
		requestArgs.put("uid", "new-user");
		requestArgs.put("subuser", "foobar");

		response = adminApi.execute("PUT", "/admin/user", "subuser", requestArgs);
		System.out.println(response.getStatusLine());
		entity = response.getEntity();

		try {
			System.out.println("\nResponse Content is: "
				+ EntityUtils.toString(entity, "UTF-8") + "\n");
			response.close();
		} catch (IOException e){
			System.err.println ("Encountered an I/O exception.");
			e.printStackTrace();
		}


		/*
		 * Delete a user
		 */
		requestArgs = new HashMap();
		requestArgs.put("format", "json");
		requestArgs.put("uid", "new-user");

		response = adminApi.execute("DELETE", "/admin/user", null, requestArgs);
		System.out.println(response.getStatusLine());
		entity = response.getEntity();

		try {
			System.out.println("\nResponse Content is: "
				+ EntityUtils.toString(entity, "UTF-8") + "\n");
			response.close();
		} catch (IOException e){
			System.err.println ("Encountered an I/O exception.");
			e.printStackTrace();
		}
	}
}

Additional Resources

See the S3 Authentication section in the Red Hat Ceph Storage Developer Guide for additional details.
For a more extensive explanation of the Amazon S3 authentication procedure, consult the Signing and Authenticating REST Requests section of Amazon Simple Storage Service documentation.

1.4. Creating an administrative user

Important

To run the radosgw-admin command from the Ceph Object Gateway node, ensure the node has the admin key. The admin key can be copied from any Ceph Monitor node.

Prerequisites

Root-level access to the Ceph Object Gateway node.

Procedure

Create an object gateway user:

Syntax

radosgw-admin user create --uid="USER_NAME" --display-name="DISPLAY_NAME"

Example

[user@client ~]$ radosgw-admin user create --uid="admin-api-user" --display-name="Admin API User"

The radosgw-admin command-line interface will return the user.

Example output

{
    "user_id": "admin-api-user",
    "display_name": "Admin API User",
    "email": "",
    "suspended": 0,
    "max_buckets": 1000,
    "auid": 0,
    "subusers": [],
    "keys": [
        {
            "user": "admin-api-user",
            "access_key": "NRWGT19TWMYOB1YDBV1Y",
            "secret_key": "gr1VEGIV7rxcP3xvXDFCo4UDwwl2YoNrmtRlIAty"
        }
    ],
    "swift_keys": [],
    "caps": [],
    "op_mask": "read, write, delete",
    "default_placement": "",
    "placement_tags": [],
    "bucket_quota": {
        "enabled": false,
        "max_size_kb": -1,
        "max_objects": -1
    },
    "user_quota": {
        "enabled": false,
        "max_size_kb": -1,
        "max_objects": -1
    },
    "temp_url_keys": []
}

Assign administrative capabilities to the user you create:

Syntax

radosgw-admin caps add --uid="USER_NAME" --caps="users=*"

Example

[user@client ~]$ radosgw-admin caps add --uid=admin-api-user --caps="users=*"

The radosgw-admin command-line interface will return the user. The "caps": will have the capabilities you assigned to the user:

Example output

{
    "user_id": "admin-api-user",
    "display_name": "Admin API User",
    "email": "",
    "suspended": 0,
    "max_buckets": 1000,
    "auid": 0,
    "subusers": [],
    "keys": [
        {
            "user": "admin-api-user",
            "access_key": "NRWGT19TWMYOB1YDBV1Y",
            "secret_key": "gr1VEGIV7rxcP3xvXDFCo4UDwwl2YoNrmtRlIAty"
        }
    ],
    "swift_keys": [],
    "caps": [
        {
            "type": "users",
            "perm": "*"
        }
    ],
    "op_mask": "read, write, delete",
    "default_placement": "",
    "placement_tags": [],
    "bucket_quota": {
        "enabled": false,
        "max_size_kb": -1,
        "max_objects": -1
    },
    "user_quota": {
        "enabled": false,
        "max_size_kb": -1,
        "max_objects": -1
    },
    "temp_url_keys": []
}

Now you have a user with administrative privileges.

1.5. Get user information

Get the user’s information.

Capabilities

users=read

Syntax

GET /admin/user?format=json HTTP/1.1
Host: FULLY_QUALIFIED_DOMAIN_NAME

Table 1.1. Request Parameters
Name	Description	Type	Example	Required
`uid`	The user for which the information is requested.	String	`foo_user`	Yes

Table 1.2. Response Entities
Name	Description	Type	Parent
`user`	A container for the user data information.	Container	N/A
`user_id`	The user ID.	String	`user`
`display_name`	Display name for the user.	String	`user`
`suspended`	True if the user is suspended.	Boolean	`user`
`max_buckets`	The maximum number of buckets to be owned by the user.	Integer	`user`
`subusers`	Subusers associated with this user account.	Container	`user`
`keys`	S3 keys associated with this user account.	Container	`user`
`swift_keys`	Swift keys associated with this user account.	Container	`user`
`caps`	User capabilities.	Container	`user`

If successful, the response contains the user information.

Special Error Responses

None.

1.6. Create a user

Create a new user. By Default, a S3 key pair will be created automatically and returned in the response. If only one of access-key or secret-key is provided, the omitted key will be automatically generated. By default, a generated key is added to the keyring without replacing an existing key pair. If access-key is specified and refers to an existing key owned by the user then it will be modified.

Capabilities

`users=write`

Syntax

PUT /admin/user?format=json HTTP/1.1
Host: FULLY_QUALIFIED_DOMAIN_NAME

Table 1.3. Request Parameters
Name	Description	Type	Example	Required
`uid`	The user ID to be created.	String	`foo_user`	Yes
`display-name`	The display name of the user to be created.	String	`foo user`	Yes
`email`	The email address associated with the user.	String	`foo@bar.com`	No
`key-type`	Key type to be generated, options are: swift, s3 (default).	String	`s3` [`s3`]	No
`access-key`	Specify access key.	String	`ABCD0EF12GHIJ2K34LMN`	No
`secret-key`	Specify secret key.	String	`0AbCDEFg1h2i34JklM5nop6QrSTUV+WxyzaBC7D8`	No
`user-caps`	User capabilities.	String	`usage=read, write; users=read`	No
`generate-key`	Generate a new key pair and add to the existing keyring.	Boolean	True [True]	No
`max-buckets`	Specify the maximum number of buckets the user can own.	Integer	500 [1000]	No
`suspended`	Specify whether the user should be suspended.	Boolean	False [False]	No

Table 1.4. Response Entities
Name	Description	Type	Parent
`user`	A container for the user data information.	Container	N/A
`user_id`	The user ID.	String	`user`
`display_name`	Display name for the user.	String	`user`
`suspended`	True if the user is suspended.	Boolean	`user`
`max_buckets`	The maximum number of buckets to be owned by the user.	Integer	`user`
`subusers`	Subusers associated with this user account.	Container	`user`
`keys`	S3 keys associated with this user account.	Container	`user`
`swift_keys`	Swift keys associated with this user account.	Container	`user`
`caps`	User capabilities.	Container	`user`

If successful, the response contains the user information.

Table 1.5. Special Error Responses
Name	Description	Code
`UserExists`	Attempt to create existing user.	409 Conflict
`InvalidAccessKey`	Invalid access key specified.	400 Bad Request
`InvalidKeyType`	Invalid key type specified.	400 Bad Request
`InvalidSecretKey`	Invalid secret key specified.	400 Bad Request
`InvalidKeyType`	Invalid key type specified.	400 Bad Request
`KeyExists`	Provided access key exists and belongs to another user.	409 Conflict
`EmailExists`	Provided email address exists.	409 Conflict
`InvalidCap`	Attempt to grant invalid admin capability.	400 Bad Request

Additional Resources

See the Red Hat Ceph Storage Developer Guide for creating subusers.

1.7. Modify a user

Modify an existing user.

Capabilities

`users=write`

Syntax

POST /admin/user?format=json HTTP/1.1
Host: FULLY_QUALIFIED_DOMAIN_NAME

Table 1.6. Request Parameters
Name	Description	Type	Example	Required
`uid`	The user ID to be modified.	String	`foo_user`	Yes
`display-name`	The display name of the user to be modified.	String	`foo user`	No
`email`	The email address to be associated with the user.	String	`foo@bar.com`	No
`generate-key`	Generate a new key pair and add to the existing keyring.	Boolean	True [False]	No
`access-key`	Specify access key.	String	`ABCD0EF12GHIJ2K34LMN`	No
`secret-key`	Specify secret key.	String	`0AbCDEFg1h2i34JklM5nop6QrSTUV+WxyzaBC7D8`	No
`key-type`	Key type to be generated, options are: swift, s3 (default).	String	`s3`	No
`user-caps`	User capabilities.	String	`usage=read, write; users=read`	No
`max-buckets`	Specify the maximum number of buckets the user can own.	Integer	500 [1000]	No
`suspended`	Specify whether the user should be suspended.	Boolean	False [False]	No

Table 1.7. Response Entities
Name	Description	Type	Parent
`user`	A container for the user data information.	Container	N/A
`user_id`	The user ID.	String	`user`
`display_name`	Display name for the user.	String	`user`
`suspended`	True if the user is suspended.	Boolean	`user`
`max_buckets`	The maximum number of buckets to be owned by the user.	Integer	`user`
`subusers`	Subusers associated with this user account.	Container	`user`
`keys`	S3 keys associated with this user account.	Container	`user`
`swift_keys`	Swift keys associated with this user account.	Container	`user`
`caps`	User capabilities.	Container	`user`

If successful, the response contains the user information.

Table 1.8. Special Error Responses
Name	Description	Code
`InvalidAccessKey`	Invalid access key specified.	400 Bad Request
`InvalidKeyType`	Invalid key type specified.	400 Bad Request
`InvalidSecretKey`	Invalid secret key specified.	400 Bad Request
`KeyExists`	Provided access key exists and belongs to another user.	409 Conflict
`EmailExists`	Provided email address exists.	409 Conflict
`InvalidCap`	Attempt to grant invalid admin capability.	400 Bad Request

Additional Resources

See the Red Hat Ceph Storage Developer Guide for modifying subusers.

1.8. Remove a user

Remove an existing user.

Capabilities

`users=write`

Syntax

DELETE /admin/user?format=json HTTP/1.1
Host: FULLY_QUALIFIED_DOMAIN_NAME

Table 1.9. Request Parameters
Name	Description	Type	Example	Required
`uid`	The user ID to be removed.	String	`foo_user`	Yes.
`purge-data`	When specified the buckets and objects belonging to the user will also be removed.	Boolean	True	No

Response Entities

None.

Special Error Responses

None.

Additional Resources

See Red Hat Ceph Storage Developer Guide for removing subusers.

1.9. Create a subuser

Create a new subuser, primarily useful for clients using the Swift API.

Note

Either gen-subuser or subuser is required for a valid request. In general, for a subuser to be useful, it must be granted permissions by specifying access. As with user creation if subuser is specified without secret, then a secret key will be automatically generated.

Capabilities

`users=write`

Syntax

PUT /admin/user?subuser&format=json HTTP/1.1
Host FULLY_QUALIFIED_DOMAIN_NAME

Table 1.10. Request Parameters
Name	Description	Type	Example	Required
`uid`	The user ID under which a subuser is to be created.	String	`foo_user`	Yes
`subuser`	Specify the subuser ID to be created.	String	`sub_foo`	Yes (or `gen-subuser`)
`gen-subuser`	Specify the subuser ID to be created.	String	`sub_foo`	Yes (or `subuser`)
`secret-key`	Specify secret key.	String	`0AbCDEFg1h2i34JklM5nop6QrSTUVWxyzaBC7D8`	No
`key-type`	Key type to be generated, options are: swift (default), s3.	String	`swift` [`swift`]	No
`access`	Set access permissions for sub-user, should be one of `read, write, readwrite, full`.	String	`read`	No
`generate-secret`	Generate the secret key.	Boolean	True [False]	No

Table 1.11. Response Entities
Name	Description	Type	Parent
`subusers`	Subusers associated with the user account.	Container	N/A
`id`	Subuser ID.	String	`subusers`
`permissions`	Subuser access to user account.	String	`subusers`

If successful, the response contains the subuser information.

Table 1.12. Special Error Responses
Name	Description	Code
`SubuserExists`	Specified subuser exists.	409 Conflict
`InvalidKeyType`	Invalid key type specified.	400 Bad Request
`InvalidSecretKey`	Invalid secret key specified.	400 Bad Request
`InvalidAccess`	Invalid subuser access specified.	400 Bad Request

1.10. Modify a subuser

Modify an existing subuser.

Capabilities

`users=write`

Syntax

POST /admin/user?subuser&format=json HTTP/1.1
Host FULLY_QUALIFIED_DOMAIN_NAME

Table 1.13. Request Parameters
Name	Description	Type	Example	Required
`uid`	The user ID under which the subuser is to be modified.	String	`foo_user`	Yes
`subuser`	The subuser ID to be modified.	String	`sub_foo`	Yes
`generate-secret`	Generate a new secret key for the subuser, replacing the existing key.	Boolean	True [False]	No
`secret`	Specify secret key.	String	`0AbCDEFg1h2i34JklM5nop6QrSTUV+WxyzaBC7D8`	No
`key-type`	Key type to be generated, options are: swift (default), s3.	String	`swift` [`swift`]	No
`access`	Set access permissions for sub-user, should be one of `read, write, readwrite, full`.	String	`read`	No

Table 1.14. Response Entities
Name	Description	Type	Parent
`subusers`	Subusers associated with the user account.	Container	N/A
`id`	Subuser ID.	String	`subusers`
`permissions`	Subuser access to user account.	String	`subusers`

If successful, the response contains the subuser information.

Table 1.15. Special Error Responses
Name	Description	Code
`InvalidKeyType`	Invalid key type specified.	400 Bad Request
`InvalidSecretKey`	Invalid secret key specified.	400 Bad Request
`InvalidAccess`	Invalid subuser access specified.	400 Bad Request

1.11. Remove a subuser

Remove an existing subuser.

Capabilities

`users=write`

Syntax

DELETE /admin/user?subuser&format=json HTTP/1.1
Host FULLY_QUALIFIED_DOMAIN_NAME

Table 1.16. Request Parameters
Name	Description	Type	Example	Required
`uid`	The user ID under which the subuser is to be removed.	String	`foo_user`	Yes
`subuser`	The subuser ID to be removed.	String	`sub_foo`	Yes
`purge-keys`	Remove keys belonging to the subuser.	Boolean	True [True]	No

Response Entities

None.

Special Error Responses

None.

1.12. Add capabilities to a user

Add an administrative capability to a specified user.

Capabilities

`users=write`

Syntax

PUT /admin/user?caps&format=json HTTP/1.1
Host FULLY_QUALIFIED_DOMAIN_NAME

Table 1.17. Request Parameters
Name	Description	Type	Example	Required
`uid`	The user ID to add an administrative capability to.	String	`foo_user`	Yes
`user-caps`	The administrative capability to add to the user.	String	`usage=read, write`	Yes

Table 1.18. Response Entities
Name	Description	Type	Parent
`user`	A container for the user data information.	Container	N/A
`user_id`	The user ID.	String	`user`
`caps`	User capabilities.	Container	`user`

If successful, the response contains the user’s capabilities.

Table 1.19. Special Error Responses
Name	Description	Code
`InvalidCap`	Attempt to grant invalid admin capability.	400 Bad Request

1.13. Remove capabilities from a user

Remove an administrative capability from a specified user.

Capabilities

`users=write`

Syntax

DELETE /admin/user?caps&format=json HTTP/1.1
Host FULLY_QUALIFIED_DOMAIN_NAME

Table 1.20. Request Parameters
Name	Description	Type	Example	Required
`uid`	The user ID to remove an administrative capability from.	String	`foo_user`	Yes
`user-caps`	The administrative capabilities to remove from the user.	String	`usage=read, write`	Yes

Table 1.21. Response Entities
Name	Description	Type	Parent
`user`	A container for the user data information.	Container	N/A
`user_id`	The user ID.	String	`user`
`caps`	User capabilities.	Container	`user`

If successful, the response contains the user’s capabilities.

Table 1.22. Special Error Responses
Name	Description	Code
`InvalidCap`	Attempt to remove an invalid admin capability.	400 Bad Request
`NoSuchCap`	User does not possess specified capability.	404 Not Found

1.14. Create a key

Create a new key. If a subuser is specified then by default created keys will be swift type. If only one of access-key or secret-key is provided the committed key will be automatically generated, that is if only secret-key is specified then access-key will be automatically generated. By default, a generated key is added to the keyring without replacing an existing key pair. If access-key is specified and refers to an existing key owned by the user then it will be modified. The response is a container listing all keys of the same type as the key created.

Note

When creating a swift key, specifying the option access-key will have no effect. Additionally, only one swift key might be held by each user or subuser.

Capabilities

`users=write`

Syntax

PUT /admin/user?key&format=json HTTP/1.1
Host FULLY_QUALIFIED_DOMAIN_NAME

Table 1.23. Request Parameters
Name	Description	Type	Example	Required
`uid`	The user ID to receive the new key.	String	`foo_user`	Yes
`subuser`	The subuser ID to receive the new key.	String	`sub_foo`	No
`key-type`	Key type to be generated, options are: swift, s3 (default).	String	`s3` [`s3`]	No
`access-key`	Specify the access key.	String	`AB01C2D3EF45G6H7IJ8K`	No
`secret-key`	Specify the secret key.	String	`0ab/CdeFGhij1klmnopqRSTUv1WxyZabcDEFgHij`	No
`generate-key`	Generate a new key pair and add to the existing keyring.	Boolean	True [`True`]	No

Table 1.24. Response Entities
Name	Description	Type	Parent
`keys`	Keys of type created associated with this user account.	Container	N/A
`user`	The user account associated with the key.	String	`keys`
`access-key`	The access key.	String	`keys`
`secret-key`	The secret key	String	`keys`

Table 1.25. Special Error Responses
Name	Description	Code
`InvalidAccessKey`	Invalid access key specified.	400 Bad Request
`InvalidKeyType`	Invalid key type specified.	400 Bad Request
`InvalidSecretKey`	Invalid secret key specified.	400 Bad Request
`InvalidKeyType`	Invalid key type specified.	400 Bad Request
`KeyExists`	Provided access key exists and belongs to another user.	409 Conflict

1.15. Remove a key

Remove an existing key.

Capabilities

`users=write`

Syntax

DELETE /admin/user?key&format=json HTTP/1.1
Host FULLY_QUALIFIED_DOMAIN_NAME

Table 1.26. Request Parameters
Name	Description	Type	Example	Required
`access-key`	The S3 access key belonging to the S3 key pair to remove.	String	`AB01C2D3EF45G6H7IJ8K`	Yes
`uid`	The user to remove the key from.	String	`foo_user`	No
`subuser`	The subuser to remove the key from.	String	`sub_foo`	No
`key-type`	Key type to be removed, options are: swift, s3. Note Required to remove swift key.	String	`swift`	No

Special Error Responses

None.

Response Entities

None.

1.16. Bucket notifications

As a storage administrator, you can use these APIs to provide configuration and control interfaces for the bucket notification mechanism. The API topics are named objects that contain the definition of a specific endpoint. Bucket notifications associate topics with a specific bucket. The S3 bucket operations section gives more details on bucket notifications.

Note

In all topic actions, the parameters are URL encoded, and sent in the message body using application/x-www-form-urlencoded content type.

Note

Any bucket notification already associated with the topic needs to be re-created for the topic update to take effect.

1.16.1. Prerequisites

Create bucket notifications on the Ceph Object Gateway.

1.16.2. Creating a topic

You can create topics before creating bucket notifications. A topic is a Simple Notification Service (SNS) entity and all the topic operations, that is, create, delete, list and get, are SNS operations. The topic needs to have endpoint parameters that are used when a bucket notification is created. Once the request is successful, the response includes the topic Amazon Resource Name (ARN) that can be used later to reference this topic in the bucket notification request.

Note

A topic_arn provides the bucket notification configuration, and is generated after a topic is created.

Prerequisites

A running Red Hat Ceph Storage cluster.
Root-level access.
Installation of the Ceph Object Gateway.
User access key and secret key.
Endpoint parameters.

Procedure

Create a topic with the following request format:
Syntax
```
POST
Action=CreateTopic
&Name=TOPIC_NAME
[&Attributes.entry.1.key=amqp-exchange&Attributes.entry.1.value=EXCHANGE]
[&Attributes.entry.2.key=amqp-ack-level&Attributes.entry.2.value=none|broker|routable]
[&Attributes.entry.3.key=verify-ssl&Attributes.entry.3.value=true|false]
[&Attributes.entry.4.key=kafka-ack-level&Attributes.entry.4.value=none|broker]
[&Attributes.entry.5.key=use-ssl&Attributes.entry.5.value=true|false]
[&Attributes.entry.6.key=ca-location&Attributes.entry.6.value=FILE_PATH]
[&Attributes.entry.7.key=OpaqueData&Attributes.entry.7.value=OPAQUE_DATA]
[&Attributes.entry.8.key=push-endpoint&Attributes.entry.8.value=ENDPOINT]
```
Here are the request parameters:
- Endpoint: URL of an endpoint to send notifications to.
- OpaqueData: opaque data is set in the topic configuration and added to all notifications triggered by the topic.
- HTTP endpoint:
  - URL: http[s]://FQDN[: PORT ]
  - port defaults to: Use 80/443 for HTTP[S] accordingly.
  - verify-ssl: Indicates whether the server certificate is validated by the client or not. By default , it is true.
- AMQP0.9.1 endpoint:
  - URL: amqp://[USER : PASSWORD @] FQDN [: PORT][/VHOST].
  - User and password defaults to: guest and guest respectively.
  - User and password can only be provided with HTTPS. Otherwise, the topic creation request is rejected.
  - port defaults to: 5672.
  - vhost defaults to: “/”
  - amqp-exchange: The exchanges must exist and be able to route messages based on topics. This is a mandatory parameter for AMQP0.9.1. Different topics pointing to the same endpoint must use the same exchange.
  - amqp-ack-level: No end to end acknowledgement is required, as messages may persist in the broker before being delivered into their final destination. Three acknowledgement methods exist:
    none: Message is considered delivered if sent to the broker.
    broker: By default the message is considered delivered if acknowledged by the broker.
    routable: Message is considered delivered if the broker can route to a consumer.
    Note
    The key and value of a specific parameter does not have to reside in the same line, or in any specific order, but must use the same index. Attribute indexing does not need to be sequential or start from any specific value.
    Note
    The topic-name is used for the AMQP topic.
- Kafka endpoint:
  - URL: kafka://[USER: PASSWORD @] FQDN[: PORT].
  - If use-ssl is set to false by default. If use-ssl is set to true, secure connection is used for connecting with the broker.
  - If ca-location is provided, and secure connection is used, the specified CA will be used, instead of the default one, to authenticate the broker.
  - User and password can only be provided over HTTP[S]. If not,topic creation request will be rejected.
  - User and password may only be provided together with use-ssl, if not, connection to the broker would fail.
  - port defaults to: 9092.
  - kafka-ack-level: no end to end acknowledgement required, as messages may persist in the broker before being delivered into their final destination. Two acknowledgement methods exist:
    none: message is considered delivered if sent to the broker.
    broker: By default, the message is considered delivered if acknowledged by the broker.

Create a response in the following format:

Syntax

<CreateTopicResponse xmlns="https://sns.amazonaws.com/doc/2010-03-31/">
    <CreateTopicResult>
        <TopicArn></TopicArn>
    </CreateTopicResult>
    <ResponseMetadata>
        <RequestId></RequestId>
    </ResponseMetadata>
</CreateTopicResponse>

Note

The topic Amazon Resource Name (ARN) in the response will have the following format: arn:aws:sns:ZONE_GROUP:TENANT:TOPIC

The following is an example of AMQP0.9.1 endpoint:

Syntax

"client.create_topic(Name='my-topic' , Attributes={'push-endpoint': 'amqp://127.0.0.1:5672', 'amqp-exchange': 'ex1', 'amqp-ack-level': 'broker'})"

1.16.3. Getting topic information

Returns information about specific topic. This can include endpoint information if it is provided.

Prerequisites

A running Red Hat Ceph Storage cluster.
Root-level access.
Installation of the Ceph Object Gateway.
User access key and secret key.
Endpoint parameters.

Procedure

Get topic information with the following request format:
Syntax
```
POST
Action=GetTopic
&TopicArn=TOPIC_ARN
```
Here is an example of the response format:
```
<GetTopicResponse>
  <GetTopicRersult>
    <Topic>
      <User>
      </User>
      <Name>
      </Name>
      <EndPoint>
        <EndpointAddress>
        </EndpointAddress>
        <EndpointArgs>
        </EndpointArgs>
        <EndpointTopic>
        </EndpointTopic>
      </EndPoint>
      <TopicArn>
      </TopicArn>
      <OpaqueData>
      </OpaqueData>
    </Topic>
  </GetTopicResult>
  <ResponseMetadata>
    <RequestId>
    </RequestId>
  </ResponseMetadata>
</GetTopicResponse>
```
These are the tags and their definitions:
- User: Name of the user that created the topic.
- Name: Name of the topic.
- EndpointAddress: The endpoint URL. If the endpoint URL contains user and password information, request must be made over HTTPS. If not, the topic get request will be rejected.
- EndPointArgs: The endpoint arguments.
- EndpointTopic: The topic name that will be sent to the endpoint, can be different than the above topic name.
- TopicArn: Topic ARN.

1.16.4. Listing topics

List the topics that the user has defined.

Prerequisites

A running Red Hat Ceph Storage cluster.
Root-level access.
Installation of the Ceph Object Gateway.
User access key and secret key.
Endpoint parameters.

Procedure

List topic information with the following request format:

POST
Action=ListTopics

Here is an example of the response format:

<ListTopicdResponse xmlns="https://sns.amazonaws.com/doc/2020-03-31/">
  <ListTopicsRersult>
    <Topics>
      <member>
        <User>
        </User>
        <Name>
        </Name>
        <EndPoint>
          <EndpointAddress>
          </EndpointAddress>
          <EndpointArgs>
          </EndpointArgs>
          <EndpointTopic>
          </EndpointTopic>
        </EndPoint>
        <TopicArn>
        </TopicArn>
        <OpaqueData>
        </OpaqueData>
      </member>
    </Topics>
  </ListTopicsResult>
  <ResponseMetadata>
    <RequestId>
    </RequestId>
  </ResponseMetadata>
</ListTopicsResponse>

Note

If endpoint URL contains user and password information, in any of the topics, the request must be made over HTTPS. If not, topic list request is rejected.

1.16.5. Deleting topics

Removing a deleted topic results with no operation and not a failure.

Prerequisites

A running Red Hat Ceph Storage cluster.
Root-level access.
Installation of the Ceph Object Gateway.
User access key and secret key.
Endpoint parameters.

Procedure

Delete a topic with the following request format:

Syntax

POST
Action=DeleteTopic
&TopicArn=TOPIC_ARN

Here is an example of the response format:

<DeleteTopicResponse xmlns="https://sns.amazonaws.com/doc/2020-03-31/">
  <ResponseMetadata>
    <RequestId>
    </RequestId>
  </ResponseMetadata>
</DeleteTopicResponse>

1.16.6. Event record

An event holds information about the operation done by the Ceph Object Gateway and is sent as a payload over the chosen endpoint, such as, HTTP, HTTPS, Kafka or AMQ0.9.1. The event record is in a JSON format.

Example

{"Records":[
    {
        "eventVersion":"2.1",
        "eventSource":"ceph:s3",
        "awsRegion":"us-east-1",
        "eventTime":"2019-11-22T13:47:35.124724Z",
        "eventName":"s3:ObjectCreated:Put",
        "userIdentity":{
            "principalId":"tester"
        },
        "requestParameters":{
            "sourceIPAddress":""
        },
        "responseElements":{
            "x-amz-request-id":"503a4c37-85eb-47cd-8681-2817e80b4281.5330.903595",
            "x-amz-id-2":"14d2-zone1-zonegroup1"
        },
        "s3":{
            "s3SchemaVersion":"1.0",
            "configurationId":"mynotif1",
            "bucket":{
                "name":"mybucket1",
                "ownerIdentity":{
                    "principalId":"tester"
                },
                "arn":"arn:aws:s3:us-east-1::mybucket1",
                "id":"503a4c37-85eb-47cd-8681-2817e80b4281.5332.38"
            },
            "object":{
                "key":"myimage1.jpg",
                "size":"1024",
                "eTag":"37b51d194a7513e45b56f6524f2d51f2",
                "versionId":"",
                "sequencer": "F7E6D75DC742D108",
                "metadata":[],
                "tags":[]
            }
        },
        "eventId":"",
        "opaqueData":"me@example.com"
    }
]}

These are the event record keys and their definitions:

awsRegion: Zonegroup.
eventTime: Timestamp that indicates when the event was triggered.
eventName: The type of the event.
userIdentity.principalId: The identity of the user that triggered the event.
requestParameters.sourceIPAddress: The IP address of the client that triggered the event. This field is not supported.
responseElements.x-amz-request-id: The request ID that triggered the event.
responseElements.x_amz_id_2: The identity of the Ceph Object Gateway on which the event was triggered. The identity format is RGWID-ZONE-ZONEGROUP.
s3.configurationId: The notification ID that created the event.
s3.bucket.name: The name of the bucket.
s3.bucket.ownerIdentity.principalId: The owner of the bucket.
s3.bucket.arn: Amazon Resource Name (ARN) of the bucket.
s3.bucket.id: Identity of the bucket.
s3.object.key: The object key.
s3.object.size: The size of the object.
s3.object.eTag: The object etag.
s3.object.version: The object version in a versioned bucket.
s3.object.sequencer: Monotonically increasing identifier of the change per object in the hexadecimal format.
s3.object.metadata: Any metadata set on the object sent as x-amz-meta.
s3.object.tags: Any tags set on the object.
s3.eventId: Unique identity of the event.
s3.opaqueData: Opaque data is set in the topic configuration and added to all notifications triggered by the topic.

Additional Resources

See the Event Message Structure for more information.
See the Supported event types section of the Red Hat Ceph Storage Developer Guide for more information.

1.16.7. Supported event types

The following event types are supported:

s3:ObjectCreated:*
s3:ObjectCreated:Put
s3:ObjectCreated:Post
s3:ObjectCreated:Copy
s3:ObjectCreated:CompleteMultipartUpload
s3:ObjectRemoved:*
s3:ObjectRemoved:Delete
s3:ObjectRemoved:DeleteMarkerCreated

1.16.8. Additional Resources

See the Creating bucket notifications section is the Red Hat Ceph Storage Object Gateway Configuration and Administration Guide for more details.

1.17. Get bucket information

Get information about a subset of the existing buckets. If uid is specified without bucket then all buckets belonging to the user will be returned. If bucket alone is specified, information for that particular bucket will be retrieved.

Capabilities

`buckets=read`

Syntax

GET /admin/bucket?format=json HTTP/1.1
Host FULLY_QUALIFIED_DOMAIN_NAME

Table 1.27. Request Parameters
Name	Description	Type	Example	Required
`bucket`	The bucket to return info on.	String	`foo_bucket`	No
`uid`	The user to retrieve bucket information for.	String	`foo_user`	No
`stats`	Return bucket statistics.	Boolean	True [False]	No

Table 1.28. Response Entities
Name	Description	Type	Parent
`stats`	Per bucket information.	Container	N/A
`buckets`	Contains a list of one or more bucket containers.	Container	`bucket`
Container for single bucket information.	Container	`buckets`	`name`
The name of the bucket.	String	`bucket`	`pool`
The pool the bucket is stored in.	String	`bucket`	`id`
The unique bucket ID.	String	`bucket`	`marker`
Internal bucket tag.	String	`bucket`	`owner`
The user ID of the bucket owner.	String	`bucket`	`usage`
Storage usage information.	Container	`bucket`	`index`

If successful the request returns a buckets container containing the desired bucket information.

Table 1.29. Special Error Responses
Name	Description	Code
`IndexRepairFailed`	Bucket index repair failed.	409 Conflict

1.18. Check a bucket index

Check the index of an existing bucket.

Note

To check multipart object accounting with check-objects, fix must be set to True.

Capabilities

buckets=write

Syntax

GET /admin/bucket?index&format=json HTTP/1.1
Host FULLY_QUALIFIED_DOMAIN_NAME

Table 1.30. Request Parameters
Name	Description	Type	Example	Required
`bucket`	The bucket to return info on.	String	`foo_bucket`	Yes
`check-objects`	Check multipart object accounting.	Boolean	True [False]	No
`fix`	Also fix the bucket index when checking.	Boolean	False [False]	No

Table 1.31. Response Entities
Name	Description	Type
`index`	Status of bucket index.	String

Table 1.32. Special Error Responses
Name	Description	Code
`IndexRepairFailed`	Bucket index repair failed.	409 Conflict

1.19. Remove a bucket

Removes an existing bucket.

Capabilities

`buckets=write`

Syntax

DELETE /admin/bucket?format=json HTTP/1.1
Host FULLY_QUALIFIED_DOMAIN_NAME

Table 1.33. Request Parameters
Name	Description	Type	Example	Required
`bucket`	The bucket to remove.	String	`foo_bucket`	Yes
`purge-objects`	Remove a buckets objects before deletion.	Boolean	True [False]	No

Response Entities

None.

Table 1.34. Special Error Responses
Name	Description	Code
`BucketNotEmpty`	Attempted to delete non-empty bucket.	409 Conflict
`ObjectRemovalFailed`	Unable to remove objects.	409 Conflict

1.20. Link a bucket

Link a bucket to a specified user, unlinking the bucket from any previous user.

Capabilities

`buckets=write`

Syntax

PUT /admin/bucket?format=json HTTP/1.1
Host FULLY_QUALIFIED_DOMAIN_NAME

Table 1.35. Request Parameters
Name	Description	Type	Example	Required
`bucket`	The bucket to unlink.	String	`foo_bucket`	Yes
`uid`	The user ID to link the bucket to.	String	`foo_user`	Yes

Table 1.36. Response Entities
Name	Description	Type	Parent
`bucket`	Container for single bucket information.	Container	N/A
`name`	The name of the bucket.	String	`bucket`
`pool`	The pool the bucket is stored in.	String	`bucket`
`id`	The unique bucket ID.	String	`bucket`
`marker`	Internal bucket tag.	String	`bucket`
`owner`	The user ID of the bucket owner.	String	`bucket`
`usage`	Storage usage information.	Container	`bucket`
`index`	Status of bucket index.	String	`bucket`

Table 1.37. Special Error Responses
Name	Description	Code
`BucketUnlinkFailed`	Unable to unlink bucket from specified user.	409 Conflict
`BucketLinkFailed`	Unable to link bucket to specified user.	409 Conflict

1.21. Unlink a bucket

Unlink a bucket from a specified user. Primarily useful for changing bucket ownership.

Capabilities

`buckets=write`

Syntax

POST /admin/bucket?format=json HTTP/1.1
Host FULLY_QUALIFIED_DOMAIN_NAME

Table 1.38. Request Parameters
Name	Description	Type	Example	Required
`bucket`	The bucket to unlink.	String	`foo_bucket`	Yes
`uid`	The user ID to unlink the bucket from.	String	`foo_user`	Yes

Response Entities

None.

Table 1.39. Special Error Responses
Name	Description	Code
`BucketUnlinkFailed`	Unable to unlink bucket from specified user.	409 Conflict

1.22. Get a bucket or object policy

Read the policy of an object or bucket.

Capabilities

`buckets=read`

Syntax

GET /admin/bucket?policy&format=json HTTP/1.1
Host FULLY_QUALIFIED_DOMAIN_NAME

Table 1.40. Request Parameters
Name	Description	Type	Example	Required
`bucket`	The bucket to read the policy from.	String	`foo_bucket`	Yes
`object`	The object to read the policy from.	String	`foo.txt`	No

Table 1.41. Response Entities
Name	Description	Type	Parent
`policy`	Access control policy.	Container	N/A

If successful, returns the object or bucket policy

Table 1.42. Special Error Responses
Name	Description	Code
`IncompleteBody`	Either bucket was not specified for a bucket policy request or bucket and object were not specified for an object policy request.	400 Bad Request

1.23. Remove an object

Remove an existing object.

Note

Does not require owner to be non-suspended.

Capabilities

`buckets=write`

Syntax

DELETE /admin/bucket?object&format=json HTTP/1.1
Host FULLY_QUALIFIED_DOMAIN_NAME

Table 1.43. Request Parameters
Name	Description	Type	Example	Required
`bucket`	The bucket containing the object to be removed.	String	`foo_bucket`	Yes
`object`	The object to remove.	String	`foo.txt`	Yes

Response Entities

None.

Table 1.44. Special Error Responses
Name	Description	Code
`NoSuchObject`	Specified object does not exist.	404 Not Found
`ObjectRemovalFailed`	Unable to remove objects.	409 Conflict

1.24. Quotas

The administrative Operations API enables you to set quotas on users and on bucket owned by users. Quotas include the maximum number of objects in a bucket and the maximum storage size in megabytes.

To view quotas, the user must have a users=read capability. To set, modify or disable a quota, the user must have users=write capability.

Valid parameters for quotas include:

Bucket: The bucket option allows you to specify a quota for buckets owned by a user.
Maximum Objects: The max-objects setting allows you to specify the maximum number of objects. A negative value disables this setting.
Maximum Size: The max-size option allows you to specify a quota for the maximum number of bytes. A negative value disables this setting.
Quota Scope: The quota-scope option sets the scope for the quota. The options are bucket and user.

1.25. Get a user quota

To get a quota, the user must have users capability set with read permission.

Syntax

GET /admin/user?quota&uid=UID&quota-type=user

1.26. Set a user quota

To set a quota, the user must have users capability set with write permission.

Syntax

PUT /admin/user?quota&uid=UID&quota-type=user

The content must include a JSON representation of the quota settings as encoded in the corresponding read operation.

1.27. Get a bucket quota

To get a bucket quota, the user must have users capability set with read permission.

Syntax

GET /admin/user?quota&uid=UID&quota-type=bucket

1.28. Set a bucket quota

To set a quota, the user must have users capability set with write permission.

Syntax

PUT /admin/user?quota&uid=UID&quota-type=bucket

The content must include a JSON representation of the quota settings as encoded in the corresponding read operation.

1.29. Set quota for an individual bucket

To set a quota, the user must have buckets capability set with write permission.

Syntax

PUT /admin/bucket?quota&uid=UID&bucket=BUCKET_NAME&quota

The content must include a JSON representation of the quota settings.

1.30. Get usage information

Requesting bandwidth usage information.

Capabilities

`usage=read`

Syntax

GET /admin/usage?format=json HTTP/1.1
Host: FULLY_QUALIFIED_DOMAIN_NAME

Table 1.45. Request Parameters
Name	Description	Type	Required
`uid`	The user for which the information is requested.	String.	Yes
`start`	Date and (optional) time that specifies the start time of the requested data. E.g., `2012-09-25 16:00:00`	String	No
`end`	Date and (optional) time that specifies the end time of the requested data (non-inclusive). E.g., `2012-09-25 16:00:00`	String	No
`show-entries`	Specifies whether data entries should be returned.	Boolean	No
`show-summary`	Specifies whether data summary should be returned.	Boolean	No

Table 1.46. Response Entities
Name	Description	Type
`usage`	A container for the usage information.	Container
`entries`	A container for the usage entries information.	Container
`user`	A container for the user data information.	Container
`owner`	The name of the user that owns the buckets.	String
`bucket`	The bucket name.	String
`time`	Time lower bound for which data is being specified (rounded to the beginning of the first relevant hour).	String
`epoch`	The time specified in seconds since `1/1/1970`.	String
`categories`	A container for stats categories.	Container
`entry`	A container for stats entry.	Container
`category`	Name of request category for which the stats are provided.	String
`bytes_sent`	Number of bytes sent by the Ceph Object Gateway.	Integer
`bytes_received`	Number of bytes received by the Ceph Object Gateway.	Integer
`ops`	Number of operations.	Integer
`successful_ops`	Number of successful operations.	Integer
`summary`	A container for stats summary.	Container
`total`	A container for stats summary aggregated total.	Container

If successful, the response contains the requested information.

1.31. Remove usage information

Remove usage information. With no dates specified, removes all usage information.

Capabilities

`usage=write`

Syntax

DELETE /admin/usage?format=json HTTP/1.1
Host: FULLY_QUALIFIED_DOMAIN_NAME

Table 1.47. Request Parameters
Name	Description	Type	Example	Required
`uid`	The user for which the information is requested.	String	`foo_user`	No
`start`	Date and (optional) time that specifies the start time of the requested data.	String	`2012-09-25 16:00:00`	No
`end`	Date and (optional) time that specifies the end time of the requested data (none inclusive).	String	`2012-09-25 16:00:00`	No
`remove-all`	Required when `uid` is not specified, in order to acknowledge multi-user data removal.	Boolean	True [False]	No

1.32. Standard error responses

The following table details standard error responses and their descriptions.

Name	Description	Code
`AccessDenied`	Access denied.	403 Forbidden
`InternalError`	Internal server error.	500 Internal Server Error
`NoSuchUser`	User does not exist.	404 Not Found
`NoSuchBucket`	Bucket does not exist.	404 Not Found
`NoSuchKey`	No such access key.	404 Not Found

Chapter 1. Ceph Object Gateway administrative API

1.1. Prerequisites

1.2. Administration operations

1.3. Administration authentication requests

1.4. Creating an administrative user

1.5. Get user information

1.6. Create a user

1.7. Modify a user

1.8. Remove a user

1.9. Create a subuser

1.10. Modify a subuser

1.11. Remove a subuser

1.12. Add capabilities to a user

1.13. Remove capabilities from a user

1.14. Create a key

1.15. Remove a key

1.16. Bucket notifications

1.16.1. Prerequisites

1.16.2. Creating a topic

1.16.3. Getting topic information

1.16.4. Listing topics

1.16.5. Deleting topics

1.16.6. Event record

1.16.7. Supported event types

1.16.8. Additional Resources

1.17. Get bucket information

1.18. Check a bucket index

1.19. Remove a bucket

1.20. Link a bucket

1.21. Unlink a bucket

1.22. Get a bucket or object policy

1.23. Remove an object

1.24. Quotas

1.25. Get a user quota

1.26. Set a user quota

1.27. Get a bucket quota

1.28. Set a bucket quota

1.29. Set quota for an individual bucket

1.30. Get usage information

1.31. Remove usage information

1.32. Standard error responses

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

Making open source more inclusive

About Red Hat

Red Hat legal and privacy links

Red Hat legal and privacy links