OpenStack API Documentation

Database Service API v1.0 (CURRENT)

API versions

GET

List versions

Lists information about all Database Service API versions.

Normal response codes

200

Error response codes

badRequest (400), unauthorized (401), forbidden (403), badMethod (405), overLimit (413), unprocessableEntity (422), instanceFault (500), notImplemented (501), serviceUnavailable (503), itemNotFound (404)

GET / HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 153
Date: Wed, 25 Jan 2012 21:53:04 GMT

{
    "versions": [
        {
            "id": "v1.0",
            "links": [
                {
                    "href": "https://openstack.example.com/v1.0/",
                    "rel": "self"
                }
            ],
            "status": "CURRENT",
            "updated": "2012-01-01T00:00:00Z"
        }
    ]
}

GET

/v1.0

Show version details

Shows details for the Database Service API v1.0.

Normal response codes

200

Error response codes

GET /v1.0/ HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 158
Date: Tue, 22 Apr 2014 19:02:58 GMT

{
    "versions": [
        {
            "status": "CURRENT",
            "updated": "2012-08-01T00:00:00Z",
            "id": "v1.0",
            "links": [
                {
                    "href": "http://23.253.228.211:8779/v1.0/",
                    "rel": "self"
                }
            ]
        }
    ]
}

Database instances (instances)

POST

/v1.0/{accountId}/instances

Create database instance

Creates a database instance.

This operation asynchronously provisions a new database instance. This call requires the user to specify a flavor and a volume size. The service then provisions the instance with the requested flavor and sets up a volume of the specified size, which is the storage for the database instance.

Notes

You can create only one database instance per POST request.
You can create a database instance with one or more databases, and users associated to those databases.
The default binding for the MySQL instance is port 3306.

Normal response codes

200

Error response codes

Request parameters

Parameter	Style	Type	Description
accountId	URI	xsd:string	The account ID of the owner of the specified instance.
instance	plain	xsd:string	An `instance` object.
flavorRef	plain	xsd:string	Reference (href), which is the actual URI to a flavor as specified in the response from the list flavors API call. Rather than the flavor URI, you can also pass the flavor id (integer) as the value for `flavorRef`. For example, the flavor ID for the flavor URI shown above is `1`.
size	plain	xsd:int	The volume size, in gigabytes (GB). A valid value is from 1 to 50.
databases	plain	xsd:string	A `databases` object.
name (Optional)	plain	xsd:string	Name of the instance to create. A valid value is up to 255 characters long. All characters are permitted.
name (Optional)	plain	xsd:string	Specifies database names for creating databases on instance creation.
character_set (Optional)	plain	xsd:string	Set of symbols and encodings. The default character set is `utf8`.
collate (Optional)	plain	xsd:string	Set of rules for comparing characters in a character set. The default value for collate is `utf8_general_ci`.
users	plain	xsd:string	A `users` object.
name (Optional)	plain	xsd:string	The user name for the database on instance creation.
password (Optional)	plain	xsd:string	The password for those users on instance creation.

POST /v1.0/1234/instances HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: d6cafa5b-e0c7-4ab8-948e-7c95f2acd031
Accept: application/json
Content-Type: application/json

