数据导入导出

数据的导入、导出任务一旦成功建立，结果将以邮件的形式发送到创建任务的用户邮箱里。

数据导出

接口

POST https://cloud.minapp.com/oserve/v1.5/table/:table_id/export/

其中 table_id 是数据表的 ID

请求参数

参数类型必填说明

file_type

String

是

导出文件的格式，支持 csv、json 格式

mode

String

是

导出任务的模式

where

Object

否

导出数据的查询条件

exclude_keys

Array

否

导出数据时排除的字段列表

include_keys

Array

否

导出数据时包含的字段列表

order_by

Array

否

导出数据时需要进行排序的字段列表

csv_customize_headers

Array

否

导出数据为 CSV 时，可指定列名

timestamp_convert_keys

Array

否

导出数据时需要进行时间类型转换的字段列表

导出任务支持两种模式：

值说明

all

导出全部数据

part

导出部分数据

order_by 排序支持指定正序或者倒序，在字段前面加 "-" 表示倒序，目前支持排序的字段类型有 5 种，分别是 {"boolean", "date", "integer", "number", "string"}

代码示例

curl -X POST \
-H "Authorization: Bearer cfb5912724dd7ff0b0c17683cc3074bb548bc7f4" \
-H "Content-Type: application/json" \
-d '{
    "file_type": "csv",
    "mode": "all"
  }' \
https://cloud.minapp.com/oserve/v1.5/table/:table_id/export/
var request = require('request')

var opt = {
  uri: 'https://cloud.minapp.com/oserve/v1.5/table/:table_id/export/',
  method: 'POST',
  headers: {
    Authorization: `Bearer ${token}`
  },
  json: {   // 指定 data 以 "Content-Type": 'application/json' 传送
    file_type: 'csv',
    mode: 'all'
  }
}

request(opt, function (err, res, body) {
  console.log(res.statusCode)
})
<?php
$table_id = 1; // 数据表的 ID
$url = "https://cloud.minapp.com/oserve/v1.5/table/{$table_id}/export/";
$param = array(
  'file_type' => 'csv',
  "mode" => "all"
);

$ch = curl_init();
$header = array(
  "Authorization: Bearer {$token}",
  'Content-Type: application/json; charset=utf-8'
);

curl_setopt($ch, CURLOPT_HTTPHEADER,$header);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_URL,$url);
curl_setopt($ch, CURLOPT_POST,true);
curl_setopt($ch, CURLOPT_POSTFIELDS,json_encode($param));
curl_setopt($ch, CURLOPT_RETURNTRANSFER,true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER,true);

$res['response'] = curl_exec($ch); // 反馈结果
$res['status_code'] = curl_getinfo($ch, CURLINFO_HTTP_CODE); // 请求状态码
curl_close($ch);

返回示例

{
  "status": "ok",
  "job_id": "xxxxxxxxxxxxxxxxxxxx"
}

状态码说明

201: 导出任务创建成功

400: 1min 内多次创建任务；数据量超过 100W；数据格式错误

获取单个导出任务信息

接口

GET https://cloud.minapp.com/oserve/v1.5/table/:table_id/export/:job_id/

其中 :table_id 需替换为数据表 ID，:job_id 需替换为建立导出任务时返回的 job_id。

返回参数说明

字段名称类型说明

job_id

String

导出任务 ID

status

String

任务状态，等待处理：pending、正在处理：ready、已完成：finish

operation

String

操作类型，固定为：export

file_name

String

文件名

file_type

String

文件类型

download_url

String

下载链接

created_at

Integer

任务创建时间戳

updated_at

Integer

最近一次任务更新时间戳

代码示例

curl -X GET \
-H "Authorization: Bearer cfb5912724dd7ff0b0c17683cc3074bb548bc7f4" \
-H "Content-Type: application/json" \
https://cloud.minapp.com/oserve/v1.5/table/1/export/RcnyXjPH8zLSsUYrIlPsG5qnBERYFrGF/
var request = require('request')

var opt = {
  uri: 'https://cloud.minapp.com/oserve/v1.5/table/1/export/RcnyXjPH8zLSsUYrIlPsG5qnBERYFrGF/',
  method: 'GET',
  headers: {
    Authorization: `Bearer ${token}`
  }
}

request(opt, function (err, res, body) {
  console.log(body)
})
<?php
$table_id = 1; // 数据表的 ID
$job_id = 'RcnyXjPH8zLSsUYrIlPsG5qnBERYFrGF'; // 导出任务 ID
$url = "https://cloud.minapp.com/oserve/v1.5/table/{$table_id}/export/{$job_id}/";

