本文へジャンプします。

ニフクラ ユーザーガイド

クラウド トップ>API> RDB> ModifyDBInstance

ModifyDBInstance

処理概要

DBサーバーの設定を変更します。

一度に複数のDB設定を変更することができます。

一部のパラメーターは、ApplyImmediatelyをfalseに指定しても「今すぐ」適用されることにご注意ください。

また、設定変更内容によってはIO性能低下・DBサーバー停止・DBサービス停止を伴うことがあります。

詳しくはユーザガイドとRDB技術仕様を参照してください。

指定するパラメーター

パラメーター 説明 必須
AccountingType string 利用料金タイプ
値:
  • 1 (月額課金)
  • 2 (従量課金)
AllocatedStorage integer

ディスク容量(GB)

  • ※容量を減らすことはできません

値:
  • 50
  • 100
  • 150
  • 200
  • 250
Default: 既存の設定
AllowMajorVersionUpgrade boolean ※指定不可
ApplyImmediately boolean

「今すぐ」適用するかどうか

  • ※false を指定した場合には次回のメンテナンス時に変更が適用されます
  • ※一部のパラメーターはこのパラメーターのfalseであっても「今すぐ」変更が適用されることにご注意ください

Default: False
AutoMinorVersionUpgrade boolean ※指定不可
BackupRetentionPeriod integer

バックアップ保持期間(日)

  • ※リードレプリカのマスターDBサーバーでは0を指定することはできません

Default: 既存の設定
使用可能文字: 0〜10
BinlogRetentionPeriod integer

バイナリログ保持期間(日)
1-10が指定可能

  • ※CustomBinlogRetentionPeriod=trueでない場合は、本パラメータは無視されます
  • ※必ず「CustomBinlogRetentionPeriod=true」とセットで指定してください

○ (CustomBinlogRetentionPeriod=trueを指定した場合)
CustomBinlogRetentionPeriod boolean

独自のバイナリログ保持期間を設定するかどうか

  • ※false指定時はRDBのデフォルト値のバイナリログ保持期間が適用されます
  • ※MySQLのみ指定可能です
  • ※バックアップ保持期間が0日の場合は指定できません

CACertificateIdentifier string

DBサーバーのサーバー証明書と紐付くCA証明書

  • ※1〜63字のアルファベット・数字・ハイフン(‘-’)が使用できます
  • ※最初の文字はアルファベットである必要があります
  • ※末尾にハイフンをつけたりハイフンを2個連続させたりすることはできません

DBInstanceClass string DBサーバータイプ
値:
  • db.mini
  • db.e-small
  • db.small
  • db.e-small2
  • db.small2
  • db.e-small4
  • db.small4
  • db.e-small8
  • db.small8
  • db.e-small16
  • db.small16
  • db.e-medium
  • db.medium
  • db.e-medium4
  • db.medium4
  • db.e-medium8
  • db.medium8
  • db.e-medium16
  • db.medium16
  • db.e-medium24
  • db.medium24
  • db.e-large
  • db.large
  • db.e-large8
  • db.large8
  • db.e-large16
  • db.large16
  • db.e-large24
  • db.large24
  • db.e-large32
  • db.large32
  • db.e-extra-large8
  • db.extra-large8
  • db.e-extra-large16
  • db.extra-large16
  • db.e-extra-large24
  • db.extra-large24
  • db.e-extra-large32
  • db.extra-large32
  • db.e-extra-large48
  • db.extra-large48
  • db.e-double-large16
  • db.double-large16
  • db.e-double-large24
  • db.double-large24
  • db.e-double-large32
  • db.double-large32
  • db.e-double-large48
  • db.double-large48
  • db.e-double-large64
  • db.double-large64
  • db.e-double-large96
  • db.double-large96
  • db.triple-large32
  • db.triple-large48
  • db.triple-large64
  • db.triple-large96
  • db.triple-large128
  • db.quad-large64
  • db.quad-large96
  • db.quad-large128
  • db.septa-large128
Default: 既存の設定
DBInstanceIdentifier string 設定変更対象のDBサーバー名
DBParameterGroupName string

DBパラメーターグループ名

  • ※DBサーバーのエンジンに適合するDBパラメーターグループのみ指定できます

Default: 既存の設定
DBSecurityGroups.member.N string

DBファイアウォールグループのリスト

  • ※1つのみ指定可能です。複数指定した場合、2つ目以降は無視されます

EngineVersion string ※指定不可
Iops integer ※指定不可
MasterUserPassword string

マスターユーザーの新パスワード

  • ※「/」、「@」、「"」、「 」、「’」を除く印字可能なASCII文字が使用できます
  • ※MySQLの場合、1〜41文字で指定してください
  • ※PostgreSQLの場合、1〜128文字で指定してください
  • ※MariaDBの場合、1〜41文字で指定してください

Default: 既存の設定
MultiAZ boolean

冗長化機能を有効にするかどうか

  • ※DBサーバーがリードレプリカの場合、このパラメーターは指定できません

