本文へジャンプします。

【重要なお知らせ】サービス統合に基づくサービス名称の読み替えのお願い（2024年4月1日）

2024年4月1日をもって、「ニフクラ」は、「FJcloud-V」に統合し、名称を変更しました。
当サイトのアドレス（ドメイン名）に含まれる「nifcloud.com」は現時点では変更はございませんが、
各ページに記載の「ニフクラ」「NIFCLOUD」「nifcloud」は、「FJcloud-V」に読み替えていただきますようお願いいたします。

ニフクラ ユーザーガイド

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

CreateDBInstanceReadReplica

処理概要

DBサーバーからリードレプリカを作成します。

すべてのリードレプリカは冗長化機能無効・自動バックアップ無効で作成されます。

リクエストパラメーターで指定したもの以外の属性は、作成元のDBサーバーから継承されます。

[重要]
作成元のDBサーバーは自動バックアップが有効でなければなりません。

指定するパラメーター

パラメーター 型 説明 必須
AccountingType string リードレプリカの利用料金タイプ
値:
  • 1 (月額課金)
  • 2 (従量課金)
Default: 2
AutoMinorVersionUpgrade boolean ※指定不可
AvailabilityZone string ※指定不可
DBInstanceClass string DBサーバータイプ
値:
  • 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
DBInstanceIdentifier string

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

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

 ○
Iops integer ※指定不可
OptionGroupName string ※指定不可
Port integer ※指定不可
PubliclyAccessible boolean ※指定不可
SourceDBInstanceIdentifier string

リードレプリカの元になるDBサーバーの名前

  • ※DBサーバーは5つまでリードレプリカを持つことができます
  • ※存在するDBサーバーの名前である必要があります
  • ※リードレプリカの DB サーバー名を指定することはできません

 ○
NiftyStorageType integer

ディスクタイプ
使用するディスクのタイプを指定


値:
  • 0 (高速ディスク)
  • 1 (フラッシュドライブ)
  • 2 (標準フラッシュドライブ)
  • 3 (高速フラッシュドライブ)
Default: 0
備考: ニフクラ独自仕様
NiftyReadReplicaPrivateAddress string リードレプリカ用のプライベートIPアドレス
備考: ニフクラ独自仕様
 ○ (プライベートLANを利用している場合)

応答フィールド

フィールド (項目) 型 説明
CreateDBInstanceReadReplicaResponse structure ルート
␣CreateDBInstanceReadReplicaResult 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サーバーのステータス
␣␣␣DBInstanceUpgradeStatus string

DBサーバーの基盤アップグレードステータス

  • required(アップグレードが必要)
  • preparing(アップグレード準備中)
  • upgradable(アップグレード可能)
  • upgrading(アップグレード中)
  • latest(最新)
  • canceling(キャンセル中)
  • not-upgradable(アップグレード不可)
␣␣␣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.6系の場合、default:mysql-5-6
  • DBエンジンがMySQL 5.7系の場合、default:mysql-5-7
  • DBエンジンがMySQL 8.0系の場合、default:mysql-8-0
  • DBエンジンがPostgreSQL9.3系の場合、default:postgres-9-3
  • DBエンジンがPostgreSQL9.6系の場合、default:postgres-9-6
  • DBエンジンがPostgreSQL11系の場合、default:postgres-11
  • DBエンジンがPostgreSQL13系の場合、default:postgres-13
␣␣␣␣␣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.DBInstanceClass

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

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

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

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

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 SourceDBInstanceIdentifierに指定したDBサーバーのBackupRetentionPeriodが0の場合
Client.InvalidParameterDuplicate.DBInstanceIdentifier

DB Instance already exists

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

Private address is already in use: 192.168.1.110

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

Private address is already in use: 192.168.1.110

 Sender 400 NiftyReadReplicaPrivateAddressにすでに使用済みのIPアドレスを指定した場合
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.NiftyReadReplicaPrivateAddress

Invalid NiftyReadReplicaPrivateAddress: aaa.bbb.ccc.ddd.

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

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

Invalid Accounting Type: 3

 Sender 400 AccountingTypeに1,2以外を指定した場合
Client.InvalidParameterIllegalInput.DBInstanceClass

Invalid DB instance class:aaa

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

Invalid Storage Type: 9

 Sender 400 NiftyStorageTypeに 0,1,2,3以外を指定した場合
Client.InvalidParameterIllegalInput.Port
Sender 400 Portに数値でない値を指定した場合
Client.InvalidParameterMissing.NiftyReadReplicaPrivateAddress

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

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

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

 Sender 400 (postgresの場合のみ) マスターとする予定のDBサーバーよりDBサーバータイプのスペックが低いリードレプリカを作成しようとした場合
