ac4cc65cb5
Contains .inc files which have all the contents of the .rst files but are grouped together for easier editing. Contains parameters.yaml, which has all parameters in one file. Contains request and response samples (JSON and XML) that are pointed to from the .inc files. Change-Id: I42d5451300f95774a3ec4df66bc95cb36795844d
138 lines
1.8 KiB
ReStructuredText
138 lines
1.8 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
=====================
|
|
Databases (databases)
|
|
=====================
|
|
|
|
Creates, lists all, and deletes databases.
|
|
|
|
|
|
Delete database
|
|
===============
|
|
|
|
.. rest_method:: DELETE /v1.0/{accountId}/instances/{instanceId}/databases/{databaseName}
|
|
|
|
Deletes a database.
|
|
|
|
This operation also deletes all data that is associated with the
|
|
database.
|
|
|
|
Error response codes:202,413,405,404,403,401,400,422,503,500,501,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- instanceId: instanceId
|
|
- databaseName: databaseName
|
|
- accountId: accountId
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Create database
|
|
===============
|
|
|
|
.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/databases
|
|
|
|
Creates a database within an instance.
|
|
|
|
The ``name`` of the database is a required attribute.
|
|
|
|
Error response codes:202,413,405,404,403,401,400,422,503,500,501,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- characterSet: characterSet
|
|
- collate: collate
|
|
- name: name
|
|
- instanceId: instanceId
|
|
- accountId: accountId
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/db-create-databases-request.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
List instance databases
|
|
=======================
|
|
|
|
.. rest_method:: GET /v1.0/{accountId}/instances/{instanceId}/databases
|
|
|
|
Lists databases for an instance.
|
|
|
|
This operation returns only the user-defined databases and not the
|
|
system databases. Only the database administrator can view the
|
|
``mysql``, ``information_schema``, and ``lost+found`` system
|
|
databases.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:413,405,404,403,401,400,422,503,500,501,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- instanceId: instanceId
|
|
- accountId: accountId
|
|
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/db-list-databases-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|