Delete the backup strategy of a tenant|V4.3.1| docs|Distributed Database

Delete the backup strategy of a tenant

Last Updated：2024-09-13 09:55:53 Updated

Description

You can call this operation to delete the backup strategy of a tenant.

Call description

Prerequisites

You have passed the authentication for the OceanBase Cloud Platform (OCP) application service.

Request path

DELETE /api/v2/ob/clusters/{id}/tenants/{tenantId}/backup/config/backupStrategy

Request parameters

Path parameters

Parameter	Type	Required	Example value	Description
id	Integer	Yes	1002	The ID of the cluster.
tenantId	Integer	Yes	108	The ID of the tenant.

Response parameters

Basic data structure

Parameter	Type	Description
data	Object	For more information, see Data structure of `BackupCommonResponse`.
successful	Boolean	Indicates whether the request was successful.
timestamp	Datetime	The timestamp when the server completed the request.
duration	Integer	The amount of time taken by the server to process the request, in milliseconds.
status	Integer	The HTTP status code.
traceId	String	The trace ID of the request. This trace ID is used for troubleshooting.
server	String	The address of the application server that responded to the request.

Data structure of BackupCommonResponse

Parameter	Type	Description
obBackupTaskType	String	The type of the backup operation, for example, "CREATE_BACKUP_STRATEGY".
backupObjectOpsResultList	Array	The operation result set of the backup object.
\|--obBackupObjectList	Array	The list of backup objects.
\|--clusterId	Long	The cluster ID.
\|--tenantId	Long	The tenant ID.
\|--backupDimension	String	The backup dimension. For example, `CLUSTER` indicates cluster backup and `TENANT` indicates tenant backup.
\|--beSuccessful	Boolean	Indicates whether the operation was successful.
\|--taskIdList	Array	The list of task IDs, which is returned only for asynchronous tasks.
\|--errorCode	Object	The error code.
\|--hint	String	The prompt information.

Examples

Sample request

DELETE /api/v2/ob/clusters/1000005/tenants/1000012/backup/config/backupStrategy

Sample response

{
    "data": {
        "backupObjectOpsResultList": [
            {
                "beSuccessful": true,
                "obBackupObjectList": [
                    {
                        "backupDimension": "TENANT",
                        "clusterId": 1000005,
                        "tenantId": 1000012
                    }
                ],
            }
            "taskIdList": []
        ],
        "obBackupTaskType": "DELETE_BACKUP_STRATEGY"
    },
    "duration": 93,
    "server": "a83ad33525",
    "status": 200,
    "successful": true,
    "timestamp": "2024-08-08T14:43:36.923+08:00",
    "traceId": "df433f7a864a49f6"
}