Unlocking a DB Instance from the Read-Only State (RDS for PostgreSQL)
Function
This API is used to remove the read-only status of a DB instance.
- Before calling this API, learn how to authenticate it.
- Before calling this API, learn about the request header parameters.
Authorization Information
- If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
|
Action |
Access Level |
Resource Type (*: required) |
Condition Key |
Alias |
Dependencies |
|---|---|---|---|---|---|
|
rds:instance:update |
write |
- |
- |
rds:instance:modify |
- |
Constraints
This API is available to RDS for PostgreSQL only.
URI
- Parameter description
Table 1 Parameters Parameter
Mandatory
Description
project_id
Yes
Definition
Project ID of a tenant in a region.
Constraints
The value cannot be empty.
Range
To obtain the value, see Obtaining a Project ID.
Default Value
N/A
instance_id
Yes
Definition
Instance ID.
Constraints
The value cannot be empty.
Range
You can obtain the value of this parameter from id in Table 4 by calling the API for querying DB instances.
Default Value
N/A
Request
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
status_preservation_time |
Yes |
Integer |
Definition Duration (in minutes) during which the HA component no longer sets the instance to read-only. Constraints N/A Range
Default Value N/A |
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
Definition
Calling result.
Range
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
- Normal
- Abnormal
For details, see Status Codes.
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot