本文へジャンプします。

ニフクラ ユーザーガイド

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

ModifyDBInstanceNetwork

処理概要

DBサーバーのプライベートLAN・プライベートIPアドレスを変更します。

指定するパラメーター

パラメーター 説明 必須
DBInstanceIdentifier string

DBサーバー名

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

NiftyNetworkId string 変更先のプライベートLANのネットワークID
使用可能文字: net-COMMON_PRIVATE(共通プライベートにする場合) | プライベートLANのネットワークユニークID(プライベートLANにする場合)
備考: ニフクラ独自仕様
○ (共通プライベート→プライベートLANの場合、またはプライベートLAN→共通プライベートの場合、またはプライベートLANから別のプライベートLANへの変更の場合)
NiftyVirtualPrivateAddress string 仮想ロードバランサー用のプライベートIPアドレス
備考: ニフクラ独自仕様
○ (共通プライベート→プライベートLANの場合、またはプライベートLANから別のプライベートLANへの変更の場合、または同じプライベートLANでプライベートIPアドレスの変更の場合)
NiftyMasterPrivateAddress string 主系DBサーバー用のプライベートIPアドレス
備考: ニフクラ独自仕様
○ (共通プライベート→プライベートLANの場合、またはプライベートLANから別のプライベートLANへの変更の場合、または同じプライベートLANでプライベートIPアドレスの変更の場合)
NiftySlavePrivateAddress string 待機系DBサーバー用のプライベートIPアドレス
備考: ニフクラ独自仕様
○ (冗長化構成(データ優先)かつ次のいずれかを満たす場合。共通プライベート→プライベートLANの場合、またはプライベートLANから別のプライベートLANへの変更の場合、または同じプライベートLANでプライベートIPアドレスの変更の場合)

応答フィールド

フィールド (項目) 説明
ModifyDBInstanceNetworkResponse structure ルート
ModifyDBInstanceNetworkResult 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
備考: ニフクラ独自仕様
AccountingType string 当月の利用料金タイプ
NextMonthAccountingType string 翌月の利用料金タイプ
ResponseMetadata structure 共通メタ情報
RequestId string リクエスト識別子

エラー

コード メッセージ タイプ HTTPステータスコード 説明
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.InvalidParameterNotFound.DBInstance

DBInstance aaa not found.

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

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

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

The specified DB Instance is not in the available state.

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

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

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

Invalid NiftyMasterPrivateAddress: aaa.bbb.ccc.ddd.

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

Invalid NiftySlavePrivateAddress: aaa.bbb.ccc.ddd.

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

Invalid NiftyVirtualPrivateAddress: aaa.bbb.ccc.ddd.

Sender 400 NiftyVirtualPrivateAddressにIPアドレスとして無効な値を指定した場合
Client.InvalidParameterDuplicate.PrivateAddress

Private addresses are not unique: 192.168.1.112

Sender 400 NiftyVirtualPrivateAddress、NiftyMasterPrivateAddress、NiftySlavePrivateAddressに重複したIPアドレスを指定した場合
Client.InvalidParameterDuplicate.PrivateAddress

Private address is already in use: 192.168.1.110

Sender 400 NiftyVirtualPrivateAddress、NiftyMasterPrivateAddress、NiftySlavePrivateAddressにすでに使用済みのIPアドレスを指定した場合
Client.ZoneMisMatch.DBInstance.and.NiftyNetworkId

Private LAN net-123456ab does not belong to availability zone west-12.

Sender 400 指定されたNiftyNetworkIdが所属するゾーンとDBサーバーのゾーンが一致しない場合
Client.InvalidParameterOutOfRange.NiftyMasterPrivateAddress

Invalid NiftyMasterPrivateAddress: 192.168.100.100. Valid range is 192.168.1.1-192.168.1.254

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

Invalid NiftyMasterPrivateAddress: 192.168.1.113/8. Valid CIDR prefix is /24

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

Invalid NiftySlavePrivateAddress: 192.168.100.100. Valid range is 192.168.1.1-192.168.1.254

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

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

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

Invalid NiftyVirtualPrivateAddress: 192.168.100.100. Valid range is 192.168.1.1-192.168.1.254

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

Invalid NiftyVirtualPrivateAddress: 192.168.1.112/8. Valid CIDR prefix is /24

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

Private LAN net-123456ab does not exist.

Sender 404 存在しないNiftyNetWorkIdを指定した場合
Client.InvalidParameterNotAllowed.DBInstanceWithReadReplica

The specified DB Instance has read replicas.

