データベースプロキシ機能の有効化または無効化 - ApsaraDB RDS

ApsaraDB RDS for MySQLの専用プロキシ機能は、読み書き分離や短期間の接続最適化などの機能を提供します。詳細については、「データベースプロキシとは」をご参照ください。
ApsaraDB RDS for PostgreSQLのデータベースプロキシ機能は、読み書き分離をサポートしています。詳細については、「データベースプロキシとは」をご参照ください。

この API を呼び出す場合、インスタンスは次の要件を満たしている必要があります。

インスタンスがMySQLを実行する場合、インスタンスは次のMySQLバージョンとRDSエディションのいずれかを実行する必要があります。

RDS Enterprise Editionの20191204以降のマイナーエンジンバージョンを使用したMySQL 8.0
RDS High-availability Editionの20190915以降のマイナーエンジンバージョンを使用したMySQL 8.0
RDS Enterprise Editionの20191128以降のマイナーエンジンバージョンを使用したMySQL 5.7
RDS High-availability Editionの20190925以降のマイナーエンジンバージョンを使用したMySQL 5.7
RDS High-availability Editionの20200229以降のマイナーエンジンバージョンを使用したMySQL 5.6

インスタンスがPostgreSQLを実行する場合、インスタンスは次の要件を満たす必要があります。

インスタンスは、PostgreSQL 10、PostgreSQL 11、PostgreSQL 12、PostgreSQL 13、またはPostgreSQL 14を実行します。
インスタンスは、標準SSDまたは拡張SSD (ESSD) を使用します。
インスタンスはRDS High-availability Editionを実行します。
インスタンスはプライマリインスタンスです。

デバッグ

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

リクエストパラメーター


項目	データ型	必須／任意	例:	説明
操作	String	必須	ModifyDBProxy	実行する操作です。値をModifyDBProxyに設定します。
DBInstanceId	String	必須	rm-uf6wjk5xxxxxxx	インスタンスの ID です。 DescribeDBInstancesを呼び出して、インスタンスのIDを照会できます。
ConfigDBProxyService	String	必須	起動	データベースプロキシ機能を有効にするか無効にするかを指定します。有効な値： Startup: データベースプロキシ機能を有効にします。シャットダウン: データベースプロキシ機能を無効にします。
DBProxyInstanceNum	String	いいえ	1	有効になっているプロキシインスタンスの数。有効な値: 1〜60。デフォルト値: 1 説明リクエストを処理するデータベースプロキシの機能は、有効になっているプロキシインスタンスの数とともに増加します。インスタンスの負荷を監視し、負荷監視データに基づいて適切な数のプロキシインスタンスを指定できます。
RegionId	String	任意	cn-hangzhou	インスタンスが設置されているリージョンの ID です。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。
InstanceNetworkType	String	任意	VPC	インスタンスのネットワークタイプです。値をVPCに設定します。説明インスタンスがPostgreSQLを実行し、インスタンスのデータベースプロキシ機能を有効にする場合、このパラメーターを指定する必要があります。
VPCId	String	任意	vpc-xxxxxxxxxxxx	インスタンスが属する仮想プライベートクラウド (VPC) のID。 DescribeDBInstanceAttributeを呼び出して、インスタンスのVPC IDを照会できます。説明インスタンスがPostgreSQLを実行し、インスタンスのデータベースプロキシ機能を有効にする場合、このパラメーターを指定する必要があります。
VSwitchId	String	任意	vsw-xxxxxxxxxxxx	指定されたVPCに関連付けられているvSwitchのID。 DescribeDBInstanceAttributeを呼び出して、インスタンスのvSwitch IDを照会できます。説明インスタンスがPostgreSQLを実行し、インスタンスのデータベースプロキシ機能を有効にする場合、このパラメーターを指定する必要があります。
DBProxyEngineType	String	任意	normal	内部パラメーター。指定する必要はありません。
ResourceGroupId	String	任意	rg-acfmy *****	リソースグループの ID です。

レスポンスパラメーター


項目	データ型	例:	説明
RequestId	String	FC452BB1-EED8-4278-95C7-0324B3710DF1	リクエストの ID です。

例

リクエストの例

http(s):// rds.aliyuncs.com/?Action=ModifyDBProxy
&DBInstanceId=rm-uf6wjk5xxxxxxx
&ConfigDBProxyService=スタートアップ
&<共通リクエストパラメーター>

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

XML 形式

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

<ModifyDBProxyResponse>
  <RequestId>FC452BB1-EED8-4278-95C7-0324B3710DF1</RequestId>
</ModifyDBProxyResponse>

JSON 形式

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

{
  "RequestId" : "FC452BB1-EED8-4278-95C7-0324B3710DF1"
}

エラーコード


HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	MaxscaleAlreadyExist	Maxscaleはすでに存在しています。	MaxScaleが既に存在する場合に返されるエラーメッセージ。
400	MaxscaleNotSupport	Maxscaleがサポートされていません	インスタンスが専用プロキシ機能をサポートしていない場合に返されるエラーメッセージ。指定した専用プロキシ設定を確認する必要があります。
400	InvalidVpcParameter	VPC IDまたはvSwitch IDのいずれかが正しくありません。もう一度確認してください。	指定したVPC IDが無効な場合に返されるエラーメッセージ。
400	MaxscaleInternalError	データベースプロキシのステータスはCLASS_CHANGINGです。	データベースプロキシの仕様が変更されている場合に返されるエラーメッセージ。しばらくしてからもう一度お試しください。
400	InvalidDBInstanceName	指定されたパラメーターDBInstanceNameは無効です。	DBInstanceNameパラメーターの値が無効な場合に返されるエラーメッセージ。値がnullまたは空の文字列であるかどうかを確認します。
404	Maxscale.NotFound	相対maxscaleインスタンスが見つかりません。	関連付けられたMaxScaleインスタンスが見つからない場合に返されるエラーメッセージ。
404	InvalidVSwitchId.NotFound	指定されたVSwitchは無効です。	指定したvSwitch IDが無効な場合に返されるエラーメッセージ。

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