AllocateReadWriteSplittingConnection - ApsaraDB RDS - Alibaba Cloud ドキュメントセンター

インスタンスの読み取り専用ルートエンドポイントを申請します。

操作説明

サポートされているデータベースエンジン

MySQL
SQL Server

機能説明

読み取り専用インスタンスがプライマリ ApsaraDB RDS for SQL Server インスタンスにアタッチされている場合、この操作を呼び出して、プライマリインスタンスの統一された読み取り専用ルートエンドポイントを申請できます。プライマリインスタンスの読み取り専用ルートエンドポイントを申請した後も、プライマリインスタンスとその読み取り専用インスタンスの既存のエンドポイントは引き続き有効です。さらに、内部エンドポイントとパブリックエンドポイントも引き続き申請できます。

前提条件

この操作を呼び出す前に、次の要件が満たされていることを確認してください：

ご利用の ApsaraDB RDS for MySQL インスタンスで共有プロキシ機能が有効になっていること。
インスタンスが「実行中」状態であること。
読み取り専用インスタンスがプライマリインスタンスにアタッチされていること。
インスタンスに進行中の Data Transmission Service (DTS) 移行タスクがないこと。
インスタンスが次のいずれかのデータベースバージョンと RDS エディションを実行していること：
- SQL Server on RDS Cluster Edition
- MySQL 5.7 on RDS High-availability Edition (ローカルディスク)
- MySQL 5.6

今すぐお試しください

この 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:AllocateReadWriteSplittingConnection

create

*DBInstance

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

rds:ResourceTag

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	プライマリインスタンスの ID。DescribeDBInstances 操作を呼び出して、プライマリインスタンスの ID をクエリできます。	rm-uf6wjk5****
ConnectionStringPrefix	string	任意	読み取り専用ルートエンドポイントのプレフィックス。プレフィックスは一意である必要があります。最大 30 文字で、小文字とハイフン (-) を使用できます。小文字で始まる必要があります。説明デフォルトのプレフィックスは、プライマリインスタンスの名前に `rw` を付けたものです。	rr-m5e****-rw.mysql.rds.aliyuncs.com
Port	string	任意	読み取り専用ルートエンドポイントに関連付けられているポート。有効な値：1000～5999。デフォルト値：1433。	1433
MaxDelayTime	string	任意	読み取り専用インスタンスで許容されるレイテンシーのしきい値。有効な値：0～7200。デフォルト値：30。単位：秒。説明読み取り専用インスタンスのレイテンシーが指定されたしきい値を超えた場合、ApsaraDB RDS はその読み取り専用インスタンスに読み取りリクエストを転送しません。	30
NetType	string	任意	読み取り専用ルートエンドポイントのネットワークタイプ。有効な値： Internet Intranet 説明デフォルト値は Intranet です。読み取り専用ルートエンドポイントのネットワークタイプがプライマリインスタンスのネットワークタイプと同じであることを確認してください。	Intranet
DistributionType	string	任意	読み取り重みを割り当てるために使用されるメソッド。有効な値： Standard：システムは、プライマリインスタンスと読み取り専用インスタンスの仕様に基づいて、自動的に読み取り重みを割り当てます。 Custom：各インスタンスに手動で読み取り重みを割り当てる必要があります。	Standard
Weight	string	任意	プライマリインスタンスとその読み取り専用インスタンスの読み取り重み。読み取り重みは 100 単位で増加します。最大値は 10000 です。 ApsaraDB RDS インスタンスの場合、このパラメーターの値は次のフォーマットです：`{"<読み取り専用インスタンスの ID>":<重み>,"master":<重み>,"slave":<重み>}`。 ApsaraDB MyBase インスタンスの場合、このパラメーターの値は次のフォーマットです：`[{"instanceName":"<プライマリインスタンス ID>","weight":<重み>,"role":"master"},{"instanceName":"<プライマリインスタンス ID>","weight":<重み>,"role":"slave"},{"instanceName":"<読み取り専用インスタンス ID>","weight":<重み>,"role":"master"}]` 説明このパラメーターは、DistributionType が Custom に設定されている場合に指定する必要があります。 DistributionType が Standard に設定されている場合、このパラメーターは無効です。	{ "rm-bp1****": 800, "master": 400, "slave": 400 }

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	4C467B38-3910-447D-87BC-AC049166F216

例

成功レスポンス

JSONJSON

{
  "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.
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	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type
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.
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	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.
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.

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

変更履歴

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