tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateBackUpSchedule

Last updated: 2024-08-26 18:48:07

1. API Description

Domain name for API request: cdwdoris.tencentcloudapi.com.

This API is used to create or modify backup policies.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateBackUpSchedule.
Version Yes String Common Params. The value used for this API: 2021-12-28.
Region No String Common Params. This parameter is not required for this API.
ScheduleId No Integer Required to be uploaded when editing
WeekDays No String Selected weeks, separated by commas.
Discarded: Use ScheduleInfo.
ExecuteHour No Integer Hour for executing the backup taskDiscarded: Use ScheduleInfo.
BackUpTables.N No Array of BackupTableContent Backup table list
BackupType No Integer 0: default; 1: one-time backup for the remote Doris
DorisSourceInfo No DorisSourceInfo Connection information of the remote doris cluster
BackupTimeType No Integer 0: default; 1: one-time backup; 2: remote backup
RestoreType No Integer 0: default; 1: immediate recovery after the backup is completed.
AuthType No Integer 0: default; 1: connecting to COS using a custom key.
CosSourceInfo No CosSourceInfo Cos certification information

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Example

Input Example

POST / HTTP/1.1
Host: cdwdoris.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBackUpSchedule
<Common request parameters>

{
    "ScheduleId": 0,
    "WeekDays": "1",
    "BackUpTables": [
        {
            "Table": "1",
            "TotalBytes": 0,
            "Database": "1"
        }
    ],
    "ExecuteHour": 0
}

Output Example

{
    "Response": {
        "RequestId": "1"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy