Todos los productos
Search
Centro de documentos

ApsaraDB RDS:ModifyDBProxyEndpoint

Última actualización: Sep 02, 2026

Modifica la configuración de conexión de un endpoint de proxy de base de datos.

Descripción de la operación

Motores de base de datos compatibles

  • RDS MySQL

  • RDS PostgreSQL

Referencias

Nota

Antes de llamar a esta operación, lea los siguientes temas y asegúrese de comprender completamente los requisitos previos y los impactos de esta operación.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

  • Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.

  • API: La API que debe invocarse para llevar a cabo la acción.

  • Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.

  • Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.

    • En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.

    • Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.

  • Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.

  • Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

rds:ModifyDBProxyEndpoint

update

*DBInstance.

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

  • rds:ResourceTag
  • rds:ResourceTag
  • rds:ResourceTag
Ninguna

Parámetros de la solicitud

Parámetro

Tipo

Obligatorio

Descripción

Ejemplo

DBInstanceId

string

Sí

El ID de la instancia. Puede llamar a la operación DescribeDBInstances para consultar el ID de la instancia.

rm-bp145737x5bi6****

DBProxyEndpointId

string

No

El ID del endpoint de proxy. Puede llamar a la operación DescribeDBProxyEndpoint para consultar el ID del endpoint de proxy.

Nota
  • Si la instancia ejecuta MySQL y establece DbEndpointOperator en Delete o Modify, debe especificar DBProxyEndpointId.

  • Si la instancia ejecuta PostgreSQL y establece DbEndpointOperator en Delete, Modify o Create, debe especificar DBProxyEndpointId.

gos787jog2wk0y****

ConfigDBProxyFeatures

string

No

Las capacidades que desea habilitar para el endpoint de proxy. Si especifica más de una capacidad, separe las capacidades con punto y coma (;). Formato: Capacidad 1:Estado;Capacidad 2:Estado;.... No agregue un punto y coma (;) al final del valor.

Valores de capacidad válidos:

  • ReadWriteSpliting: división de lectura/escritura

  • ConnectionPersist: agrupación de conexiones

  • TransactionReadSqlRouteOptimizeStatus: división de transacciones

  • AZProximityAccess: acceso más cercano

  • CausalConsistRead: consistencia de lectura

Valores de estado válidos:

  • 1: habilitado

  • 0: deshabilitado

Nota
  • Si la instancia ejecuta PostgreSQL, solo puede habilitar la división de lectura/escritura, que se especifica mediante ReadWriteSpliting.

  • El acceso más cercano solo es compatible con proxies de base de datos dedicados para instancias de RDS que ejecutan MySQL.

ReadWriteSpliting:1;ConnectionPersist:0

RegionId

string

No

El ID de la región. Puede llamar a la operación DescribeRegions para consultar la lista de regiones más reciente.

cn-hangzhou

ReadOnlyInstanceMaxDelayTime

string

No

El umbral máximo de latencia permitido para la división de lectura/escritura. Si la latencia en una instancia de solo lectura supera el umbral que especificó, el sistema deja de reenviar solicitudes de lectura a la instancia de solo lectura. Si no especifica este parámetro, se conserva el valor original de este parámetro. Valores válidos: 0 a 3600.

Nota
  • Debe especificar este parámetro solo cuando la división de lectura/escritura está habilitada.

  • Si el endpoint de proxy de base de datos tiene atributos de lectura y escritura, el valor predeterminado de este parámetro es 30 y se admite la división de lectura/escritura. Si el endpoint de proxy de base de datos tiene el atributo de solo lectura, el valor predeterminado de este parámetro es -1 y no se admite la división de lectura/escritura. Unidad: segundos.

30

CausalConsistReadTimeout

string

No

El tiempo de espera de lectura de consistencia. Unidad: milisegundos. Valor predeterminado: 10. Unidad: milisegundos. Valores válidos: 0 a 60000.

10

ReadOnlyInstanceDistributionType

string

No

La política que se utiliza para asignar pesos de lectura. Valores válidos:

  • Standard (predeterminado): El sistema asigna automáticamente pesos de lectura a las instancias principales y de solo lectura según las especificaciones de estas instancias.

  • Custom: Debe asignar manualmente pesos de lectura a las instancias principales y de solo lectura.

Nota

