全部產品
Search

搜尋本產品

    ApsaraDB RDS：ModifyDBProxyEndpoint - 設定資料庫代理串連地址存取原則

    文件中心

    ApsaraDB RDS：ModifyDBProxyEndpoint - 設定資料庫代理串連地址存取原則

    更新時間：Apr 18, 2026

    該介面用於配置RDS執行個體資料庫代理串連地址的存取原則。

    介面說明

    適用引擎

    • RDS MySQL

    • RDS PostgreSQL

    相關功能文檔

    重要 使用該介面前，請仔細閱讀功能文檔，確保完全瞭解使用介面的前提條件及使用後造成的影響後，再進行操作。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    rds:ModifyDBProxyEndpoint

    update

    *DBInstance

    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    • rds:ResourceTag
    • rds:ResourceTag
    		 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DBInstanceId

    string

    是

    執行個體 ID。可調用 DescribeDBInstances 擷取。

    rm-bp145737x5bi6****
    DBProxyEndpointId

    string

    否

    代理串連地址 ID。可以通過介面 DescribeDBProxyEndpoint 查看。

    說明

    • MySQL：當 DbEndpointOperator 取值為 Delete 或 Modify 時，本參數必須傳入。

    • PostgreSQL：當 DbEndpointOperator 取值為 Delete、Modify 或 Create 時，本參數必須傳入。

    gos787jog2wk0y****
    ConfigDBProxyFeatures

    string

    否

    設定代理串連地址想要開通的代理功能，各功能之間以英文分號（;）隔開。格式：功能 1:開通情況;功能 2:開通情況;... ，末尾不加英文分號（;）。

    功能取值：

    • ReadWriteSpliting：讀寫分離

    • ConnectionPersist：串連池

    • TransactionReadSqlRouteOptimizeStatus：事務拆分

    • AZProximityAccess：就近訪問

    • CausalConsistRead：讀一致性

    • HtapFilter：HTAP 行列自動分流

    開通情況取值：

    • 1：功能已開通

    • 0：功能未開通

    說明

    • RDS PostgreSQL 僅支援設定 ReadWriteSpliting。

    • 就近訪問功能僅支援 MySQL 獨享型代理。

    ReadWriteSpliting:1;ConnectionPersist:0
    RegionId

    string

    否

    地區 ID。可調用 DescribeRegions 擷取。

    cn-hangzhou
    ReadOnlyInstanceMaxDelayTime

    string

    否

    讀寫分離中唯讀執行個體的最大延遲閾值，當唯讀執行個體延遲時間超過該值時，讀取流量不發往該執行個體，單位：秒。不傳該參數則保持原值。取值：0~3600。

    說明

    • 開通讀寫分離時才需要傳入該參數。

    • 預設值：讀寫屬性為讀寫（讀寫分離）時預設 30 秒，讀寫屬性為唯讀時預設 -1 (關閉)。

    30
    CausalConsistReadTimeout

    string

    否

    一致性讀逾時時間，單位：毫秒。預設為 10 毫秒，取值：0～60000

    10
    ReadOnlyInstanceDistributionType

    string

    否

    讀權重分配模式。取值：

    • Standard：預設值，按規格權重自動分配。

    • Custom：自訂分配權重。

    說明

    開通讀寫分離時才需要傳入該參數。許可權分配模式的詳細資料，MySQL 請參見讀權重分配，PostgreSQL 請參見開通並設定資料庫代理服務。

    Standard
    ReadOnlyInstanceWeight

    string

    否

    自訂讀權重分配，即傳入主執行個體和唯讀執行個體的讀請求權重。以 100 遞增，最大值為 10000，格式：

    • 常規執行個體：{"主執行個體 ID":"權重","唯讀執行個體 ID":"權重"...}

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

    • RDS MySQL 叢集版執行個體：{"唯讀執行個體 ID":"權重","DBClusterNode":{"主節點 ID":"權重","備節點 ID":"權重","備節點 ID":"權重"...}}

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

      說明

      DBClusterNode 為叢集版專屬的請求資訊，包含主備節點的 NodeID 以及權重。

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

    string

    是

    執行個體 ID。可調用 DescribeDBInstances 擷取。

    rm-bp145737x5bi6****
    DbEndpointOperator

    string

    否

    操作類型，取值：

    • Modify：預設值，修改代理終端。

    • Create：建立代理終端。

    • Delete：刪除代理終端。

    Modify
    DbEndpointAliases

    string

    否

    代理終端的備忘資訊。

    test-proxy
    DbEndpointType

    string

    否

    代理終端的類型，保留參數，無需設定。

    RWSplit
    DbEndpointReadWriteMode

    string

    否

    讀寫類型，取值：

    • ReadWrite：串連主執行個體，可接受寫請求。

    • ReadOnly：預設值，不串連主執行個體，無法接受寫請求。

    說明

    • 當 DbEndpointOperator 取值為 Create 時，本參數必須傳入。

    • RDS MySQL 執行個體中，本參數的取值從 ReadWrite 更換為 ReadOnly 時，會關閉事務拆分功能。

    ReadWrite
    DBProxyEngineType

    string

    否

    廢棄參數，無需配置。

    normal
    VSwitchId

    string

    否

    指定代理串連地址的可用性區域對應的交換器 ID。預設為代理執行個體預設終端對應的交換器 ID。可通過調用 DescribeVSwitches 介面查詢已建立的交換器。

    vsw-uf6adz52c2p****
    EffectiveTime

    string

    否

    生效時間，取值：

    • Immediate：立即生效。

    • MaintainTime：在可營運時間段內生效，請參見 ModifyDBInstanceMaintainTime。

    • SpecificTime：指定時間生效。

    預設值：MaintainTime。

    MaintainTime
    EffectiveSpecificTime

    string

    否

    指定時間生效。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

    說明

    EffectiveTime 為 SpecificTime 時，該參數必傳。

    2023-05-06T07:08:09Z
    DbEndpointMinSlaveCount

    string

    否

    最小保留執行個體數。

    2
    DbEndpointCostThresholdForDuckdb

    string

    否

    VpcId

    string

    否

    指定代理串連地址的可用性區域對應的 VPC ID。預設為代理執行個體預設終端對應的 VPC ID。可通過調用 DescribeDBInstanceAttribute 介面查詢執行個體預設 VPC。

    vpc-2zeusejj******

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回參數詳情。

    RequestId

    string

    請求 ID。

    6B50D92C-1960-4D4F-A290-AFADD6B1A5C8

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidVpcInstanceId The specified VPC instance ID is invalid. 操作失敗，當前VPC instance ID無效。
    400 InvalidEndPoint.Format The specified EndPoint is not valid. 獨享代理串連地址ID（DBProxyEndpointId）未傳，查詢不存在， 請檢查Endpoint參數。
    400 InvalidEndpointType.Format The specified EndpointType is invalid. 指定的EndpointType無效，請檢查參數正確性。
    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. 指定的執行個體名稱（DBInstanceName）無效，請檢查參數值是否為null或Null 字元串。
    400 ClusterEndpoint.StatusNotValid The cluster endpoint status is invalid. 叢集endpoint 狀態無效。
    400 MaxscaleNotSupport Current custins can not support Maxscale. 帶有maxscale的執行個體不支援此操作。
    400 InvalidAvZone.Format Specified AvZone is not valid. 指定的AvZone不合法，請檢查該參數的正確性。
    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. 您的賬戶可用額度小於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. 客戶您好，阿里雲計劃對當前地區進行最佳化調整，該地區雲端服務將停止營運，為確保您的商務持續性及資料移轉工作的平穩過渡，您目前無法操作新購類型的訂單，感謝理解與支援。
    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. 提供的DBInstanceId不存在。
    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. 指定的 wal_level 參數無效。執行個體中仍然存在複製槽，因此無法將其設定為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. 當前執行個體引擎版本不支援歸檔冷資料。
    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. DB執行個體引擎類型不支援此操作。
    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 APICallingFailed Api calling failed. 後端API內部調用失敗
    400 InvalidVSwitchId.Format The specified vswitch Id format is incorrect. 指定的vswitch Id格式不正確。
    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. 由於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. 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 key已禁用。
    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. 操作失敗，未找到關聯的maxscale執行個體。
    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. 指定的主機資訊不存在。

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。