すべてのプロダクト
Search
ドキュメントセンター

:CreateReadOnlyDBInstance

最終更新日:Apr 18, 2026

この API は、RDS インスタンスの読み取り専用インスタンスを作成するために使用されます。

操作説明

サポートされるエンジン

  • RDS MySQL

  • RDS PostgreSQL

  • RDS SQL Server

関連する機能ドキュメント

重要 この API を使用する前に、機能ドキュメントをよく読み、この API を使用するための前提条件と潜在的な影響を十分に理解した上で、操作を進めてください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

rds:CreateReadOnlyDBInstance

create

*DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

  • rds:ResourceTag
なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

ClientToken

string

任意

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

ETnLKlblzczshOTUbOC****

RegionId

string

必須

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

cn-hangzhou

ZoneId

string

必須

ゾーン ID。DescribeRegions 操作を呼び出して、ゾーン ID を照会できます。

  • シングルゾーンデプロイ方法を使用する場合、このパラメーターを 1 つのゾーンの ID に設定します。例:cn-hangzhou-b

  • マルチ AZ デプロイ方法を使用する場合、このパラメーターを複数のゾーンの ID に設定し、ID をコロン (:) で区切ります。例:cn-hangzhou-b:cn-hangzhou-c

  • 指定するゾーン ID の数は、読み取り専用インスタンス用に作成されたノードの数以下である必要があります。RDS Basic Edition を実行する読み取り専用インスタンスを作成する場合、プロビジョニングされるノードは 1 つだけです。RDS High-availability Edition を実行する読み取り専用インスタンスを作成する場合、1 つのプライマリノードと 1 つのセカンダリノードがプロビジョニングされます。

cn-hangzhou-b

DBInstanceId

string

必須

プライマリインスタンスの ID。DescribeDBInstances 操作を呼び出して、インスタンス ID を照会できます。

rm-uf6wjk5****

DBInstanceClass

string

必須

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

mysqlro.n2.small.1c

DBInstanceStorage

integer

必須

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

20

EngineVersion

string

必須

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

  • 読み取り専用インスタンスが MySQL を実行する場合、このパラメーターを 5.65.7、または 8.0 に設定します。

  • 読み取り専用インスタンスが SQL Server を実行する場合、このパラメーターを 2017_ent、2019_ent、または 2022_ent に設定します。

  • 読み取り専用インスタンスが PostgreSQL を実行する場合、このパラメーターを 10.0、11.0、12.0、13.0、14.0、または 15.0 に設定します。

5.6

PayType

string

必須

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

  • Postpaid:従量課金

  • Prepaid:サブスクリプション

Postpaid

DBInstanceDescription

string

任意

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

説明

値は `http://` または `https://` で始めることはできません。

testReadOnly

InstanceNetworkType

string

任意

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

  • VPC

  • Classic

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

説明

読み取り専用インスタンスのネットワークタイプは、プライマリインスタンスのネットワークタイプと異なっていてもかまいません。

Classic

VPCId

string

任意

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

説明
  • プライマリインスタンスがローカルディスクを使用する場合、読み取り専用インスタンスとプライマリインスタンスは同じ VPC または異なる VPC に属することができます。

  • プライマリインスタンスがクラウドディスクを使用する場合、読み取り専用インスタンスとプライマリインスタンスは同じ VPC に属する必要があります。

vpc-uf6f7l4fg90****

VSwitchId

string

任意

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

vsw-uf6adz52c2p****

PrivateIpAddress

string

任意

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

172.16.XX.XX

ResourceGroupId

string

任意

リソースグループの ID。

rg-acfmy****

Category

string

任意

インスタンスの RDS エディション。有効値:

  • Basic:RDS Basic Edition

  • HighAvailability (デフォルト):RDS High-availability Edition

  • AlwaysOn:RDS Cluster Edition

説明

PostgreSQL を実行し、クラウドディスクを使用するプライマリインスタンスの読み取り専用インスタンスは、RDS Basic Edition を実行します。したがって、このパラメーターを Basic に設定します。

HighAvailability

DBInstanceStorageType

string

任意

インスタンスのストレージタイプ。有効値:

  • local_ssd:ローカル SSD

  • cloud_ssd:標準 SSD

  • cloud_essd:パフォーマンスレベル 1 (PL1) の拡張 SSD (ESSD)

  • cloud_essd2:PL2 の ESSD

  • cloud_essd3:PL3 の ESSD

説明
  • プライマリインスタンスがローカルディスクで MySQL を実行する場合、このパラメーターを local_ssd に設定する必要があります。プライマリインスタンスがクラウドディスクで MySQL を実行する場合、このパラメーターを cloud_ssd、cloud_essd、cloud_essd2、または cloud_essd3 に設定する必要があります。

  • プライマリインスタンスが SQL Server を実行する場合、このパラメーターを cloud_ssd、cloud_essd、cloud_essd2、または cloud_essd3 に設定する必要があります。

local_ssd

DedicatedHostGroupId

string

任意

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