NiftyMultiAZType integer

冗長構成タイプ

  • 使用する冗長構成のタイプを指定
  • 本パラメータを指定する場合は、自動スナップショットが取得済みになっているDBサーバーを指定してください
  • また、必ず「MultiAZ=true」とセットで指定してください

値:
  • 0 (データ優先)
  • 1 (性能優先)
Default: 0
備考: ニフクラ独自仕様
NiftyReadReplicaDBInstanceIdentifier string

リードレプリカのDBサーバー名

MultiAZ=true, NiftyMultiAZType=1のとき、すでにリードレプリカがあるDBサーバーの場合は本パラメータは無視されます

  • ※1〜63字のアルファベット(小文字)・数字・ハイフン(‘-’)が使用できます
  • ※最初の文字はアルファベットである必要があります
  • ※末尾にハイフンをつけたりハイフンを2個連続させたりすることはできません

備考: ニフクラ独自仕様
NewDBInstanceIdentifier string

名前変更する場合の新しいDBサーバー名

  • ※1〜63字のアルファベット(小文字)・数字・ハイフン(‘-’)が使用できます
  • ※最初の文字はアルファベットである必要があります
  • ※末尾にハイフンをつけたりハイフンを2個連続させたりすることはできません

OptionGroupName string ※指定不可
備考: 対象外
PreferredBackupWindow string

バックアップ時間帯

  • ※自動バックアップが有効の場合に日次のバックアップが行われる時間帯を指定します
  • ※30分間以上の時間帯を指定する必要があります
  • ※指定がない場合には、リージョンごとに定められた10時間の中からランダムに30分間が決定されます
    時間帯については、クラウド技術仕様(RDB:自動バックアップ)をご参照ください
  • ※時刻の指定はUTCで行ってください
  • ※PreferredMaintenanceWindow と重複した時間帯を設定することはできません
  • ※バックアップは条件により30分を超えて行われることがあります
  • 形式: hh24:mi-hh24:mi

PreferredMaintenanceWindow string

メンテナンス時間帯

  • ※週次のメンテナンスが行われる時間帯を指定します
  • ※30分間以上23時間30分以内の時間帯を指定する必要があります
  • ※指定がない場合には、リージョンごとに定められた10時間の中からランダムに30分間が決定されます(曜日もランダムで決定されます)
    時間帯については、クラウド技術仕様(RDB:メンテナンス)をご参照ください
  • ※時刻の指定はUTCで行ってください
  • ※メンテナンスの内容によってはDBサーバーの停止やDBサービスの再起動が行われる場合があります (詳しくはユーザーガイドを参照してください)

RDB:メンテナンス

  • ※現在時間を含む時間帯を指定するとこのパラメーター以外で指定した変更および保留中の変更が「今すぐ」適用されます
  • ※メンテナンスは条件により30分を超えて行われることがあります
  • 形式:ddd:hh24:mi-ddd:hh24:mi
  • 曜日部分の値: Mon, Tue, Wed, Thu, Fri, Sat, Sun
  • 例. Sun:05:00-Sun:06:00

Default: 既存の設定
ReadReplicaAccountingType string

リードレプリカの利用料金タイプ

  • MultiAZ=true, NiftyMultiAZType=1のとき、すでにリードレプリカがあるDBサーバーの場合は本パラメータは無視されます

値:
  • 1 (月額課金)
  • 2 (従量課金)
Default: 2
VpcSecurityGroupIds.member.N string ※指定不可
NiftySlavePrivateAddress string 待機系DBサーバー用のプライベートIPアドレス
備考: ニフクラ独自仕様
○ (プライベートLANを利用している場合、かつ、MultiAZをfalseからtrue(NiftyMutiAZType = 0)に変更した場合)
NiftyReadReplicaPrivateAddress string

リードレプリカ用のプライベートIPアドレス

MultiAZ=true, NiftyMultiAZType=1のとき、すでにリードレプリカがあるDBサーバーの場合は本パラメータは無視されます


備考: ニフクラ独自仕様
○ (リードレプリカが存在しない、かつ、プライベートLANを利用している場合、かつ、MultiAZをfalseからtrue(NiftyMutiAZType = 1)に変更した場合)

応答フィールド

フィールド (項目) 説明
ModifyDBInstanceResponse structure ルート
ModifyDBInstanceResult structure 結果
DBInstance structure DBサーバー
備考: DBInstanceの子要素はDescribeDBInstancesで返却される要素をすべて記載しているためAPIによっては返却されない要素もあります。実際のレスポンスはレスポンスサンプルを参照してください。
AllocatedStorage integer 割り当てるディスク容量(GB)
AutoMinorVersionUpgrade boolean マイナーバージョンの自動アップデートを行うかどうか
備考: 固定値falseを返却
AvailabilityZone string DBサーバーのゾーン
BackupRetentionPeriod integer バックアップ保持期間
BinlogRetentionPeriod integer

バイナリログ保持期間(日)

  • BinlogRetentionPeriodを変更した場合のみ要素を返却します。

