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

ApsaraDB RDS:ModifyDBProxyEndpoint

最終更新日:Apr 18, 2026

プロキシ接続アドレスの接続設定を変更します。

操作説明

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

  • RDS MySQL

  • RDS PostgreSQL

関連ドキュメント

説明

この操作を呼び出す前に、以下のトピックをお読みになり、この操作の前提条件と影響を十分に理解してください。

今すぐお試しください

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

update

*DBInstance

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

  • rds:ResourceTag
  • rds:ResourceTag
  • rds:ResourceTag
なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

DBInstanceId

string

必須

インスタンス ID。DescribeDBInstances 操作を呼び出してインスタンス ID をクエリできます。

rm-bp145737x5bi6****

DBProxyEndpointId

string

任意

プロキシエンドポイントの ID。DescribeDBProxyEndpoint 操作を呼び出してプロキシエンドポイント ID をクエリできます。

説明
  • インスタンスで MySQL が実行されていて、DbEndpointOperatorDelete または Modify に設定する場合は、DBProxyEndpointId を指定する必要があります。

  • インスタンスで PostgreSQL が実行されていて、DbEndpointOperatorDeleteModify、または Create に設定する場合は、DBProxyEndpointId を指定する必要があります。

gos787jog2wk0y****

ConfigDBProxyFeatures

string

任意

プロキシエンドポイントで有効にする機能。複数の機能を指定する場合は、セミコロン (;) で区切ります。フォーマット:機能1:ステータス;機能2:ステータス;...。値の末尾にセミコロン (;) を追加しないでください。

有効な機能の値:

  • ReadWriteSpliting:読み書き分離

  • ConnectionPersist:コネクションプーリング

  • TransactionReadSqlRouteOptimizeStatus:トランザクション分割

  • AZProximityAccess:最寄りアクセス

  • CausalConsistRead:読み取り整合性

有効なステータスの値:

  • 1:有効

  • 0:無効

説明
  • インスタンスで PostgreSQL が実行されている場合、ReadWriteSpliting で指定される読み書き分離のみを有効にできます。

  • 最寄りアクセスは、MySQL を実行する RDS インスタンスの専用データベースプロキシでのみサポートされます。

ReadWriteSpliting:1;ConnectionPersist:0

RegionId

string

任意

リージョン ID。DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。

cn-hangzhou

ReadOnlyInstanceMaxDelayTime

string

任意

読み書き分離に許容される最大レイテンシーしきい値。読み取り専用インスタンスのレイテンシーが指定したしきい値を超えた場合、システムは読み取りリクエストをその読み取り専用インスタンスに転送しなくなります。このパラメーターを指定しない場合、このパラメーターの元の値が保持されます。有効な値:03600

説明
  • このパラメーターは、読み書き分離が有効な場合にのみ指定する必要があります。

  • プロキシ接続アドレスに読み取り/書き込み属性がある場合、このパラメーターのデフォルト値は 30 で、読み書き分離がサポートされます。プロキシ接続アドレスに読み取り専用属性がある場合、このパラメーターのデフォルト値は -1 で、読み書き分離はサポートされません。単位:秒。

30

CausalConsistReadTimeout

string

任意

整合性読み取りのタイムアウト期間。単位:ミリ秒。デフォルト値:10。有効な値:0~60000

10

ReadOnlyInstanceDistributionType

string

任意

読み取り重みを割り当てるために使用されるポリシー。有効な値:

  • Standard (デフォルト):システムは、プライマリインスタンスと読み取り専用インスタンスの仕様に基づいて、これらのインスタンスに読み取り重みを自動的に割り当てます。

  • Custom:プライマリインスタンスと読み取り専用インスタンスに読み取り重みをを手動で割り当てる必要があります。

説明

このパラメーターは、読み書き分離が有効な場合に指定する必要があります。権限割り当てポリシーの詳細については、「ApsaraDB RDS for MySQL インスタンスのレイテンシーしきい値と読み取り重みの変更」および「ApsaraDB RDS for PostgreSQL インスタンスのデータベースプロキシ機能の有効化と設定」をご参照ください。

Standard

ReadOnlyInstanceWeight

string

任意

インスタンスとその読み取り専用インスタンスの読み取り重み。読み取り重みは 100 の倍数で、10000 を超えることはできません。フォーマット:

  • 標準インスタンス:{"プライマリインスタンスの ID":"重み","読み取り専用インスタンスの ID":"重み"...}

    例:{"rm-uf6wjk5****":"500","rr-tfhfgk5xxx":"200"...}

  • RDS Cluster Edition のインスタンス:{"読み取り専用インスタンスの ID":"重み","DBClusterNode":{"プライマリノードの ID":"重み","セカンダリノードの ID":"重み","セカンダリノードの ID":"重み"...}}

    例:{"rr-tfhfgk5****":"200","DBClusterNode":{"rn-2z****":"0","rn-2z****":"400","rn-2z****":"400"...}}

    説明

    インスタンスが RDS Cluster Edition を実行している場合、DBClusterNode が必要です。DBClusterNode パラメーターには、プライマリノードとセカンダリノードの ID重みに関する情報が含まれます。

{"rm-uf6wjk5****":"500","rr-tfhfgk5xxx":"200"...}

