1. 对象管理

对象管理主要在超级控制台下进行。开发者进入consolex.xdua.com,点击自己的社区，进入社区(触发AddLogon操作)，创建对象。

因为验证码的创建仅仅是通过tmpl来进行的。隐藏了各种验证码是T,M,N的区别。所以验证码的创建不再分离,tobj,mobj,iobj的区别。而是直接是obj。也不再区分objx和objr，即，也不就验证码是神店铺还是红店铺进行区分。

放弃idx1,idx2,idx3三个索引的考虑：地球号对象服务致力于完成对象的存储/删/改/查询。为了尽可能的满足可能出现的多种查询,地球号增加了三种索引字段:idx1,idx2,idx3。客户完全自定义使用他们。但是索引的顺序是严格按照idx1>idx2>idx3的优先顺序安排。后来我们从数据库删掉了这三个字段，但保留用户命名okey的要求。也就是保留了okey.

接口列表

缩名 全名 方法 中文 角色 描述
ADD Create POST 创建 Zoon 创建对象
DEL Delete DELETE 删除 Zoon 删除对象
SET Update PUT 修改 Zoon 修改对象
SIT Updite PUT 修改 Zoon 私改对象
DOL Deleto PUT 软删 Zoon 软删对象
DIS Disable PUT 关闭 Zoon 关闭对象
ENB Enable PUT 打开 Zoon 打开对象
RCC Recycle PUT 回收 Zoon 回收对象
PUB Publish PUT 发布 Zoon 发布对象
OFF Offline PUT 下线 Zoon 下线对象
GET Get GET 详情 Zoon 详情对象
GIT Git GET 私详 Zoon 私详对象
QRY Query GET 查询 Zoon 查询对象
QRI Queri GET 私查 Zoon 私查对象

资源状态

错误码

2. 创建对象。

  1. 用户在任何地方登录后调用本接口上传JSON对象。
  2. 用户在调用oss_upload接口上传文件触发函数计算，把FSON对象添加到OSS和对应的数据库。
  3. 蓝牙网关遇到网关扫描数据后创建到JSON对象。这是在蓝牙网关的函数计算去触发。

请求参数

名称 位置 类型 必填 默认值 示例 说明
objc_id body String 是 无 ArtGzhMH 对象的目录ID
okey body string 否 小于等于128字符的字符串。如果用户不指明本字段，将会用对象的id,也就是8个字符的md5码代替。
jata body string 是 小于等于1024字节的字符串,或者串化的JSON对象

返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 创建的对象ID

错误码

3. 删除对象。

请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要删除的对象ID

返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 删除的对象ID

错误码

4. 关闭对象。

关闭对象。

请求方式

PUT:http://api.xdua.com/obj/[id]/state/disable

请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要删除的对象ID

返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 删除的对象ID

错误码

5. 软删对象。

开发者登录超级控制台后,可以点击自己的对象，然后删除掉。如果哪天后悔了，可以联系Zoon来恢复。

请求方式

请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要删除的对象ID

返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 删除的对象ID

错误码

6. 激活对象。

请求方式

PUT:http://api.xdua.com/obj/[id]/state/enable

请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要删除的对象ID

返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 删除的对象ID

错误码

7. 详情对象。

获取对象的详情，管理员登录超级控制台后,可以随意查询能看见的所有对象列表。点击其中一个对象（不管是不是自己的），就可以点击访问。

请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要修改的对象ID

返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 详情的对象ID
app_id result.list[] string ConsoleX 生成这个对象的应用的ID
objc_id result.list[] string ArtGzhMH 对象的频道的ID
user_id result.list[] string Dt5mvrtU 创建这个对象的用户的ID
okey result.list[] string Student20180712 对象的别名key
skma result.list[] string 对象json数据解析格式
jata result.list[] string 对象的内容
state result.list[] int 1 对象的状态
stato result.list[] string "冻服更新" 对象的状态说明
expire result.list[] int 0 对象状态过期时间(UNIX时间戳)
cstamp result.list[] string 2020-01-20 02:19:55 对象创建时间
istamp result.list[] string 2020-01-20 02:23:24 对象最近更新时间

[!note] 对象的使能状态,0:打开 1:关闭. 关闭的对象处于冻结状态,不接受编辑.

错误码

8. 私详对象。

开发者登录超级控制台后,在对象列表，选择对象，点击详情，就可以查看自己创建的对象。GIT的默认字段和GET不一样。从数据库查看的时候就是根据user_id查看。

请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要修改的对象ID

