Zoho crm Logo

安排数据备份

目的

调度数据备份 API 在 Zoho CRM 中,允许具有 Admin 权限的 Users 调度所有 CRM 数据的备份,包括附件。Users 可以选择立即启动备份或设置在指定时间进行备份。生成的备份将作为 CSV 文件并压缩成 ZIP 文件提供。

端点

  • POST /backup

请求详情

请求URL

{api-domain}/crm/bulk/{version}/backup

标题

授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.bulk.backup.ALL
(或)
ZohoCRM.bulk.backup.CREATE

可能的操作类型

全部 - 完全访问备份数据
创建 - 安排备份

示例请求

Copiedcurl "https://www.zohoapis.com/crm/bulk/v8/backup"
-X POST
-d "backup_rule.json"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

注意

如果您想立即备份CRM数据,请将输入主体留空。

输入 JSON

  • rrule字符串,如果您想在指定时间安排备份,这是必需的

    表示在特定间隔安排备份的重复规则

重复规则参数

  • FREQ string, mandatory

    定义备份的频率。 
    可能的值:
    WEEKLY - 定期每周备份CRM数据
    MONTHLY - 每月备份CRM数据

  • INTERVAL number, mandatory

    每次计划备份之间的间隔。例如,如果您为每周备份设置了一个间隔值为2,那么下一次备份将在第一次备份后的两周后进行。 
    可能的值在1到52之间。

  • BYDAY字符串,如果未指定 BYMONTHDAY 则为必填项

    指定备份发生的星期几。适用于每周、每月和每年的备份。
    可能的值:
    SU - 星期日
    MO - 星期一
    TU - 星期二
    WE - 星期三
    TH - 星期四
    FR - 星期五
    SA - 星期六

  • BYMONTHDAY数字,如果未指定 BYDAY 则为必填项

    表示每月或每年备份的具体日期。有效值范围为 1 到 31。
    可能的值在 1 到 31 之间。

支持的 RRULE 示例
以下是一些用于安排备份的有效 rrule 字符串示例:

  • rrule: "RRULE:FREQ=WEEKLY;INTERVAL=2;BYDAY=TH":每隔一周的星期四进行备份
  • rrule: "RRULE:FREQ=MONTHLY;INTERVAL=1;BYMONTHDAY=16":每月16日进行备份
  • rrule: "RRULE:FREQ=MONTHLY;INTERVAL=1;BYDAY=1TH":每月的第一个星期四进行备份
  • rrule: "RRULE:FREQ=MONTHLY;INTERVAL=1;BYDAY=4TH":每月的第四个星期四进行备份
  • rrule: "RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=FR":每周五进行备份

示例输入

Copied{
  "backup": {
    "rrule": "RRULE:FREQ=WEEKLY;INTERVAL=2;BYDAY=TU"
    }
}

可能的错误

  • INVALID_REQUEST_METHODHTTP 400

    请求方法不正确。
    解决方法:使用 HTTP POST 方法来进行此 API 调用。任何其他请求方法都会导致此错误。

  • INVALID_DATAHTTP 400

    您指定了无效的规则或规则模式。
    解决方法:请指定有效的重复规则。有关详细信息,请参阅输入 JSON部分。

  • BACKUP_ALREADY_SCHEDULEDHTTP 400

    备份已安排
    解决方案:您已经安排了一个备份。您必须等待已安排的备份完成后才能安排另一个备份。

  • LIMIT_EXCEEDEDHTTP 400

    备份限制已超出。
    解决方案:您已用尽当前 CRM 版本的最大备份数量。您可以等待到下个月,当您的数据备份限制刷新时,或者购买额外的备份。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    您用于进行此 API 调用的访问令牌不具有所需的范围。
    解决方案:生成一个具有此 API 所需范围的新访问令牌。请参阅本页开头的范围部分以获取所需范围的列表。

  • NO_PERMISSIONHTTP 403

    没有权限创建
    解决方案:用户没有备份数据的权限。请联系系统管理员。

  • INVALID_URL_PATTERNHTTP 404

    请求的URL不正确。
    解决方法:请指定一个有效的请求URL。有关详细信息,请参阅本页开头的请求URL部分。

  • INTERNAL_ERRORHTTP 500

    服务器中出现意外且未处理的异常。 
    解决方法:请联系支持团队,邮箱地址为 support@zohocrm.com。

示例响应

Copied{
    "backup": {
        "status": "success",
        "code": "SUCCESS",
        "message": "Backup scheduled successfully.",
        "details": {
            "id": "4876876000001593003"
        }
    }
}