dhg-4n****

TargetDedicatedHostIdForMaster

string

任意

プライマリインスタンスが存在するホストの ID。このパラメーターは、専用クラスターに読み取り専用インスタンスを作成する場合に有効です。

i-bp****

GdnInstanceName

string

任意

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

test

TddlBizType

string

任意

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

test

TddlRegionConfig

string

任意

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

test

InstructionSetArch

string

任意

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

test

UsedTime

string

任意

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

  • Period パラメーターを Year に設定した場合、UsedTime パラメーターの値の範囲は 15 です。

  • Period パラメーターを Month に設定した場合、UsedTime パラメーターの値の範囲は 19 です。

説明

PayType パラメーターを Prepaid に設定した場合は、UsedTime パラメーターを指定する必要があります。

1

Period

string

任意

読み取り専用インスタンスの更新期間。有効値:

  • Year

  • Month

Month

AutoRenew

string

任意

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

  • true:機能を有効にします。

  • false:機能を無効にします。

説明
  • Period パラメーターを Month に設定した場合、自動更新期間は 1 か月です。

  • Period パラメーターを Year に設定した場合、自動更新期間は 1 年です。

true

DeletionProtection

boolean

任意

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

  • true

  • false (デフォルト)

説明

PayType パラメーターを Postpaid に設定した場合にのみ、読み取り専用インスタンスのリリース保護機能を有効にできます。

true

Port

string

任意

読み取り専用 ApsaraDB RDS for MySQL インスタンスを作成するときに初期化できるポート。

有効値:1000~65534。

3306

BurstingEnabled

boolean

任意

無効なパラメーターです。このパラメーターを指定する必要はありません。

false

IsAnalyticReadOnlyIns

boolean

任意

DuckDB 分析インスタンスを作成するかどうかを指定します。有効値:

  • true:有効

  • false:無効

説明

現在、DuckDB 分析インスタンスの作成をサポートしているのは、RDS MySQL と RDS PostgreSQL のみです。

AutoPay

boolean

任意

支払いを自動的に完了するかどうかを指定します。有効値:

  1. true:支払いを自動的に完了します。アカウントの残高が十分であることを確認してください。

  2. false:支払いを自動的に完了しません。未払いの注文が生成されます。

説明

デフォルト値:true。アカウントの残高が不足している場合は、AutoPay パラメーターを false に設定して未払いの注文を生成できます。その後、ApsaraDB RDS コンソールにログインして支払いを完了できます。

false

AutoCreateProxy

boolean

任意

データベースプロキシを自動的に作成するかどうかを指定します。有効値:

  • true:データベースプロキシを自動的に作成します。デフォルトでは、汎用データベースプロキシが作成されます。

  • false:データベースプロキシを自動的に作成しません。

false

IoAccelerationEnabled

string

任意

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

0

AutoUseCoupon

boolean

任意

クーポンを使用するかどうかを指定します。有効値:

  • true:クーポンを使用します。

  • false (デフォルト):クーポンを使用しません。

true

PromotionCode

string

任意

クーポンコード。

71744626****

CustomExtraInfo

string

任意

予約済みのパラメーターです。設定は不要です。

None

レスポンスフィールド

フィールド

説明

object

レスポンスパラメーター。

ConnectionString

string

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

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

DBInstanceId

string

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

rr-uf6wjk5****

OrderId

string

注文の ID。

10078937****

Port

string

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

3306

RequestId

string

