Tüm Ürünler
Search

Bu Ürün

    :ModifyDBProxyEndpoint

    Belge Merkezi

    :ModifyDBProxyEndpoint

    Son Güncelleme:Oct 02, 2026

    Bir veritabanı proxy uç noktasının bağlantı ayarlarını değiştirir.

    Operation description

    Desteklenen veritabanı motorları

    • RDS MySQL

    • RDS PostgreSQL

    Referanslar

    Not

    Bu işlemi çağırmadan önce aşağıdaki konuları okuyun ve işlemin ön koşullarını ve etkilerini tam olarak anladığınızdan emin olun.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    rds:ModifyDBProxyEndpoint

    update

    *DBInstance

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

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBInstanceId

    string

    Yes

    Örnek kimliği. Örnek kimliğini sorgulamak için DescribeDBInstances işlemini çağırabilirsiniz.

    rm-bp145737x5bi6****
    DBProxyEndpointId

    string

    No

    Proxy uç noktasının kimliği. Proxy uç noktası kimliğini sorgulamak için DescribeDBProxyEndpoint işlemini çağırabilirsiniz.

    Not

    • Örnek MySQL çalıştırıyorsa ve DbEndpointOperator parametresini Delete veya Modify olarak ayarlarsanız, DBProxyEndpointId parametresini belirtmeniz gerekir.

    • Örnek PostgreSQL çalıştırıyorsa ve DbEndpointOperator parametresini Delete, Modify veya Create olarak ayarlarsanız, DBProxyEndpointId parametresini belirtmeniz gerekir.

    gos787jog2wk0y****
    ConfigDBProxyFeatures

    string

    No

    Proxy uç noktası için etkinleştirmek istediğiniz özellikler. Birden fazla özellik belirtirseniz, özellikleri noktalı virgül (;) ile ayırın. Biçim: Özellik 1:Durum;Özellik 2:Durum;.... Değerin sonuna noktalı virgül (;) eklemeyin.

    Geçerli özellik değerleri:

    • ReadWriteSpliting: okuma/yazma bölme

    • ConnectionPersist: bağlantı havuzu

    • TransactionReadSqlRouteOptimizeStatus: işlem bölme

    • AZProximityAccess: en yakın erişim

    • CausalConsistRead: okuma tutarlılığı

    Geçerli durum değerleri:

    • 1: etkin

    • 0: devre dışı

    Not

    • Örnek PostgreSQL çalıştırıyorsa, yalnızca ReadWriteSpliting ile belirtilen okuma/yazma bölmeyi etkinleştirebilirsiniz.

    • En yakın erişim, yalnızca MySQL çalıştıran RDS örnekleri için ayrılmış veritabanı proxy'leri tarafından desteklenir.

    ReadWriteSpliting:1;ConnectionPersist:0
    RegionId

    string

    No

    Bölge kimliği. En son bölge listesini sorgulamak için DescribeRegions işlemini çağırabilirsiniz.

    cn-hangzhou
    ReadOnlyInstanceMaxDelayTime

    string

    No

    Okuma/yazma bölme için izin verilen maksimum gecikme eşiği. Salt okunur bir örnekteki gecikme belirttiğiniz eşiği aşarsa, sistem artık okuma isteklerini salt okunur örneğe iletmez. Bu parametreyi belirtmezseniz, bu parametrenin orijinal değeri korunur. Geçerli değerler: 0 ile 3600 arası.

    Not

    • Bu parametreyi yalnızca okuma/yazma bölme etkinleştirildiğinde belirtmeniz gerekir.

    • Veritabanı proxy uç noktası okuma ve yazma özniteliklerine sahipse, bu parametrenin varsayılan değeri 30'dur ve okuma/yazma bölme desteklenir. Veritabanı proxy uç noktası salt okunur özniteliğine sahipse, bu parametrenin varsayılan değeri -1'dir ve okuma/yazma bölme desteklenmez. Birim: saniye.

    30
    CausalConsistReadTimeout

    string

    No

    Tutarlılık okuma zaman aşımı süresi. Birim: milisaniye. Varsayılan değer: 10 Birim: milisaniye. Geçerli değerler: 0 ile 60000 arası.

    10
    ReadOnlyInstanceDistributionType

    string

    No

    Okuma ağırlıklarını dağıtmak için kullanılan ilke. Geçerli değerler:

    • Standard (varsayılan): Sistem, birincil ve salt okunur örneklere bu örneklerin teknik özelliklerine göre otomatik olarak okuma ağırlıkları atar.

    • Custom: Birincil ve salt okunur örneklere okuma ağırlıklarını manuel olarak dağıtmanız gerekir.

    Not

    Okuma/yazma bölme etkinleştirildiğinde bu parametreyi belirtmeniz gerekir. İzin dağıtım ilkesi hakkında daha fazla bilgi için ApsaraDB RDS for MySQL örneklerinin gecikme eşiğini ve okuma ağırlıklarını değiştirme ve ApsaraDB RDS for PostgreSQL örneği için veritabanı proxy özelliğini etkinleştirme ve yapılandırma konularına bakın.

    Standard
    ReadOnlyInstanceWeight

    string

    No

    Örneğin ve salt okunur örneklerinin okuma ağırlıkları. Okuma ağırlığı 100'ün katı olmalı ve 10000'i aşmamalıdır. Biçimler:

    • Standart örnek: {"Birincil örneğin kimliği":"Ağırlık","Salt okunur örneğin kimliği":"Ağırlık"...}

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

    • RDS Cluster Edition üzerindeki örnek: {"Salt okunur örneğin kimliği":"Ağırlık","DBClusterNode":{"Birincil düğümün kimliği":"Ağırlık","İkincil düğümün kimliği":"Ağırlık","İkincil düğümün kimliği":"Ağırlık"...}}

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

      Not

      Örnek RDS Cluster Edition çalıştırıyorsa DBClusterNode gereklidir. DBClusterNode parametresi, birincil ve ikincil düğümlerin kimlikleri ve ağırlıkları hakkındaki bilgileri içerir.

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

    string

    Yes

    Örnek kimliği. Örnek kimliğini sorgulamak için DescribeDBInstances işlemini çağırabilirsiniz.

    rm-bp145737x5bi6****
    DbEndpointOperator

    string

    No

    Gerçekleştirmek istediğiniz işlemin türü. Geçerli değerler:

    • Modify: Bir proxy terminalini değiştirir. Bu, varsayılan değerdir.

    • Create: Bir proxy terminali oluşturur.

    • Delete: Bir proxy terminalini siler.

    Modify
    DbEndpointAliases

    string

    No

    Proxy terminalinin açıklaması.

    test-proxy
    DbEndpointType

    string

    No

    Proxy terminalinin türü. Bu, ayrılmış bir parametredir. Bu parametreyi belirtmeniz gerekmez.

    RWSplit
    DbEndpointReadWriteMode

    string

    No

    Proxy terminalinin okuma ve yazma öznitelikleri. Geçerli değerler:

    • ReadWrite: Proxy terminali birincil örneğe bağlanır ve hem okuma hem de yazma istekleri alabilir.

    • ReadOnly: Proxy terminali birincil örneğe bağlanmaz ve yalnızca okuma istekleri alabilir. Bu, varsayılan değerdir.

    Not

    • DbEndpointOperator parametresini Create olarak ayarlarsanız, DbEndpointReadWriteMode parametresini de belirtmeniz gerekir.

    • Örnek MySQL çalıştırıyorsa ve bu parametrenin değerini ReadWrite değerinden ReadOnly değerine değiştirirseniz, işlem bölme özelliği devre dışı bırakılır.

    ReadWrite
    DBProxyEngineType

    string

    No

    Kullanımdan kaldırılmış bir parametre. Bu parametreyi belirtmeniz gerekmez.

    normal
    VSwitchId

    string

    No

    Proxy uç noktasının belirtildiği bölgedeki vSwitch kimliği. Varsayılan değer, veritabanı proxy'sinin varsayılan terminaline karşılık gelen vSwitch kimliğidir. Mevcut vSwitch'leri sorgulamak için DescribeVSwitches işlemini çağırabilirsiniz.

    vsw-uf6adz52c2p****
    EffectiveTime

    string

    No

    Yürürlüğe girme zamanı. Geçerli değerler:

    • Immediate: Yürürlüğe girme zamanı anlıktır.

    • MaintainTime: Yürürlüğe girme zamanı bakım penceresi içindedir. Daha fazla bilgi için ModifyDBInstanceMaintainTime konusuna bakın.

    • SpecificTime: Yürürlüğe girme zamanı belirtilen bir zaman noktasıdır.

    Varsayılan değer: MaintainTime.

    MaintainTime
    EffectiveSpecificTime

    string

    No

    Belirtmek istediğiniz zaman noktası. Zamanı ISO 8601 standardında yyyy-MM-ddTHH:mm:ssZ biçiminde belirtin. Zaman UTC olmalıdır.

    Not

    EffectiveTime parametresi SpecificTime olarak ayarlanmışsa, bu parametreyi belirtmeniz gerekir.

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

    string

    No

    Ayrılmış örneklerin minimum sayısı.

    2
    DbEndpointCostThresholdForDuckdb

    string

    No

    VpcId

    string

    No

    The VPC ID that corresponds to the zone of the proxy endpoint. Default value: the VPC ID of the default endpoint of the proxy instance. You can call DescribeDBInstanceAttribute to query the default VPC of the instance.

    vpc-2zeusejj******

    Response elements

    Element

    Type

    Description

    Example

    object

    Yanıt parametreleri.

    RequestId

    string

    İsteğin kimliği.

    6B50D92C-1960-4D4F-A290-AFADD6B1A5C8

    Examples

    Success response

    JSON format

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

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidVpcInstanceId The specified VPC instance ID is invalid. The operation failed. The current VPC instance ID is invalid.
    400 InvalidEndPoint.Format The specified EndPoint is not valid. The dedicated proxy connection address ID (DBProxyEndpointId) is not specified or does not exist. Check the Endpoint parameter.
    400 InvalidEndpointType.Format The specified EndpointType is invalid. The value of the EndpointType parameter is invalid. Check the value of this parameter.
    400 IncorrectDBInstanceNetType The current database instance network type does not support the operation. The operation failed. The operation is not supported for the network type of the RDS instance.
    400 EndpointNum.Error The number of endpoint is invalid. The number of proxy terminals is not supported. Check the maximum number of proxy terminals that are allowed.
    400 EndpointTypeOperation.NotSupport The endpoint type does not support the operation. The operation is not supported for the type of proxy terminal that you configure.
    400 InvalidDBInstanceName Specified parameter DBInstanceName is not valid. The value of the DBInstanceName parameter is invalid. Check that the value of this parameter is not null or an empty string.
    400 ClusterEndpoint.StatusNotValid The cluster endpoint status is invalid. The status of the endpoint is invalid.
    400 MaxscaleNotSupport Current custins can not support Maxscale. This operation is not supported for instances with maxscale.
    400 InvalidAvZone.Format Specified AvZone is not valid. The value of the AvZone parameter is invalid. Check the value of this parameter.
    400 Order.ComboInstanceNotAllowOperate A package instance is not allowed to operate independently. A package instance is not allowed to operate independently.
    400 Price.PricingPlanResultNotFound Pricing plan price result not found. 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. You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
    400 InsufficientAvailableQuota Your account quota limit is less than 0, please recharge before trying to purchase. Your account available limit is less than 0, please recharge before trying to purchase.
    400 CommodityServiceCalling.Exception Failed to call commodity service. Failed to call commodity service return.
    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. Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, 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. 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. Hello customer, this area has been abolished.
    400 Price.CommoditySys Commodity system call exception. Commodity system call exception.
    400 Pay.InsufficientBalance Insufficient available balance. Insufficient available balance.
    400 Order.PeriodInvalid There is a problem with the period you selected, please choose again. There is a problem with the period you selected, please choose again.
    400 pay.noCreditCard Account not bound to credit card. The account is not bound to a 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. 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. No payment method has been specified for your account. We recommend that you add a payment method.
    400 BasicInfoUncompleted Your information is incomplete. Complete your information before the operation. Your basic information is not complete, please complete your basic information before operation.
    400 Risk.RiskControlRejection Your account is abnormal, please contact customer service for details. Your account is abnormal, please contact customer service for details.
    400 Api.NotSupport Specified api is not supported. The current interface does not support.
    400 ContainForbiddenLabelError There is a label that prohibits placing orders. Please contact your distributor for assistance. You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
    400 InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in records. The DBInstanceId provided does not exist.
    400 InvalidInstanceLevel.DiskType Specified instance level not support request disk type The current instance type does not support the specified storage type.
    400 InvalidParam Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
    400 KmsApiError User secret key invalid. The user key is invalid.
    400 System.SaleValidateFailed Sales expression validation system error. A system error occurs when the sales expression is verified.
    400 Abs.InvalidAccount.NotFound account is not found. The account does not exist.
    400 SqlExecuteFailedOrTimeout sql command execution failed or timed out:%s. SQL command execution failed or timed out
    400 ColdData.EngineVersionNotSupport The current instance engine version not support coldDataEnabled. The current instance engine version not support coldDataEnabled.
    400 ColdData.MinorVersionNotSupport The current instance minor version not support coldDataEnabled. The current instance minor version not support coldDataEnabled.
    400 IncorrectTargetClasscode The current instance type does not support this operation. This operation is not supported by the instance type.
    400 InvalidConnectionString.Duplicate Specified connection string already exists in the RDS. The link address name is duplicate. Please reset the connection string.
    400 RequiredParam.NotFound Required input param is not found. A required parameter is missing.
    400 Parameters.Invalid Parameter error, please check the parameters. Parameter error, please check the parameters.
    400 BackupPolicyNotSupport Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. 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. The instance status does not support this operation.
    400 InvalidReleasedKeepPolicy.Format Specified Released Keep Policy is not valid. Specified Released Keep Policy is not valid.
    400 InvalidDBInstanceEngineType.Format the DB instance engine type does not support this operation. This operation is not supported for the database engine of the instance.
    400 Pay.NoCreditCard No credit cards. No credit cards.
    400 VpcNetworkTypeNotSupport The vpc network type instance does not support this operation. The vpc network type instance does not support this operation.
    400 MirrorInsExists Specified DB instance mirror ins already existed. Specified DB instance mirror ins already existed.
    400 UnsupportedClassCode The specified DB instance class stops selling. The specified DB instance class stops selling.
    400 InvalidBackupSet The specified database does not exist in the backup set. The specified database does not exist in the backup set.
    400 OrdTCommodityQueryError Failed to query for product. Failed to query product.
    400 ProductInstanceReleased The instance has been released. Please check before placing the order. The instance has been released, please verify and place an order.
    400 RegionEndTimeDissolvedIndia The region is no longer supported. The region is no longer supported.
    400 APICallingFailed Api calling failed. An internal error occurred.
    400 InvalidVSwitchId.Format The specified vswitch Id format is incorrect. The specified vSwitch ID format is invalid.
    500 ExternalFailure The request processing has failed due to external service failure. The request processing has failed due to external service failure.
    500 RequestMetaDataFailed The service request failed. Please try again later or contact service personnel. 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. The request failed to be processed due to an RDS API failure.
    403 MaxScaleLevel.NotSupport The current maxscale ins_num does not support this operation. The operation failed. The specifications of the database proxy are low.
    403 ReadDBInstance.NotFound The current database instance does not contain any read only instance. The current database instance does not have a read-only instance.
    403 IncorrectKindCode The current KindCode of the custins does not support the operation. The operation failed. The environment type of the current instance is not supported. Check the instance types supported by the operation.
    403 IncorrectDBInstanceState The current database instance state does not support the operation. The operation failed. The RDS instance is not running.
    403 IncorrectDBInstanceEngine Current DB Instance engine does not support this operation. The operation failed. The operation is not supported for the database engine that is run on the RDS instance.
    403 IncorrectDBInstanceType Current DB instance type does not support this operation. The operation failed. The RDS instance is not in a ready state.
    403 OrderStatus.UnPaid The specified db instance has unpaid order. The instance has an unpaid order. Please pay first and try again.
    403 InvalidReduceDiskSize The storage capacity after the scale-down must be larger than the used amount. The scale-in target capacity cannot be less than the current storage space usage
    403 CloudSSDNotSupport Cloud ssd does not support this operation, please upgrade to essd. SSD cloud disks do not support this operation. Upgrade to ESSD.
    403 InvalidUserOperatorPermission The user permission does not support this operation. The user is not authorized to perform this operation.
    403 InvalidVswitchId Specified conn vswitch id is not valid. The specified VSwitchId is in an invalid format or is empty.
    403 IncorrectMinorVersion Current engine minor version does not support operations. This operation is not supported for the current minor engine version.
    403 OperationDenied.ZoneResource There is no available zone for inventory. There is no available zone for inventory.
    403 NotInFlowController Sorry,no permission. Sorry,no permission.
    403 InvalidKmsKey Kms key is disabled. The KMS key is disabled.
    403 InvalidInstanceLevel.Malformed Current DB instance level does not support this operation. The specified database instance type does not support this operation.
    404 EndpointConfig.Invalid Please check the endpoint config parameter. Please check the endpoint configuration parameter.
    404 Readins.NotFound The current instance does not contain any read only instance. The operation is not supported. The operation failed. The RDS instance is not attached with read-only RDS instances.
    404 Endpoint.NotFound Specified endpoint is not found. The port that is associated with the dedicated proxy endpoint cannot be found.
    404 EndpointType.NotFound The specified endpoint type is not found. The operation failed. Unknown types of proxy terminals are detected.
    404 InvalidReadDBInstance.NotFound The specified read only database instance does not exist. The read-only RDS instance is not created, or the values of the request parameters are invalid.
    404 InvalidParam The specified Weight is invalid. The weight is invalid.
    404 Maxscale.NotFound The related maxscale instance is not found. The operation failed. No associated MaxScale instances can be found.
    404 IncorrectVswitchId The specified parameter VSwitchId is not valid. The vSwitch ID is invalid.
    404 InvalidClusterKms The current instance does not authorized to access the Key Management Service. The instance does not have permissions to access Key Management Service (KMS).
    404 Request.NotFound The requested resource is not available. The requested resources are unavailable.
    404 HostInfo.NotFound The specified host info is not found. The specified host information does not exist.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.