导出元数据 - ExportMetadata
功能介绍
导出数据表的元数据,即将数据表的各个字段信息导出,但不包含具体的数据记录。导出完成后,可根据得到的定时任务ID,查看该任务的执行情况。
URI
POST 华为云Astro轻应用域名/u-route/baas/bulk/v1.0/export/schema?flag={template}
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
flag | 否 | String | 参数解释: 当前支持的“flag”为“template”,是否支持通过指定的模板导出。 约束限制: 当“flag=template”时,需通过templateName同时指定需要使用的模板名称。 取值范围: 当前支持的“flag”为“template”。 默认取值: 不涉及。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
encodeType | 是 | String | 参数解释: 元数据导出文件的编码格式。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
firstScheduleDate | 否 | String | 参数解释: 首次执行时间,格式为“yyyy-MM-dd HH:mm:ss”。 约束限制:
取值范围: 不涉及。 默认取值: 不涉及。 |
objects | 否 | Array of Strings | 参数解释: 一个字符串数组,每一项为一个希望导出元数据的对象名称。 约束限制: 不涉及。 |
scheduleMode | 是 | Number | 参数解释: 导出的模式。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
intervalUnit | 否 | String | 参数解释: 执行间隔单位。 约束限制: “scheduleMode=2”时,必选。 取值范围:
默认取值: 不涉及。 |
scheduleInterval | 否 | Number | 参数解释: 执行间隔,为某个数值。 约束限制: “scheduleMode=2”时,必选。 取值范围: 不涉及。 默认取值: 不涉及。 |
isImmediate | 否 | Boolean | 参数解释: 是否立即导出。 约束限制: “scheduleMode=1”时可选,“scheduleMode=1”时与firstScheduleDate互斥。 取值范围:
默认取值: 不涉及。 |
templateName | 否 | String | 参数解释: 需要使用的模板名称。 约束限制: 与查询参数中的flag配合使用,“flag=template”必选。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
参数 | 参数类型 | 描述 |
|---|---|---|
resCode | String | 参数解释: 返回码。 取值范围: 如果返回“0”代表请求成功,其他错误码说明请参考错误码(数据面)。 |
resMsg | String | 参数解释: 返回消息。 取值范围: 成功返回“成功”,其他情况会返回具体的错误信息。 |
result | String | 参数解释: 创建成功的记录ID,成功时返回。 取值范围: 不涉及。 |
请求示例
POST https://华为云Astro轻应用域名/u-route/baas/bulk/v1.0/export/schema
{
"scheduleMode":1,
"firstScheduleDate":"2020-06-02 00:00:00",
"encodeType":"gbk",
"objects":["Lead","PortalUser"]
} 响应示例
{
"resCode": "0",
"resMsg": "成功",
"result": "1234567890abcdefg"
} 状态码
状态码请参见状态码。
错误码
错误码请参见错误码(数据面)。