ExternalReplicationInfo structure

外部レプリケーション情報

  • ※DBサーバーが以下の場合のみこのタグは返却されます
  • MySQLでシングル構成
  • MySQLで冗長構成 (データ優先)

ExternalReplicationMessage string

外部レプリケーション操作結果

  • ※エラー発生時は、実行時に出力されたメッセージ

ExternalReplicationStatus string

外部レプリケーション操作ステータス

  • set(SetExternalMaster実行成功 & StartReplication未実行)
  • started(StartReplication実行成功 & StopReplication未実行)
  • stopped(StopReplication実行成功 & ResetExternalMaster未実行)
  • set-error(SetExternalMaster実行失敗)
  • start-error(StartReplication実行失敗)
  • stop-error(StopReplication実行失敗)
  • reset-error(ResetExternalMaster実行失敗)

ReplicationAddresses list 外部レプリケーション接続元グローバルIPアドレスリスト
ReplicationAddress string

外部レプリケーション接続元グローバルIPアドレス

  • ※シングル構成の場合は外部レプリケーション接続元グローバルIPアドレスを1つ返却します
  • ※冗長構成(データ優先)の場合は外部レプリケーション接続元グローバルIPアドレスを2つ返却します

ReplicationPrivateAddresses list 外部レプリケーション接続元プライベートIPアドレスリスト
ReplicationPrivateAddress string

外部レプリケーション接続元プライベートIPアドレス

  • ※シングル構成の場合は外部レプリケーション接続元プライベートIPアドレスを1つ返却します
  • ※冗長構成(データ優先)の場合は外部レプリケーション接続元プライベートIPアドレスを2つ返却します

ExternalMasterAddress string マスターとなるDBサーバーのIPアドレスまたはホスト名
CACertificateIdentifier string DBサーバーのサーバー証明書と紐付くCA証明書
DBInstanceClass string DBサーバータイプ
DBInstanceIdentifier string DBサーバー名
DBInstanceStatus string DBサーバーのステータス
DBName string DB名
DBParameterGroups list DBパラメーターグループ情報リスト
DBParameterGroup structure DBパラメーターグループ
DBParameterGroupName string DBパラメーターグループ名
ParameterApplyStatus string

DBパラメーターの適用ステータス

  • 値:applying(適用中) | pending-reboot(再起動待ち) | in-sync(適用済み)

DBSecurityGroups list DBファイアウォールグループ情報リスト
DBSecurityGroup structure DBファイアウォールグループ
DBSecurityGroupName string DBファイアウォールグループ名
Status string

DBファイアウォールグループのステータス

  • 値:active(有効) | adding(適用中) | removing(取り外し中) | failed(変更失敗)

Endpoint structure DB接続時のエンドポイント
Port integer ポート番号
Address string

グローバルIPアドレス

  • ※PubliclyAccessibleがオフの場合、このタグは返却されません。

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

下記の固定値を返却

  • DBエンジンがMySQL 5.5系の場合、default:mysql-5-5
  • DBエンジンがMySQL 5.6系の場合、default:mysql-5-6
  • DBエンジンがMySQL 5.7系の場合、default:mysql-5-7
  • DBエンジンがPostgreSQL9.3系の場合、default:postgres-9-3
  • DBエンジンがPostgreSQL9.6系の場合、default:postgres-9-6
  • DBエンジンがPostgreSQL11系の場合、default:postgres-11
  • DBエンジンがMariaDB10.1系の場合、default:mariadb-10-1

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サーバーのゾーン

  • ※冗長化機能がオンの場合、固定でAvailabilityZoneと同じ値が返却されます
  • ※冗長化機能がオフの場合、このタグは返却されません

StatusInfos list

リードレプリカのステータス

  • ※DBサーバーがリードレプリカでない場合、空タグが返却されます

DBInstanceStatusInfo structure DBサーバーのステータス情報のリスト
Message string

エラーメッセージ

  • ※エラーが発生していない場合は空タグが返却されます

Normal boolean 正常かどうか
Status string

DBサーバーのステータス

  • 値(StatusTypeが“read replication”の場合): replicating(レプリケーション中) | error(レプリケーションエラー)

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.InvalidParameterCannotSpecify.AllocatedStorage

AllocatedStorage should specify the multiple of 50.

Sender 400 AllocatedStorageに50の倍数でない値を指定した場合
Client.InvalidParameterCannotSpecify.BackupRetentionPeriod

Multi-AZ deployment Type: 1 is not enabled for this database instance. To enable Multi-AZ deployment Type: 1, set the backup retention period to a non-zero value.

Sender 400 NiftyMultiAZType=1の時、BackupRetentionPeriodに0を指定した場合
Client.InvalidParameterCannotSpecify.BackupRetentionPeriod

Invalid backup retention period: 0. Retention period must be between 1 and 10.

Sender 400 リードレプリカを持つマスターのDBサーバーのBackupRetentionPeriodを0に変更しようとした場合
Client.InvalidParameterCannotSpecify.CustomBinlogRetentionPeriod

