1. 描述
创建对象。
2. 调用场景
- 用户在任何地方登录后调用本接口上传JSON对象。
- 用户在调用oss_upload接口上传文件触发函数计算,把FSON对象添加到OSS和对应的数据库。
- 蓝牙网关遇到网关扫描数据后创建到JSON对象。
[!note|label:第2和第3点并不属于本接口]
3. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | AddObj | |
Url | https://api.xdua.com/obj | |
Method | POST | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | ADD | |
XduaApiColor | * | 只有持有神对象,才可以创建对象 |
XduaApiAudience | * | 只有obj_id为ConsoleX的对象,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | * | 对象直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | u | 需要登录 |
XduaApiRoles | Zoon,None | Zoon可以创建对象 |
XduaApiResource | obj | |
XduaApiKparam | name | |
XduaApiAction | CreateObj | |
XduaApiRule | CreateObj | |
XduaApiAstates | 0 | |
XduaApiEnable | true | 接口使能 |
4. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
objc | body | String | 是 | 无 | 对象的目录ID | 对象的目录 |
okey | body | string | 是 | 小于等于128位的字符串,在一个对象下一个用户的key必须保持唯一 | ||
data | body | string | 是 | 小于等于1024字节的字符串,或者串化的JSON对象 | ||
idx1 | body | string | 否 | 空 | 小于等于16字符的字符串,在一个对象下一个用户的key必须保持唯一,可中文 | |
idx2 | body | string | 否 | 空 | 小于等于16字符的字符串,同一对象用户下可以相同 | |
idx3 | body | string | 否 | 空 | 小于等于16字符的字符串,用了辅助索引的第三索引字段,最长128个字节 |
地球号对象服务致力于完成对象的存储/删/改/查询。为了尽可能的满足可能出现的多种查询,地球号增加了三种索引字段:idx1,idx2,idx3。客户完全自定义使用他们。但是索引的顺序是严格按照idx1>idx2>idx3的优先顺序安排。
5. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 创建的对象ID |
6. 错误码
错误码来自于error字段,通用错误码参考地球号通用错误码