UpgradeDBInstance
処理概要
DBサーバーの基盤アップグレードを実行します。
基盤アップグレードステータスが「アップグレード可能」な場合のみ実行可能です。
マスターDBサーバーのみ指定可能でリードレプリカを持つ場合は、同時にリードレプリカの基盤アップグレードを行います。
基盤アップグレード完了後、基盤アップグレードステータスは「最新」になります。
指定するパラメーター
パラメーター | 型 | 説明 | 必須 |
---|---|---|---|
DBInstanceIdentifier | string |
基盤アップグレード実行対象のDBサーバー名 |
○ |
PreUpgradeDBSnapshotIdentifier | string |
基盤アップグレード前にDBスナップショットを作成する場合のDBスナップショット名
|
○ (SkipPreUpgradeSnapshotがfalseの場合) |
SkipPreUpgradeSnapshot | boolean |
基盤アップグレード前にDBスナップショットの作成をスキップするかどうか Default: false |
応答フィールド
フィールド (項目) | 型 | 説明 |
---|---|---|
UpgradeDBInstanceResponse | structure |
ルート |
␣UpgradeDBInstanceResult | structure |
結果 |
␣␣DBInstance | structure |
DBサーバー 備考: DBInstanceの子要素はDescribeDBInstancesで返却される要素をすべて記載しているためAPIによっては返却されない要素もあります。実際のレスポンスはレスポンスサンプルを参照してください。 |
␣␣␣AllocatedStorage | integer |
割り当てるディスク容量(GB) |
␣␣␣AutoMinorVersionUpgrade | boolean |
マイナーバージョンの自動アップデートを行うかどうか 備考: 固定値falseを返却 |
␣␣␣AvailabilityZone | string |
DBサーバーのゾーン |
␣␣␣BackupRetentionPeriod | integer |
バックアップ保持期間 |
␣␣␣BinlogRetentionPeriod | integer |
バイナリログ保持期間(日)
|
␣␣␣ExternalReplicationInfo | structure |
外部レプリケーション情報
|
␣␣␣␣ExternalReplicationMessage | string |
外部レプリケーション操作結果
|
␣␣␣␣ExternalReplicationStatus | string |
外部レプリケーション操作ステータス
|
␣␣␣␣ReplicationAddresses | list |
外部レプリケーション接続元グローバルIPアドレスリスト |
␣␣␣␣␣ReplicationAddress | string |
外部レプリケーション接続元グローバルIPアドレス
|
␣␣␣␣ReplicationPrivateAddresses | list |
外部レプリケーション接続元プライベートIPアドレスリスト |
␣␣␣␣␣ReplicationPrivateAddress | string |
外部レプリケーション接続元プライベートIPアドレス
|
␣␣␣␣ExternalMasterAddress | string |
マスターとなるDBサーバーのIPアドレスまたはホスト名 |
␣␣␣CACertificateIdentifier | string |
DBサーバーのサーバー証明書と紐付くCA証明書 |
␣␣␣DBInstanceClass | string |
DBサーバータイプ |
␣␣␣DBInstanceIdentifier | string |
DBサーバー名 |
␣␣␣DBInstanceStatus | string |
DBサーバーのステータス |
␣␣␣DBInstanceUpgradeStatus | string |
DBサーバーの基盤アップグレードステータス
|
␣␣␣DBName | string |
DB名 |
␣␣␣DBParameterGroups | list |
DBパラメーターグループ情報リスト |
␣␣␣␣DBParameterGroup | structure |
DBパラメーターグループ |
␣␣␣␣␣DBParameterGroupName | string |
DBパラメーターグループ名 |
␣␣␣␣␣ParameterApplyStatus | string |
DBパラメーターの適用ステータス
|
␣␣␣DBSecurityGroups | list |
DBファイアウォールグループ情報リスト |
␣␣␣␣DBSecurityGroup | structure |
DBファイアウォールグループ |
␣␣␣␣␣DBSecurityGroupName | string |
DBファイアウォールグループ名 |
␣␣␣␣␣Status | string |
DBファイアウォールグループのステータス
|
␣␣␣Endpoint | structure |
DB接続時のエンドポイント |
␣␣␣␣Port | integer |
ポート番号 |
␣␣␣␣Address | string |
グローバルIPアドレス
|
␣␣␣␣NiftyPrivateAddress | string |
プライベートIPアドレス |
␣␣␣Engine | string |
データベースエンジン |
␣␣␣EngineVersion | string |
データベースエンジンのバージョン |
␣␣␣InstanceCreateTime | timestamp |
DBサーバーの作成日時 |
␣␣␣LatestRestorableTime | timestamp |
ポイントインタイムリカバリー可能な最新の時刻 |
␣␣␣LicenseModel | string |
DBサーバーのライセンスモデル |
␣␣␣MasterUsername | string |
DBサーバーのマスターユーザー名 |
␣␣␣MultiAZ | boolean |
冗長化機能が有効かどうか |
␣␣␣NiftyMultiAZType | string |
冗長構成タイプ 備考: ニフクラ独自仕様 |
␣␣␣OptionGroupMemberships | list |
オプショングループ情報リスト |
␣␣␣␣OptionGroupMembership | structure |
オプショングループ情報 |
␣␣␣␣␣OptionGroupName | string |
下記の固定値を返却
|
␣␣␣␣␣Status | string |
オプショングループのステータス 備考: 固定値in-syncを返却 |
␣␣␣PendingModifiedValues | structure |
保留の修正情報 |
␣␣␣␣AllocatedStorage | integer |
保留中のディスク容量 |
␣␣␣␣BackupRetentionPeriod | integer |
保留中のバックアップ保持期間 |
␣␣␣␣DBInstanceClass | string |
保留中のDBサーバータイプ |
␣␣␣␣DBInstanceIdentifier | string |
保留中のDBサーバー名 |
␣␣␣␣EngineVersion | string |
保留中のデータベースエンジンのバージョン |
␣␣␣␣MasterUserPassword | string |
保留中のDBサーバーのマスターユーザー名 |
␣␣␣␣MultiAZ | boolean |
保留中の「冗長化機能が有効かどうか」フラグ |
␣␣␣␣Port | integer |
保留中のアクセス可能なポート番号 |
␣␣␣PreferredBackupWindow | string |
バックアップ時間 |
␣␣␣PreferredMaintenanceWindow | string |
メンテナンス時間 |
␣␣␣PubliclyAccessible | boolean |
グローバルIPアドレスを有効にするかどうか |
␣␣␣ReadReplicaDBInstanceIdentifiers | list |
リードレプリカ名リスト |
␣␣␣␣ReadReplicaDBInstanceIdentifier | string |
リードレプリカ名 |
␣␣␣ReadReplicaSourceDBInstanceIdentifier | string |
リードレプリカのマスターとして設定されているDBサーバー名 |
␣␣␣SecondaryAvailabilityZone | string |
待機系DBサーバーのゾーン
|
␣␣␣StatusInfos | list |
リードレプリカのステータス
|
␣␣␣␣DBInstanceStatusInfo | structure |
DBサーバーのステータス情報のリスト |
␣␣␣␣␣Message | string |
エラーメッセージ
|
␣␣␣␣␣Normal | boolean |
正常かどうか |
␣␣␣␣␣Status | string |
DBサーバーのステータス
|
␣␣␣␣␣StatusType | string |
DBサーバーのステータス種別 備考: 固定値"read replication"を返却 |
␣␣␣VpcSecurityGroups | string |
※返却値なし |
␣␣␣NiftyStorageType | integer |
ディスクタイプ 備考: ニフクラ独自仕様 |
␣␣␣NiftyNetworkId | string |
プライベートLANのネットワークユニークID 備考: ニフクラ独自仕様 |
␣␣␣NiftyMasterPrivateAddress | string |
主系DBサーバー用のプライベートIPアドレス 備考: ニフクラ独自仕様 |
␣␣␣NiftySlavePrivateAddress | string |
待機系DBサーバー用のプライベートIPアドレス 備考: ニフクラ独自仕様 |
␣␣␣AccountingType | string |
当月の利用料金タイプ |
␣␣␣NextMonthAccountingType | string |
翌月の利用料金タイプ |
␣ResponseMetadata | structure |
共通メタ情報 |
␣␣RequestId | string |
リクエスト識別子 |
エラー
コード | メッセージ | タイプ | HTTPステータスコード | 説明 |
---|---|---|---|---|
Client.InvalidParameterDuplicate.DBSnapshotIdentifier | Cannot create the snapshot because a snapshot with the identifier sample-snapshot already exists. |
Sender | 400 | すでに存在するDBSnapshotIdentifierを指定した場合 |
Client.InvalidParameterFormat.DBInstanceIdentifier | The parameter DBInstanceIdentifier is not a valid identifier. Identifiers must begin with a letter; must contain only lowercase ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens. |
Sender | 400 | DBInstanceIdentifierに無効な値(ハイフンから始まる 等)を指定した場合 |
Client.InvalidParameterFormat.DBSnapshotIdentifier | The parameter PreUpgradeDBSnapshotIdentifier is not a valid identifier. Identifiers must begin with a letter; must contain only lowercase ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens. |
Sender | 400 | PreUpgradeDBSnapshotIdentifierに無効な値(ハイフンから始まる 等)を指定した場合 |
Client.InvalidParameterIllegalInput.SkipPreUpgradeSnapshot | Sender | 400 | SkipPreUpgradeSnapshotにBoolean型以外の値を指定した場合 | |
Client.InvalidParameterNotAllowed.ReadReplica | The specified DB instance is read replica. |
Sender | 400 | リードレプリカを指定した場合 |
Client.InvalidParameterNotFound.DBInstance | DBInstance not found: aaa |
Sender | 404 | DBInstanceIdentifierに存在しないDBInstanceIdentifierを指定した場合 |
Client.InvalidParameterMissing.DBSnapshotIdentifier | PreUpgradeDBSnapshotIdentifier is required unless SkipPreUpgradeSnapshot is specified. |
Sender | 400 | SkipPreUpgradeSnapshot=falseの時、PreUpgradeDBSnapshotIdentifierを指定しなかった場合 |
Client.InvalidParameterRequired.DBInstanceIdentifier | The parameter DBInstanceIdentifier must be provided and must not be blank. |
Sender | 400 | 必須のDBInstanceIdentifierを指定しなかった場合 |
Client.InvalidParameterTooLong.DBInstanceIdentifier | The parameter DBInstanceIdentifier is not a valid identifier because it is longer than 63 characters. |
Sender | 400 | DBInstanceIdentifierに63文字を超える値を指定した場合 |
Client.InvalidParameterTooLong.DBSnapshotIdentifier | The parameter PreUpgradeDBSnapshotIdentifier is not a valid identifier because it is longer than 255 characters. |
Sender | 400 | PreUpgradeDBSnapshotIdentifierに255字を超える値を指定した場合 |
Client.LimitExceeded.NumberOfDBSnapshot | Request would result in user exceeding the allowed number of DB Snapshots. |
Sender | 400 | 作成可能なDBスナップショットの上限に達している場合 |
Client.ResourceInapplicable.DBSnapshotIdentifier | Only one of SkipPreUpgradeSnapshot and PreUpgradeDBSnapshotIdentifier can be specified |
Sender | 400 | SkipPreUpgradeSnapshot=trueの時、PreUpgradeDBSnapshotIdentifierを指定した場合 |
Client.ResourceIncorrectState.DBInstance.Unavailable | The specified DB Instance is not in the available state. |
Sender | 400 | DBサーバーのステータスが有効でない場合 |
Client.ResourceIncorrectState.DBInstanceUpgradeStatus.NotUpgradable | The upgrade status of the specified DB Instance is not upgradable. |
Sender | 400 | DBサーバーの基盤アップグレードステータスが「upgradable」でない場合 |
Client.ResourceIncorrectState.ReadReplica.Unavailable | TThe readreplica DB instance relevant to specified master DB instance is not the available. |
Sender | 400 | リードレプリカのステータスが有効でない場合 |
リクエストサンプル
https://jp-east-1.rdb.api.nifcloud.com/
?Action=UpgradeDBInstance
&DBInstanceIdentifier=mydbinstance
&SkipPreUpgradeSnapshot=true
&SignatureVersion=2
&SignatureMethod=HmacSHA256
&Timestamp=2013-12-09T00:00:00.000Z
&AWSAccessKeyId=<NIFCLOUD Access Key ID>
&Signature=<Signature>
応答サンプル
<UpgradeDBInstanceResponse>
<UpgradeDBInstanceResult>
<DBInstance>
<AllocatedStorage>50</AllocatedStorage>
<AutoMinorVersionUpgrade>false</AutoMinorVersionUpgrade>
<AvailabilityZone>east-13</AvailabilityZone>
<BackupRetentionPeriod>1</BackupRetentionPeriod>
<CACertificateIdentifier>rdb-ca-2023</CACertificateIdentifier>
<DBInstanceClass>db.small</DBInstanceClass>
<DBInstanceIdentifier>mydbinstance</DBInstanceIdentifier>
<DBInstanceStatus>modifying</DBInstanceStatus>
<DBInstanceUpgradeStatus>upgrading</DBInstanceUpgradeStatus>
<DBName>mydb</DBName>
<DBParameterGroups>
<DBParameterGroup>
<DBParameterGroupName>default.mysql5.6</DBParameterGroupName>
<ParameterApplyStatus>in-sync</ParameterApplyStatus>
</DBParameterGroup>
</DBParameterGroups>
<DBSecurityGroups>
<DBSecurityGroup>
<DBSecurityGroupName>mydbsecuritygroup</DBSecurityGroupName>
<Status>active</Status>
</DBSecurityGroup>
</DBSecurityGroups>
<Endpoint>
<Port>3306</Port>
<Address>XXX.XXX.XXX.XXX</Address>
<NiftyPrivateAddress>YYY.YYY.YYY.YYY</NiftyPrivateAddress>
</Endpoint>
<Engine>mysql</Engine>
<EngineVersion>5.6.12</EngineVersion>
<ExternalReplicationInfo>
<ReplicationAddresses>
<ReplicationAddress>xxx.xxx.xxx.xxx</ReplicationAddress>
<ReplicationAddress>yyy.yyy.yyy.yyy</ReplicationAddress>
</ReplicationAddresses>
<ReplicationPrivateAddresses>
<ReplicationPrivateAddress>xxx.xxx.xxx.xxx</ReplicationPrivateAddress>
<ReplicationPrivateAddress>yyy.yyy.yyy.yyy</ReplicationPrivateAddress>
</ReplicationPrivateAddresses>
</ExternalReplicationInfo>
<InstanceCreateTime>2013-11-30T06:28:42.000Z</InstanceCreateTime>
<LatestRestorableTime>2013-11-30T06:40:00.000Z</LatestRestorableTime>
<LicenseModel>general-public-license</LicenseModel>
<MasterUsername>mydbuser</MasterUsername>
<MultiAZ>true</MultiAZ>
<OptionGroupMemberships>
<OptionGroupMembership>
<OptionGroupName>default:mysql-5-6</OptionGroupName>
<Status>in-sync</Status>
</OptionGroupMembership>
</OptionGroupMemberships>
<PendingModifiedValues/>
<PreferredBackupWindow>05:30-06:00</PreferredBackupWindow>
<PreferredMaintenanceWindow>mon:06:01-mon:07:31</PreferredMaintenanceWindow>
<PubliclyAccessible>true</PubliclyAccessible>
<SecondaryAvailabilityZone>east-13</SecondaryAvailabilityZone>
<VpcSecurityGroups/>
<NiftyStorageType>0</NiftyStorageType>
<AccountingType>2</AccountingType>
<NextMonthAccountingType>2</NextMonthAccountingType>
</DBInstance>
</UpgradeDBInstanceResult>
<ResponseMetadata>
<RequestId>4838a0d1-e2ff-4da9-b675-0e3f9eb21c10</RequestId>
</ResponseMetadata>
</UpgradeDBInstanceResponse>