Automated backups are not enabled for this database instance. To enable automated backups, use ModifyDBInstance to set the backup retention period to a non-zero value.

Sender 400 BackupRetentionPeriodが0のDBサーバーでCustomBinlogRetentionPeriodを指定した場合
Client.InvalidParameterCannotSpecify.DBInstanceClass

Specified DB Instance class is not available in the specified Availability Zone.

Sender 400 指定されたAvailabilityZoneで作成できないDBサーバータイプを指定した場合
Client.InvalidParameterCannotSpecify.DBSecurityGroupName

DBSecurityGroupName must not contain leading or trailing spaces.

Sender 400 DBSecurityGroups.member.Nの最初または最後にスペースを入力した場合
Client.InvalidParameterCannotSpecify.Engine

CustomBinlogRetentionPeriod: true is not enabled for this database instance. To enable CustomBinlogRetentionPeriod: true, set the engine to a mysql.

Sender 400 CustomBinlogRetentionPeriodを指定したとき、DBエンジンがmysqlでない場合
Client.InvalidParameterCannotSpecify.Engine

Multi-AZ deployment Type: 1 is not enabled for this database instance. To enable Multi-AZ deployment Type: 1, set the engine to a mysql.

Sender 400 NiftyMultiAZType=1の時、Engineにpostgresまたはmariadbを指定した場合
Client.InvalidParameterCannotSpecify.MasterUserPassword

The parameter MasterUserPassword is not a valid password. Only printable ASCII characters besides ‘/’, ‘@’, ‘"’, ’ ‘,’'’ may be used.

Sender 400 MasterUserPasswordに無効な値(@など)を指定した場合
Client.InvalidParameterCannotSpecify.NiftyReadReplicaPrivateAddress

NiftyReadReplicaPrivateAddress is not allowed in the range of 10.0.0.0/8.

Sender 400 NiftyReadReplicaPrivateAddressに許可されないIPアドレスを指定した場合
Client.InvalidParameterCannotSpecify.NiftySlavePrivateAddress

NiftySlavePrivateAddress is not allowed in the range of 10.0.0.0/8.

Sender 400 NiftySlavePrivateAddressに許可されないIPアドレスを指定した場合
Client.InvalidParameterCannotSpecify.PreferredBackupWindow

Invalid backup window time ‘23:00-24:00’ specified. Should be specified as a time hh24:mi (24H Clock UTC). Example: 03:15

Sender 400 PreferredBackupWindowに24:00を指定した場合
Client.InvalidParameterCannotSpecify.PreferredBackupWindow

Backup window must be at least 30 minutes.

Sender 400 PreferredBackupWindowに30分未満を指定した場合
Client.InvalidParameterCannotSpecify.PreferredBackupWindow

The specified backup window overlaps all available default maintenance windows. Shrink the backup window or specify a non-overlapping maintenance window.

Sender 400 PreferredBackupWindowにPreferredMaintenanceWindowを設定する余地がない時間を指定した場合(0:00-23:40 等)
Client.InvalidParameterCannotSpecify.PreferredMaintenanceWindow

Maintenance window must be at least 30 minutes.

Sender 400 PreferredMaintenanceWindowに30分未満を指定した場合
Client.InvalidParameterCannotSpecify.PreferredMaintenanceWindow

Maintenance window must be less than 24 hours.

Sender 400 PreferredMaintenanceWindowに24時間を超える値を指定した場合
Client.InvalidParameterCannotSpecify.PreferredMaintenanceWindow

Maintenance window cannot end before it begins.

Sender 400 PreferredMaintenanceWindowのTOがFROMより前の場合
Client.InvalidParameterCannotSpecify.PreferredMaintenanceWindow

The specified maintenance window overlaps all available default backup windows. Shrink the maintenance window or specify a non-overlapping backup window.

Sender 400 PreferredMaintenanceWindowにPreferredBackupWindowを設定する余地がない時間を指定した場合(0:00-23:40 等)
Client.InvalidParameterCombination.BackupRetentionPeriod.and.BinlogRetentionPeriod

BinlogRetentionPeriod: 1 with BackupRetentionPeriod: 0 cannot be enable. To enable BinlogRetentionPeriod: 1, set the backup retention period to a non-zero value.

Sender 400 BackupRetentionPeriod=0とBinlogRetentionPeriodを同時に指定した場合
Client.InvalidParameterCombination.DBParameterGroupFamily.and.DBParameterGroup
  • MySQLの場合
    The Parameter Group default.mysql5.1 with DBParameterGroupFamily mysql5.1 cannot be used for this instance. Please use a Parameter Group with DBParameterGroupFamily mysql5.5
  • PostgreSQLの場合
    The Parameter Group default.postgresn.n with DBParameterGroupFamily postgresn.n cannot be used for this instance. Please use a Parameter Group with DBParameterGroupFamily postgres9.3
  • MariaDBの場合
    The Parameter Group default.mariadbn.n with DBParameterGroupFamily mariadbn.n cannot be used for this instance. Please use a Parameter Group with DBParameterGroupFamily mariadb10.1
