搜索归档日志

搜索归档日志。

请求 URL

GET {base_url}/{api_path}/archival_logs/search?access_token={access_token}

请求参数

参数 是否必填 类型 说明
page 否 Integer 定义显示第几个页面。
page_size 否 Integer 定义每页显示几项查询结果。
search_value 否 String 搜索关键字，用于匹配任务名称。
file_type 否 String 要筛选的归档文件类型。

取值范围：

  • recording_files：录音文件。
  • backup_files：备份文件。
execution_result 否 String 要筛选的归档任务执行结果。

取值范围：

  • success：归档任务执行成功。
  • failed：归档任务执行失败。
  • retrying：归档任务正在重试。
sort_by 否 String 定义排序字段。

取值范围：id
order_by 否 String 定义显示顺序。

取值范围：

  • asc：升序。
  • desc：降序。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
total_number Integer 符合搜索条件的归档日志总数。
data Array<Archival_Log> 符合搜索条件的归档日志列表。
Archival_Log
参数 类型 说明
id Integer 归档日志的 ID。
name String 生成该日志的归档任务的名称。
file_type String 归档文件的类型。
  • recording_files：录音文件
  • backup_files：备份文件
execution_time String 归档任务的执行时间。
execution_result String 归档任务的执行结果。
  • success：归档任务执行成功。
  • failed：归档任务执行失败。
  • retrying：归档任务正在重试。

示例

请求示例

GET /openapi/v1.0/archival_logs/search?page=1&page_size=2&file_type=backup_files&access_token=gwakjgu9ZBUfz36wql4ndsVKkryI0kdj HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
  "errcode": 0,
  "errmsg": "SUCCESS",
  "submsg": "",
  "total_number": 11,
  "data": [
    {
      "id": 35,
      "name": "111",
      "file_type": "backup_files",
      "execution_time": "2026/02/01 16:12:00",
      "execution_result": "success"
    },
    {
      "id": 33,
      "name": "111",
      "file_type": "backup_files",
      "execution_time": "2026/01/31 16:12:00",
      "execution_result": "success"
    }
  ]
}