{
    "instance": {
        "databases": [
            {
                "character_set": "utf8",
                "collate": "utf8_general_ci",
                "name": "sampledb"
            },
            {
                "name": "nextround"
            }
        ],
        "flavorRef": "https://openstack.example.com/v1.0/1234/flavors/1",
        "name": "json_rack_instance",
        "users": [
            {
                "databases": [
                    {
                        "name": "sampledb"
                    }
                ],
                "name": "demouser",
                "password": "secretsecret"
            }
        ],
        "volume": {
            "size": 2
        }
    }
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 636
Date: Wed, 25 Jan 2012 21:53:10 GMT

{
    "instance": {
        "created": "2012-01-25T21:53:09Z",
        "flavor": {
            "id": "1",
            "links": [
                {
                    "href": "https://openstack.example.com/v1.0/1234/flavors/1",
                    "rel": "self"
                },
                {
                    "href": "https://openstack.example.com/flavors/1",
                    "rel": "bookmark"
                }
            ]
        },
        "hostname": "e09ad9a3f73309469cf1f43d11e79549caf9acf2.rackspaceclouddb.com",
        "id": "dea5a2f7-3ec7-4496-adab-0abb5a42d635",
        "links": [
            {
                "href": "https://openstack.example.com/v1.0/1234/instances/dea5a2f7-3ec7-4496-adab-0abb5a42d635",
                "rel": "self"
            },
            {
                "href": "https://openstack.example.com/instances/dea5a2f7-3ec7-4496-adab-0abb5a42d635",
                "rel": "bookmark"
            }
        ],
        "name": "json_rack_instance",
        "status": "BUILD",
        "updated": "2012-01-25T21:53:10Z",
        "volume": {
            "size": 2
        }
    }
}

GET

/v1.0/{accountId}/instances

List database instances

Lists information, including status, for all database instances.

Lists status and information for all database instances.

Normal response codes

200

Error response codes

Request parameters

Parameter	Style	Type	Description
accountId	URI	xsd:string	The account ID of the owner of the specified instance.

GET /v1.0/1234/instances HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1150
Date: Tue, 19 Jun 2012 19:53:04 GMT

{
    "instances": [
        {
            "flavor": {
                "id": "1",
                "links": [
                    {
                        "href": "https://openstack.example.com/v1.0/1234/flavors/1",
                        "rel": "self"
                    },
                    {
                        "href": "https://openstack.example.com/flavors/1",
                        "rel": "bookmark"
                    }
                ]
            },
            "id": "28d1b8f3-172a-4f6d-983d-36021508444a",
            "links": [
                {
                    "href": "https://openstack.example.com/v1.0/1234/instances/28d1b8f3-172a-4f6d-983d-36021508444a",
                    "rel": "self"
                },
                {
                    "href": "https://openstack.example.com/instances/28d1b8f3-172a-4f6d-983d-36021508444a",
                    "rel": "bookmark"
                }
            ],
            "name": "json_rack_instance",
            "status": "ACTIVE",
            "volume": {
                "size": 2
            }
        },
        {
            "flavor": {
                "id": "1",
                "links": [
                    {
                        "href": "https://openstack.example.com/v1.0/1234/flavors/1",
                        "rel": "self"
                    },
                    {
                        "href": "https://openstack.example.com/flavors/1",
                        "rel": "bookmark"
                    }
                ]
            },
            "id": "8fb081af-f237-44f5-80cc-b46be1840ca9",
            "links": [
                {
                    "href": "https://openstack.example.com/v1.0/1234/instances/8fb081af-f237-44f5-80cc-b46be1840ca9",
                    "rel": "self"
                },
                {
                    "href": "https://openstack.example.com/instances/8fb081af-f237-44f5-80cc-b46be1840ca9",
                    "rel": "bookmark"
                }
            ],
            "name": "xml_rack_instance",
            "status": "ACTIVE",
            "volume": {
                "size": 2
            }
        }
    ]
}

GET

/v1.0/{accountId}/instances/{instanceId}

Show database instance details

Shows database instance details.

Lists the status and details of the specified database instance.

Lists the volume size in gigabytes (GB) and the approximate GB used.

After instance creation, the used value is greater than 0, which is expected and due to the automatic creation of non-empty transaction logs for MySQL optimization. The used attribute is not returned in the response when the instance status is BUILD, REBOOT, RESIZE, or ERROR.

The list operations return a DNS-resolvable host name that is associated with the database instance rather than an IP address. Because the host name always resolves to the correct IP address for the database instance, you do not need to maintain the mapping. Although the IP address might change when you resize, migrate, or perform other operations, the host name always resolves to the correct database instance.

Normal response codes

200

Error response codes

Request parameters

Parameter	Style	Type	Description
accountId	URI	xsd:string	The account ID of the owner of the specified instance.
instanceId	URI	xsd:string	The instance ID for the specified database instance.

GET /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 685
Date: Wed, 28 Mar 2012 21:37:29 GMT

{
    "instance": {
        "created": "2012-03-28T21:31:02Z",
        "flavor": {
            "id": "1",
            "links": [
                {
                    "href": "https://openstack.example.com/v1.0/1234/flavors/1",
                    "rel": "self"
                },
                {
                    "href": "https://openstack.example.com/flavors/1",
                    "rel": "bookmark"
                }
            ]
        },
        "hostname": "e09ad9a3f73309469cf1f43d11e79549caf9acf2.rackspaceclouddb.com",
        "id": "2450c73f-7805-4afe-a42c-4094ab42666b",
        "links": [
            {
                "href": "https://openstack.example.com/v1.0/1234/instances/2450c73f-7805-4afe-a42c-4094ab42666b",
                "rel": "self"
            },
            {
                "href": "https://openstack.example.com/instances/2450c73f-7805-4afe-a42c-4094ab42666b",
                "rel": "bookmark"
            }
        ],
        "name": "xml_rack_instance",
        "status": "ACTIVE",
        "updated": "2012-03-28T21:34:25Z",
        "volume": {
            "size": 2,
            "used": 0.124542236328125
        }
    }
}

DELETE

/v1.0/{accountId}/instances/{instanceId}

Delete database instance

Deletes a specified database instance, including any associated data.

This operation does not delete any read slaves.

This operation is not permitted when the instance state is either REBUILDING or BUILDING.

Normal response codes

202

Error response codes

Request parameters

Parameter	Style	Type	Description
accountId	URI	xsd:string	The account ID of the owner of the specified instance.
instanceId	URI	xsd:string	The instance ID for the specified database instance.

DELETE /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json

HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 0
Date: Wed, 27 Jun 2012 23:15:51 GMT

This operation does not return a response body.

PUT

/v1.0/{accountId}/instances/{instanceId}

Attach configuration group

Attaches a configuration group to a specified instance.

Normal response codes

202

Error response codes

Request parameters

Parameter	Style	Type	Description
accountId	URI	xsd:string	The account ID of the owner of the specified instance.
instanceId	URI	xsd:string	The instance ID for the specified database instance.
configuration	plain	xsd:string	ID of the configuration group that you want to attach to the instance.

PUT /v1.0/1234/instances/4c93c73b-d6d0-47d7-b8c6-b699d19d7de9 HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json

{
    "instance": {
        "configuration": "2aa51628-5c42-4086-8682-137caffd2ba6"
    }
}

HTTP/1.1 202 OK
Content-Type: application/json
Content-Length: 0
Date: Mon, 13 Jul 2015 19:53:04 GMT

PUT

/v1.0/{accountId}/instances/{instanceId}

Detach configuration group

Detaches a configuration group from a specified instance.

When you pass in only an instance ID (no configuration ID), this operation detaches whatever configuration group was attached to the specified instance.

Normal response codes

202

Error response codes

Request parameters

Parameter	Style	Type	Description
accountId	URI	xsd:string	The account ID of the owner of the specified instance.
instanceId	URI	xsd:string	The instance ID for the specified database instance.
configuration	plain	xsd:string	To detach a configuration group, set the configuration parameter to null.

PUT /v1.0/1234/instances/4c93c73b-d6d0-47d7-b8c6-b699d19d7de9 HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json

{
    "instance": {}
}

HTTP/1.1 202 OK
Content-Type: application/json
Content-Length: 0
Date: Mon, 13 Jul 2015 19:53:04 GMT

GET

/v1.0/{accountId}/instances/{instanceId}

List configuration defaults

Lists the configuration defaults for a specified instance.

Normal response codes

200

Error response codes

Request parameters

Parameter	Style	Type	Description
accountId	URI	xsd:string	The account ID of the owner of the specified instance.
instanceId	URI	xsd:string	The instance ID for the specified database instance.

GET /v1.0/1234/instances/instance_1 HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1559
Date: Wed, 08 Jul 2015 19:53:04 GMT

{
    "instance": {
        "configuration": {
            "tmp_table_size": "16M",
            "innodb_log_files_in_group": "2",
            "skip-external-locking": "1",
            "read_rnd_buffer_size": "512 K",
            "max_user_connections": "100",
            "max_heap_table_size": "16M",
            "port": "3306",
            "tmpdir": "/var/tmp",
            "pid_file": "/var/run/mysqld/mysqld.pid",
            "myisam-recover ": "BACKUP",
            "server_id": "334596",
            "innodb_buffer_pool_size": "150M",
            "basedir": "/usr",
            "max_allowed_packet": "1024K",
            "datadir": "/var/lib/mysql/data",
            "inno db_log_buffer_size": "25M",
            "max_connections": "100",
            "table_open_cache": "256",
            "connect_timeout": "15",
            "query_cache_type": "1",
            "local-infile": "0",
            "innodb_ log_file_size": "50M",
            "thread_stack": "192K",
            "query_cache_limit": "1M",
            "wait_timeout": "120",
            "user": "mysql",
            "thread_cache_size": "4",
            "query_cache_size": "8M",
            "innodb_data_file_path": "ibdata1:10M:autoextend",
            "default_storage_engine": "innodb",
            "sort_buffer_size": "1M",
            "table_definition_cache": "256",
            "read_bu ffer_size": "512K",
            "open_files_limit": "512",
            "innodb_file_per_table": "1",
            "key_buffer_size": "50M",
            "join_buffer_size": "1M"
        }
    }
}

POST

/v1.0/{accountId}/instances/{instanceId}/root

Enable root user

Enables the root user for a specified database instance and returns the root password.

This operation enables login from any host for the root user and provides the user with a generated root password.

Changes you make as a root user may cause detrimental effects to the database instance and unpredictable behavior for API operations. When you enable the root user, you accept the possibility that we will not be able to support your database instance. While enabling root does not prevent us from a “best effort” approach to helping you if something goes wrong with your instance, we cannot ensure that we will be able to assist you if you change core MySQL settings. These changes can be (but are not limited to) turning off binlogs, removing users that we use to access your instance, and so forth.

Normal response codes

200

Error response codes

Request parameters

Parameter	Style	Type	Description
accountId	URI	xsd:string	The account ID of the owner of the specified instance.
instanceId	URI	xsd:string	The instance ID for the specified database instance.

POST /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/root HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 78
Date: Wed, 25 Jan 2012 21:58:11 GMT

{
    "user": {
        "name": "root",
        "password": "secretsecret"
    }
}

GET

/v1.0/{accountId}/instances/{instanceId}/root

Show root-enabled status for database instance

Shows root-enabled status for a database instance.

Returns true if root user is enabled for a specified database instance or false otherwise.

This operation checks an active specified database instance to see if root access is enabled. It returns True if root user is enabled for the specified database instance or False otherwise.

Normal response codes

200

Error response codes

Request parameters

Parameter	Style	Type	Description
accountId	URI	xsd:string	The account ID of the owner of the specified instance.
instanceId	URI	xsd:string	The instance ID for the specified database instance.

GET /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/root HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 21
Date: Wed, 25 Jan 2012 21:58:13 GMT

{
    "rootEnabled": true
}

Database instance actions (action)

POST

/v1.0/{accountId}/instances/{instanceId}/action

Resize instance

Resizes the memory for an instance.

If you provide a valid flavorRef, this operation changes the memory size of the instance, and restarts MySQL.

Normal response codes

202

Error response codes

Request parameters

Parameter	Style	Type	Description
accountId	URI	xsd:string	The account ID of the owner of the specified instance.
instanceId	URI	xsd:string	The instance ID for the specified database instance.

POST /v1.0/1234/instances/23a3d4fb-3731-497b-afd4-bf25bde2b5fc/action HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 2eeb3252-0164-40f5-8fb7-85df5faa2698
Accept: application/json
Content-Type: application/json

{
    "resize": {
        "flavorRef": "https://openstack.example.com/v1.0/1234/flavors/2"
    }
}

HTTP/1.1 202 Accepted
Content-Type: text/plain; charset=UTF-8
Content-Length: 58
Date: Mon, 06 Feb 2012 21:28:10 GMT

POST

/v1.0/{accountId}/instances/{instanceId}/action

Resize instance volume

Resizes the volume that is attached to an instance.

You can use this operation to increase but not decrease the volume size. A valid volume size is an integer value in gigabytes (GB).

You cannot increase the volume to a size that is larger than the API volume size limit.

If this operation succeeds, it returns a 202 Accepted response.

Normal response codes

202

Error response codes

Request parameters

Parameter	Style	Type	Description
accountId	URI	xsd:string	The account ID of the owner of the specified instance.
instanceId	URI	xsd:string	The instance ID for the specified database instance.

POST /v1.0/1234/instances/23a3d4fb-3731-497b-afd4-bf25bde2b5fc/action HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 2eeb3252-0164-40f5-8fb7-85df5faa2698
Accept: application/json
Content-Type: application/json

{
    "resize": {
        "volume": {
            "size": 4
        }
    }
}

HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 0
Date: Wed, 27 Jun 2012 23:12:20 GMT

POST

/v1.0/{accountId}/instances/{instanceId}/action

Restart instance

Restarts the database service for a specified instance.

The restart operation restarts only the MySQL instance. Restarting MySQL erases any dynamic configuration settings that you make in MySQL.

The MySQL service is unavailable until the instance restarts.

If the operation succeeds, it returns a 202 Accepted response.

Normal response codes

202

Error response codes

Request parameters

Parameter	Style	Type	Description
accountId	URI	xsd:string	The account ID of the owner of the specified instance.
instanceId	URI	xsd:string	The instance ID for the specified database instance.

POST /v1.0/1234/instances/13d940c4-70bb-4ff4-8866-6ee9ab5e5cae/action HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json

{
    "restart": {}
}

HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 0
Date: Wed, 27 Jun 2012 23:11:19 GMT

Databases (databases)

POST

/v1.0/{accountId}/instances/{instanceId}/databases

Create database

Creates a database within a specified instance.

This operation creates a new database within the specified instance.

The name of the database is a required attribute.

The following additional attributes can be specified for each database: collate and character_set.

Required and optional attributes for creating a database
Name	Description	Required
name	Specifies the database name for creating the database. See the request examples for the required xml/json format.	Yes
character_set	Set of symbols and encodings. The default character set is `utf8`.	No
collate	Set of rules for comparing characters in a character set. The default value for collate is `utf8_general_ci`.	No

See the MySQL documentation for information about supported character sets and collations at http://dev.mysql.com/doc/refman/5.1/en/charset-mysql.html.

The following database names are reserved and cannot be used for creating databases: lost+found, information_schema, and mysql.

See the following tables for information about characters that are valid/invalid for creating database names.

Valid characters in a database name
Character
Letters (upper and lower cases allowed)
Numbers
'@', '?', '#', and spaces are allowed, but not at the beginning and end of the database name
'_' is allowed anywhere in the database name

Characters that cannot be used in a database name
Character
Single quotes
Double quotes
Back quotes
Semicolons
Commas
Backslashes
Forwardslashes

Length restrictions for database name
Restriction	Value
Database-name maximum length	64

Normal response codes

202

Error response codes

Request parameters

Parameter	Style	Type	Description
accountId	URI	xsd:string	The account ID of the owner of the specified instance.
instanceId	URI	xsd:string	The instance ID for the specified database instance.

POST /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/databases HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json

{
    "databases": [
        {
            "character_set": "utf8",
            "collate": "utf8_general_ci",
            "name": "testingdb"
        },
        {
            "name": "sampledb"
        }
    ]
}

HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 0
Date: Wed, 27 Jun 2012 23:11:18 GMT

GET

/v1.0/{accountId}/instances/{instanceId}/databases

List instance databases

Lists databases for a specified instance.

This operation lists the databases for the specified instance.

This operation returns only the user-defined databases, not the system databases. The system databases (mysql, information_schema, lost+found) can only be viewed by a database administrator.

Normal response codes

200

Error response codes

Request parameters

Parameter	Style	Type	Description
accountId	URI	xsd:string	The account ID of the owner of the specified instance.
instanceId	URI	xsd:string	The instance ID for the specified database instance.

GET /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/databases HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 136
Date: Wed, 25 Jan 2012 21:58:01 GMT

{
    "databases": [
        {
            "name": "anotherexampledb"
        },
        {
            "name": "exampledb"
        },
        {
            "name": "nextround"
        },
        {
            "name": "sampledb"
        },
        {
            "name": "testingdb"
        }
    ]
}

DELETE

/v1.0/{accountId}/instances/{instanceId}/databases/{databaseName}

Delete database

Deletes a specified database.

This operation deletes the requested database within the specified database instance. Note that all data associated with the database is also deleted.

Normal response codes

202

Error response codes

Request parameters

Parameter	Style	Type	Description
accountId	URI	xsd:string	The account ID of the owner of the specified instance.
instanceId	URI	xsd:string	The instance ID for the specified database instance.
databaseName	URI	xsd:string	The name for the specified database.

DELETE /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/databases/exampledb HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json

HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 0
Date: Wed, 27 Jun 2012 23:11:18 GMT

Users (users)

POST

/v1.0/{accountId}/instances/{instanceId}/users

Create user

Creates a user for a specified database instance.

This operation asynchronously provisions a new user for the specified database instance based on the configuration defined in the request object. Once the request is validated and progress has started on the provisioning process, a 202 Accepted response object is returned.

Writer: please add the following note back into the doc once the list User details call is added back into the API: Using the identifier, the caller can check on the progress of the operation by performing a GET on users/name (for more details on this operation see the "List User details" section of this document).

If the corresponding request cannot be fulfilled due to insufficient or invalid data, an HTTP 400 "Bad Request" error response is returned with information regarding the nature of the failure. Failures in the validation process are non-recoverable and require the caller to correct the cause of the failure and POST the request again.

The following table lists the required attributes for creating user. See the request examples for the required xml/json format:

Required attributes for creating a user
Applies To	Name	Description	Required
User	name	Name of the user for the database.	Yes
	password	User password for database access.	Yes
	(database) name	Name of the database that the user can access. One or more database names must be specified.	No

Notes

A user is granted all privileges on the specified databases.
The following user name is reserved and cannot be used for creating users: root.

See the following tables for information about characters that are valid/invalid for creating database names, user names, and passwords.

Valid characters in a database name, user name, and password
Character
Letters (upper and lower cases allowed)
Numbers
'@', '?', '#', and spaces are allowed, but not at the beginning and end of the database name, user name, and password
"_" is allowed anywhere in the database name, user name, and password

Characters that cannot be used in a database name, user name, and password
Character
Single quotes
Double quotes
Back quotes
Semicolons
Commas
Backslashes
Forwardslashes
Spaces at the front or end of the user name or password

Length restrictions for database name, user name, and password
Restriction	Value
Database name maximum length	64
User name maximum length	16
Password maximum length	unlimited (no restrictions)

Normal response codes

202

Error response codes

Request parameters

Parameter	Style	Type	Description
accountId	URI	xsd:string	The account ID of the owner of the specified instance.
instanceId	URI	xsd:string	The instance ID for the specified database instance.

POST /v1.0/1234/instances/1c59bdb8-03b6-4079-a7db-ba92d23a98b3/users HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: bb64d788-2dec-4a6b-a670-7151d108cacf
Accept: application/json
Content-Type: application/json

{
    "users": [
        {
            "databases": [
                {
                    "name": "databaseA"
                }
            ],
            "name": "dbuser3",
            "password": "secretsecret"
        },
        {
            "databases": [
                {
                    "name": "databaseB"
                },
                {
                    "name": "databaseC"
                }
            ],
            "name": "dbuser4",
            "password": "secretsecret"
        }
    ]
}

HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 0
Date: Wed, 27 Jun 2012 23:11:18 GMT

GET

/v1.0/{accountId}/instances/{instanceId}/users

List database instance users

Lists the users in a specified database instance.

This operation lists the users in the specified database instance, along with the associated databases for that user.

This operation does not return the system users (database administrators that administer the health of the database). Also, this operation returns the "root" user only if "root" user has been enabled.

The following notes apply to MySQL users:

User names can be up to 16 characters long.
When you create accounts with INSERT, you must use FLUSH PRIVILEGES to tell the server to reload the grant tables.
For additional information, See: http://dev.mysql.com/doc/refman/5.1/en/user-account-management.html

Normal response codes

200

Error response codes

Request parameters

Parameter	Style	Type	Description
accountId	URI	xsd:string	The account ID of the owner of the specified instance.
instanceId	URI	xsd:string	The instance ID for the specified database instance.

GET /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/users HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 152
Date: Wed, 21 Mar 2012 17:46:46 GMT

{
    "users": [
        {
            "databases": [
                {
                    "name": "databaseA"
                }
            ],
            "name": "dbuser3"
        },
        {
            "databases": [
                {
                    "name": "databaseB"
                },
                {
                    "name": "databaseC"
                }
            ],
            "name": "dbuser4"
        }
    ]
}

DELETE

/v1.0/{accountId}/instances/{instanceId}/users/{name}

Delete user

Deletes a specified user for a specified database instance.

This operation deletes the specified user for the specified database instance.

There is a bug in a python library that Rackspace is using that may cause incorrect user deletions to occur if a period (.) is used in the user name. In this case, the user name is truncated to remove the portion of the name from the period to the end, leaving only the portion from the beginning up to the period. For example, for a user named "my.userA", the bug would truncate the user name to "my", and if the user "my" exists, that user will be incorrectly deleted. To avoid the problem, do not use periods in user names.

Normal response codes

202

Error response codes

Request parameters

Parameter	Style	Type	Description
accountId	URI	xsd:string	The account ID of the owner of the specified instance.
instanceId	URI	xsd:string	The instance ID for the specified database instance.
name	URI	xsd:string	The name for the specified user.

DELETE /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/users/testuser HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json

HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 0
Date: Wed, 27 Jun 2012 23:11:19 GMT

Flavors (flavors)

GET

/v1.0/{accountId}/flavors

List flavors

Lists information for all available flavors.

This operation lists information for all available flavors.

This resource is identical to the flavors found in the OpenStack Nova API, but without the disk property.

Normal response codes

200

Error response codes

Request parameters

Parameter	Style	Type	Description
accountId	URI	xsd:string	The account ID of the owner of the specified instance.

GET /v1.0/1234/flavors HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1768
Date: Tue, 19 Jun 2012 19:52:45 GMT

{
    "flavors": [
        {
            "id": 1,
            "links": [
                {
                    "href": "https://openstack.example.com/v1.0/1234/flavors/1",
                    "rel": "self"
                },
                {
                    "href": "https://openstack.example.com/flavors/1",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.tiny",
            "ram": 512
        },
        {
            "id": 2,
            "links": [
                {
                    "href": "https://openstack.example.com/v1.0/1234/flavors/2",
                    "rel": "self"
                },
                {
                    "href": "https://openstack.example.com/flavors/2",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.small",
            "ram": 1024
        },
        {
            "id": 3,
            "links": [
                {
                    "href": "https://openstack.example.com/v1.0/1234/flavors/3",
                    "rel": "self"
                },
                {
                    "href": "https://openstack.example.com/flavors/3",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.medium",
            "ram": 2048
        },
        {
            "id": 4,
            "links": [
                {
                    "href": "https://openstack.example.com/v1.0/1234/flavors/4",
                    "rel": "self"
                },
                {
                    "href": "https://openstack.example.com/flavors/4",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.large",
            "ram": 4096
        }
    ]
}

GET

/v1.0/{accountId}/flavors/{flavorId}

Show flavor details

Shows flavor details.

This operation lists all information for the specified flavor ID with details of the RAM.

This resource is identical to the flavors found in the OpenStack Nova API, but without the disk property.

The flavorId parameter should be an integer. If a floating point value is used for the flavorId parameter, the decimal portion is truncated and the integer portion is used as the value of the flavorId.

Writer: need to confirm that this behavior is not changed in subsequent releases, and if it is prevented, remove the Note above.

Normal response codes

200

Error response codes

Request parameters

Parameter	Style	Type	Description
accountId	URI	xsd:string	The account ID of the owner of the specified instance.
flavorId	URI	xsd:string	The flavor ID for the specified flavor.

GET /v1.0/1234/flavors/1 HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 209
Date: Wed, 25 Jan 2012 21:53:05 GMT

{
    "flavor": {
        "id": 1,
        "links": [
            {
                "href": "https://openstack.example.com/v1.0/1234/flavors/1",
                "rel": "self"
            },
            {
                "href": "https://openstack.example.com/flavors/1",
                "rel": "bookmark"
            }
        ],
        "name": "m1.tiny",
        "ram": 512
    }
}

Datastores (datastores)

GET

/v1.0/{accountId}/datastores/{datastore_name}/versions

List datastore versions

Lists the available versions of a specified datastore.

Normal response codes

200

Error response codes

Request parameters

Parameter	Style	Type	Description
accountId	URI	xsd:string	The account ID of the owner of the specified instance.
datastore_name	URI	xsd:uuid	The name of the datastore whose versions you want to list.

GET /v1.0/1234/datastores/mysql/versions HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 580
Date: Tue, 23 Jun 2015 21:58:13 GMT

{
    "name": "5.6",
    "links": [
        {
            "href": "https://10.240.28.38:8779/v1.0/27bee406abb5486e81ef3ff4382aabaf/datastores/versions/2dc7faa0-efff-4c2b-8cff-bcd949c518a5",
            "rel": "self"
        },
        {
            "href": "https://10.240.28.38:8779/datastores/versions/2dc7faa0-efff-4c2b-8cff-bcd949c518a5",
            "rel": "bookmark"
        }
    ],
    "image": "b69fbd9e-b31d-46ff-8afb-cbf452f6f835",
    "active": 1,
    "datastore": "3a8968d8-e5f5-4452-83ca-f6c90b5de06a",
    "packages": "mysql-server-5.6",
    "id": "2dc7faa0-efff-4c2b-8cff-bcd949c518a5"
}

GET

/v1.0/{accountId}/datastores/versions/{datastore_version_id}/parameters

List configuration parameters

Lists the available configuration parameters for a specified datastore version.

Parameter information includes the type, minimum and maximum values, and whether you must restart the instance after you change a parameter value.

Normal response codes

200

Error response codes

Request parameters

Parameter	Style	Type	Description
accountId	URI	xsd:string	The account ID of the owner of the specified instance.
datastore_version_id	URI	xsd:uuid	The ID of the data store version.

GET /v1.0/1234/datastores/versions/692d8418-7a8f-47f1-8060-59846c6e024f/parameters HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 8454
Date: Fri, 12 Jun 2015 21:58:13 GMT

{
    "configuration-parameters": [
        {
            "name": "myisam_sort_buffer_size",
            "min": 4096,
            "max": 18446744073709552000,
            "restart_required": false,
            "type": "integer",
            "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758"
        },
        {
            "name": "sync_binlog",
            "min": 0,
            "max": 4294967295,
            "restart_required": false,
            "type": "integer",
            "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758"
        },
        {
            "name": "max_allowed_packet",
            "min": 1024,
            "max": 1073741824,
            "restart_required": false,
            "type": "integer",
            "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758"
        },
        {
            "type": "string",
            "name": "character_set_connection",
            "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758",
            "restart_required": false
        },
        {
            "name": "autocommit",
            "min": 0,
            "max": 1,
            "restart_required": false,
            "type": "integer",
            "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758"
        },
        {
            "type": "string",
            "name": "character_set_client",
            "datastore_version_id": "f597f709-70ef474d-ac18-2c6abd35a758",
            "restart_required": false
        },
        {
            "name": "join_buffer_size",
            "min": 128,
            "max": 18446744073709548000,
            "restart_required": false,
            "type": "integer",
            "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758"
        },
        {
            "name": "local_infile",
            "min": 0,
            "max": 1,
            "restart_required": false,
            "type": "integer",
            "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758"
        },
        {
            "name": "auto_increment_offset",
            "min": 1,
            "max": 65535,
            "restart_required": false,
            "type": "integer",
            "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758"
        },
        {
            "name": "max_connections",
            "min": 1,
            "max": 100000,
            "restart_required": false,
            "type": "integer",
            "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758"
        },
        {
            "name": "bulk_insert_buffer_size",
            "min": 0,
            "max": 18446744073709552000,
            "restart_required": false,
            "type": "integer",
            "datastore_version_id": "f597f709-70ef474dac18-2c6abd35a758"
        },
        {
            "name": "sort_buffer_size",
            "min": 32768,
            "max": 18446744073709552000,
            "restart_required": false,
            "type": "integer",
            "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758"
        },
        {
            "name": "innodb_log_buffer_size",
            "min": 262144,
            "max": 4294967295,
            "restart_required": true,
            "type": "integer",
            "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758"
        },
        {
            "name": "innodb_file_per_table",
            "min": 0,
            "max": 1,
            "restart_required": false,
            "type": "integer",
            "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758"
        },
        {
            "type": "string",
            "name": "character_set_server",
            "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758",
            "restart_required": false
        },
        {
            "name": "innodb_buffer_pool_size",
            "min": 5242880,
            "max": 18446744073709552000,
            "restart_required": true,
            "type": "integer",
            "datastore_version_id": "f597f709-70ef474dac18-2c6abd35a758"
        },
        {
            "type": "string",
            "name": "collation_server",
            "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758",
            "restart_required": false
        },
        {
            "type": "string",
            "name": "character_set_filesystem",
            "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758",
            "restart_required": false
        },
        {
            "type": "string",
            "name": "collation_database",
            "datastore_version_id": "f597f709-70ef474d-ac18-2c6abd35a758",
            "restart_required": false
        },
        {
            "name": "innodb_flush_log_at_trx_commit",
            "min": 0,
            "max": 2,
            "restart_required": false,
            "type": "integer",
            "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758"
        },
        {
            "name": "interactive_timeout",
            "min": 1,
            "max": 65535,
            "restart_required": false,
            "type": "integer",
            "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758"
        },
        {
            "name": "max_user_connections",
            "min": 0,
            "max": 4294967295,
            "restart_required": false,
            "type": "integer",
            "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758"
        },
        {
            "name": "innodb_thread_concurrency",
            "min": 0,
            "max": 1000,
            "restart_required": false,
            "type": "integer",
            "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758"
        },
        {
            "name": "innodb_open_files",
            "min": 10,
            "max": 4294967295,
            "restart_required": true,
            "type": "integer",
            "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758"
        },
        {
            "name": "key_buffer_size",
            "min": 8,
            "max": 4294967295,
            "restart_required": false,
            "type": "integer",
            "datastore_version_id": "f597f709-70ef474d-ac18-2c6abd35a758"
        },
        {
            "name": "connect_timeout",
            "min": 2,
            "max": 31536000,
            "restart_required": false,
            "type": "integer",
            "datastore_version_id": "f597f709-70ef474d-ac18-2c6abd35a758"
        },
        {
            "type": "string",
            "name": "collation_connection",
            "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758",
            "restart_required": false
        },
        {
            "type": "string",
            "name": "character_set_database",
            "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758",
            "restart_required": false
        },
        {
            "name": "auto_increment_increment",
            "min": 1,
            "max": 65535,
            "restart_required": false,
            "type": "integer",
            "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758"
        },
        {
            "name": "max_connect_errors",
            "min": 1,
            "max": 18446744073709552000,
            "restart_required": false,
            "type": "integer",
            "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758"
        },
        {
            "type": "string",
            "name": "character_set_results",
            "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758",
            "restart_required": false
        },
        {
            "name": "expire_logs_days",
            "min": 0,
            "max": 99,
            "restart_required": false,
            "type": "integer",
            "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758"
        },
        {
            "name": "wait_timeout",
            "min": 1,
            "max": 31536000,
            "restart_required": false,
            "type": "integer",
            "datastore_version_id": "f597f709-70ef474d-ac18-2c6abd35a758"
        },
        {
            "name": "server_id",
            "min": 0,
            "max": 4294967295,
            "restart_required": false,
            "type": "integer",
            "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758"
        }
    ]
}

GET

/v1.0/{accountId}/datastores/versions/{datastore_version_id}/parameters/{parameter_name}

Show configuration parameter details

Displays details for a configuration parameter associated with a specified datastore version.

Details include the type, minimum and maximum values, and whether you must restart the instance after you change the parameter value.

Normal response codes

200

Error response codes

Request parameters

Parameter	Style	Type	Description
accountId	URI	xsd:string	The account ID of the owner of the specified instance.
datastore_version_id	URI	xsd:uuid	The ID of the data store version.
parameter_name	URI	xsd:uuid	Name of the parameter whose details you want.

GET /v1.0/1234/datastores/versions/f8e67741-e767-4137-b394-3fb8a3fafd2f/parameters/connect_timeout HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 180
Date: Tue, 16 Jun 2015 21:58:13 GMT

{
    "name": "connect_timeout",
    "min": 2,
    "max": 31536000,
    "restart_required": false,
    "type": "integer",
    "datastore_version_id": "f8e67741-e767-4137-b394-3fb8a3fafd2f"
}

Configuration groups (configurations)

POST

/v1.0/{accountId}/configurations

Create configuration group

Creates a configuration group.

Normal response codes

200

Error response codes

Request parameters

Parameter	Style	Type	Description
accountId	URI	xsd:string	The account ID of the owner of the specified instance.
datastore	plain	xsd:string	Datastore assigned to the configuration group. Required if default datastore is not configured.
values	plain	xsd:string	Dictionary that lists configuration parameter names and associated values.
name	plain	xsd:string	Name of the configuration group you are creating.

POST /v1.0/1234/configurations HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: d6cafa5b-e0c7-4ab8-948e-7c95f2acd031
Accept: application/json
Content-Type: application/json

{
    "configuration": {
        "datastore": [
            {
                "type": "mysql"
            }
        ],
        "values": [
            {
                "sync_binlog": 1
            }
        ],
        "name": "group1"
    }
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 360
Date: Mon, 6 Jul 2015 21:53:10 GMT

{
    "updated": "2015-07-01T16:38:27",
    "name": "group1",
    "created": "2015-07-01T16:38:27",
    "instance_count": 0,
    "values": {
        "sync_binlog": 1
    },
    "datastore_version_id": "2dc7faa0-efff-4c2b-8cff-bcd949c518a5",
    "id": "2aa51628-5c42-4086-8682-137caffd2ba6",
    "datastore_name": "mysql",
    "datastore_version_name": "5.6",
    "description": null
}

GET

/v1.0/{accountId}/configurations

List configuration groups

Lists all configuration groups.

The list includes the associated datastore and datastore version for each configuration group.

Normal response codes

200

Error response codes

Request parameters

Parameter	Style	Type	Description
accountId	URI	xsd:string	The account ID of the owner of the specified instance.

GET /v1.0/1234/configurations HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 426
Date: Tue, 07 Jul 2012 19:53:04 GMT

{
    "configurations": [
        {
            "datastore_name": "mysql",
            "updated": "2015-07-01T16:38:27",
            "name": "group1",
            "created": "2015-07-01T16:38:27",
            "datastore_version_name": "5.6",
            "id": "2aa51628-5c42-4086-8682-137caffd2ba6",
            "datastore_version_id": "2dc7faa0-efff-4c2b-8cff-bcd949c518a5",
            "description": null
        }
    ]
}