ApsaraDB RDS:ModifyDBProxyEndpoint

Instance ID of the instance. You can call the DescribeDBInstances operation to obtain instance ID.

The ID of the proxy endpoint. You can call the DescribeDBProxyEndpoint operation to query the ID.

Specifies the proxy features to be enabled for the proxy endpoint. Separate multiple features with semicolons (;). Format: Feature 1:Enablement status;Feature 2:Enablement status;.... Do not add a semicolon (;) at the end.

Valid values for features:

• ReadWriteSpliting: Read/write splitting.

• ConnectionPersist: Connection pool.

• TransactionReadSqlRouteOptimizeStatus: Transaction splitting.

• AZProximityAccess: Nearest access.

• CausalConsistRead: Read consistency.

• HtapFilter: HTAP automatic request distribution among row store and column store nodes.

Valid values for enablement status:

• 1: Enabled.

• 0: Disabled.

The region ID. You can call the DescribeRegions operation to query the region ID.

The maximum latency threshold for read-only instances in read/write splitting. If the latency of a read-only instance exceeds this value, read requests are not routed to the instance. Unit: seconds. If you do not specify this parameter, the original value is retained. Valid values: 0 to 3600.

The timeout period for read consistency. Unit: milliseconds. Default value: 10. Valid values: 0 to 60000.

The read weight allocation pattern. Valid values:

• Standard: The default value. Used to automatically allocate weights based on instance specifications.

• Custom: Used to allocate custom weights.

The custom read weight distribution. You can specify the read request weights for the primary instance and read-only instances. The weight must be a multiple of 100, and the maximum value is 10000. Format:

• Standard instance: {"Primary instance ID":"Weight","Read-only instance ID":"Weight"...}

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

• ApsaraDB RDS for MySQL Cluster Edition instance: {"Read-only instance ID":"Weight","DBClusterNode":{"Primary node ID":"Weight","Secondary node ID":"Weight","Secondary node ID":"Weight"...}}

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

  Note

  DBClusterNode is a request parameter specific to Cluster Edition instances. It contains the NodeID and Weight of the primary and secondary nodes.

The operation type. Valid values:

• Modify: Modifies the proxy terminal. This is the default value.

• Create: Creates a proxy terminal.

• Delete: Deletes a proxy terminal.

The description of the proxy terminal.

The type of the proxy terminal. This parameter is reserved and does not need to be specified.

The read/write mode. Valid values:

• ReadWrite: Connects to the primary instance and can accept write requests.

• ReadOnly: Does not connect to the primary instance and cannot accept write requests. This is the default value.

[Deprecated] This parameter is deprecated and does not need to be configured.

The ID of the vSwitch in the zone to which the proxy endpoint belongs. Default value: the ID of the vSwitch to which the default terminal of the proxy instance belongs. You can call the DescribeVSwitches operation to query the created vSwitches.

The effective time. Valid values:

• Immediate: Takes effect immediately.

• MaintainTime: Takes effect within the maintenance window. For more information, see ModifyDBInstanceMaintainTime.

• SpecificTime: Takes effect at a specified time.

Default value: MaintainTime.

The specific time when the modification takes effect. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

The minimum number of reserved instances.

The execution cost threshold for SQL statements in HTAP automatic request distribution among row store and column store nodes.

The ID of the VPC in the zone to which the proxy endpoint belongs. Default value: the ID of the VPC to which the default terminal of the proxy instance belongs. You can call the DescribeDBInstanceAttribute operation to query the default VPC of the instance.