Description
The interface is used to delete the specified tenant in the specified cluster.
Call note
Interface constraints
The caller needs to be authenticated through OCP application services.
Request path
DELETE /api/v2/ob/clusters/{id}/tenants/{tenantId}
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. |
Return result
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 issues. |
| server | String | The address of the application service that responds to the request. |
Examples
Request example
DELETE /api/v2/ob/clusters/1000001/tenants/1000005
Return example
{
"duration": 325,
"server": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2020-12-15T18:35:38.874+08:00",
"traceId": "9dc0c94ed1d043dc"
}