Debe especificar este parámetro cuando la división de lectura/escritura está habilitada. Para obtener más información sobre la política de asignación de permisos, consulte Modificar el umbral de latencia y los pesos de lectura de instancias de ApsaraDB RDS for MySQL y Habilitar y configurar la función de proxy de base de datos para una instancia de ApsaraDB RDS for PostgreSQL.

Standard

ReadOnlyInstanceWeight

string

No

Los pesos de lectura de la instancia y sus instancias de solo lectura. Un peso de lectura debe ser múltiplo de 100 y no puede exceder 10000. Formatos:

  • Instancia estándar: {"ID de la instancia principal":"Peso","ID de la instancia de solo lectura":"Peso"...}

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

  • Instancia en RDS Cluster Edition: {"ID de la instancia de solo lectura":"Peso","DBClusterNode":{"ID del nodo principal":"Peso","ID del nodo secundario":"Peso","ID del nodo secundario":"Peso"...}}

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

    Nota

    DBClusterNode es obligatorio si la instancia ejecuta RDS Cluster Edition. El parámetro DBClusterNode incluye información sobre los ID y los pesos de los nodos principales y secundarios.

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

DBInstanceId

string

Sí

El ID de la instancia. Puede llamar a la operación DescribeDBInstances para consultar el ID de la instancia.

rm-bp145737x5bi6****

DbEndpointOperator

string

No

El tipo de operación que desea realizar. Valores válidos:

  • Modify: Modificar un endpoint de proxy. Este es el valor predeterminado.

  • Create: Crear un endpoint de proxy.

  • Delete: Eliminar un endpoint de proxy.

Modify

DbEndpointAliases

string

No

La descripción del endpoint de proxy.

test-proxy

DbEndpointType

string

No

El tipo de endpoint de proxy. Este es un parámetro reservado. No necesita especificar este parámetro.

RWSplit

DbEndpointReadWriteMode

string

No

Los atributos de lectura y escritura del endpoint de proxy. Valores válidos:

  • ReadWrite: El endpoint de proxy se conecta a la instancia principal y puede recibir solicitudes de lectura y escritura.

  • ReadOnly: El endpoint de proxy no se conecta a la instancia principal y solo puede recibir solicitudes de lectura. Este es el valor predeterminado.

Nota
  • Si establece DbEndpointOperator en Create, también debe especificar DbEndpointReadWriteMode.

  • Si la instancia ejecuta MySQL y cambia el valor de este parámetro de ReadWrite a ReadOnly, la función de división de transacciones se deshabilita.

ReadWrite

DBProxyEngineType

string

No

Un parámetro obsoleto. No necesita especificar este parámetro.

normal

VSwitchId

string

No

El ID del vSwitch en la zona donde se especifica el endpoint de proxy. El valor predeterminado es el ID del vSwitch que corresponde al endpoint predeterminado del proxy de base de datos. Puede llamar a la operación DescribeVSwitches para consultar los vSwitches existentes.

vsw-uf6adz52c2p****

EffectiveTime

string

No

La hora de entrada en vigor. Valores válidos:

  • Immediate: La entrada en vigor es inmediata.

  • MaintainTime: La entrada en vigor ocurre dentro de la ventana de mantenimiento. Para obtener más información, consulte ModifyDBInstanceMaintainTime.

  • SpecificTime: La entrada en vigor ocurre en un momento específico.

Valor predeterminado: MaintainTime.

MaintainTime

EffectiveSpecificTime

string

No

El momento específico que desea indicar. Especifique la hora en formato ISO 8601: aaaa-MM-ddTHH:mm:ssZ. La hora debe estar en UTC.

Nota

Si EffectiveTime se establece en SpecificTime, debe especificar este parámetro.

2023-05-06T07:08:09Z

DbEndpointMinSlaveCount

string

No

El número mínimo de instancias reservadas.

2

DbEndpointCostThresholdForDuckdb

string

No

VpcId

string

No

El ID de VPC de la zona donde se especifica el endpoint de proxy. El valor predeterminado es el ID de VPC que corresponde al endpoint predeterminado del proxy de base de datos. Puede llamar a la operación DescribeDBInstanceAttribute para consultar la VPC predeterminada de una instancia.

vpc-2zeusejj******

Elementos de la respuesta

Elemento

Tipo

Descripción

Ejemplo

object

Los parámetros de respuesta.

RequestId

string

El ID de la solicitud.

6B50D92C-1960-4D4F-A290-AFADD6B1A5C8

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Código de estado HTTP

Código de error

Mensaje de error

Descripción

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.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.