CreateReadOnlyDBInstanceを呼び出して、プライマリApsaraDB RDSインスタンス用の読み取り専用RDSインスタンスを作成できます。

この操作を呼び出す前に、次の制限事項に注意してください。
  • プライマリインスタンスは専用クラスターに属することができず、次のデータベースエンジンバージョンとRDSエディションのいずれかを実行する必要があります。
    • RDS High-availability EditionまたはRDS Enterprise EditionのMySQL 8.0。
    • RDS High-availability EditionまたはRDS Enterprise EditionのMySQL 5.7。
    • MySQL 5.6。
    • RDS Cluster EditionでのSQL Server 2017。
    • RDS High-availability EditionのPostgreSQL 10、PostgreSQL 11、PostgreSQL 12、PostgreSQL 13、またはPostgreSQL 14。 プライマリインスタンスがPostgreSQL 10を実行している場合は、ローカルSSDを使用する必要があり、少なくとも8コアと32 GBのメモリを提供する専用RDSインスタンスである必要があります。
  • プライマリインスタンスがMySQLを実行する場合、最大10個の読み取り専用インスタンスを作成できます。
  • プライマリインスタンスがSQL Serverを実行している場合、最大7つの読み取り専用インスタンスを作成できます。
  • プライマリインスタンスがローカルSSDでPostgreSQLを実行している場合、最大5つの読み取り専用インスタンスを作成できます。 プライマリインスタンスが標準SSDまたは拡張SSD (ESSD) でPostgreSQLを実行している場合、最大32の読み取り専用インスタンスを作成できます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

項目 データ型 必須／任意 例: 説明　
操作 String 必須 CreateReadOnlyDBInstance

実行する操作です。 値をCreateReadOnlyDBInstanceに設定します。

ClientToken String 任意 ETnLKlblzczshOTUbOC ****

リクエストのべき等性を保証するために使用されるクライアントトークン。 クライアントを使用して値を生成できますが、値が異なるリクエスト間で一意であることを確認する必要があります。 トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。

RegionId String 必須 cn-hangzhou

読み取り専用インスタンスのリージョンID。 読み取り専用インスタンスとプライマリインスタンスは、同じリージョンに存在する必要があります。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

ZoneId String 必須 cn-hangzhou-d

読み取り専用インスタンスのゾーンID。 DescribeRegions を呼び出して、最新のゾーンリストをクエリできます。

DBInstanceId String 必須 rm-uf6wjk5 ****

プライマリRDSインスタンスのID。

DBInstanceClass String 必須 rds.mys2.small

読み取り専用インスタンスのインスタンスタイプ。 詳細については、「読み取り専用ApsaraDB RDSインスタンスタイプ」をご参照ください。 プライマリインスタンスのインスタンスタイプの仕様以上の仕様のインスタンスタイプを指定することを推奨します。 読み取り専用インスタンスの仕様がプライマリインスタンスの仕様よりも低い場合、読み取り専用インスタンスでは、高レイテンシや高負荷などの問題が発生する可能性があります。

DBInstanceStorage Integer 〇 20

読み取り専用インスタンスのストレージ容量。 詳細については、「読み取り専用インスタンスタイプ」のストレージスペース列をご参照ください。 この値は5 GBの倍数である必要があります。 単位 : GB

EngineVersion String 必須 5.6

読み取り専用インスタンスのメジャーエンジンバージョン。 読み取り専用インスタンスとプライマリインスタンスは、同じメジャーエンジンバージョンを実行する必要があります。

  • 読み取り専用インスタンスがMySQLを実行する場合、このパラメーターを5.6、5.7、または8.0に設定します。
  • 読み取り専用インスタンスがSQL Serverを実行している場合、このパラメーターを2017_entまたは2019_entに設定します。
PayType String 必須 Postpaid

読み取り専用インスタンスの課金方法。 有効な値：

  • 後払い: 従量課金
  • プリペイド: サブスクリプション
DBInstanceDescription String 任意 読み取り専用インスタンスのテスト

読み取り専用インスタンスの説明。 説明は2 ~ 256文字で、英数字、アンダースコア (_) 、ハイフン (-) を使用できます。 説明は文字で始める必要があります。

説明 http:// または https:// で始めることはできません。
InstanceNetworkType String 任意 Classic

読み取り専用インスタンスのネットワークタイプ。 有効な値：

  • [VPC]
  • クラシック

デフォルト値: VPC このパラメーターをVPCに設定した場合、VPCIdおよびVSwitchIdパラメーターも指定する必要があります。

説明 読み取り専用インスタンスのネットワークタイプは、プライマリインスタンスのネットワークタイプとは異なる場合があります。
VPCId String 任意 vpc-uf6f7l4fg90 ****

読み取り専用インスタンスが属する仮想プライベートクラウド (VPC) のID。 InstanceNetworkTypeパラメーターを空のままにするか、VPCに設定する場合は、このパラメーターも指定する必要があります。

