更新时间:2018-07-11 15:36
支持新增、更新、删除 等操作,以及对应批量操作
/v3/openapi/apps/$app_name/$table_name/actions/bulk
JSON
POST
推送涉及的签名及设置请求 Header 操作,请参考 V3版API 签名机制 文档中的描述。
标准版应用不支持 timestamp 参数。如果指定 timestamp 选项,推送会报4007
错误码。
以高级版数据格式为例:
[
{
"cmd": "add",
"timestamp": 1401342874777,
"fields": {
"id": "1",
"title": "This is the title",
"body": "This is the body"
}
},
{
"cmd": "update",
"timestamp": 1401342874778,
"fields": {
"id": "2",
"title": "This is the new title"
}
},
{
"cmd": "delete",
"fields": {
"id": "3"
}
}
]
timestamp : 可选字段。用来记录文档实际发生时间,单位为毫秒。系统会用该时间戳来作为同一主键文档更新顺序的判断标准,该选项仅支持高级版,标准版应用,没有该timestamp选项,若指定该选项,推送会报4007错误码。在没有该timestamp项时,默认以文档发送到OpenSearch的时间作为文档更新时间进行操作。
cmd : 必选字段。定义该文档的操作行为,可以为“add”、“update”、“delete”,标准版不支持“update”。建议一个请求中进行批量更新操作,提高网络交互及处理效率。“add”表示新增文档,如果该主键对应文档已经存在,则执行先“delete”再“add”的操作;“update”表示更新文档,对该主键对应文档进行部分字段更新;“delete”表示删除文档,如果该主键对应文档已经不存在,则认为删除成功。
fields : 必选字段。要操作的文档内容,主键字段必选,系统所有操作都是通过主键来进行的。对于“delete”只需要提供文档主键即可。
对于Array类型,需要使用JsonArray来处理,如[{“fields”: { “id”: “0”,”int_array”: [14,85],”string_array”: [“abc”,”xyz”]},”cmd”: “ADD”}];
参数 | 类型 | 描述 |
---|---|---|
errors | string | 推送报错内容,message代表错误信息。params代表错误参数,code代表错误码 |
request_id | string | 该条查询的记录id,主要用于排查问题使用 |
status | string | 执行结果,OK为成功,FAIL为失败,请根据返回错误码进行排查 |
result | string | 执行成功返回该参数,值为true,报错不返回该参数 |
请求:(此处省略了请求Header参数及编码等因素)
http://host/v3/openapi/apps/app_schema_demo/tab/actions/bulk
//下面的待上传数据,需要放到body体中
[{"cmd":"ADD","fields":{"id":1,"name":"Test Data Push"}}]
{
"errors": [],
"request_id": "150116724719940316170289",
"status": "OK",
"result": true
}
{
"errors": [
{
"code": 2001,
"message": "待查应用不存在.待查应用不存在。",
"params": {
"friendly_message": "待查应用不存在。"
}
}
],
"request_id": "150116732819940316116461",
"status": "FAIL"
}
在文档使用中是否遇到以下问题
更多建议
匿名提交