DBInstanceId

string

必須

インスタンス ID。DescribeDBInstances 操作を呼び出してインスタンス ID をクエリできます。

rm-bp145737x5bi6****

DbEndpointOperator

string

任意

実行する操作のタイプ。有効な値:

  • Modify:プロキシターミナルを変更します。これはデフォルト値です。

  • Create:プロキシターミナルを作成します。

  • Delete:プロキシターミナルを削除します。

Modify

DbEndpointAliases

string

任意

プロキシターミナルの説明。

test-proxy

DbEndpointType

string

任意

プロキシターミナルのタイプ。これは予約済みのパラメーターです。このパラメーターを指定する必要はありません。

RWSplit

DbEndpointReadWriteMode

string

任意

プロキシターミナルの読み取り/書き込み属性。有効な値:

  • ReadWrite:プロキシターミナルはプライマリインスタンスに接続し、読み取りリクエストと書き込みリクエストの両方を受信できます。

  • ReadOnly:プロキシターミナルはプライマリインスタンスに接続せず、読み取りリクエストのみを受信できます。これはデフォルト値です。

説明
  • DbEndpointOperatorCreate に設定する場合は、DbEndpointReadWriteMode も指定する必要があります。

  • インスタンスで MySQL が実行されていて、このパラメーターの値を ReadWrite から ReadOnly に変更すると、トランザクション分割機能が無効になります。

ReadWrite

DBProxyEngineType

string

任意

非推奨のパラメーターです。このパラメーターを指定する必要はありません。

normal

VSwitchId

string

任意

プロキシエンドポイントが指定されているゾーン内の vSwitch の ID。デフォルト値は、データベースプロキシのデフォルトターミナルに対応する vSwitch の ID です。DescribeVSwitches 操作を呼び出して、既存の vSwitch をクエリできます。

vsw-uf6adz52c2p****

EffectiveTime

string

任意

有効開始時刻。有効な値:

  • Immediate:すぐに有効になります。

  • MaintainTime:メンテナンスウィンドウ内に有効になります。詳細については、「ModifyDBInstanceMaintainTime」をご参照ください。

  • SpecificTime:指定した時刻に有効になります。

デフォルト値:MaintainTime

MaintainTime

EffectiveSpecificTime

string

任意

指定する時刻。時刻は、ISO 8601 規格に準拠した yyyy-MM-ddTHH:mm:ssZ 形式で指定する必要があります。時刻は協定世界時 (UTC) である必要があります。

説明

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

2023-05-06T07:08:09Z

DbEndpointMinSlaveCount

string

任意

予約済みインスタンスの最小数。

2

VpcId

string

任意

プロキシエンドポイントが指定されているゾーンの VPC ID。デフォルト値は、データベースプロキシのデフォルトターミナルに対応する VPC ID です。DescribeDBInstanceAttribute 操作を呼び出して、インスタンスのデフォルト VPC をクエリできます。

vpc-2zeusejj******

レスポンスフィールド

フィールド

説明

object

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

RequestId

string

リクエスト ID。

6B50D92C-1960-4D4F-A290-AFADD6B1A5C8

成功レスポンス

JSONJSON

{
  "RequestId": "6B50D92C-1960-4D4F-A290-AFADD6B1A5C8"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidVpcInstanceId The specified VPC instance ID is invalid.
400 InvalidEndPoint.Format The specified EndPoint is not valid.
400 InvalidEndpointType.Format The specified EndpointType is invalid.
400 IncorrectDBInstanceNetType The current database instance network type does not support the operation.
400 EndpointNum.Error The number of endpoint is invalid.
400 EndpointTypeOperation.NotSupport The endpoint type does not support the operation.
400 InvalidDBInstanceName Specified parameter DBInstanceName is not valid.
400 ClusterEndpoint.StatusNotValid The cluster endpoint status is invalid.
400 MaxscaleNotSupport Current custins can not support Maxscale.
400 InvalidAvZone.Format Specified AvZone is not valid.
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.
400 APICallingFailed Api calling failed.
400 InvalidVSwitchId.Format The specified vswitch Id format is incorrect.
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 MaxScaleLevel.NotSupport The current maxscale ins_num does not support this operation.
403 ReadDBInstance.NotFound The current database instance does not contain any read only instance.
403 IncorrectKindCode The current KindCode of the custins does not support the operation.
403 IncorrectDBInstanceState The current database instance state does not support the operation.
403 IncorrectDBInstanceEngine Current DB Instance engine does not support this operation. 現在のインスタンスがロックされているため、この操作は一時的にサポートされません。
403 IncorrectDBInstanceType Current DB instance type does not support this operation.
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 EndpointConfig.Invalid Please check the endpoint config parameter.
404 Readins.NotFound The current instance does not contain any read only instance. The operation is not supported.
404 Endpoint.NotFound Specified endpoint is not found.
404 EndpointType.NotFound The specified endpoint type is not found.
404 InvalidReadDBInstance.NotFound The specified read only database instance does not exist.
404 InvalidParam The specified Weight is invalid.
404 Maxscale.NotFound The related maxscale instance is not found.
404 IncorrectVswitchId The specified parameter VSwitchId is not valid.
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.

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

変更履歴

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