$ch = curl_init();
$header = array(
  "Authorization: Bearer {$token}",
  'Content-Type: application/json; charset=utf-8'
);

curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);

$res['response'] = curl_exec($ch); // 反馈结果
$res['status_code'] = curl_getinfo($ch, CURLINFO_HTTP_CODE); // 请求状态码
curl_close($ch);

返回示例

{
  "created_at": 1574405175,
  "download_url": null,
  "file_name": null,
  "file_type": "json",
  "job_id": "RcnyXjPH8zLSsUYrIlPsG5qnBERYFrGF",
  "operation": "export",
  "status": "pending",
  "updated_at": 1574405175
}

状态码说明

200: 成功

404: 找不到 job_id 对应的任务

批量获取导出任务信息

接口

GET https://cloud.minapp.com/oserve/v1.5/table/:table_id/export/

其中 :table_id 需替换为你的数据表 ID。

代码示例

curl -X GET \
-H "Authorization: Bearer cfb5912724dd7ff0b0c17683cc3074bb548bc7f4" \
-H "Content-Type: application/json" \
https://cloud.minapp.com/oserve/v1.5/table/1/export/
var request = require('request')

var opt = {
  uri: 'https://cloud.minapp.com/oserve/v1.5/table/1/export/',
  method: 'GET',
  headers: {
    Authorization: `Bearer ${token}`
  }
}

request(opt, function (err, res, body) {
  console.log(body)
})
<?php
$table_id = 1; // 数据表的 ID
$url = "https://cloud.minapp.com/oserve/v1.5/table/{$table_id}/export/";

$ch = curl_init();
$header = array(
  "Authorization: Bearer {$token}",
  'Content-Type: application/json; charset=utf-8'
);

curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);

$res['response'] = curl_exec($ch); // 反馈结果
$res['status_code'] = curl_getinfo($ch, CURLINFO_HTTP_CODE); // 请求状态码
curl_close($ch);

返回示例

{
  "meta": {
    "limit": 20,
    "next": null,
    "offset": 0,
    "previous": null,
    "total_count": 1
  },
  "objects": [
    {
      "created_at": 1574405175,
      "download_url": null,
      "file_name": null,
      "file_type": "json",
      "job_id": "RcnyXjPH8zLSsUYrIlPsG5qnBERYFrGF",
      "operation": "export",
      "status": "pending",
      "updated_at": 1574405175
    }
  ]
}

状态码说明

200: 成功

数据导入

接口

POST https://cloud.minapp.com/oserve/v1/table/:table_id/import/

提交参数

Content-Type: multipart/form-data

参数类型必填说明

file

String

Y

上传的文件流

info 支持 csv、json 文件导入，格式请于帮助中心查看

代码示例

curl -X POST \
-H "Authorization: Bearer cfb5912724dd7ff0b0c17683cc3074bb548bc7f4" \
-H "Content-Type: multipart/form-data" \
-F file=@"filename" \
https://cloud.minapp.com/oserve/v1/table/:table_id/import/
var request = require('request');
var fs = require('fs');

var opt = {
  uri: 'https://cloud.minapp.com/oserve/v1/table/:table_id/import/',  
  method: 'POST',
  headers: {
    Authorization: `Bearer ${token}`
  },
  formData: {   // 指定 data 以 "Content-Type": "multipart/form-data" 传送
    file: fs.createReadStream(__dirname + '/test.csv')   // 参数需为文件流
  }
}

request(opt, function(err, res, body) {
  console.log(res.statusCode, body)
})
<?php
$table_id = 1; // 数据表的 ID
$url = "https://cloud.minapp.com/oserve/v1/table/{$table_id}/import/";

if (class_exists('CURLFile')) {
  $param = array(
    'file' => new \CURLFile(realpath( __DIR__.'/demo.csv'), 'csv', 'demo.csv')
  );
} else {
  $param = array(
    'file'=>'@'.realpath( __DIR__.'/demo.csv')
  );
}

$ch = curl_init();
$header = array(
  "Authorization: Bearer {$token}",
  'Content-Type: multipart/form-data; charset=utf-8'
);

curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $param);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);

$res['response'] = curl_exec($ch); // 反馈结果
$res['status_code'] = curl_getinfo($ch, CURLINFO_HTTP_CODE); // 请求状态码
curl_close($ch);

返回示例

{
  "status": "ok"
}

状态码说明

201: 导入任务创建成功

400: 无效的文件

Previous数据操作Next内容模块

Last updated