All Products
Search
Document Center

Tair:LockDBInstanceWrite

Last Updated:Feb 20, 2024

Places a write lock on an instance. After the instance is locked, it supports only read operations.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The instance ID.

r-bp1zxszhcgatnx****
LockReasonstringYes

The reason why write operations on the instance are locked.

lock reason

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

2BE6E619-A657-42E3-AD2D-18F8428A****
DBInstanceNamestring

The instance ID.

r-2ev03avw0r0552***
TaskIdlong

The task ID.

21986****
LockReasonstring

The reason why write operations on the instance are locked.

lock reason

Examples

Sample success responses

JSONformat

{
  "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.