Zoho crm Logo

获取数据备份历史

目的

获取过去一年中为您的Zoho CRM账户安排的最近数据备份信息。

端点

  • GET /backup/history

Request 详情

Request URL

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

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

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

可能的操作类型

ALL - 对备份数据的完全访问
READ - 获取有关计划备份的信息

参数

  • page整数,可选

    指定要从中检索记录的页码。默认值是1。
    可能的值:仅限正整数。

  • per_page整数,可选

    指定每页返回的记录数。默认值和可能的最大值是200。
    可能的值:仅限正整数。

注意

过去一年的备份历史记录是可用的。超过一年的备份历史记录是不可用的。

Response JSON

  • 历史JSON 数组

    一个对象数组,每个对象代表一个预定的备份。

  • id字符串

    计划备份任务的ID。

  • done_byJSON 对象

    安排备份的用户的详细信息。详细信息包括用户的姓名,记录ID和ZUID。

  • log_timeDateTime

    备份计划的日期和时间。如果在计划备份时未指定rrule,此键为空。

  • statestring

    表示计划备份的完成状态。可能的值有completed,failure和null。当备份正在进行或处于计划状态时,返回空值。

  • actionstring

    代表了计划备份所采取的行动。可能的值有计划,停止,购买和空。如果状态是完成或失败,则返回空值。

  • repeat_type字符串

    代表计划备份的重复类型。可能的值有立即,每周,每两周和每月。

  • file_namestring

    如果适用,可供下载的ZIP文件的名称。如果没有生成文件,这将为null。

  • 计数整数

    代表客户购买的额外备份数量。

注意

如果在过去的一年里没有安排备份,系统会以无内容的主体和状态码204进行响应。

可能的错误

  • NO_CONTENTHTTP 204

    无内容
    解决方案:过去一年没有安排备份。

  • INVALID_REQUEST_METHODHTTP 400

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

  • OAUTH_SCOPE_MISMATCHHTTP 401

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

  • NO_PERMISSIONHTTP 403

    拒绝访问权限
    解决方案:用户没有权限读取数据备份历史数据。请联系您的系统管理员。

  • INVALID_URL_PATTERNHTTP 404

    请求的URL不正确。
    解决方案:指定一个有效的请求URL。请参考本页开头的请求URL部分以获取更多详细信息。

  • INTERNAL_ERRORHTTP 500

    服务器中出现意外且未处理的异常。 
    解决方案:联系support@zohocrm.com的支持团队。

样本回应