RDB：CreateDBInstanceReadReplica
処理概要
DBサーバーからリードレプリカを作成します。
すべてのリードレプリカは冗長化機能無効・自動バックアップ無効で作成されます。
リクエストパラメーターで指定したもの以外の属性は、作成元のDBサーバーから継承されます。
[重要]
作成元のDBサーバーは自動バックアップが有効でなければなりません。
リクエストパラメーター
| 要素名 | 説明 | 必須 | 値 | 最大値 | デフォルト値 | 備考 |
|---|---|---|---|---|---|---|
| AutoMinorVersionUpgrade |
|
真偽値 | − | − | ||
| AvailabilityZone |
|
文字列 | − | − | ||
| DBInstanceClass | 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-medium | db. medium | db. e-medium4 | db. medium4 | db. e-medium8 | db. medium8 | db. e-medium16 | db. medium16 | 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-large16 | db. extra-large16 | db. e-extra-large24 | db. extra-large24 | db. e-extra-large32 | db. extra-large32 | db. e-double-large32 | db. double-large32 | db. e-double-large48 | db. double-large48 | db. e-double-large64 | db. double-large64 |
文字列 | − | − | ||
| DBInstanceIdentifier |
リードレプリカのDBサーバー名
|
○ | 文字列 | − | − | |
| Iops |
|
数値 | − | − | ||
| OptionGroupName |
|
文字列 | − | − | ||
| Port | ※指定不可 | 数値 | − | − | マスターDBの値と同じものが使用されます | |
| PubliclyAccessible |
|
真偽値 | − | − | マスターDBの値と同じものが使用されます | |
| SourceDBInstanceIdentifier |
リードレプリカの元になるDBサーバーの名前
|
○ | 文字列 | − | − | |
| NiftyStorageType | ディスクタイプ 使用するディスクのタイプを指定 値：0(HDD) | 1(フラッシュドライブ) |
数値 | − | 0 | ニフクラ独自仕様 | |
| NiftyReadReplicaPrivateAddress | リードレプリカ用のプライベートIPアドレス | ○ (プライベートLANを利用している場合) |
文字列 | − | − | ニフクラ独自仕様 |
レスポンス
XML
status
statusは共通の応答メッセージを返却します。
result
| 要素名 | 説明 | 値 | 備考 |
|---|---|---|---|
| CreateDBInstanceReadReplicaResponse | ルート | − | |
| CreateDBInstanceReadReplicaResult | 結果 | − | |
| DBInstance | DBサーバー | − | |
| AllocatedStorage | ディスク容量 (GB) | 数値 | |
| AutoMinorVersionUpgrade | マイナーバージョンの自動アップデートするかどうか | 真偽値 | 固定値falseを返却 |
| AvailabilityZone | DBサーバーのゾーン | 文字列 | |
| BackupRetentionPeriod | バックアップ保持期間 | 数値 | |
| 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 | データベースエンジンのバージョン | 文字列 | |
| LicenseModel | DBサーバーのライセンスモデル | 文字列 | |
| MasterUsername | DBサーバーのマスターユーザー | 文字列 | |
| MultiAZ | 冗長化機能が有効かどうか | 真偽値 | |
| OptionGroupMemberships | オプショングループ情報リスト | リスト | |
| OptionGroupMembership | オプショングループ情報 | − | |
| OptionGroupName | 下記の固定値を返却
|
文字列 | |
| Status | オプショングループのステータス |
文字列 | 固定値in-syncを返却 |
| PendingModifiedValues | 保留の修正情報 | − | |
| PreferredBackupWindow | バックアップ時間 | 文字列 | |
| PreferredMaintenanceWindow | メンテナンス時間 | 文字列 | |
| PubliclyAccessible | グローバルIPアドレスを有効にするかどうか | 真偽値 | |
| ReadReplicaDBInstanceIdentifiers | リードレプリカのDBサーバー名 | 文字配列 | |
| ReadReplicaSourceDBInstanceIdentifier | リードレプリカのマスターDBサーバー名 | 文字列 | |
| VpcSecurityGroups | ※返却値なし | リスト | |
| NiftyStorageType | ディスクタイプ | 数値 | ニフクラ独自仕様 |
| NiftyNetworkId | プライベートLANのネットワークユニークID | 文字列 | ニフクラ独自仕様 |
| ResponseMetadata | 共通メタ情報 | − |
エラー
| コード | メッセージ | タイプ | 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 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 ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens. | Sender | 400 | SourceDBInstanceIdentifierに無効な値(ハイフンから始まる 等)を指定した場合 |
| Client.InvalidParameterIllegalInput.DBInstanceClass | Invalid DB instance class:aaa | Sender | 400 | DBInstanceClassに存在しないDBサーバータイプを指定した場合 |
| Client.InvalidParameterIllegalInput.NiftyStorageType | Invalid Storage Type: 9 | Sender | 400 | StrageTypeに 0,1以外を指定した場合 |
| 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アドレスを指定した場合 |
| Invalid NiftyReadReplicaPrivateAddress: 192.168.1.112/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 | Invalid database identifier:sample-dbinstance012345678901234567890123456789012345678901234567890123456789012345678901234567890 | Sender | 400 | DBInstanceIdentifierに63文字を超える値を指定した場合 |
| Client.InvalidParameterTooLong.ReadReplicaSourceDBInstanceIdentifier | Invalid database identifier:sample-dbinstance012345678901234567890123456789012345678901234567890123456789012345678901234567890 | 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.ZoneMisMatch.NiftyStorageType | Invalid Storage Type: 1 | Sender | 400 | 指定したAvailabilityZoneに存在しないストレージタイプを指定した場合 |
サンプル
リクエストサンプル
https://rdb.jp-east-1.api.cloud.nifty.com/
?Action=CreateDBInstanceReadReplica
&SourceDBInstanceIdentifier=mydbinstance
&DBInstanceIdentifier=mydbinstancereadreplica
&SignatureVersion=2
&SignatureMethod=HmacSHA256
&Timestamp=2013-12-09T00%3A00%3A00.000Z
&AWSAccessKeyId=<Nifty Cloud Access Key ID>
&Signature=<Signature>
レスポンスサンプル
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<CreateDBInstanceReadReplicaResponse>
<CreateDBInstanceReadReplicaResult>
<DBInstance>
<AllocatedStorage>50</AllocatedStorage>
<AutoMinorVersionUpgrade>false</AutoMinorVersionUpgrade>
<AvailabilityZone>east-13</AvailabilityZone>
<BackupRetentionPeriod>0</BackupRetentionPeriod>
<DBInstanceClass>db.small</DBInstanceClass>
<DBInstanceIdentifier>mydbinstancereadreplica</DBInstanceIdentifier>
<DBInstanceStatus>creating</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>
<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>
</DBInstance>
</CreateDBInstanceReadReplicaResult>
<ResponseMetadata>
<RequestId>e2dc16db-bae8-4760-8775-d7dcb95b9daa</RequestId>
</ResponseMetadata>
</CreateDBInstanceReadReplicaResponse>
