Description
This topic describes the API for locking a tenant in a specified cluster.
Syntax
API constraints
You must authenticate by using the OCP application service.
Request path
POST /api/v2/ob/clusters/{id}/tenants/{tenantId}/lock
Request parameters
path:
Parameter |
Type |
Required |
Example value |
Description |
|---|---|---|---|---|
| id | Long | Yes | 1000001 | The cluster ID of the target tenant in OCP. |
| tenantId | Long | Yes | 1000005 | The tenant ID of the target tenant in OCP. |
Response
Basic data structure
Parameter |
Type |
Description |
|---|---|---|
| successful | Boolean | Indicates whether the request is successful. |
| timestamp | Datetime | The timestamp when the server completes the request. |
| duration | Integer | The time taken by the server to process the request, in milliseconds. |
| status | Integer | The HTTP status code that conforms to the HTTP Status specification. |
| traceId | String | The Trace ID of the request, which is used to troubleshoot problems. |
| server | String | The address of the application service that responds to the request. |
Examples
Request example
POST /api/v2/ob/clusters/1000001/tenants/1000005/lock
Response example
{
"duration": 325,
"server": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2020-12-15T18:35:38.874+08:00",
"traceId": "9dc0c94ed1d043dc"
}