This topic describes how to unlock a locked tenant by using an API.
Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| name | Yes | String | The name of the tenant to be unlocked. |
Response parameters
| Parameter | Type | Description |
|---|---|---|
| successful | bool | Indicates whether the request was successful. |
| timestamp | time.Time | The timestamp when the server completed the request. |
| duration | int | The time (in milliseconds) that the server took to process the request. |
| status | int | The HTTP status code. |
| traceId | string | The Trace ID of the request. |
| error | ApiError | The error generated by the request, which contains the following information:
|
Examples
Request example
DELETE 10.10.10.1:2886/api/v1/tenant/t1/lock
Response example
{
"successful": true,
"timestamp": "2024-10-14T10:36:09.901853967+08:00",
"duration": 56,
"status": 200,
"traceId": "8c80798010e1b469"
}
References
You can also call the API by using SDK methods.
For more information about how to call the unlock tenant API by using obshell-sdk-python, see Unlock a tenant.
For more information about how to call the unlock tenant API by using obshell-sdk-go, see Unlock a tenant.