Restart virtual database server (POST /v1.0/{tenantId}/instances/{instanceId}/action)
Restarts a virtual database server.
Request URI
{tenantID}
Project ID of the owner of the instance
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
{instanceId}
ID of the virtual database server
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
Request Parameters
action
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| None | reboot |
reboot
Stops the virtual database server.
A read replica instance starts if this parameter is defined.
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| None | 0..1 | action | None |
failover
Failover occurs if this parameter is set to "true" and redundancy configuration is used for the virtual database server.
true | false
Default: false
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Boolean | 0..1 | None | None |
applyPatch
If set to true, update will be performed if security update or minor version upgrade is possible.
true | false
Default value: false
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Boolean | 0..1 | None | None |
Response Headers
Status
Returns the status of the request.
One of the following values will be returned.
- 400:
- badRequest
- 401:
- unauthorized
- 403:
- forbidden
- 404:
- itemNotFound
- 413:
- overLimit
- 422:
- unprocessableEntity
- 500:
- instanceFault
- 501:
- notImplemented
- 503:
- serviceUnavailable
- 504:
- gatewayTimeout
| Data Type | Cardinality |
|---|---|
| Int | 1..1 |
Response Elements
n/a
Example of Request
{
"reboot": ""
"failover": false
}