返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 详情的对象ID
app_id result.data string ConsoleX 生成这个对象的应用的ID
objc_id result.data string ArtGzhMH 对象的频道的ID
user_id result.data string Dt5mvrtU 创建这个对象的用户的ID
okey result.data string Student20180712 对象的别名key
skma result.data string 对象json数据解析格式
jata result.data string 对象的内容
state result.data int 1 对象的状态
stato result.data string "冻服更新" 对象的状态说明
expire result.data int 0 对象状态过期时间(UNIX时间戳)
cstamp result.data string 2020-01-20 02:19:55 对象创建时间
istamp result.data string 2020-01-20 02:23:24 对象最近更新时间

错误码

9. 下线对象。

调用场景

开发者登录超级控制台后,可以下线自己创建的对象。

配置参数

参数意义参考接口参数

参数名 参数值 说明
Name OffObj
URL https://api.xdua.com/obj
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod OFF
XduaApiColor X 只有持有神对象，才可以创建对象
XduaApiAudience ConsoleX 只有obj_id为ConsoleX的对象，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 对象直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 只能对象的创建者才能下线自己的对象
XduaApiRoles Zoon 只要登录就可以创建对象
XduaApiResource obj
XduaApiKparam id
XduaApiAction OfflineObj
XduaApiRule OfflineObj
XduaApiAstates 0 按序obj,zone,corp,shop,obj,obj,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要删除的对象ID

返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 删除的对象ID

错误码

描述

发布对象。

调用场景

开发者登录超级控制台后,可以下线/发布自己的对象。这个动作是管理员不能干涉的。

配置参数

参数意义参考接口参数

参数名 参数值 说明
Name PubObj
URL https://api.xdua.com/obj
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod PUB
XduaApiColor X 只有持有神对象，才可以创建对象
XduaApiAudience ConsoleX 只有obj_id为ConsoleX的对象，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 对象直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 只有对象的创建者自己才能上下线自己的对象
XduaApiRoles Zoon 只要登录就可以创建对象
XduaApiResource obj
XduaApiKparam id
XduaApiAction OnlineObj
XduaApiRule OnlineObj
XduaApiAstates 0 按序obj,zone,corp,shop,obj,obj,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要删除的对象ID

返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 删除的对象ID

错误码

描述

私查对象。

调用场景

开发者登录http://consolex.xdua.com后,可以以Zoon角色查询所有对象。

配置参数

参数意义参考接口参数

参数名 参数值 说明
Name QriObj
URL https://api.xdua.com/obj
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod QRI
XduaApiColor X 只有持有神对象，才可以创建对象
XduaApiAudience ConsoleX 只有obj_id为ConsoleX的对象，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 对象直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 所有注册对象均可以使用
XduaApiRoles Zoon 必须是Zoon才可以查询角色
XduaApiResource obj
XduaApiKparam where 常量
XduaApiAction QueriObj
XduaApiRule QueriObj
XduaApiAstates 0 按序obj,zone,corp,shop,obj,obj,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

URL

GET:https://api.xdua.com/obj

请求参数

参考标准查询接口请求参数

返回参数

参考标准查询接口返回参数

result.list部分

名称 位置 类型 示例 说明
id result string rYub4wrT 详情的对象ID
name result.list[] string 对象的名称
avatar result.list[] string 对象图标
brief result.list[] string 对象的描述
state result.list[] int 0 对象的状态
stato result.list[] string "冻服更新" 对象的状态说
expire result.list[] int 0 对象状态过期时间(UNIX时间戳)
creator_id result.list[] string Dmtv7TrE 对象创建者ID
creator_name result.list[] string 辣椒帅 对象创建者名字
ipdator_id result.list[] string XiyRvUp3 对象最近一次更新者ID
ipdator_name result.list[] string 周海潮 对象最近一次更新者名字
cstamp result.list[] string 2020-01-20 02:19:55 对象创建时间
istamp result.list[] string 2020-01-20 02:23:24 对象最近更新时间

错误码

10. 查询对象

查询对象。

调用场景

开发者登录http://consolex.xdua.com后,可以以Zoon角色查询属于自己名下的所有对象。

配置参数

URL

GET:https://api.xdua.com/obj

请求参数

参考标准查询接口请求参数

字段名 位置 类型 说明 描述 可选
objc_id query string 对象的类别ID 这是一个8个字符的字符串 可选

返回参数

参考标准查询接口返回参数

result.list部分

名称 位置 类型 示例 说明
id result string rYub4wrT 详情的对象ID
okey result.list[] string obj的的key 对象的名称
jata result.list[] string 存放obj内容的json结构体 对象图标
state result.list[] string "冻服更新" 对象的状态说
cstamp result.list[] string 2020-01-20 02:19:55 对象创建时间
ustamp result.list[] string 2020-01-20 02:23:24 对象最近更新时间

