ModifyDBProxyInstanceを呼び出して、ApsaraDB RDSインスタンスのデータベースプロキシ設定を変更できます。

ModifyDBProxyInstance操作を呼び出す前に、インスタンスのデータベースプロキシ機能を有効にするためにModifyDBProxy操作が呼び出されていることを確認してください。

デバッグ

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

リクエストパラメーター

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

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

DBInstanceId String 必須 rm-t4n3a ****

インスタンスの ID です。 DescribeDBInstancesを呼び出して、インスタンスのIDを照会できます。

DBProxyInstanceType String 必須 DedicatedProxy

インスタンスに対して有効になっているデータベースプロキシのタイプ。 値をDedicatedProxyに設定します。

DBProxyInstanceNum String 必須 2

有効になっているプロキシインスタンスの数。 このパラメーターの値が0の場合、インスタンスのデータベースプロキシ機能は無効になります。 有効な値: 1〜60。

説明 リクエストを処理するデータベースプロキシの機能は、有効になっているプロキシインスタンスの数とともに増加します。 インスタンスの負荷を監視し、負荷監視データに基づいて適切な数のプロキシインスタンスを指定できます。
EffectiveTime String 任意 MaintainTime

新しいデータベースプロキシ設定を適用する時刻。 有効な値：

  • Immediate: ApsaraDB RDSはすぐに新しい設定を適用します。
  • MaintainTime: ApsaraDB RDSは、指定したメンテナンス期間中に新しい設定を適用します。 詳細については、「メンテナンスウィンドウの変更」をご参照ください。
  • SpecificTime: ApsaraDB RDSは、指定された時点で新しい設定を適用します。

デフォルト値: MaintainTime。

EffectiveSpecificTime String 任意 2019-07-10T13:15:12Z

新しいデータベースプロキシ設定を適用する時点。 yyyy-MM-dd T HH:mm:ss Z形式のISO 8601標準で時刻を指定します。 時間は UTC にする必要があります。

説明 EffectiveTimeパラメーターをSpecificTimeに設定した場合、EffectiveSpecificTimeパラメーターを指定する必要があります。
RegionId String 任意 cn-hangzhou

インスタンスが設置されているリージョンの ID です。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

DBProxyEngineType String 任意 normal

内部パラメーター。 指定する必要はありません。

レスポンスパラメーター

項目 データ型 例: 説明　
RequestId String 65C55572-530E-4A53-BE03-1D08CAF0F046

リクエストの ID です。

例

リクエストの例

http(s):// rds.aliyuncs.com/?Action=ModifyDBProxyInstance
&DBInstanceId=rm-t4n3a ****
&DBProxyInstanceType=DedicatedProxy
&DBProxyInstanceNum=2
&EffectiveTime=Immediate
&<共通リクエストパラメーター>

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

XML 形式 

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

<ModifyDBProxyInstanceResponse>
  <RequestId>65C55572-530E-4A53-BE03-1D08CAF0F046</RequestId>
</ModifyDBProxyInstanceResponse>

JSON 形式 

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

{
  "RequestId" : "65C55572-530E-4A53-BE03-1D08CAF0F046"
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明　
400 InvalidDBInstanceName 指定されたパラメーターDBInstanceNameは無効です。 DBInstanceNameパラメーターの値が無効な場合に返されるエラーメッセージ。 値がnullまたは空の文字列であるかどうかを確認します。
403 DBInstanceStatusNotActive 現在のDBインスタンスのステータスはアクティブである必要があります。 インスタンスのステータスが操作をサポートしていない場合に返されるエラーメッセージ。
403 InvalidInstanceLevel.Malformed 指定されたクラスコードはエンドポイント番号をサポートしていません。 シャード番号と現在のエンドポイント番号を確認してください。 インスタンスのインスタンスタイプが指定したプロキシ端末の数をサポートしていない場合に返されるエラーメッセージ。 プロキシインスタンスの数とプロキシ端末の数を確認します。

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