Help Center/ Relational Database Service/ API Reference/ Historical APIs/ API v3/ Database Proxy (PostgreSQL)/ Changing the Delay Threshold of Read/Write Splitting
Updated on 2024-04-01 GMT+08:00

Changing the Delay Threshold of Read/Write Splitting

Function

This API is used to modify the delay threshold of read/write splitting in a specified DB instance.

This API will be unavailable on April 30, 2024.

  • Before calling an API, you need to understand the API in Authentication.

Constraints

  • Only RDS for PostgreSQL 11 and 12 are supported.
  • The database proxy of DB instance has been enabled.

URI

  • URI format

    PUT /v3/{project_id}/instances/{instance_id}/proxy/delay-threshold

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

    For details about how to obtain the project ID, see Obtaining a Project ID.

    instance_id

    Yes

    Specifies the DB instance ID.

Request

Parameter description
Table 2 Parameter description

Name

Mandatory

Type

Description

delay_threshold_in_kilobytes

Yes

Integer

Specifies the delay threshold in KB. It can be a value from 0 to 10485760.

Example Request

https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/proxy/delay-threshold

{
    "delay_threshold_in_kilobytes":30
}

Response

  • Normal response
    Table 3 Parameter description

    Name

    Type

    Description

    result

    String

    Indicates the modified result of the delay threshold of read/write splitting.

  • Example normal response
    {
     "result":"success"
    }

Status Code

Error Code

For details, see Error Codes.