Sender 400 リードレプリカを持つDBサーバーを指定した場合
Client.InvalidParameterNotAllowed.ReadReplica

The specified DB Instance is read replica.

Sender 400 リードレプリカを指定した場合
Client.InvalidParameterNotAllowed.DBInstanceInOldPrivateLan

The specified DB Instance is in old privatelan.

Sender 400 DBサーバーの所属するネットワークがプライベートLAN(旧)の場合
Client.InvalidParameterNotAllowed.NiftyVirtualPrivateAddress

Cannot modify NiftyVirtualPrivateAddress. The network of the specified DB Instance is not PrivateLAN.

Sender 400 共通プライベートを利用している時、NiftyVirtualPrivateAddressを指定した場合
Client.InvalidParameterNotAllowed.NiftyMasterPrivateAddress

Cannot modify NiftyMasterPrivateAddress. The network of the specified DB Instance is not PrivateLAN.

Sender 400 共通プライベートを利用している時、NiftyMasterPrivateAddressを指定した場合
Client.InvalidParameterNotAllowed.NiftySlavePrivateAddress

Cannot modify NiftySlavePrivateAddress. The network of the specified DB Instance is not PrivateLAN.

Sender 400 共通プライベートを利用している、かつ、冗長化構成(データ優先)の時、NiftySlavePrivateAddressを指定した場合
Client.InvalidParameterMissing.NiftyVirtualPrivateAddress

The parameter NiftyVirtualPrivateAddress must be provided and must not be blank for PrivateLAN instances.

Sender 400 プライベートLANを利用している時、NiftyVirtualPrivateAddressを指定しなかった場合
Client.InvalidParameterMissing.NiftyMasterPrivateAddress

The parameter NiftyMasterPrivateAddress must be provided and must not be blank for PrivateLAN instances.

Sender 400 プライベートLANを利用している時、NiftyMasterPrivateAddressを指定しなかった場合
Client.InvalidParameterMissing.NiftySlavePrivateAddress

The parameter NiftySlavePrivateAddress must be provided and must not be blank for PrivateLAN instances.

Sender 400 プライベートLANを利用している、かつ、冗長化構成(データ優先)の時、NiftySlavePrivateAddressを指定しなかった場合
Client.InvalidParameterNotAllowed.NiftySlavePrivateAddress

Cannot specify NiftySlavePrivateAddress. The specified DB Instance is not Multi-AZ.

Sender 400 シングル構成の時、NiftySlavePrivateAddressを指定した場合
Client.InvalidParameterNotAllowed.DBInstanceWithNiftyMultiAZType1

The specified DB Instance is Multi-AZ deployment Type: 1.

Sender 400 冗長構成(性能優先)のDBサーバーを指定した場合

リクエストサンプル

    https://jp-east-1.rdb.api.nifcloud.com/
  ?Action=ModifyDBInstanceNetwork
  &DBInstanceIdentifier=mydbinstance
  &NiftyNetworkId=net-0xxxxxxx
  &NiftyMasterPrivateAddress=192.168.1.100/24
  &NiftyVirtualPrivateAddress=192.168.1.110/24
  &SignatureVersion=2
  &SignatureMethod=HmacSHA256
  &Timestamp=2013-12-09T00:00:00.000Z
  &AWSAccessKeyId=<NIFCLOUD Access Key ID>
  &Signature=<Signature>

  

応答サンプル

    <ModifyDBInstanceNetworkResponse>
  <ModifyDBInstanceNetworkResult>
    <DBInstance>
      <AllocatedStorage>100</AllocatedStorage>
      <AutoMinorVersionUpgrade>false</AutoMinorVersionUpgrade>
      <AvailabilityZone>east-13</AvailabilityZone>
      <BackupRetentionPeriod>1</BackupRetentionPeriod>
      <DBInstanceClass>db.mini</DBInstanceClass>
      <DBInstanceIdentifier>mydbinstance</DBInstanceIdentifier>
      <DBInstanceStatus>failed</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-30T08:45: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>
      <NiftyNetworkId>net-0xxxxxxx</NiftyNetworkId>
      <NiftyMasterPrivateAddress>xxx.xxx.xxx.xxx</NiftyMasterPrivateAddress>
      <AccountingType>2</AccountingType>
      <NextMonthAccountingType>2</NextMonthAccountingType>
    </DBInstance>
  </ModifyDBInstanceNetworkResult>
  <ResponseMetadata>
    <RequestId>96293bd4-f64f-45ef-8cfa-724974067bde</RequestId>
  </ResponseMetadata>
</ModifyDBInstanceNetworkResponse>

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

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