Sender 400 DBサーバーのDBParameterGroupFamilyと異なるDBパラメーターグループを指定した場合
Client.InvalidParameterDuplicate.DBInstanceIdentifier

There is already an instance named as sample-dbinstance. Please choose another name.

Sender 400 NewDBInstanceIdentifierにすでに存在するDBInstanceIdentifierを指定した場合
Client.InvalidParameterDuplicate.DBInstanceIdentifier.and.NiftyReadReplicaDBInstanceIdentifier

can not set the same value in DBInstanceIdentifier and NiftyReadReplicaDBInstanceIdentifier.

Sender 400 DBInstanceIdentifierとNiftyReadReplicaDBInstanceIdentifierに、同じ値を指定した場合
Client.InvalidParameterDuplicate.NiftyReadReplicaDBInstanceIdentifier

DB Instance already exists

Sender 400 NiftyReadReplicaDBInstanceIdentifierにすでに存在するDBInstanceIdentifierを指定した場合
Client.InvalidParameterDuplicate.NiftySlavePrivateAddress

Private address is already in use: 192.168.1.111

Sender 400 NiftySlavePrivateAddressにすでに使用済みのIPアドレスを指定した場合
Client.InvalidParameterDuplicate.PreferredBackupWindow.and.PreferredMaintenanceWindow

The backup window and maintenance window must not overlap.

Sender 400 PreferredBackupWindowとPreferredMaintenanceWindowが重なるように指定した場合
Client.InvalidParameterDuplicate.PrivateAddress

Private address is already in use: 192.168.1.110

Sender 400 NiftySlavePrivateAddress、NiftyReadReplicaPrivateAddressにすでに使用済みのIPアドレスを指定した場合
Client.InvalidParameterFormat.CACertificateIdentifier

The parameter CACertificateIdentifier is not a valid identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

Sender 400 CACertificateIdentifierに無効な値(ハイフンから始まる 等)を指定した場合
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.DBInstanceIdentifier

The parameter NewDBInstanceIdentifier 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 NewDBInstanceIdentifierに無効な値(ハイフンから始まる 等)を指定した場合
Client.InvalidParameterFormat.DBSecurityGroupName

DBSecurityGroupName can contain only lowercase ASCII letters and digits, spaces, underscores, and hyphens.

Sender 400 DBSecurityGroupNameに無効な値(ハイフンから始まる 等)を指定した場合
Client.InvalidParameterFormat.NiftyReadReplicaDBInstanceIdentifier

The parameter NiftyReadReplicaDBInstanceIdentifier 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 NiftyReadReplicaDBInstanceIdentifierに無効な値(ハイフンから始まる 等)を指定した場合
Client.InvalidParameterFormat.NiftyReadReplicaPrivateAddress

Invalid NiftyReadReplicaPrivateAddress: aaa.bbb.ccc.ddd.

Sender 400 NiftyReadReplicaPrivateAddressにIPアドレスとして無効な値を指定した場合
Client.InvalidParameterFormat.NiftySlavePrivateAddress

Invalid NiftySlavePrivateAddress: aaa.bbb.ccc.ddd.

Sender 400 NiftySlavePrivateAddressにIPアドレスとして無効な値を指定した場合
Client.InvalidParameterFormat.PreferredBackupWindow

Invalid backup window time ‘11:22’ specified. Should be specified as a time hh24:mi (24H Clock UTC). Example: 03:15

Sender 400 PreferredBackupWindowに無効なフォーマット(11:22 等)で指定した場合
Client.InvalidParameterFormat.PreferredMaintenanceWindow

Invalid maintenance window format. Should be specified as a range ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). Example: Sun:23:45-Mon:00:15

Sender 400 PreferredMaintenanceWindowに無効な値(aaa 等)を指定した場合
Client.InvalidParameterFormat.PreferredMaintenanceWindow

Invalid maintenance window time ‘aaa:12:00’ specified. Should be specified as a time ddd:hh24:mi (24H Clock UTC). Example: Mon:00:15

Sender 400 PreferredMaintenanceWindowに無効なフォーマットの値(sun:10:11-01:11 等)を指定した場合
Client.InvalidParameterIllegalInput.AccountingType

Invalid Accounting Type: 3

Sender 400 AccountingTypeに1,2以外を指定した場合
Client.InvalidParameterIllegalInput.AllocatedStorage
Sender 400 AllocatedStorageに数値でない値を指定した場合
Client.InvalidParameterIllegalInput.ApplyImmediately
Sender 400 ApplyImmediatelyに真偽値型でない値を指定した場合
Client.InvalidParameterIllegalInput.BackupRetentionPeriod
Sender 400 BackupRetentionPeriodに数値でない値を指定した場合
Client.InvalidParameterIllegalInput.BinlogRetentionPeriod

Invalid BinlogRetentionPeriod: 11

Sender 400 BinlogRetentionPeriodに1-10以外を指定した場合
Client.InvalidParameterIllegalInput.CustomBinlogRetentionPeriod
Sender 400 CustomBinlogRetentionPeriodに真偽値型でない値を指定した場合
Client.InvalidParameterIllegalInput.DBInstanceClass

Invalid DB instance class:aaa

Sender 400 DBInstanceClassに存在しないDBサーバータイプを指定した場合
Client.InvalidParameterFormat.DBParameterGroupName

The parameter DBParameterGroupName 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 ParameterGroupNameに無効な値を指定した場合
Client.InvalidParameterIllegalInput.MultiAZ
Sender 400 MultiAZに真偽値型でない値を指定した場合
Client.InvalidParameterIllegalInput.NiftyMultiAZType

Invalid Multi-AZ deployment Type: 9

Sender 400 NiftyMultiAZTypeに 0,1以外を指定した場合
Client.InvalidParameterIllegalInput.ReadReplicaAccountingType

Invalid ReadReplica Accounting Type: 3

Sender 400 ReadReplicaAccountingTypeに1,2以外を指定した場合
Client.InvalidParameterMissing.BinlogRetentionPeriod

The parameter BinlogRetentionPeriod must be provided and must not be blank for CustomBinlogRetentionPeriod instances.

Sender 400 CustomBinlogRetentionPeriod=trueのとき、BinlogRetentionPeriodを指定しなかった場合
Client.InvalidParameterMissing.NiftyReadReplicaDBInstanceIdentifier

The parameter NiftyReadReplicaDBInstanceIdentifier must be provided and must not be blank for ReadReplica instances.

Sender 400 リードレプリカが存在しない、かつ、NiftyMultiAZType=1の時、NiftyReadReplicaDBInstanceIdentifierを指定しなかった場合
Client.InvalidParameterMissing.NiftyReadReplicaPrivateAddress

The parameter NiftyReadReplicaPrivateAddress must be provided and must not be blank for ReadReplica instances.

Sender 400 リードレプリカが存在しない、かつ、プライベートLANを利用している、かつ、NiftyMultiAZType=1の時、NiftyReadReplicaPrivateAddressを指定しなかった場合
Client.InvalidParameterMissing.NiftySlavePrivateAddress

The parameter NiftySlavePrivateAddress must be provided and must not be blank for Multi-AZ instances.

Sender 400 プライベートLANを利用しているかつ、NiftyMultiAZType=0の時、NiftySlavePrivateAddressを指定しなかった場合
Client.InvalidParameterNotAllowed.BackupRetentionPeriodOfReadReplica

DB Backups not supported on a read replica.

Sender 400 リードレプリカのBackupRetentionPeriodを0以外に変更しようとした場合
Client.InvalidParameterNotAllowed.DBParameterGroupOfPostgresDBInstanceWithReadReplica

The parameter DBParameterGroupName cannot be modified. The specified DB Instance has read replicas.

Sender 400 (postgresの場合のみ) リードレプリカを持つDBサーバーに対してDBParameterGroupNameの変更をしようとした場合
Client.InvalidParameterNotAllowed.DBParameterGroupOfPostgresReadReplica

The parameter DBParameterGroupName cannot be modified. The specified DB Instance is read replica.

Sender 400 (postgresの場合のみ) リードレプリカに対してDBParameterGroupNameの変更をしようとした場合
Client.InvalidParameterNotAllowed.LowerDBInstanceClassOfPostgresReadReplica

The DBInstanceClass of read replica must be greater than or equal to the source instance.

Sender 400 (postgresの場合のみ) マスターDBサーバーよりDBサーバータイプのスペックが低いリードレプリカに変更しようとした場合
Client.InvalidParameterNotAllowed.MasterUserPasswordOfPostgresReadReplica

Cannot modify MasterUserPassword on a read replica for DB Engine ‘postgres’.

Sender 400 (postgresの場合のみ) リードレプリカのMasterUserPasswordを変更しようとした場合
Client.InvalidParameterNotAllowed.MultiAZOfReadReplica

Cannot convert a read replica to run as a Multi-AZ deployment.

Sender 400 リードレプリカのMultiAZをtrueに変更しようとした場合
Client.InvalidParameterNotAllowed.UpperDBInstanceClassOfPostgresMaster

The DBInstanceClass of master must be less than or equal to the read replica.

Sender 400 (postgresの場合のみ) リードレプリカよりDBサーバータイプのスペックが高いマスターDBサーバーに変更しようとした場合
Client.InvalidParameterNotFound.AvailableDBSnapshot

Automated backups are not enabled for this database instance. To enable automated backups, use ModifyDBInstance to set the backup retention period to a non-zero value.

Sender 400 有効な自動バックアップが存在しないDBサーバーに対して、NiftyMultiAZTypeに1を指定した場合
Client.InvalidParameterNotFound.CACertificateIdentifier

Certificate not found: aaa

