ApsaraDB RDS インスタンスの読み取り専用インスタンスを作成します。
操作説明
サポートされているエンジン
RDS MySQL
RDS PostgreSQL
RDS SQL Server
関連ドキュメント
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
rds:CreateReadOnlyDBInstance |
create |
*DBInstance
|
|
なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ClientToken |
string |
任意 |
リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを使用でき、長さは 64 文字を超えることはできません。 |
ETnLKlblzczshOTUbOC**** |
| RegionId |
string |
必須 |
リージョン ID。読み取り専用インスタンスのリージョンは、プライマリインスタンスのリージョンと同じである必要があります。DescribeRegions を呼び出し、リージョン ID をクエリできます。 |
cn-hangzhou |
| ZoneId |
string |
必須 |
ゾーン ID。DescribeRegions を呼び出し、ゾーン ID をクエリできます。
|
cn-hangzhou-b |
| DBInstanceId |
string |
必須 |
プライマリインスタンスの ID。DescribeDBInstances を呼び出し、インスタンス ID をクエリできます。 |
rm-uf6wjk5**** |
| DBInstanceClass |
string |
必須 |
インスタンスタイプ。詳細については、「読み取り専用インスタンスタイプ」を参照してください。読み取り専用インスタンスのインスタンスタイプは、プライマリインスタンスのインスタンスタイプ以上である必要があります。そうでない場合、読み取り専用インスタンスで高遅延や高負荷が発生する可能性があります。 |
mysqlro.n2.small.1c |
| DBInstanceStorage |
integer |
必須 |
インスタンスストレージ容量。読み取り専用インスタンスのインスタンスストレージ容量は、プライマリインスタンスの容量以上である必要があります。詳細については、「読み取り専用インスタンスタイプ」の ストレージ容量 列を参照してください。値は 5 GB 単位で増加します。単位: GB。 |
20 |
| EngineVersion |
string |
必須 |
データベースエンジンのバージョン。バージョンはプライマリインスタンスのバージョンと同じである必要があります。
|
5.6 |
| PayType |
string |
必須 |
課金方法。有効な値:
|
Postpaid |
| DBInstanceDescription |
string |
任意 |
インスタンスの説明。説明の長さは 2~256 文字で、英字、数字、アンダースコア (_)、ハイフン (-) を含めることができます。英字または漢字で始める必要があります。 説明
説明の先頭に http:// または https:// を使用することはできません。 |
testReadOnly |
| InstanceNetworkType |
string |
任意 |
読み取り専用インスタンスのネットワークタイプ。有効な値:
デフォルトでは、VPC 接続のインスタンスが作成されます。VPCId と VSwitchId も指定する必要があります。 説明
読み取り専用インスタンスのネットワークタイプは、プライマリインスタンスのネットワークタイプと異なる場合があります。 |
Classic |
| VPCId |
string |
任意 |
読み取り専用インスタンスの VPC ID。このパラメーターは、InstanceNetworkType が空のまま、または VPC にセットされている場合に必須です。 説明
|
vpc-uf6f7l4fg90**** |
| VSwitchId |
string |
任意 |
読み取り専用インスタンスの vSwitch ID。このパラメーターは、InstanceNetworkType が空のまま、または VPC にセットされている場合に必須です。 |
vsw-uf6adz52c2p**** |
| PrivateIpAddress |
string |
任意 |
読み取り専用インスタンスの内部 IP アドレス。IP アドレスは、指定された vSwitch のアドレス範囲内である必要があります。デフォルトでは、システムは VPCId と VSwitchId の値に基づいて内部 IP アドレスを自動的に割り当てます。 |
172.16.XX.XX |
| ResourceGroupId |
string |
任意 |
リソースグループ ID。 |
rg-acfmy**** |
| Category |
string |
任意 |
インスタンスエディション。有効な値:
説明
PostgreSQL クラウドディスクインスタンスの読み取り専用インスタンスは Basic Edition を使用します。このパラメーターは Basic に設定する必要があります。 |
HighAvailability |
| DBInstanceStorageType |
string |
任意 |
インスタンスのストレージタイプ。有効な値:
説明
|
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 |
任意 |
サブスクリプション期間。有効な値:
説明
このパラメーターは、PayType が Prepaid にセットされている場合に必須です。 |
1 |
| Period |
string |
任意 |
サブスクリプション期間の単位。有効な値:
|
Month |
| AutoRenew |
string |
任意 |
自動更新を有効にするかどうかを指定します。このパラメーターは、サブスクリプションインスタンスに対してのみ必須です。有効な値:
説明
|
true |
| DeletionProtection |
boolean |
任意 |
リリース保護特徴を有効にするかどうかを指定します。有効な値:
説明
この特徴は、課金方法が 従量課金 のインスタンスに対してのみサポートされています。 |
true |
| Port |
string |
任意 |
RDS MySQL プライマリインスタンスの読み取り専用インスタンスを作成するときに初期化されるポート。 有効な値: 1000~65534。 |
3306 |
| BurstingEnabled |
boolean |
任意 |
非推奨のパラメーター。このパラメーターを指定する必要はありません。 |
0 |
| IsAnalyticReadOnlyIns |
boolean |
任意 |
高性能 ESSD クラウドディスク の I/O バースト機能を有効にするかどうかを指定します。有効な値:
|
false |
| AutoPay |
boolean |
任意 |
DuckDB 分析インスタンスを作成するかどうかを指定します。有効な値:
説明
DuckDB 分析インスタンスは、RDS MySQL と RDS PostgreSQL のみでサポートされています。 |
false |
| AutoCreateProxy |
boolean |
任意 |
自動支払いを有効にするかどうかを指定します。有効な値:
説明
デフォルト値: true。支払方法の残高が不足している場合は、AutoPay を false にセットします。この場合、未払いの注文が生成されます。ApsaraDB RDS コンソールにログインして、注文の支払いを行うことができます。 |
false |
| IoAccelerationEnabled |
string |
任意 |
データベースプロキシの自動作成を有効にするかどうかを指定します。有効な値:
|
false |
| AutoUseCoupon |
boolean |
任意 |
高性能 ESSD クラウドディスクの バッファープール拡張 (BPE) 特徴を有効にするかどうかを指定します。有効な値:
|
0 |
| PromotionCode |
string |
任意 |
クーポンを使用するかどうかを指定します。有効な値:
|
true |
| CustomExtraInfo |
string |
任意 |
クーポンコード。 |
71744626**** |
|
任意 |
予約済みパラメーター。このパラメーターを指定する必要はありません。 |
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. | クラウドストレージが選択されている場合、InstanceNetworkType パラメーターを Classic に設定することは無効です。 |
| 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. | 指定されたセキュリティ IP リストに重複する値が含まれているため、無効です。有効なリストを指定してください。 |
| 400 | InvalidParameter | The specified parameter dbInstanceId is not valid. | |
| 400 | OperationDenied | VPC IP is in use, please check. | 操作が失敗しました。VPC サービスでエラーが発生しました。パラメーターが正しいかどうかを確認してください。 |
| 400 | InvalidZoneId.NotSupported | The Specified vpc Zone not supported. | 現在のゾーンでは、VPC ネットワークタイプのインスタンスの作成はサポートされていません。別のゾーンを選択して、アクティブな VPC インスタンスを作成してください。 |
| 400 | InvalidAvZone.NotSupport | Specified availableArea multiZone does not support in RDS. | 指定された availableArea マルチゾーンは、ApsaraDB 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. | プライマリインスタンスの engineVersion が読み取り専用インスタンスのものと一致しません。 |
| 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. | 実名認証が完了していないため、購入資格がありません。実名認証を完了するには、Expenses and Costs にログインしてください。 |
| 400 | InsufficientAvailableQuota | Your account quota limit is less than 0, please recharge before trying to purchase. | アカウント残高が 0 未満です。購入を試みる前にアカウントに入金してください。 |
| 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. | Alibaba Cloud は現在のリージョンの最適化と調整を計画しています。このリージョンのクラウドサービスは提供を終了します。業務継続性とスムーズなデータ移行を確保するため、現時点では新規購入注文を行うことはできません。ご理解とご支援のほどよろしくお願いいたします。 |
| 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. | SQL コマンドの実行に失敗したか、またはタイムアウトしました。 |
| 400 | ColdData.EngineVersionNotSupport | The current instance engine version not support coldDataEnabled. | インスタンスの現在の DPI エンジンバージョンはコールドデータアーカイブをサポートしていません。 |
| 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. | この操作は、VPC ネットワークタイプのインスタンスではサポートされていません。 |
| 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. | 指定された vSwitch ID のフォーマットが無効です。 |
| 400 | InvalidParameterValue.NotStandard | Invalid parameter format. | 指定されたパラメーターのフォーマットが無効です。 |
| 400 | AtLeastThreeVSwitchAvailableIp | The primary vswitch requires at least three available IP addresses. | プライマリ vSwitch には、少なくとも 3 つの利用可能な IP アドレスが必要です。 |
| 400 | AtLeastTwoVSwitchAvailableIp | The primary vswitch requires at least two available IP addresses. | プライマリ vSwitch には、少なくとも 2 つの利用可能な IP アドレスが必要です。 |
| 400 | DuckDBOperationConflictBetweenPrimaryAndReadOnlyInstance | Current instance is already attached to another duckdb instance, operation is conflict. | 現在のインスタンスは既に別の DuckDB ベースの分析インスタンスに関連付けられており、現在の DuckDB 読み取り操作と競合しています。 |
| 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. | ApsaraDB RDS API サービスのエラーにより、リクエストが失敗しました。 |
| 403 | OperationDenied.PrimaryDBInstanceStatus | The operation is not permitted due to status of primary instance. | 専用クラスター内で Running 状態ではない ApsaraDB RDS インスタンスは移行できないため、操作に失敗しました。 |
| 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. | SSD クラウドディスクでは、この操作はサポートされていません。ESSD にアップグレードしてください。 |
| 403 | InvalidUserOperatorPermission | The user permission does not support this operation. | ユーザー権限ではこの操作はサポートされていません。 |
| 403 | InvalidVswitchId | Specified conn vswitch id is not valid. | 指定された VSwitchId のフォームが無効であるか、または空です。 |
| 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. | KMS キーが無効になっています。 |
| 403 | InvalidInstanceLevel.Malformed | Current DB instance level does not support this operation. | 操作が失敗しました。指定された仕様コードは、指定されたエンドポイント数をサポートしていません。シャード数と現在のエンドポイント数を確認してください。 |
| 403 | BasicCategoryNotSupport | The Basic category is not supported. | Basic Edition はサポートされていません。 |
| 403 | GuardDBInstanceNotSupport | Guard instance does not support this operation. | この操作はディザスタリカバリインスタンスではサポートされていません。 |
| 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. | 現在のインスタンスには Key Management サービスへのアクセス権限が付与されていません。 |
| 404 | Request.NotFound | The requested resource is not available. | リクエストされたリソースは利用できません。 |
| 404 | HostInfo.NotFound | The specified host info is not found. | 指定されたホスト情報がフォームまたはフォーマットに従っていません。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。