数据处理

更新时间: 2024-01-08 10:47:00

上传文档

支持新增、更新、删除 等操作,以及对应批量操作

URL

/v3/openapi/apps/$app_name/$table_name/actions/bulk
  • $app_name 为您要操作的应用名

  • $table_name 为您要将数据推送到应用中的表名

  • 以上 URL 省略了请求Header参数及编码等因素

  • 以上 URL 中省略了访问应用的 host 地址

支持格式

JSON

HTTP请求方式

POST

请求参数

推送涉及的签名及设置请求 Header 操作,请参考 v3 API 签名机制文档中的描述。

文档数据格式

以数据格式为例:

[
    {
        "cmd": "add",
        "timestamp": 1401342874777,
        "fields": {
            "id": "1",
            "title": "This is the title",
            "body": "This is the body"
        }
    },
    {
        "cmd": "delete",
        "fields": {
            "id": "2"
        }
    }
]
  • cmd : 必选字段。定义该文档的操作行为,可以为“add”、“delete”。建议一个请求中进行批量更新操作,提高网络交互及处理效率。“add”表示新增文档,如果该主键对应文档已经存在,则执行先“delete”再“add”的操作;“delete”表示删除文档,如果该主键对应文档已经不存在,则认为删除成功。

  • fields : 必选字段。要操作的文档内容,主键字段必选,系统所有操作都是通过主键来进行的。对于“delete”只需要提供文档主键即可。

  • 对于Array类型,需要使用JsonArray来处理,如[{“fields”: { “id”: “0”,”int_array”: [14,85],”string_array”: [“abc”,”xyz”]},”cmd”: “ADD”}]

  • 注意:最外层是JsonArray类型,支持多个文档批量操作。

返回结果

参数

类型

描述

errors

array

推送报错内容,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"
}

注意事项

  • 使用API/SDK推送数据时,应用的字段名称大小写不敏感。

  • 使用API/SDK推送数据有次数及大小限制,不同应用限制不同,具体请参考使用限制描述。

  • 数据上传后请务必检查返回值,并对相关错误码进行重试(尤其是3007错误),否则会出现数据丢失情况。同时,数据处理是异步的,系统返回“OK”后只表示系统接收数据成功,数据处理过程的错误会在控制台错误信息中展示,请注意及时检查。

  • POST的数据大小有限制,如果您上传的文档总量过大(编码前2M),服务器将拒绝接收任何参数,同时返回异常。

  • POST推送操作 body 部分的数据若包含中文必须要做 utf-8 编码,Header中的Content-MD5 参数也一样,在计算数据 MD5 值前,必须要先进行 utf-8 编码,否则会出现推送报错问题。

阿里云首页 智能开放搜索 OpenSearch 相关技术圈