Sender 404 存在しないCACertificateIdentifierを指定した場合
Client.InvalidParameterNotFound.DBInstance

DBInstance not found: aaa

Sender 404 DBInstanceIdentifierに存在しないDBInstanceIdentifierを指定した場合
Client.InvalidParameterNotFound.DBParameterGroup

DBParameterGroup not found: aaa

Sender 404 存在しないDBParameterGroupNameを指定した場合
Client.InvalidParameterNotFound.DBSecurityGroup

DBSecurityGroup not found: aaa

Sender 400 存在しないDBSecurityGroups.member.Nを指定した場合
Client.InvalidParameterOutOfRange.AllocatedStorage

Invalid storage size: 5,000. The storage size for the specified instance class and database engine must be between 50 and 250 GB.

Sender 400 AllocatedStorageに50〜指定された最大値(デフォルトは250)でない値を指定した場合
Client.InvalidParameterOutOfRange.NiftyReadReplicaPrivateAddress

Invalid NiftyReadReplicaPrivateAddress: 192.168.100.100. Valid range is 192.168.1.1-192.168.1.254

Sender 400 NiftyReadReplicaPrivateAddressにサブネットの範囲外のIPアドレスを指定した場合
Client.InvalidParameterOutOfRange.NiftyReadReplicaPrivateAddress

Invalid NiftyReadReplicaPrivateAddress: 192.168.1.115/8. Valid CIDR prefix is /24

Sender 400 NiftyReadReplicaPrivateAddressのプレフィックスにプライベートLAN作成時に指定したプレフィックスと異なる値を指定した場合
Client.InvalidParameterOutOfRange.NiftySlavePrivateAddress

Invalid NiftySlavePrivateAddress: 192.168.128.31. Valid range is 192.168.128.1-192.168.128.30

Sender 400 NiftySlavePrivateAddressにサブネットの範囲外のIPアドレスを指定した場合
Client.InvalidParameterOutOfRange.NiftySlavePrivateAddress

Invalid NiftySlavePrivateAddress: 192.168.1.114/8. Valid CIDR prefix is /24

Sender 400 NiftySlavePrivateAddressのプレフィックスにプライベートLAN作成時に指定したプレフィックスと異なる値を指定した場合
Client.InvalidParameterRequired.DBInstanceIdentifier

The parameter DBInstanceIdentifier must be provided and must not be blank.

Sender 400 必須のDBInstanceIdentifierを指定しなかった場合
Client.InvalidParameterTooLarge.BackupRetentionPeriod

Invalid backup retention period: 100. Retention period must be between 0 and 10.

Sender 400 BackupRetentionPeriodに10より大きい数字を指定した場合
Client.InvalidParameterTooLong.CACertificateIdentifier

The parameter CACertificateIdentifier is not a valid identifier because it is longer than 63 characters.

Sender 400 CACertificateIdentifierに63文字を超える値を指定した場合
Client.InvalidParameterTooLong.DBInstanceIdentifier

The parameter DBInstanceIdentifier is not a valid identifier because it is longer than 63 characters.

Sender 400 DBInstanceIdentifierに63文字を超える値を指定した場合
Client.InvalidParameterTooLong.DBInstanceIdentifier

The parameter NewDBInstanceIdentifier is not a valid identifier because it is longer than 63 characters.

Sender 400 NewDBInstanceIdentifierに63文字を超える値を指定した場合
Client.InvalidParameterTooLong.DBParameterGroupName

The parameter DBParameterGroupName is not a valid identifier because it is longer than 255 characters.

Sender 400 DBParameterGroupNameに255文字を超える値を指定した場合
Client.InvalidParameterTooLong.MasterUserPassword

The parameter MasterUserPassword is not a valid password because it is longer than 41 characters.

Sender 400 MasterUserPasswordに41文字を超える値を指定した場合
Client.InvalidParameterTooLong.NiftyReadReplicaDBInstanceIdentifier

The parameter NiftyReadReplicaDBInstanceIdentifier is not a valid identifier because it is longer than 63 characters.

Sender 400 NiftyReadReplicaDBInstanceIdentifierに63文字を超える値を指定した場合
Client.LimitExceeded.NumberOfDBInstance

Request would result in user exceeding the allowed number of DB Instances.

Sender 400 作成可能なDBサーバーの上限に達している場合
Client.ResourceInapplicable.CACertificateIdentifierAndOtherParameters

The parameter CACertificateIdentifier can not be modified with other parameters.

Sender 400 CACertificateIdentifierと同時に、他要素を指定した場合(ApplyImmediatelyは除く)
Client.ResourceInapplicable.LessAllocatedStorage

Requested storage size (50) cannot be less then the current storage size (100)

Sender 400 AllocatedStorageに現在より小さい値を指定した場合
Client.ResourceInapplicable.NiftyMultiAZType0

Multi-AZ deployment Type: 0 is not enabled for this database instance. To enable Multi-AZ deployment Type: 0, set the Single AZ.

