This topic describes how to cancel a tenant restore through the API.
Request parameters
Request constraints
If a password is set, authentication is required. For more information, see API hybrid encryption.
Request path
DELETE /api/v1/tenant/:name/restore
Return results
| Parameter | Type | Description |
|---|---|---|
| successful | bool | Indicates whether the request is 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 during the request, which contains the following information:
|
Examples
Request example
DELETE 10.10.10.1:2886/api/v1/tenant/rt1/restore
Response example
{
"successful": true,
"timestamp": "2024-01-09T17:11:43.385889278+08:00",
"duration": 1,
"status": 200,
"traceId": "877fe32b83634153",
}
References
You can also call the API through SDK methods.
For more information about how to call the API through the obshell-sdk-python, see Cancel a tenant restore.
For more information about how to call the API through the obshell-sdk-go, see Cancel a tenant restore.