データベース仮想サーバの情報参照 (GET /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

なし

Response Headers

ステータス

リクエストのステータスを返却する。

以下の値を返却する。
401:
unauthorized
403:
forbidden
404:
itemNotFound
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

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

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 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"}
		],
		
	}
}