查询单个归档任务

获取单个归档任务的详细信息。

请求 URL

GET {base_url}/{api_path}/archive_task/get?access_token={access_token}

请求参数

参数 是否必填 类型 说明
id 是 Integer 归档任务的 ID。
注： 可通过 查询归档任务列表 接口获取该 ID。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
data Object<Archive_Task> 归档任务信息。
Archive_Task
参数 类型 说明
id Integer 归档任务的 ID。
auth_info_id Integer 关联归档服务器的 ID。
name String 归档任务的名称。
file_type String 归档的文件类型。
  • recording_files：录音文件
  • backup_files：备份文件
time_range String 归档文件的时间范围。
  • today：今天
  • yesterday：昨天
  • last_7days：最近 7 天
  • last_30days：最近 30 天
  • this_month：本月
  • last_month：上个月
  • custom：自定义
time_begin String 归档时间范围的开始时间。
注： 仅当 time_range 为 custom 时，此字段才有值。
time_end String 归档时间范围的结束时间。
注： 仅当 time_range 为 custom 时，此字段才有值。
freq_type String 归档任务的执行频率。
  • now：立即执行。
  • daily：每天执行。
  • weekly：每周执行。
  • monthly：每月执行。
freq_time String 归档任务的执行时间，采用 24 小时制。
注： 仅当 freq_type 不为 now 时，此字段才有值。
freq_week Integer 执行归档任务的星期。
  • 1：星期一
  • 2：星期二
  • 3：星期三
  • 4：星期四
  • 5：星期五
  • 6：星期六
  • 7：星期日
注： 仅当 freq_type 为 weekly 时，此字段才有值。
freq_day Integer 执行归档任务的日期。
注：
  • 仅当 freq_type 为 monthly 时，此字段才有值。
  • 日期范围为 1 到 31，其中 -1 表示当月最后一天。
status String 归档任务的执行状态。
  • scheduled：归档任务已排期。
  • waitingforexecuting：归档任务等待执行。
  • executing：归档任务正在执行。
  • finished：归档任务已执行完成。
storage_method String 归档文件的存储方式。
  • create_folder_once：在所选路径下创建名为“FileType-TaskName”的文件夹，并将文件存储在该文件夹内。
  • create_folder_each_time：每次任务执行时，在所选路径下创建名为“FileType-TaskName-ExecutionDate”的文件夹，并将文件存储在该文件夹内。
  • create_folder_reuse：首次执行时在所选路径下创建名为“FileType-TaskName”的文件夹，后续执行产生的文件存储在同一文件夹内。
  • direct_save：将归档文件直接保存到所选路径，不创建文件夹。
file_organization_by_date Integer 是否按日期分类存储归档文件。
  • 0：不按日期分类存储。
  • 1：按日期分类存储。
file_path String 归档服务器上的目标文件路径。
注： 仅当关联归档服务器的 server_type 为 ftp 或 sftp 时，此字段才有值。
bucket_name String 存储桶的名称。
注： 仅当关联归档服务器的 server_type 为 amazon_s3 或 google_storage 时，此字段才有值。
bucket_path String 存储桶内的目标路径前缀。
region String 云存储的区域。
site_id String SharePoint 站点的 ID。
注： 仅当关联归档服务器的 server_type 为 sharepoint 时，此字段才有值。
site_name String SharePoint 站点的名称。
注： 仅当关联归档服务器的 server_type 为 sharepoint 时，此字段才有值。
drive_id String SharePoint 文档库的 ID。
注： 仅当关联归档服务器的 server_type 为 sharepoint 时，此字段才有值。
drive_name String SharePoint 文档库的名称。
注： 仅当关联归档服务器的 server_type 为 sharepoint 时，此字段才有值。
path_id String SharePoint 文件夹的 ID。
注： 仅当关联归档服务器的 server_type 为 sharepoint 时，此字段才有值。
record_file_format String 录音文件的格式。
注： 仅当 file_type 为 recording_files 时，此字段才有值。
  • wav：WAV 格式。
  • mp3：MP3 格式。
enb_skip_achive_file Integer 是否跳过已归档的录音文件。
  • 0：再次归档已归档的录音文件。
  • 1：跳过已归档的录音文件。
enb_delete_local_file Integer 归档后是否删除本地文件。
  • 0：保留本地文件。
  • 1：删除本地文件。
enable_retention Integer 是否启用保留配置。
  • 0：禁用保留配置。
  • 1：启用保留配置。
retention_type String 保留模式。
注： 仅当 enable_retention 为 1 时，此字段才有值。
  • quantity：按数量保留。
  • days：按天数保留。
retention_unit String 保留策略。
注： 仅当 enable_retention 为 1 时，此字段才有值。
  • folder：对文件夹应用保留策略。
  • file：对文件应用保留策略。
file_rotation_num Integer 保留上限，单位由 retention_type 指定。
注： 仅当 enable_retention 为 1 时，此字段才有值。

示例

请求示例

GET /openapi/v1.0/archive_task/get?id=11&access_token=gwakjgu9ZBUfz36wql4ndsVKkryI0kdj HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
  "errcode": 0,
  "errmsg": "SUCCESS",
  "submsg": "",
  "data": {
    "id": 11,
    "auth_info_id": 8,
    "name": "January-Backup",
    "time_range": "today",
    "freq_type": "now",
    "freq_time": "",
    "freq_day": 0,
    "freq_week": 0,
    "status": "finished",
    "file_path": "",
    "time_begin": "",
    "time_end": "",
    "file_type": "backup_files",
    "bucket_name": "yeastar-demo",
    "bucket_path": "",
    "region": "ap-east-1",
    "site_id": "",
    "site_name": "",
    "drive_id": "",
    "drive_name": "",
    "path_id": "",
    "record_file_format": "",
    "enb_skip_achive_file": 0,
    "enb_delete_local_file": 0,
    "enable_retention": 0,
    "retention_type": "",
    "retention_unit": "",
    "storage_method": "direct_save",
    "file_organization_by_date": 0
  }
}