本文へジャンプします。

ニフクラ APIリファレンス

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

RDB:ResetExternalMaster

処理概要

外部レプリケーションを解除します。

リクエストパラメーター

要素名 説明 必須 最大値 デフォルト値 備考
DBInstanceIdentifier

DBサーバー名

  • ※ステータスが"available"のDBサーバーのみ指定できます
文字列  

レスポンス

XML

status

statusは共通の応答メッセージを返却します。

result
要素名 説明 備考
ResetExternalMasterResponse ルート -  
ResetExternalMasterResult 結果 -  
DBInstance DBサーバー -  
AllocatedStorage ディスク容量 (GB) 数値  
AutoMinorVersionUpgrade マイナーバージョンの自動アップデートを行うかどうか 真偽値 固定値falseを返却
AvailabilityZone DBサーバーのゾーン 文字列  
BackupRetentionPeriod バックアップ保持期間 数値  
BinlogRetentionPeriod バイナリログ保持期間 (日)
BinlogRetentionPeriodを変更した場合のみ要素を返却します。
数値  
CACertificateIdentifier DBサーバーのサーバー証明書と紐付くCA証明書 文字列  
DBInstanceClass DBサーバータイプ 文字列  
DBInstanceIdentifier DBサーバー名 文字列  
DBInstanceStatus DBサーバーのステータス 文字列  
DBName DB名 文字列  
DBParameterGroups DBパラメーターグループ情報リスト リスト  
DBParameterGroup DBパラメーターグループ -  
DBParameterGroupName DBパラメーターグループ名 文字列  
ParameterApplyStatus DBパラメーターの適用ステータス
値:applying(適用中) | pending-reboot(再起動待ち) | in-sync(適用済み)
文字列  
DBSecurityGroups DBファイアウォールグループ情報リスト リスト  
DBSecurityGroup DBファイアウォールグループ -  
DBSecurityGroupName DBファイアウォールグループ名 文字列  
Status DBファイアウォールグループのステータス
値:active(有効) | adding(適用中) | removing(取り外し中) | failed(変更失敗)
文字列  
Engine データベースエンジン 文字列  
EngineVersion データベースエンジンのバージョン 文字列  
ExternalReplicationInfo

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

  • ※DBサーバーが以下の場合のみこのタグは返却されます
  • MySQLでシングル構成
  • MySQLで冗長構成 (データ優先)
-  
ExternalMasterAddress マスターとなるDBサーバーのIPアドレスまたはホスト名 文字列  
ExternalReplicationMessage

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

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

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

  • set(SetExternalMaster実行成功 & StartReplication未実行)
  • started(StartReplication実行成功 & StopReplication未実行)
  • stopped(StopReplication実行成功 & ResetExternalMaster未実行)
  • set-error(SetExternalMaster実行失敗)
  • start-error(StartReplication実行失敗)
  • stop-error(StopReplication実行失敗)
  • reset-error(ResetExternalMaster実行失敗)
文字列  
ReplicationAddresses 外部レプリケーション接続元IPアドレス情報リスト リスト  
ReplicationAddress

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

  • ※シングル構成の場合は外部レプリケーション接続元IPアドレスを1つ返却します
  • ※冗長構成(データ優先)の場合は外部レプリケーション接続元IPアドレスを2つ返却します
文字列  
LicenseModel DBサーバーのライセンスモデル 文字列  
MasterUsername DBサーバーのマスターユーザー名 文字列  
MultiAZ 冗長化機能が有効かどうか 真偽値  
NiftyMultiAZType 冗長構成タイプ 文字列 ニフクラ独自仕様
OptionGroupMemberships オプショングループ情報リスト リスト  
OptionGroupMembership オプショングループ情報 -  
OptionGroupName

下記の固定値を返却

  • 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エンジンがMariaDB10.1系の場合、default:mariadb-10-1
文字列  
Status オプショングループのステータス 文字列 固定値in-syncを返却
PendingModifiedValues 保留の修正情報 -  
MasterUserPassword 保留中のDBサーバーのマスターユーザーパスワード 文字列  
PreferredBackupWindow バックアップ時間 文字列  
PreferredMaintenanceWindow メンテナンス時間 文字列  
PubliclyAccessible グローバルIPアドレスを有効にするかどうか 真偽値  
ReadReplicaDBInstanceIdentifiers リードレプリカ名 文字配列  
NiftyStorageType ディスクタイプ 数値  
AccountingType 当月の利用料金タイプ 文字列  
NextMonthAccountingType 翌月の利用料金タイプ 文字列  
ResponseMetadata 共通メタ情報 -  

