共通パラメーター
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 |
【説明】 データベース仮想サーバが正常で、使用可能な状態です。 【データベース接続】 データベースに接続できます。 【APIリクエスト】 本状態のデータベース仮想サーバに対して、すべてのAPIを実行できます。 |
| Backup |
【説明】 データベース仮想サーバをバックアップ中です。 【データベース接続】 データベースに接続できます。 【APIリクエスト】 本状態のデータベース仮想サーバに対して、以下の操作はできません。
|
| Restart_Required |
【説明】 反映されていないデータベース仮想サーバの変更やセキュリティアップデート、マイナーバージョンアップがある状態です。反映する場合は、データベース仮想サーバの再起動が必要です。 【データベース接続】 データベースに接続できる状態です。 【APIリクエスト】 本状態のデータベース仮想サーバに対して、すべてのAPIを実行できます。 |
| Switched |
【説明】 データベースがフェイルオーバーしたことで、正系と副系が逆転して運用しています。 【データベース接続】 データベースに接続できる状態です。 【APIリクエスト】 本状態のデータベース仮想サーバに対して、すべてのAPIを実行できます。 |
| Degenerated |
【説明】 データベース仮想サーバが片系で縮退運用中、および、冗長化復旧中の状態です。 冗長化復旧時間は、データ量に依存し、30分以上の時間がかかる場合があります。 preferredRecoveryTimeに設定した時刻に自動復旧が開始されるとイベント通知により復旧開始の通知を行います。 【データベース接続】 データベースに接続できる状態です。 【APIリクエスト】 本状態のデータベース仮想サーバに対して、以下の操作はできません。
|
| Build |
【説明】 データベース仮想サーバを作成中です。 【データベース接続】 データベースに接続できません。 【APIリクエスト】 本状態のデータベース仮想サーバに対して、POST/PUT/DELETEの操作はできません。 |
| Deleting |
【説明】 データベース仮想サーバを削除中です。 【データベース接続】 データベースに接続できない状態です。 【APIリクエスト】 本状態のデータベース仮想サーバに対して、POST/PUT/DELETEの操作はできません。 |
| Deleted |
【説明】 データベース仮想サーバは削除済みですが、そのデータベース仮想サーバに紐付いたDBスナップショットが存在していることを示している状態です。 【データベース接続】 データベースに接続できない状態です。 【APIリクエスト】 本状態のデータベース仮想サーバに対して、POST/PUT/DELETEの操作はできません。 |
| Failed |
【説明】 データベース仮想サーバが不正な状態です。 データベース仮想サーバが異常な状態になっている可能性があるため、DBスナップショットからのデータベース仮想サーバ復旧API、または、ポイントイン・タイムリカバリーによるデータベース仮想サーバの復旧APIにより復旧してください。 【データベース接続】 データベースに接続できない状態です。 【APIリクエスト】 本状態のデータベース仮想サーバに対して、以下を除くPOST/PUTの操作はできません。
|
| Error |
【説明】 データベース仮想サーバが不正な状態です。 データベース仮想サーバの作成API、DBスナップショットからのデータベース仮想サーバ復旧API、ポイントイン・タイムリカバリーによるデータベース仮想サーバの復旧APIのうちのどれかを実行し、Errorとなった場合は、再作成を実施してください。 その他の場合は、サービス窓口まで連絡してください。 【データベース接続】 データベースに接続できる場合もありますが、不正な状態のため、再作成または復旧が必要です。 【APIリクエスト】 本状態のデータベース仮想サーバに対して、以下を除くPOST/PUTの操作はできません。
|
| Modifying |
【説明】 データベース仮想サーバの変更中です。 【データベース接続】 変更したパラメーターによってデータベース仮想サーバの再起動を伴い、再起動中はデータベースに接続できません。再起動を伴うパラメーターは「ModifyDBInstanceで再起動が必要になるパラメーター」を参照してください。 【APIリクエスト】 本状態のデータベース仮想サーバに対して、以下を除くPOST/PUT/DELETEの操作はできません。
|
| Resize |
【説明】 データベース仮想サーバのデータディスクのサイズ変更中です。 【データベース接続】 データベース仮想サーバの再起動を伴い、再起動中はデータベースに接続できません。 【APIリクエスト】 本状態のデータベース仮想サーバに対して、以下を除くPOST/PUT/DELETEの操作はできません。
|
| Shutdown |
【説明】 データベース仮想サーバが停止済みの状態です。 【データベース接続】 データベースに接続できない状態です。 【APIリクエスト】 本状態のデータベース仮想サーバに対して、以下の操作はできません。
※Degenerated状態からデータベース仮想サーバを停止した場合は、applyImmediatelyパラメーターにかかわらず、データベース仮想サーバの変更APIは実行できません。 |
| Reboot |
【説明】 データベース仮想サーバを再起動中です。 【データベース接続】 データベースに接続できない状態です。 【APIリクエスト】 本状態のデータベース仮想サーバに対して、以下を除くPOST/PUT/DELETEの操作はできません。
|
| Starting |
【説明】 データベース仮想サーバを起動中です。 【データベース接続】 データベースに接続できない状態です。 【APIリクエスト】 本状態のデータベース仮想サーバに対して、以下を除くPOST/PUT/DELETEの操作はできません。
|
| Stopping |
【説明】 データベース仮想サーバを停止中です。 【データベース接続】 データベースに接続できない状態です。 【APIリクエスト】 本状態のデータベース仮想サーバに対して、以下を除くPOST/PUT/DELETEの操作はできません。
|
| Restoring |
【説明】 Symfowareデータベース仮想サーバのリストア中です。 【データベース接続】 データベースに接続できない状態です。 【APIリクエスト】 本状態のデータベース仮想サーバに対して、POST/PUT/DELETEの操作はできません。 |
| Restored |
【説明】 Symfowareデータベース仮想サーバのリストア実施済みの状態です。 【データベース接続】 データベースに接続できない状態です。 【APIリクエスト】 本状態のデータベース仮想サーバに対して、POST/PUTの操作はできません。 |
APIのリクエストに失敗した場合にエラーが返されます。
エラーは次の３つの要素を持つ: status code, error name, message.
JSON 型の error レスポンスは以下のとおりです。
{
"Error": [
"status":404,
"name":"notFound",
"message":"DBInstanceNotFound"
]
}