Places a write lock on an instance. After the instance is locked, it supports only read operations.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBInstanceId | string | Yes | The instance ID. | r-bp1zxszhcgatnx**** |
LockReason | string | Yes | The reason why write operations on the instance are locked. | lock reason |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "2BE6E619-A657-42E3-AD2D-18F8428A****",
"DBInstanceName": "r-2ev03avw0r0552***",
"TaskId": 0,
"LockReason": "lock reason"
}
Error codes
For a list of error codes, visit the Service error codes.