説明
  • プライマリインスタンスがローカルSSDを使用している場合、読み取り専用インスタンスとプライマリインスタンスは同じVPCまたは異なるVPCに属することができます。
  • プライマリインスタンスが標準SSDまたはESSDを使用している場合、読み取り専用インスタンスとプライマリインスタンスは同じVPCに属している必要があります。
VSwitchId String 任意 vsw-uf6adz52c2p ****

読み取り専用インスタンスが属するvSwitchのID。 InstanceNetworkTypeパラメーターを空のままにするか、VPCに設定する場合は、このパラメーターも指定する必要があります。

PrivateIpAddress String 任意 172.16.XX.XX

読み取り専用インスタンスのプライベートIPアドレス。 プライベートIPアドレスは、指定されたvSwitchでサポートされているCIDRブロック内にある必要があります。 システムは、VPCIdおよびVSwitchIdパラメーターの値に基づいて、プライベートIPアドレスを読み取り専用インスタンスに自動的に割り当てます。

ResourceGroupId String 任意 rg-acfmy ****

読み取り専用インスタンスが属するリソースグループのID。

カテゴリー String 任意 高可用性

読み取り専用インスタンスのRDSエディション。 有効な値：

  • 基本: RDS Basicエディション。
  • 高可用性: RDS高可用性エディション。 デフォルト値です。
  • AlwaysOn: RDS Cluster Edition。
説明 読み取り専用インスタンスが標準SSDまたはESSDでPostgreSQLを実行している場合、このパラメーターをBasicに設定する必要があります。
DBInstanceStorageType String 任意 local_ssd

読み取り専用インスタンスのストレージタイプ。 有効な値：

  • local_ssd: ローカルssd
  • cloud_ssd: 標準ssd
  • cloud_essd: パフォーマンスレベル1 (PL1) のessd
  • cloud_essd2: PL2のESSD
  • cloud_essd3: PL3のESSD
説明
  • プライマリインスタンスがローカルssdでMySQLを実行する場合、このパラメーターをlocal_ssdに設定する必要があります。 プライマリインスタンスが標準SSDまたはESSDでMySQLを実行する場合、このパラメーターをcloud_ssd、cloud_essd、cloud_essd2、またはcloud_essd3に設定する必要があります。
  • プライマリインスタンスがSQL Serverを実行する場合、このパラメーターをcloud_ssd、cloud_essd、cloud_essd2、またはcloud_essd3に設定する必要があります。
DedicatedHostGroupId String 任意 dhg-4n ****

読み取り専用インスタンスが属する専用クラスターのID。 このパラメーターは、専用クラスターで読み取り専用インスタンスを作成するときに有効です。

TargetDedicatedHostIdForMaster String 任意 i-bp ****

読み取り専用インスタンスがアタッチされているプライマリインスタンスのホストID。 このパラメーターは、専用クラスターで読み取り専用インスタンスを作成するときに有効です。

GdnInstanceName String 任意 なし

予約済みのパラメーター。

TddlBizType String 任意 なし

予約済みのパラメーター。

TddlRegionConfig String 任意 なし

予約済みのパラメーター。

InstructionSetArch String 任意 なし

予約済みのパラメーター。

UsedTime String いいえ 1

読み取り専用インスタンスのサブスクリプション期間。 有効な値：

  • PeriodパラメーターをYearに設定した場合、UsedTimeパラメーターの値は1から5の範囲です。
  • PeriodパラメーターをMonthに設定した場合、UsedTimeパラメーターの値は1から9の範囲です。
説明 PayTypeパラメーターを前払いに設定した場合、このパラメーターも指定する必要があります。
期間 String 任意 月

読み取り専用インスタンスの更新サイクル。 有効な値：

  • 年
  • 月
AutoRenew String 任意 真実

読み取り専用インスタンスの自動更新を有効にするかどうかを指定します。 PayTypeパラメーターをPrepaidに設定した場合は、このパラメーターも指定する必要があります。 有効な値：

  • true: 自動更新を有効にします。
  • false: 自動更新を無効にします。
説明
  • PeriodパラメーターをMonthに設定した場合、自動更新サイクルは1か月になります。
  • PeriodパラメーターをYearに設定した場合、自動更新サイクルは1年になります。
DeletionProtection Boolean いいえ 真実

読み取り専用インスタンスのリリース保護機能を有効にするかどうかを指定します。 有効な値：

  • true: リリース保護機能を有効にします。
  • false: リリース保護機能を無効にします。
説明 この機能は、PayTypeパラメーターをPostpaidに設定した場合にのみ有効にできます。

レスポンスパラメーター

項目 データ型 例: 説明　
DBInstanceId String rr-uf6wjk5 ****

読み取り専用インスタンスのID。

RequestId String 1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC

リクエストの ID です。

ポート String 3306

読み取り専用インスタンスへの接続に使用される内部ポート番号。

ConnectionString String rr-**** .mysql.rds.aliyuncs.com

読み取り専用インスタンスへの接続に使用される内部エンドポイント。

OrderId String 10078937 ****

注文 ID。

例

リクエストの例

http(s):// rds.aliyuncs.com/?Action=CreateReadOnlyDBInstance
&ClientToken=ETnLKlblzczshOTUbOC ****
&RegionId=cn-hangzhou
&ZoneId=cn-hangzhou-b
&DBInstanceId=rm-uf6wjk5 ****
&DBInstanceClass=rds.mys2.small
&DBInstanceStorage=20
&EngineVersion=5.6
&PayType=後払い
&DBInstanceDescription=読み取り専用インスタンスのテスト
&InstanceNetworkType=クラシック
&VPCId=vpc-uf6f7l4fg90 ****
&VSwitchId=vsw-uf6adz52c2p ****
&PrivateIpAddress=172.16.XX.XX
&ResourceGroupId=rg-acfmy ****
&カテゴリ=高可用性
&DBInstanceStorageType=local_ssd
&DedicatedHostGroupId=dhg-4n ****
&TargetDedicatedHostIdForMaster=i-bp ****
&GdnInstanceName=なし
&TddlBizType=なし
&TddlRegionConfig=なし
&InstructionSetArch=なし
&UsedTime=1
&期間=月
&AutoRenew=true
&削除保護=true
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateReadOnlyDBInstanceResponse>
    <DBInstanceId>rr-uf6wjk5 ****</DBInstanceId>
    <RequestId>1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC</RequestId>
    <Port>3306</Port>
    <ConnectionString>rr-**** .mysql.rds.aliyuncs.com</ConnectionString>
    <OrderId>10078937 ****</OrderId>
</CreateReadOnlyDBInstanceResponse>

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DBInstanceId" : "rr-uf6wjk5 ****" 、
  "RequestId" : "1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC" 、
  "ポート" : 3306、
  "ConnectionString" : "rr-**** .mysql.rds.aliyuncs.com" 、
  "OrderId" : "10078937 ****"
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明　
400 InvalidEngineVersion.Malformed 指定されたパラメーター "EngineVersion" は無効です。 指定されたデータベースエンジンのバージョンが無効な場合に返されるエラーメッセージ。
400 InvalidSecurityIPList.Malformed 指定されたパラメーター "SecurityIPList" は無効です。 読み取り専用インスタンスのIPアドレスホワイトリストが無効な場合に返されるエラーメッセージ。
400 InvalidSecurityIPList.Duplicate セキュリティ IP アドレスが使用可能な範囲にないか、または既に使用されています。 指定されたIPアドレスが使用中であるか、有効な範囲内にない場合に返されるエラーメッセージ。 有効なIPアドレスを指定して、もう一度お試しください。
400 InvalidParameter 指定されたパラメーター  &quot;dbInstanceId&quot; は無効です。 指定されたインスタンスIDが無効な場合に返されるエラーメッセージ。 有効なインスタンスIDを指定して、もう一度お試しください。
400 OperationDenied VPC IP が使用中です。確認してください。 指定されたVPC IPアドレスが使用中の場合に返されるエラーメッセージ。
400 InvalidZoneId.NotSupported 指定されたvpcゾーンはサポートされていません。 指定されたゾーンがVPCネットワークタイプのインスタンスの作成をサポートしていない場合に返されるエラーメッセージ。 別のゾーンを指定して、もう一度お試しください。
400 CDDC.AvailableHostsNotEnoughInZone ターゲットゾーンに使用可能なホストが不足しています。 指定されたゾーンで使用可能なホストがない場合に返されるエラーメッセージ。 ゾーンにホストを作成し、再試行します。
403 OperationDenied.PrimaryDBInstanceStatus プライマリインスタンスのステータスにより、操作は許可されていません。 インスタンスが専用クラスターに属し、実行状態ではない場合に返されるエラーメッセージ。
404 IncorrectDBInstanceConnType 現在のDBインスタンスconnタイプはこの操作をサポートしていません。 この操作がインスタンスのネットワーク接続タイプでサポートされていない場合に返されるエラーメッセージ。
500 CannotDecreaseEssdPerfLevel cloud essdのパフォーマンスレベルを下げることはできません。 ストレージタイプの変更が許可されていない場合に返されるエラーメッセージ。 標準SSDでSQL Serverを実行するインスタンスのストレージタイプは、ESSDにのみ変更できます。 ローカルSSDでSQL Serverを実行するインスタンスのストレージタイプは、標準SSDまたはESSDに変更できます。
500 InvalidEssdStorageSize 無効なcloud essdストレージサイズ。 指定されたインスタンスタイプが無効な場合に表示されるエラーメッセージ。 有効なインスタンスタイプを選択して、もう一度お試しください。

エラーコードリストについては、「API エラーセンター」をご参照ください。