リクエストの ID。

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

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidEngineVersion.Malformed The specified parameter EngineVersion is not valid.
400 InvalidNetworkTypeClassicWhenCloudStorage The Specified InstanceNetworkType value Classic is not valid when choose cloud storage type.
400 InvalidSecurityIPList.Malformed The specified parameter SecurityIPList is not valid.
400 InvalidSecurityIPList.Duplicate The Security IP address is not in the available range or occupied.
400 InvalidParameter The specified parameter dbInstanceId is not valid.
400 OperationDenied VPC IP is in use, please check.
400 InvalidZoneId.NotSupported The Specified vpc Zone not supported.
400 InvalidAvZone.NotSupport Specified availableArea multiZone does not support in RDS.
400 CDDC.AvailableHostsNotEnoughInZone Not enough available hosts are in the target zone.
400 InvalidReadEngineVersionPattern The engine versions of the primary instance and the read-only instance do not match.
400 InvalidDBInstanceClass.Offline The specified instance type is no longer provided. Please specify another instance type.
400 SYSTEM.CONCURRENT_OPERATE Concurrent operation is detected.
400 Price.PricingPlanResultNotFound Pricing plan price result not found.
400 InvalidDBInstanceName.Duplicate Specified DB instance name already exists in the Aliyun RDS.
400 InvalidInstanceLevel.DiskType Specified instance level not support request disk type
400 InvalidRequestId The request is copy, check your token.
400 InvalidParam.InstanceNetworkType Creation of classic network instances is not supported.
400 Order.ComboInstanceNotAllowOperate A package instance is not allowed to operate independently.
400 Order.NoRealNameAuthentication You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
400 InsufficientAvailableQuota Your account quota limit is less than 0, please recharge before trying to purchase.
400 CommodityServiceCalling.Exception Failed to call commodity service.
400 RegionDissolvedEOM Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.
400 Commodity.InvalidComponent The module you purchased is not legal, please buy it again.
400 RegionEndTimeDissolvedAustralia Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400 Price.CommoditySys Commodity system call exception.
400 Pay.InsufficientBalance Insufficient available balance.
400 Order.PeriodInvalid There is a problem with the period you selected, please choose again.
400 pay.noCreditCard Account not bound to credit card.
400 Order.InstHasUnpaidOrder There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400 noAvailablePaymentMethod No payment method is specified for your account. We recommend that you add a payment method.
400 BasicInfoUncompleted Your information is incomplete. Complete your information before the operation.
400 Risk.RiskControlRejection Your account is abnormal, please contact customer service for details.
400 Api.NotSupport Specified api is not supported.
400 ContainForbiddenLabelError There is a label that prohibits placing orders. Please contact your distributor for assistance.
400 InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in records.
400 InvalidParam Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
400 KmsApiError User secret key invalid.
400 System.SaleValidateFailed Sales expression validation system error.
400 Abs.InvalidAccount.NotFound account is not found.
400 SqlExecuteFailedOrTimeout sql command execution failed or timed out:%s.
400 ColdData.EngineVersionNotSupport The current instance engine version not support coldDataEnabled.
400 ColdData.MinorVersionNotSupport The current instance minor version not support coldDataEnabled.
400 IncorrectTargetClasscode The current instance type does not support this operation.
400 InvalidConnectionString.Duplicate Specified connection string already exists in the RDS.
400 RequiredParam.NotFound Required input param is not found.
400 Parameters.Invalid Parameter error, please check the parameters.
400 BackupPolicyNotSupport Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400 InvalideStatus.Format The instance status does not support this operation.
400 InvalidReleasedKeepPolicy.Format Specified Released Keep Policy is not valid.
400 InvalidDBInstanceEngineType.Format the DB instance engine type does not support this operation.
400 Pay.NoCreditCard No credit cards.
400 VpcNetworkTypeNotSupport The vpc network type instance does not support this operation.
400 MirrorInsExists Specified DB instance mirror ins already existed.
400 UnsupportedClassCode The specified DB instance class stops selling.
400 InvalidBackupSet The specified database does not exist in the backup set.
400 OrdTCommodityQueryError Failed to query for product.
400 ProductInstanceReleased The instance has been released. Please check before placing the order.
400 RegionEndTimeDissolvedIndia The region is no longer supported.
400 InvalidVSwitchId.Format The specified vswitch Id format is incorrect.
400 InvalidParameterValue.NotStandard Invalid parameter format.
400 AtLeastThreeVSwitchAvailableIp The primary vswitch requires at least three available IP addresses.
400 AtLeastTwoVSwitchAvailableIp The primary vswitch requires at least two available IP addresses.
400 DuckDBOperationConflictBetweenPrimaryAndReadOnlyInstance Current instance is already attached to another duckdb instance, operation is conflict.
500 CannotDecreaseEssdPerfLevel cannot decrease cloud essd performance level.
500 InvalidEssdStorageSize invalid cloud essd storage size.
500 ExternalFailure The request processing has failed due to external service failure.
500 RequestMetaDataFailed The service request failed. Please try again later or contact service personnel.
500 InvokeProxyFailure The request processing has failed due to service failure of rds api.
403 OperationDenied.PrimaryDBInstanceStatus The operation is not permitted due to status of primary instance.
403 InvalidReadStorageTypePattern The storage type of the primary instance and the read-only instance do not match.
403 IncorrectCharacterType Current DB instance character type does not support this operation.
403 InvalidMultiparamZoneInfoList Zoneinfo list is invaild.
403 OrderStatus.UnPaid The specified db instance has unpaid order.
403 InvalidReduceDiskSize The storage capacity after the scale-down must be larger than the used amount.
403 CloudSSDNotSupport Cloud ssd does not support this operation, please upgrade to essd.
403 InvalidUserOperatorPermission The user permission does not support this operation.
403 InvalidVswitchId Specified conn vswitch id is not valid.
403 IncorrectMinorVersion Current engine minor version does not support operations.
403 OperationDenied.ZoneResource There is no available zone for inventory.
403 NotInFlowController Sorry,no permission.
403 InvalidKmsKey Kms key is disabled.
403 InvalidInstanceLevel.Malformed Current DB instance level does not support this operation.
403 BasicCategoryNotSupport The Basic category is not supported.
404 IncorrectDBInstanceConnType Current DB instance conn type does not support this operation.
404 InvalidDBInstance.NotFound The specified instance does not exist or is not supported.
404 InvalidClusterKms The current instance does not authorized to access the Key Management Service.
404 Request.NotFound The requested resource is not available.
404 HostInfo.NotFound The specified host info is not found.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。