1. 描述

暂时不支持

创建日志。理论上，所有日志都是内部自动产生的。不应该有自动创建日志的接口。但未来可能有远程添加日志的需求。不管怎么样，这个接口目前不支持。

2. URL

POST:https://api.xdua.com/log

3. 请求参数

名称 位置 类型 必填 默认值 示例 说明
name body string 是 健康手环 日志的名称，必须唯一，支持汉字、英文字母、数字、英文格式的下划线，必须以英文字母或汉字开头，4~32个字符
avatar body string 否 日志图标，不超过40个字符。
brief body string 否 日志描述，不超过64个字符。

4. 返回参数

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

5. 错误码

6. 描述

删除日志。

7. URL

DELETE:https://api.xdua.com/log/[id]

8. 请求参数

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

9. 返回参数

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

10. 错误码

11. 描述

创建日志。

12. 资源名称

log

13. 请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要修改的日志ID
name body string 否 日志的名称，必须唯一，支持汉字、英文字母、数字、英文格式的下划线，必须以英文字母或汉字开头，4~32个字符
avatar body string 否 日志图标，不超过40个字符。
brief body string 否 日志描述，不超过64个字符。

|secret |path|string|生成新的secret的kid|后端会用kid连同后台生成的随机数共同生成新的secret|必须 | |ugrp |body|string|日志绑定的户群名|examp_ugrp|可选| |name |body|string|日志的名字|日志名字|可选| |brief |body|String|日志的介绍|日志简介|可选| |avatar |body|string|日志的图标url|http://开头的图片地址|可选| |enabled|body|String|使能|0:关闭 1：打开|可选|

14. 返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 修改的日志ID
updates result json dict 修改的内容

示例

result字段

{
    "id":"rYub4wrT",
    "updates":{
        "name":"新的日志名",
        "brief":"新的日志介绍",    
    }    
}

15. 错误码

16. 描述

查询日志。 接口格式参考: QRY接口统一

字段action说明

枚举值 中文 说明
qrylog 查询日志 用户查询自己名下的日志，服务器端会自动在查询条件增加一个creator_id = token拥有者
qryall 查询所有日志 完全根据查询条件执行全表查询。只有XdUaXduA.root和XdUaXduA.god两个角色才可以执行这个动作

字段filter说明

枚举值 中文 说明
qrylog 查询日志 用户查询自己名下的日志，服务器端会自动在查询条件增加一个creator_id = token拥有者
qryall 查询所有日志 完全根据查询条件执行全表查询。只有XdUaXduA.root和XdUaXduA.god两个角色才可以执行这个动作

17. 请求URL

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

18. 请求参数

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

19. 返回参数

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

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 辣椒帅 日志创建者名字
updator_id result.list[] string XiyRvUp3 日志最近一次更新者ID
updator_name result.list[] string 周海潮 日志最近一次更新者名字
cstamp result.list[] string 2020-01-20 02:19:55 日志创建时间
ustamp result.list[] string 2020-01-20 02:23:24 日志最近更新时间

20. 错误码

21. 描述

详情日志。

22. 请求URL

GET:http://api.xdua.com/log/[id]

23. 请求参数

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

24. 返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 详情的日志ID
name result.data string 日志的名称
avatar result.data string 日志图标
brief result.data string 日志的描述
state result.data int 1 日志的状态
stato result.data string "冻服更新" 日志的状态说明
expire result.data int 0 日志状态过期时间(UNIX时间戳)
creator_id result.list[] string Dmtv7TrE 日志创建者ID
creator_name result.list[] string 辣椒帅 日志创建者名字
updator_id result.list[] string XiyRvUp3 日志最近一次更新者ID
updator_name result.list[] string 周海潮 日志最近一次更新者名字
cstamp result.data string 2020-01-20 02:19:55 日志创建时间
ustamp result.data string 2020-01-20 02:23:24 日志最近更新时间
字段名 位置 字段类型 字段说
id list String 授权的id8位字符串id
enabled list String 授权使能开关 1:打开 0:关闭
expire list Int 授权过期时间,-1表示无穷大,正数表示UTC时间戳
ugrp_id list String 户群id
ugrp_code list String 户群代号
ugrp_name list String 户群名字
role_id list String 本次授权的角色id
role_code list String 本次授权的角色code
role_name list String 本次授权的角色名字
name list String 日志的名字
avatar list String 日志的头像
brief list String 日志的简介
pkg list String 日志的包名
cstamp list String 日志的创建时间
creator_id list String 日志创建者的id
creator_name list String 日志创建者的名字

返回示例

result部分

{
    "id":"rYub4wrT",
    "data": {


    },
}

25. 错误码

26. 描述

关闭日志。

27. 资源名称

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

28. 请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要开放的日志ID
state body int 是 0 日志开放时的状态。系统规定常数。取值：1
stato body string 否 日志的状态说
expire body int 否 日志状态过期时间(UNIX时间戳)

29. 返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 开放的日志ID

30. 错误码

31. 描述

开放日志。

32. 资源名称

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

33. 请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要开放的日志ID
state body int 是 0 日志开放时的状态。系统规定常数。取值：1
stato body string 否 日志的状态说
expire body int 否 日志状态过期时间(UNIX时间戳)

34. 返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 开放的日志ID

35. 错误码

results matching ""

    No results matching ""