共通パラメーター
Request Headers
X-Auth-Token
ユーザー認証を行った際に取得するトークンを指定する。
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
Response Type
Content-Type
POST/PUTの場合application/json を指定
| 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 |
データベース仮想サーバの状態
| Active | SQL文の発行を受け付ける状態です
すべてのAPIを発行可能です。 |
| Backup | バックアップ中です。SQL文は発行できます。 |
| Build | データベース仮想サーバ作成中です。
作成中のデータベース仮想サーバに対しては、POST、PUTは禁止されます。 |
| Failed | データベース仮想サーバに対する、POST、PUTのAPI実行に失敗した場合の状態です。
データベース仮想サーバが異常な状態になっている可能性があるため、データベース仮想サーバを復旧してください。 |
| Error | データベース仮想サーバが不正な状態です。管理者に報告してください |
| Deleted | DELETED状態のデータベース仮想サーバが存在した場合. データベース仮想サーバは削除ずみですが、そのデータベース仮想サーバに紐付いたスナップショットが存在していることを示しています |
| Reboot | 起動中です。 |
| Resize | データボリュームのリサイズを行っています。 |
| Modyfying | データベース仮想サーバの属性変更を行っています。 |
| Restart_Required | 再起動が必要です。
SQL文のアクセスは受け付けていますが、属性値や設定が反映されていない可能性があります。 |
| Degenerated | データベース仮想サーバが片系で縮退運用されています。
データベース仮想サーバの冗長化復旧時も本ステータスが表示されます。 データベース仮想サーバの冗長化復旧時間は、データ量に依存し、30分以上の時間かかる場合があります。 preferredRecoveryTimeに指定の時間に自動復旧が開始されるとイベントにより復旧開始の通知を行います。 |
| Switched | データベースがフェールオーバーすることで、正副逆転して運用しています。 |
APIのリクエストに失敗した場合にエラーが返される。
エラーは次の３つの要素を持つ: status code, error name, message.
JSON 型の error レスポンスは以下のとおり。
{
"Error": [
"status":404,
"name":"notFound",
"message":"DBInstanceNotFound"
]
}