データベース仮想サーバの変更(PUT /v1.0/{tenantId}/instances/{instanceId})
データベース仮想サーバを変更する。
Request URI
{tenantID}
データベース仮想サーバのオーナーとなるプロジェクトID
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
{instanceId}
データベース仮想サーバのID
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
Request Parameter
instance
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| None | flavorRef
volume id name description availabilityZone multi multiAZ port preferredBackupWindow preferredMaintenanceWindow preferredRecoveryTime autoMaintenance securityGroupIds. parameterGroupId backupRetentionPeriod autoMinorVersionUpgrade engineVersion masterUserPassword privateAddress publicAddress applyImmediately downloadLogExtension |
flavorRef
型決めされたハードウェアリソースのリストのID
存在するフレーバーIDを指定する。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | Instance | None |
volume
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Volume structure | 0..1 | Instance | size
type |
size
データディスクのサイズ(GB)
10 to 10240 (GB)
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Integer | 0..1 | volume | None |
type
ディスクタイプ
M1
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | Volume | None |
id
データベース仮想サーバのID
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | Instance | None |
name
データベース仮想サーバの名前
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | Instance | None |
availabilityZone
インスタンスが作成されるアベイラビリティゾーン
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | Instance | None |
multi
マルチDBオプション
true | false
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | Instance | None |
multiAZ
マルチアベイラビリティゾーンオプション
true | false
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | Instance | None |
port
ポート番号
1024 ～ 32767
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Integer | 0..1 | Instance | None |
preferredBackupWindow
バックアップ時間帯
形式: hh24:mi-hh24:mi
Default:リージョンごとに定められた10時間の中からのランダムな30分間
自動バックアップが有効の場合に日次のバックアップが行われる時間帯を指定します。
- 東日本(east-1): 17:00-03:00 UTC
- 西日本(west-1): 17:00-03:00 UTC
時刻の指定はUTCで行ってください。
PreferredMaintenanceWIndowと重複した時間帯を設定することはできません。
バックアップは条件により30分を超えて行われることがあります
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | Instance | None |
preferredMaintenanceWindow
メンテナンス時間帯
形式:
ddd:hh24:mi-ddd:hh24:mi
Default: リージョンごとに定められた10時間の中からのランダムな30分間(曜日もランダムで決定) ※週次のメンテナンスが行われる時間帯を指定します
30分間以上23時間30分以内の時間帯を指定する必要があります。
リージョンごとに定められた10時間の中からランダムに30分間が決定されます(曜日もランダムで決定されます)。
例. Sun:05:00-Sun:06:00
曜日部分の値: Mon, Tue, Wed, Thu, Fri, Sat, Sun
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | Instance | None |
preferredRecoveryTime
自動復旧を開始する時刻
本パラメーターはデータベース仮想サーバが冗長化構成の場合のみ指定可能です(multi = trueの場合のみ指定可能)
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| preferredRecoveryTime
Structure |
0..1 | Instance | applyImmediately time |
applyImmediately
このパラメーターが定義されていた場合、データベース仮想サーバが片系運用になった時、即時自動復旧が実施されます。
preferredRecoveryTime構造体の中のapplyImmediatelyとtimeは、どちらか片方のみ指定可能です。
default value: true
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Boolean | 0..1 | preferredRecoveryTime | None |
time
このパラメーターが定義されていた場合、パラメーター値で指定された時間に自動復旧が実施されます。
preferredRecoveryTime構造体の中のapplyImmediatelyとtimeは、どちらか片方のみ指定可能です。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | preferredRecoveryTime | None |
autoMaintenance
自動メンテナンスの実施有無
true | false
Default value : true
true : 自動メンテナンスが実施されます。
false: 自動メンテナンスが実施されません。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Boolean | 0..1 | Instance | None |
securityGroupIds.
VPCセキュリティグループの名前
※VPCセキュリティグループを指定する。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String list | 0..1 | Instance | None |
parameterGroupId
DBパラメーターグループ名
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | Instance | None |
backupRetentionPeriod
バックアップ保持期間
0 to 10
※0の場合は自動バックアップを行わない
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Integer | 0..1 | Instance | None |
autoMinorVersionUpgrade
自動的なマイナーバージョンアップ
true | false
Default value: true
このパラメータは、効果がありません。
マイナーバージョンアップを実施する際は、applyPatchをtrueに設定してデータベース仮想サーバの起動・再起動APIを実施してください。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Boolean | 0..1 | Instance | None |
engineVersion
DBのバージョン
Default value: Latest version
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | Instance | None |
masterUserPassword
管理者パスワード
- 英数字または'(シングルクォート)以外の記号が使用可能
- 最大1024文字
DBスナップショットからのデータベース仮想サーバの復旧とポイントイン・タイムリカバリーによるデータベース仮想サーバの復旧APIを実行するために過去のmasterUserPasswordが必要になる場合があります。このため、masterUserPasswordを変更した後も変更前のmasterUserPasswordを記録しておいてください。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | Instance | None |
privateAddress
変更後のデータベース仮想サーバの内部アドレス(FQDN形式)
利用実績のないFQDNは指定できません
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | Instance | None |
publicAddress
変更後のデータベース仮想サーバのグローバルアドレス(FQDN形式)
利用実績のないFQDNは指定できません
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | Instance | None |
applyImmediately
このパラメーターがtrueに指定されていた場合、API実行後にインスタンスが再起動します。
true | false
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Boolean | 0..1 | Instance | None |
downloadLogExtension
ログ拡張機能
true | false
true:ログ拡張機能を有効化する。本機能を有効化した場合、DBログ容量の10%ほど、ログ情報の管理用としてディスク使用量が増加する。
false:ログ拡張機能を無効化する。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Boolean | 0..1 | Instance | None |
volume
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| volume structure list | 0..1 | Instance | size
type |
size
10～10240[GB]
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Integer | 0..1 | volume | None |
type
ディスクタイプ
M1
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | volume | None |
Response Headers
ステータス
リクエストのステータスを返却する。
- 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
instance
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| None | created
flavor id links name status updated volume privateAddress publicAddress privateIp publicIp port characterSet collate autoMinorVersionUpgrade availabilityZone backupRetentionPeriod engine engineVersion engineMinorVersion masterUserName multi multiAZ parameterGroupId pendingModifiedValues preferredBackupWindow preferredMaintenanceWindow autoMaintenance publiclyAccessible readReplicaDBInstanceIdentifiers readReplicaSrcDBInstanceIdentifier secondaryAvailabilityZone replicaStatus subnetGroupId securityGroupIds downloadLogExtension |
created
作成日時
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Date | instance | None |
flavor
仮想サーバのスペック
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Flavor structures | instance | None |
id
データベース仮想サーバのID
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | instance | None |
links
データベース仮想サーバへのURI
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | instance | None |
name
データベース仮想サーバの名前
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | instance | None |
status
データベース仮想サーバの状態
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | instance | None |
updated
更新日時
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Date | instance | None |
volume
データ格納先のディスクタイプとサイズ
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Volume structures | instance | None |
privateAddress
データベース仮想サーバが立ち上がっている仮想サーバへの内部アドレス (FQDN形式)
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | instance | None |
publicAddress
データベース仮想サーバが立ち上がっている仮想サーバへのグローバルアドレス(FQDN形式)
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | instance | None |
privateIp
データベース仮想サーバへの内部IPアドレス
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | instance | None |
publicIp
データベース仮想サーバのグローバルIPアドレス
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | instance | None |
port
ポート番号
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Integer | instance | None |
characterSet
データベースのエンコーディング
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | instance | None |
collate
データベースの照合順序
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | instance | None |
autoMinorVersionUpgrade
自動的なマイナーバージョンアップを行うかどうかのフラグ
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Boolean | instance | None |
availabilityZone
データベース仮想サーバが立ち上がっているアベイラビリティゾーン
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | instance | None |
backupRetentionPeriod
バックアップ保持期間
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Integer | instance | None |
engine
データベースの種類
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | instance | None |
engineVersion
データベースのバージョン
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | instance | None |
engineMinorVersion
データベースのマイナーバージョン
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | instance | None |
masterUserName
管理者ユーザー名
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | instance | None |
multi
マルチDBオプション
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Boolean | instance | None |
multiAZ
マルチアベイラビリティゾーンオプション
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Boolean | instance | None |
parameterGroupId
DBパラメーターグループのID
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | instance | None |
pendingModifiedValues
次の再起動時に変更される予定のパラメーターの一覧
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| PendingModifiedValues structures | instance | None |
preferredBackupWindow
バックアップ時間帯
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | instance | None |
preferredMaintenanceWindow
メンテナンス時間帯
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | instance | None |
autoMaintenance
自動メンテナンスの実施有無
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Boolean | instance | None |
publiclyAccessible
データベース仮想サーバ配備時のインターネットからの接続可否
trueの場合 : パブリックIPが割り当てられる。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Boolean | instance | None |
readReplicaDBInstanceIdentifiers
このデータベース仮想サーバに関連付けられている、リードレプリカインスタンス
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String list | instance | None |
readReplicaSrcDBInstanceIdentifier
このデータベース仮想サーバがリードレプリカインスタンスだった場合：レプリカ元のデータベース仮想サーバID
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | instance | None |
secondaryAvailabilityZone
二重化オプションがtrueだった場合:
副系データベース仮想サーバが立ち上がっているアベイラビリティゾーン
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | instance | None |
replicaStatus
リードレプリカの状態
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | instance | None |
subnetGroupId
DBサブネットグループのID
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | instance | None |
securityGroupIds
VPCセキュリティグループIDのリスト
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String list | instance | None |
downloadLogExtension
ログ拡張機能
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Boolean | instance | None |
flavor
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| None | id
links |
id
フレーバーID
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | Flavor | None |
links
フレーバーのURI
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | Flavor | None |
pendingModifiedValues
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| None | volume backupRetentionPeriod flavor id name parameterGroupId engineVersion masterUserName masterUserPassword multi multiAZ port engineMinorVersion securityUpdate |
volume
データ格納先のディスクタイプとサイズ
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Volume structures | PendingModifiedValues | None |
backupRetentionPeriod
バックアップ保持期間
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | PendingModifiedValues | None |
flavor
仮想サーバのスペック
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Flavor | PendingModifiedValues | None |
id
データベース仮想サーバのID
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | PendingModifiedValues | None |
name
データベース仮想サーバの名前
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | PendingModifiedValues | None |
parameterGroupId
DBパラメーターグループのID
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | PendingModifiedValues | None |
engineVersion
データベースのバージョン
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | PendingModifiedValues | None |
masterUserName
データベース仮想サーバのマスタユーザー名
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | PendingModifiedValues | None |
masterUserPassword
データベース仮想サーバのマスタユーザーのパスワード
ただし、セキュリティ保護のため、返り値はすべて"***"で表現される。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | PendingModifiedValues | None |
multi
マルチDBオプション
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Boolean | PendingModifiedValues | None |
multiAZ
マルチアベイラビリティゾーンオプション
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Boolean | PendingModifiedValues | None |
port
ポート番号
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Integer | PendingModifiedValues | None |
engineMinorVersion
データベースのマイナーバージョン
データベースのマイナーバージョンがリリースされた場合に、パッチ適用を実施できます。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | PendingModifiedValues | None |
securityUpdate
セキュリティアップデートの有無
セキュリティアップデートがリリースされた場合に、パッチ適用を実施できます。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Boolean | PendingModifiedValues | None |
volume
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| None | size
type |
size
データストレージのサイズ
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | Volume | None |
type
データストレージのタイプ
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | Volume | None |
Example of Request
{
"instance": {
"flavorRef":"1",
"volume":{"size":2}
"name":"json-rack-instance",
"availabilityZone":"jp-east-1a",
"multi":true
"multiAZ":true,
"subnetGroupId.":"subnetGroup1",
"port":1234,
"preferredBackupWindow":"17:00-18:00",
"preferredMaintenanceWindow":"Sun:19:00-Sun:20:00",
"preferredRecoveryTime":{
"time" : "01:00",
},
"autoMaintenance":true,
"publiclyAccessible":true,
"securityGroupIds.":[
{"securityGroupId":"secid1"},
{"securityGroupId":"secid2"}
],
"parameterGroupId":"paramid1",
"character_set":"utf8",
"collate":"C",
"backupRetentionPeriod":10,
"autoMinorVersionUpgrade":true,
"engine":"enterprisepostgres",
"engineVersion":"9.6",
"masterUserPassword":"***"
"databases": [
{
"name":"sampledb",
},
{
"name":"nextround"
}
],
"users":[
{
"databases": [
{
"name":"sampledb"
}
],
"name":"demouser",
"password":"demopassword"
}
]
}
}
Example of Response
{
"instance": {
"created": "2013-03-18T19:09:17",
"flavor": {
"id": "1",
"links": [
{
"href": "http://database.{region-name}.tps5.fujitsu.com/v1.0/1234/flavors/1",
"rel": "self"
}
]
},
"id": "44b277eb-39be-4921-be31-3d61b43651d7",
"links": [
{
"href": "http://database.{region-name}.tps5.fujitsu.com/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7",
"rel": "self"
},
],
"status": "BUILD"
"volume": {
"size": 20,
"type":"M1"
}
"name": "json_rack_instance",
"privateAddress":"fujitsu.s5.dbaas.a23w4e5r6tg7yuhjik",
"privateIp":"10.125.52.214",
"port":26500,
"characterSet":"UTF8",
"collate":"C",
"autoMinorVersionUpgrade":true,
"availabilityZone" : "jp-east-1a",
"backupRetentionPeriod":10,
"engine": "enterprisepostgres",
"engineVersion": "9.6",
"engineMinorVersion": "0",
"multi":true
"multiAZ" : true,
"parameterGroupId" : "paramid1",
"pendingModifiedValues":[
"masterUserPassword":"***"
],
"preferredBackupWindow" : "17:00-18:00",
"preferredMaintenanceWindow" : "Sun:19:00-Sun:20:00",
"preferredRecoveryTime" : {
"applyImmediately" : none,
"time" : "01:00",
},
"autoMaintenance" : true,
"downloadLogExtension": false,
"publiclyAccessible" : true,
"subnetGroupId " : "subnetGroup1",
"securityGroupIds" : [
{"securityGroupId" : "secid1"},
{"securityGroupId" : "secid2"}
],
}
}