Sender 400 NiftyMultiAZType=1のDBサーバーに対して、NiftyMultiAZTypeに0を指定した場合
Client.ResourceInapplicable.NiftyMultiAZType1

Multi-AZ deployment Type: 1 is not enabled for this database instance. To enable Multi-AZ deployment Type: 1, set the Single AZ.

Sender 400 NiftyMultiAZType=0のDBサーバーに対して、NiftyMultiAZTypeに1を指定した場合
Client.ResourceInapplicable.NiftyMultiAZType1

Multi-AZ deployment Type: 1 is not enabled for this database instance. This operation is allowed only those that were created before 2015/04/08.

Sender 400 2015/04/08 以前に作成されたマスタDBを、冗長構成タイプを1に変更しようとした場合
Client.ResourceInapplicable.NiftyMultiAZType1

Multi-AZ deployment Type: 1 is not enabled for this DB Instance when this DB Instance has external replication settings.

Sender 400 外部レプリケーションが設定されているDBサーバーに対して、NiftyMultiAZTypeに1を指定した場合
Client.ResourceIncorrectState.DBInstance.CannotModify

The specified database instance is currently in the storage-full state. The only modification permitted on a database instance in this state is an increase in allocated storage.

Sender 400 DBサーバーのステータスが「storage-full」の時、ディスクサイズの増加以外の変更をしようとした場合
Client.ResourceIncorrectState.DBInstance.CannotModify

Database instance is not in available state.

Sender 400 DBサーバーのステータスが「incompatible-parameters」の時、DBパラメーターグループ以外の変更をしようとした場合
Client.ResourceIncorrectState.DBInstance.Unavailable

The specified DB Instance is not in the available state.

Sender 400 DBサーバーのステータスが有効でない場合
Client.ResourceIncorrectState.DBParameterGroup.Applying

The database instance has been modified by a concurrent operation. Please check the instance’s status and try again.

Sender 400 ステータスが「applying」のDBパラメーターグループに対し、DBParameterGroupNameに指定した場合
Client.ResourceIncorrectState.DBSecurityGroup.Processing

DBSecurityGroup is not in available state.

Sender 400 変更しようとしたDBファイアウォールグループのルールに、ステータス「authorizing」または「revoking」のルールが存在する場合
Client.ResourceIncorrectState.ReadReplica.ReplicationError

Multi-AZ deployment Type: 1 is not enabled for this database instance. Replica instance sample-readreplica is in replication error.

Sender 400 レプリケーションエラーが発生している状態で、NiftyMultiAZTypeを1に変更しようとした場合
Client.ResourceIncorrectState.ReadReplica.Unavailable

A read replica that replicates the specified DB instance is not in the available state.

Sender 400 冗長構成タイプが1のリードレプリカのDBサーバータイプを変更する時、マスターDBサーバーのステータスが有効でない場合
Client.ResourceIncorrectState.ReadReplicaSourceDBInstance.Unavailable

The master DB instance relevant to specified readreplica DB instance is not the available.

Sender 400 冗長構成タイプが1のマスターDBサーバーのDBサーバータイプを変更する時、全てのリードレプリカのステータスが有効でない場合
Client.ZoneMisMatch.DBInstance.and.DBSecurityGroup

DBSecurityGroup default.west-11 cannot be used in east-21 zone. The availability zone of default.west-11 is west-11.

Sender 400 DBサーバーのゾーンと異なるゾーンに所属するDBファイアウォールグループをDBSecurityGroups.member.Nに指定した場合

リクエストサンプル

    https://jp-east-1.rdb.api.nifcloud.com/
?Action=ModifyDBInstance
&DBInstanceIdentifier=mydbinstance
&AllocatedStorage=100
&ApplyImmediately=false
&SignatureVersion=2
&SignatureMethod=HmacSHA256
&Timestamp=2013-12-09T00%3A00%3A00.000Z
&AWSAccessKeyId=<NIFCLOUD Access Key ID>
&Signature=<Signature> 

  

応答サンプル

    <ModifyDBInstanceResponse>
    <ModifyDBInstanceResult>
      <DBInstance>
        <AllocatedStorage>50</AllocatedStorage>
        <AutoMinorVersionUpgrade>false</AutoMinorVersionUpgrade>
        <AvailabilityZone>east-13</AvailabilityZone>
        <BackupRetentionPeriod>1</BackupRetentionPeriod>
        <DBInstanceClass>db.mini</DBInstanceClass>
        <DBInstanceIdentifier>mydbinstance</DBInstanceIdentifier>
        <DBInstanceStatus>available</DBInstanceStatus>
        <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>
            <AllocatedStorage>100</AllocatedStorage>
        </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>
  </ModifyDBInstanceResult>
  <ResponseMetadata>
    <RequestId>f68b9a04-4abb-43ed-99d9-510ede160118</RequestId>
  </ResponseMetadata>
</ModifyDBInstanceResponse> 

  
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2021年9月13日時点の情報です。

推奨画面サイズ 1024×768 以上