Common parameters
Request Headers
X-Auth-Token
Specify the authentication token.
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
Response type
Content-Type
Specify "application/json" when using POST or PUT.
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
RESTAPI RequestURI
| URL | Description |
|---|---|
| http://database.{region-name}.tps5.fujitsu.com/vx.x/1234/... | <Endpoint overall DBaaS> http://database.{region-name}.tps5.fujitsu.com <region-name> <API version information > /vx.x ex:/v1.0 <tenant ID> /{tenantId} ex:/1234 |
Normal status code
| Return | Description | HTTP status code |
|---|---|---|
| OK | Succeed | 200 |
| Created | Created | 201 |
| Accepted | Accepted | 202 |
Error and status code
| Error name | Description | HTTP status code |
|---|---|---|
| badRequest | Invalid request | 400 |
| unauthorized | Insufficient privileges | 401 |
| forbidden | Forbidden operation | 403 |
| badMethod | Not allowed method for resource. | 405 |
| overLimit | Specified value exceeds the permitted value | 413 |
| unprocessableEntity | Unable to process instructions | 422 |
| instanceFault | Internal Server Error | 500 |
| notImplemented | Not implemented | 501 |
| serviceUnavailable | The service has stopped | 503 |
| gatewayTimeout | 504 Gateway Time-out | 504 |
| itemNotFound | Not found | 404 |
Status of the virtual database server
| Active | While in this state, the issuance of SQL statements is accepted. Any API can be issued. |
| Backup | Backup is being performed. SQL statements can still be issued. |
| Build | A virtual database server is being created. POST and PUT are prohibited for virtual database server that are being created. |
| Failed | Failed state when executing POST or PUT API. Recover the virtual database server as it may be in an abnormal state. |
| Error | The virtual database server is in an invalid state. Report it to the system administrator. |
| Deleted | If a virtual database server is in a DELETED state, it indicates that the virtual database server has been deleted, but a snapshot associated with it exists. |
| Reboot | A virtual database server is being restarted. |
| Resize | A data volume is being resized. |
| Modifying | A virtual database server attribute is being changed. |
| Restart_Required | A restart is required. SQL statements can be accessed, but attribute values and settings may not have been reflected. |
| Degenerated | Operation is degraded for the virtual database server using a single node. This status is also displayed when redundancy is recovered for the virtual database server. The time to recover redundancy for the virtual database server depends on the amount of data, and may take more than 30 minutes. If automatic recovery starts at the time specified in preferredRecoveryTime, an event notifies the start of recovery. |
| Switched | Failover occurred for the DB, and primary and secondary nodes are switched for operation. |
An error is returned if an API request fails.
The error has the following three elements: status code, error name, and message.
A JSON type error response is shown below:
{
"Error": [
"status":404,
"name":"notFound",
"message":"DBInstanceNotFound"
]
}