ASTRO轻应用 ASTROZERO-导出数据:请求参数

时间:2024-04-25 16:08:57

请求参数

表2 请求参数

参数

是否必选

参数类型

描述

cond

cond objects

导出筛选条件,为一个结构体,包含conditions和conjunction两个字段。

encode-type

String

数据导出文件的编码格式,支持utf-8和gbk两种类型。

firstScheduleDate

String

首次导出时间,格式为“yyyy-MM-dd HH:mm:ss”

  • scheduleMode=2时,必选。
  • scheduleMode=1时,与isImmediate互斥。

objects

Array of Strings

需要导出的对象,为一字符串数组,数组中每个字符串为一个对象名,可同时导出多个对象数据,也可通过templateName参数指定模板选择导出的数据。

scheduleMode

Number

导出模式。

  • 1:仅执行一次。
  • 2:按设定的频率执行多次。

scheduleInterval

Number

“scheduleMode=2”时必选,导出任务执行间隔。

intervalUnit

Number

“scheduleMode=2”时必选,导出任务执行间隔对应的单位。

  • Hour:小时
  • Day:天
  • Month:月

isImmediate

Boolean

是否立即导出,“scheduleMode=1”时可选,“scheduleMode=1”时与firstScheduleDate互斥。

templateName

String

模板名称,数据导出使用的模板名称,也可通过objects参数直接指定希望导出的对象。

表3 cond参数说明

参数

参数类型

描述

conditions

Array of condition objects

条件数组,数组中每项作为一个条件。

conjunction

String

conditions数组中各个条件的组合方式。

  • AND:与
  • OR:或
表4 条件参数condition说明

参数

是否必选

描述

field

筛选条件字段。

  • createDate:创建时间
  • createBy:创建者id
  • lastModifiedDate:最后编辑时间
  • lastModifiedBy:最后编辑者id

operator

筛选运算操作。

  • gt:大于
  • ge:大于等于
  • eq:等于
  • ne:不等于
  • lt:小于
  • le:小于等于
  • timeFunc:时间函数

需要指出的是,只有时间类型的筛选字段支持所有操作,其他类型的字段仅支持eq/ne(等于或不等于)。

value

进行比较的具体值,当operator为timeFunc时,支持以下函数:

  • today:今天
  • yesterday:昨天
  • last week:上周
  • last month:上月
  • last year:去年
  • this week:本周
  • this month:本月
  • this year:今年

若比较的字段为时间类型,则此处使用的时间字符串应为“yyyy-MM-dd HH:mm:ss”格式。

support.huaweicloud.com/api-astrozero/astrozero_api_0075.html