Updated on 2024-11-19 GMT+08:00

Unlocking a DB Instance from the Read-Only State

Function

This API is used to remove the read-only status of a DB instance.

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

Constraints

This API is available to RDS for PostgreSQL only.

URI

  • URI format

    PUT /v3/{project_id}/instances/{instance_id}/unlock-node-readonly-status

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    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

    Instance ID.

Request

Table 2 Parameters

Parameter

Mandatory

Type

Description

status_preservation_time

Yes

Integer

Duration (in minutes) during which the HA component no longer sets the instance to read-only.

Minimum value: 0

Maximum value: 1440

Example Request

Unlock a DB instance from the read-only state.

PUT https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/42d4b4fc17d144bbb3ba64a306e68c72in03/unlock-node-readonly-status 

{ 
   "status_preservation_time" : 5 
 }

Response

  • Normal response
    Table 3 Parameters

    Parameter

    Type

    Description

    resp

    String

    If the operation is successful, SUCCESS is returned. Otherwise, an error code is returned.

  • Example normal response
    {
       "resp" : "SUCCESS"
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.