参照レプリカデータベース仮想サーバの作成 (POST /v1.0/{tenantId}/instances)
参照レプリカデータベース仮想サーバを作る。
参照レプリカデータベース仮想サーバの元となるデータベース仮想サーバは、下記を満たしている必要があります。
- multiがtrue
- backupRetentionPeriodが1以上
- engineがenterprisepostgres
2018年11月までは、参照レプリカを作成するためのAPIとして、POST /v1.0/{tenantId}/instances/{instanceId}がありましたが、旧APIは使用せず、このAPIを使用してください。
Request URI
{tenantID}
データベース仮想サーバのオーナーとなるプロジェクトID
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
Request Parameter
action
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| None | readreplica |
readreplica
このパラメーターが定義されていた場合、リードレプリカインスタンスが立上る。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| None | 1..1 | action | None |
instance
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| None | flavorRef
volume id name description availabilityZone subnetGroupId port preferredMaintenanceWindow preferredRecoveryTime autoMaintenance publiclyAccessible securityGroupIds parameterGroupId downloadLogExtension readReplicaSrcDBInstance |
flavorRef
型決めされたハードウェアリソースのリストのID
存在する flavor IDを指定する
Default value : 元のデータベース仮想サーバの値
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | instance | None |
volume
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Volume structures | 0..1 | instance | size
type |
size
データディスクのサイズ
10 to 10240 (GB)
Default value : 元のデータベース仮想サーバの値
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Integer | 0..1 | volume | None |
type
ディスクタイプ
M1
Default value : 元のデータベース仮想サーバの値
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | volume | None |
id
- 英数字またはハイフンのみ使用可
- 文字列の先頭は英字で始めること
- 文字列の末尾にハイフンは使用不可
- 連続した２つ以上のハイフンは使用不可
- 最大63文字
Default value : 元のデータベース仮想サーバの値。ただし、重複する場合は、random value
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | instance | None |
name
- 英数字またはハイフンのみ使用可
- 文字列の先頭は英字で始めること
- 文字列の末尾にハイフンは使用不可
- 連続した２つ以上のハイフンは使用不可
- 最大255文字
Default value : 元のデータベース仮想サーバの値
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | instance | None |
description
データベース仮想サーバの説明
最大1024文字
Default value : 元のデータベース仮想サーバの値
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | instance | None |
availabilityZone
インスタンスが作成されるアベイラビリティゾーン
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 1..1 | instance | None |
subnetGroupId
データベース仮想サーバが配備されるサブネットグループ
マルチアベイラビリティゾーンオプションの場合は、少なくとも2つ以上のアベイラビリティゾーンを含むサブネットの集合でなければならない。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 1..1 | instance | None |
port
ポート番号
1024 to 32767
Default value: 元のデータベース仮想サーバの値
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Integer | 0..1 | instance | None |
preferredMaintenanceWindow
週次のメンテナンスが行われる時間帯を指定します。
30分以上23時間30分以内の時間帯を指定する必要があります。
形式: ddd:hh24:mi-ddd:hh24:mi
例. Sun:05:00-Sun:06:00
曜日部分の値: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Default value: 元のデータベース仮想サーバの値
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | instance | None |
preferredRecoveryTime
自動復旧を開始する時刻
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| preferredRecoveryTime Structure | 0..1 | instance |
applyImmediately time |
applyImmediately
このパラメーターが定義されていた場合、参照レプリカデータベース仮想サーバが異常になった時、即時自動復旧が実施されます。
preferredRecoveryTime構造体の中のapplyImmediatelyとtimeは、どちらか片方だけ指定可能です。
Default value : 元のデータベース仮想サーバの値
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Boolean | 0..1 | preferredRecoveryTime | None |
time
このパラメーターが定義されていた場合、パラメーター値で指定された時間に自動復旧が実施されます。
preferredRecoveryTime構造体の中のapplyImmediatelyとtimeは、どちらか片方だけ指定可能です。
Default value : 元のデータベース仮想サーバの値
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | preferredRecoveryTime | None |
autoMaintenance
自動メンテナンスの実施有無
true | false
True : 自動メンテナンスが実施されます。
False: 自動メンテナンスが実施されません。
Default value : 元のデータベース仮想サーバの値
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Boolean | 0..1 | instance | None |
publiclyAccessible
データベース仮想サーバ配備時のインターネットからの接続可否
true | false
※true:外部からのインターネット経由での接続が許可される
false:VPC内からのアクセスのみ
Default value : 元のデータベース仮想サーバの値
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Boolean | 0..1 | instance | None |
securityGroupIds.
VPCセキュリティグループの名前
VPCセキュリティグループのリスト
Default value: default security group
※VPCセキュリティグループを指定する。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String list | 0..1 | instance | None |
parameterGroupId
パラメーターグループ
Default value: default parameter group
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | instance | None |
downloadLogExtension
ログ拡張機能
true | false
true:ログ拡張機能を有効化する。本機能を有効化した場合、DBログ容量の10%ほど、ログ情報の管理用としてディスク使用量が増加する。
false:ログ拡張機能を無効化する。
Default value : 元のデータベース仮想サーバの値
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Boolean | 0..1 | instance | None |
readReplicaSrcDBInstance
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 1..1 | instance |
region tenantId id |
region
元のデータベース仮想サーバのリージョン
Default value : APIを実行したリージョン
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | readReplicaSrcDBInstance | None |
tenantId
元のデータベース仮想サーバのプロジェクトID
Default value : APIを実行したプロジェクトID
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | readReplicaSrcDBInstance | None |
Id
元のデータベース仮想サーバのID
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 1..1 | readReplicaSrcDBInstance | 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 parameterGroupId pendingModifiedValues preferredBackupWindow preferredMaintenanceWindow publiclyAccessible readReplicaDBInstanceIdentifiers readReplicaSrcDBInstanceIdentifier replicaStatus subnetGroupId securityGroupIds downloadLogExtension readReplicaDBInstances readReplicaSrcDBInstance |
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 |
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 |
publiclyAccessible
データベース仮想サーバ配備時のインターネットからの接続可否
trueの場合：パブリックIPが割り当てられる。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Boolean | instance | None |
readReplicaDBInstanceIdentifiers
このパラメーターはreadReplicaDBInstancesに統合され廃止されました。常に空のlistが返却されます。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String list | instance | None |
readReplicaSrcDBInstanceIdentifier
このパラメーターはreadReplicaSrcDBInstanceに統合され廃止されました。 常にnullが返却されます。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | instance | None |
replicaStatus
リードレプリカの状態
ReplicatingまたはError
| 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 |
readReplicaDBInstances
このデータベース仮想サーバに関連付けられている、リードレプリカインスタンス
リードレプリカに対する操作とは非同期で反映されます。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| ReadReplicaDBInstance Structure list | instance |
region tenantId id |
readReplicaSrcDBInstance
元のデータベース仮想サーバ
元のデータベース仮想サーバに対する操作とは非同期で反映されます。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| ReadReplicaSrcDBInstance Structure list | instance |
region tenantId id |
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 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 |
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 |
region
このデータベース仮想サーバに関連付けられている、リードレプリカのリージョン
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | readReplicaDBInstances | None |
tenantId
このデータベース仮想サーバに関連付けられている、リードレプリカのプロジェクトID
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | readReplicaDBInstances | None |
id
このデータベース仮想サーバに関連付けられている、リードレプリカのID
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | readReplicaDBInstances | None |
region
元のデータベース仮想サーバのリージョン
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | readReplicaSrcDBInstance | None |
tenantId
元のデータベース仮想サーバのプロジェクトID
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | readReplicaSrcDBInstance | None |
id
元のデータベース仮想サーバのID
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | readReplicaSrcDBInstance | None |
Example of Request
{
"action":{"readreplica":""},
"instance": {
"availabilityZone": "jp-west-2a",
"name": "replica-instance-name",
"subnetGroupId": "replica-subnetgroup-id",
"securityGroupIds": [{"securityGroupId": "secid1"}],
"id": "replica-instance-id",
"readReplicaSrcDBInstance": {
"region": "jp-east-1",
"tenantId": "44b277eb-39be-4921-be31-3d61b43651d7",
"id": "test-instance-id"
}
}
}
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",
"address": "fujitsu.s5.dbaas.a23w4e5r6tg7yuhjik",
"ip":"10.125.52.214",
"port":26500,
"characterSet":"UTF-8",
"collate":"C",
"autoMinorVersionUpgrade":true,
"availabilityZone" : "az-1",
"backupRetentionPeriod":10,
"engine": "enterprisepostgres",
"engineVersion": "9.6",
"engineMinorVersion": "0",
"multiAZ" : true,
"parameterGroupId" : "paramid1",
"preferredBackupWindow" : 17:00-18:00,
"preferredMaintenanceWindow" : Sun:19:00-Sun:20:00,
"preferredRecoveryTime" : {"applyImmediately" : true, "time" : none},
"downloadLogExtension": false,
"publiclyAccessible" : true,
"subnetGroupId " : "subnetGroup1",
"securityGroupIds." : [{"securityGroupId" : "secid1"}, {"securityGroupId" : "secid2"}],
"readReplicaDBInstances": [],
"readReplicaSrcDBInstance": {"region": "jp-east-1", "tenantId": "29320d5e-dd29-425c-b386-3cbb2754ad03", "id": "source-dbinstance"},
"replicaStatus": "Replicating",
"readReplicaDBInstanceIdentifiers": [],
"readReplicaSrcDBInstanceIdentifier": null
}
}