エラー

コード メッセージ タイプ HTTP
ステータスコード
説明
Client.InvalidParameterFormat.DBInstanceIdentifier The parameter DBInstanceIdentifier 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 DBInstanceIdentifierに無効な値(ハイフンから始まる 等)を指定した場合
Client.InvalidParameterNotFound.DBInstance DBInstance aaa not found. Sender 404 存在しないDBInstanceIdentifierを指定した場合
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.ResourceIncorrectState.DBInstance.Unavailable The specified DB Instance is not in the available state. Sender 400 DBサーバーのステータスが有効でない場合
Client.ResourceIncorrectState.ExternalReplication.NotSet This DB Instance has no external replication settings. Sender 400 外部レプリケーションが設定されていないDBサーバーが指定された場合

サンプル

リクエストサンプル
https://jp-east-1.rdb.api.nifcloud.com/
    ?Action=ResetExternalMaster
    &DBInstanceIdentifier=mydbinstance
レスポンスサンプル
<ResetExternalMasterResponse>
  <ResetExternalMasterResult>
  <DBInstance>
    <AllocatedStorage>50</AllocatedStorage>
    <AutoMinorVersionUpgrade>false</AutoMinorVersionUpgrade>
    <AvailabilityZone>east-14</AvailabilityZone>
    <BackupRetentionPeriod>1</BackupRetentionPeriod>
    <CACertificateIdentifier>rdb-ca-2018</CACertificateIdentifier>
    <DBInstanceClass>db.mini</DBInstanceClass>
    <DBInstanceIdentifier>mydbinstance</DBInstanceIdentifier>
    <DbInstanceStatus>modifying</DbInstanceStatus>
    <DBName>db01</DBName>
    <DBParameterGroups>
     <DBParameterGroup>
      <DBParameterGroupName>default.mysql5.7</DBParameterGroupName>
      <ParameterApplyStatus>in-sync</ParameterApplyStatus>
     </DBParameterGroup>
    </DBParameterGroups>
    <DBSecurityGroups>
     <DBSecurityGroup>
      <DBSecurityGroupName>mydbsecuritygroup</DBSecurityGroupName>
      <Status>available</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.7.15</EngineVersion>
    <ExternalReplicationInfo>
     <ExternalMasterAddress>zzz.zzz.zzz.zzz</ExternalMasterAddress>
     <ExternalReplicationMessage>the SQL statement execution was successful.</ExternalReplicationMessage>
     <ExternalReplicationStatus>stopped</ExternalReplicationStatus>
     <ReplicationAddresses>
      <ReplicationAddress>xxx.xxx.xxx.xxx</ReplicationAddress>
      <ReplicationAddress>yyy.yyy.yyy.yyy</ReplicationAddress>
     </ReplicationAddresses>
    </ExternalReplicationInfo>
    <InstanceCreateTime>2019-01-01T02:30:00.000Z</InstanceCreateTime>
    <LatestRestoragleTime>2019-01-01T04:00:00.000Z</LatestRestoragleTime>
    <LicenseModel>general-public-license</LicenseModel>
    <MasterUsername>mydbuser</MasterUsername>
    <MultiAZ>true</MultiAZ>
    <NiftyMultiAZType>0</NiftyMultiAZType>
    <OptionGroupMemberships>
      <OptionGroupMembership>
        <OptionGroupName>default:mysql-5-7</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>
    <VpcSecurityGroups/>
    <NiftyStorageType>0</NiftyStorageType>
    <AccountingType>2</AccountingType>
    <NextMonthAccountingType>2</NextMonthAccountingType>
  </DBInstance>
  </ResetExternalMasterResult>
  <ResponseMetadata>
    <RequestId>4838a0d1-e2ff-4da9-b675-0e3f9eb21c10</RequestId>
  </ResponseMetadata>
</ResetExternalMasterResponse>

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