jata结构举例

慢护小程序公众号文章列表

{
    "url":"https://mp.weixin.qq.com/s/IVMdzf3T_IUignaHxdmr1w",
    "title":"降压药天天吃，但是忽略这几点等于白吃，还会引起严重的后果",
    "cover":"https://mmbiz.qpic.cn/mmbiz_jpg/GZ9ib0L9yAPWnzZYxRkiapvSqiaEV9xWG7ZBXRcvvYIoicseUeic6goffoA2dZkK7iaXosqfRLjlPDnsctDJI82HkWTw/640?wx_fmt=jpeg&tp=webp&wxfrom=5&wx_lazy=1&wx_co=1"
}

错误码

描述

回收对象。

调用场景

管理员应开发者的要求，登录超级控制台后,查询到某个开发者下面的被删除的对象。然后回收。开发者刷新就可以看到了。为此，开发者要提供自己的uid和要回收的对象的名字。

配置参数

参数意义参考接口参数

参数名 参数值 说明
Name RccObj
URL https://api.xdua.com/obj
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod RCC
XduaApiColor X 只有持有神对象，才可以创建对象
XduaApiAudience ConsoleX 只有obj_id为ConsoleX的对象，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 对象直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i u表示除了允许匿名对象之外的所有对象访问
XduaApiRoles Zoon 只要登录就可以创建对象
XduaApiResource obj
XduaApiKparam id
XduaApiAction RecycleObj
XduaApiRule RecycleObj
XduaApiAstates 0 按序obj,zone,corp,shop,obj,obj,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要删除的对象ID

返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 删除的对象ID

错误码

描述

修改对象。

调用场景

开发者登录超级控制台后,可以修改自己创建的对象。修改仅仅限于可以修改的name,brief等字段。

配置参数

参数意义参考接口参数

参数名 参数值 说明
Name SetObj
URL https://api.xdua.com/obj
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod SET
XduaApiColor X 只有持有神对象，才可以创建对象
XduaApiAudience ConsoleX 只有obj_id为ConsoleX的对象，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 对象直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i i,只有创建者自己才可以修改
XduaApiRoles Zoon 只要登录就可以创建对象
XduaApiResource obj
XduaApiKparam id
XduaApiAction UpdateObj
XduaApiRule UpdateObj
XduaApiAstates 0 按序obj,zone,corp,shop,obj,obj,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要修改的对象ID
name body string 否 对象的名称，必须唯一，支持汉字、英文字母、数字、英文格式的下划线，必须以英文字母或汉字开头，4~32个字符
avatar body string 否 对象图标，不超过40个字符。
brief body string 否 对象描述，不超过64个字符。
名称 位置 类型 必填 默认值 示例 说明
user_id path String 用户m5d,登陆时获得 可选
oldpwd body String 旧对象,32位md5码 可选
pwd body String 新对象,32位md5码 可选

返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 修改的对象ID
ipdates result json dict 修改的内容
# 示例

result字段

{
    "id":"rYub4wrT",
    "updates":{
        "name":"新的对象名",
        "brief":"新的对象介绍",    
    }    
}

错误码

描述

修改对象。

调用场景

开发者登录超级控制台后,可以修改自己创建的对象。修改仅仅限于可以修改的name,brief等字段。

配置参数

参数意义参考接口参数

参数名 参数值 说明
Name SetObj
URL https://api.xdua.com/obj
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod SET
XduaApiColor X 只有持有神对象，才可以创建对象
XduaApiAudience ConsoleX 只有obj_id为ConsoleX的对象，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 对象直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i i,只有创建者自己才可以修改
XduaApiRoles Zoon 只要登录就可以创建对象
XduaApiResource obj
XduaApiKparam id
XduaApiAction UpdateObj
XduaApiRule UpdateObj
XduaApiAstates 0 按序obj,zone,corp,shop,obj,obj,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要修改的对象ID
name body string 否 对象的名称，必须唯一，支持汉字、英文字母、数字、英文格式的下划线，必须以英文字母或汉字开头，4~32个字符
avatar body string 否 对象图标，不超过40个字符。
brief body string 否 对象描述，不超过64个字符。
名称 位置 类型 必填 默认值 示例 说明
user_id path String 用户m5d,登陆时获得 可选
oldpwd body String 旧对象,32位md5码 可选
pwd body String 新对象,32位md5码 可选

返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 修改的对象ID
ipdates result json dict 修改的内容
# 示例

result字段

{
    "id":"rYub4wrT",
    "updates":{
        "name":"新的对象名",
        "brief":"新的对象介绍",    
    }    
}

错误码

results matching ""

    No results matching ""