Client.InvalidParameterNotFound.DBParameterGroup

DBParameterGroupName does not refer to an existing DB Parameter Group.

 Sender 404 SourceDBInstanceIdentifierに指定したDBサーバーのDBパラメーターグループが存在しない場合
Client.InvalidParameterNotFound.DBSecurityGroup

DBSecurityGroupName does not refer to an existing DB Security Group.

 Sender 404 SourceDBInstanceIdentifierに指定したDBサーバーのDBファイアウォールグループが存在しない場合
Client.InvalidParameterNotFound.ReadReplicaSourceDBInstance

The source instance could not be found: aaa

 Sender 404 SourceDBInstanceIdentifierに存在しないDBInstanceIdentifierを指定した場合
Client.InvalidParameterOutOfRange.NiftyReadReplicaPrivateAddress

Invalid NiftyReadReplicaPrivateAddress: 192.168.100.110. 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.Port

Invalid endpoint port: 100000. Valid range is 1150-65535

 Sender 400 Portに1150-65535でない値を指定した場合
Client.InvalidParameterRequired.DBInstanceIdentifier

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

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

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

 Sender 400 必須のSourceDBInstanceIdentifierを指定しなかった場合
Client.InvalidParameterTooLong.AvailabilityZone
Sender 400 AvailabilityZoneに32文字を超える値を指定した場合
Client.InvalidParameterTooLong.DBInstanceIdentifier

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

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

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

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

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

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

The source DB Instance specified is only allowed a maximum of 5 read replicas.

 Sender 400 1つのDBサーバーに紐付くリードレプリカ数の上限に達している場合
Client.ResourceIncorrectState.DBSecurityGroup.Processing

DBSecurityGroup is not in available state.

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

The specified DB Instance is not in the available state.

 Sender 400 SourceDBInstanceIdentifierに指定したDBサーバーのステータスが有効でない場合
Client.ResourceIncorrectState.ReadReplicaSourceDBInstanceUpgradeStatus.Processing

Can not be specified when the upgrade status of the specified DB Instance is progress.

 Sender 400 SourceDBInstanceIdentifierに指定したDBサーバーの基盤アップグレードステータスが処理中（「required」、「latest」以外）の場合
Client.ZoneMisMatch.NiftyStorageType

Invalid Storage Type: 1

 Sender 400 指定したAvailabilityZoneに存在しないストレージタイプを指定した場合

リクエストサンプル

    https://jp-east-1.rdb.api.nifcloud.com/
  ?Action=CreateDBInstanceReadReplica
  &SourceDBInstanceIdentifier=mydbinstance
  &DBInstanceIdentifier=mydbinstancereadreplica
  &SignatureVersion=2
  &SignatureMethod=HmacSHA256
  &Timestamp=2013-12-09T00:00:00.000Z
  &AWSAccessKeyId=<NIFCLOUD Access Key ID>
  &Signature=<Signature>

応答サンプル

    <CreateDBInstanceReadReplicaResponse>
  <CreateDBInstanceReadReplicaResult>
    <DBInstance>
      <AllocatedStorage>50</AllocatedStorage>
      <AutoMinorVersionUpgrade>false</AutoMinorVersionUpgrade>
      <AvailabilityZone>east-13</AvailabilityZone>
      <BackupRetentionPeriod>0</BackupRetentionPeriod>
      <CACertificateIdentifier>rdb-ca-2023</CACertificateIdentifier>
      <DBInstanceClass>db.small</DBInstanceClass>
      <DBInstanceIdentifier>mydbinstancereadreplica</DBInstanceIdentifier>
      <DBInstanceStatus>creating</DBInstanceStatus>
      <DBInstanceUpgradeStatus>latest</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>
      <Engine>mysql</Engine>
      <EngineVersion>5.6.12</EngineVersion>
      <LicenseModel>general-public-license</LicenseModel>
      <MasterUsername>mydbuser</MasterUsername>
      <MultiAZ>false</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>
      <ReadReplicaDBInstanceIdentifiers/>
      <ReadReplicaSourceDBInstanceIdentifier>mydbinstance</ReadReplicaSourceDBInstanceIdentifier>
      <VpcSecurityGroups/>
      <NiftyStorageType>0</NiftyStorageType>
      <AccountingType>2</AccountingType>
      <NextMonthAccountingType>2</NextMonthAccountingType>
    </DBInstance>
  </CreateDBInstanceReadReplicaResult>
  <ResponseMetadata>
    <RequestId>e2dc16db-bae8-4760-8775-d7dcb95b9daa</RequestId>
  </ResponseMetadata>
</CreateDBInstanceReadReplicaResponse>

ニフクラ サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2024年11月18日時点の情報です。

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

ページの先頭へ