close

 

接口简介

任务是平台对平台上的设备的操作进程，该API包含创建任务、查询任务状态，删除任务等操作，任务对象在下文中用$TaskInfo结构来表示。

内容简述
任务信息数据结构定义(JSON) 任务信息数据的JSON格式范例
任务信息数据结构定义(表格) 任务信息数据的表格格式的字段说明
获取任务信息列表(GET) GET请求方式获取任务信息列表，包含两个接口：获取单个对象的历史任务列表，获取多个对象的最近任务列表。
获取任务信息列表(POST) POST请求方式获取任务信息列表，包含两个接口：获取单个对象的历史任务列表，获取多个对象的最近任务列表。
创建任务 创建任务对象的API
获取任务信息 获取指定的任务信息
更新任务信息 更新指定任务的信息
暂停/恢复任务 暂停、恢复执行指定任务
取消任务 取消指定任务
取消对象的所有任务 取消指定对象的所有任务
获取下一个任务 获取下一个等待执行的任务

 

现场信息数据结构定义

$TaskInfo的JSON示例

  1. {
  2. "_id":"1",
  3. "oid":"435345",
  4. "uid":"325345",
  5. "objectId":"32",
  6. "objectName":"Device2",
  7. "username":"LiSi",
  8. "userType":1,
  9. "name":"Task2",
  10. "type":4,
  11. "priority":2,
  12. "cycle":300000,
  13. "state":2,
  14. "progress":0.3,
  15. "siteId":"43254",
  16. "siteName":"Site2",
  17. "create":1324385534,
  18. "startTime":1324385535,
  19. "updateTime":1324385537,
  20. "desc":"This a test task",
  21. "error":"device log out",
  22. "data":{"desc":"ConfigV1.1","type":1,"content":"32f23324…"}
  23. }

字段说明

字段字段类型详细级别字段说明
_id string 1 API标识。注：创建/更新时忽略请求中的该项参数。
oid string 1 机构标识，仅在系统用户调用时指定。
uid string 1 用户标识，如果任务发起者为系统，则此参数表示系统用户或机构的标识。创建时不需指定，从access_token校验获得。
objectId string 1 对象标识，如设备标识。
objectName string 1 对象名称，如设备名称。
username string 1 用户姓名。创建/更新时忽略请求中的该项参数。
userType int 1 任务发起者类型。0：系统，1：用户，2：其他。
name string 2 任务名称。
type int 2 任务类型：（括号中为对应的OVDP协议TLV中的data type）1：运行配置下发（0x00010000）；2：交互命令（0x00000002）；3：OVDP配置（0x00030000）；4：运行配置获取；6：升级文件（0x00060000）；8：要求获取格式化的参数，用于立即获取地震系统要求巡检的数据和Modbus命令（0x00080000）；9：要求设备立即做功能测试，用于地震设备生成测试文件（0x00090000）；10：地震设备做功能测试时得到的EVT文件（0x000A0000）；11：InRouter证书配置文件（0x000B0000）；12：VPN 临时通道配置（0x000C0000）；13：VPN连接指令（0x000D0000）；14：zip压缩格式的配置文件(EntityConfig)?（0x000E0000）；15：定期清理access_token；16：费用定期统计；17：访问定期统计；18：流量定期统计；19：通道状态定期更新；20：闲置任务定期通知；其他：待定义。
priority int 3 任务优先等级，10：定时任务，20：低级，30：普通，40：高级
cycle int array 3 任务执行周期。[$Month, $Day, $Hour, $Min, $Sec, $Interval]。$Month：-1表示每月；其他值表示每年的该月执行任务。$Day：-1表示每天；其他值表示每月的该日执行任务。$Hour：-1表示每小时；其他值表示每天的该时执行任务。$Min：-1表示每分钟；其他值表示每小时的该分执行任务。$Sec：-1表示每秒；其他值表示没分钟的该秒执行任务。$Interval：任务执行周期，0：不采用此周期，而采用上述五个参数定义周期；非零表示采用此周期。
state int 4 任务状态，-1：失败，0：空闲或等待执行，4：暂停，1：正在执行，2：已取消，3：完成；5：等待发布。创建/更新时忽略请求中的该项参数。
progress float 4 任务进度，百分比。创建/更新时忽略请求中的该项参数。
siteId string 5 现场标识。
siteName string 5 现场名称。
create int 10 任务创建时间。创建/更新时忽略请求中的该项参数。
startTime int 10 任务启动时间。创建/更新时忽略请求中的该项参数。
updateTime int 10 任务更新时间。
desc string 20 任务描述信息。
error string 20 任务执行异常信息。创建/更新时忽略请求中的该项参数。
data object 50 任务执行过程中需要的数据信息对象，不同任务对应不同的数据信息。请参考各调用任务管理API的API中的定义。

获取任务信息列表（GET）

URL

  1. http://$AUTHSERVER/api2/tasks

支持格式

JSON

HTTP请求方式

GET

是否需要登录

是

访问授权限制

  • 访问级别: [高级接口]
  • 频次限制: [是]
  • 访问权限: [readTask]

请求参数

请求参数必选类型及范围说明
access_token true string OAuth授权后获得。注：通过HTTP认证头携带时省略。
oid false string 机构标识。仅系统用户在调用时可以指定，默认为与access_token关联的用户所属机构相同。
cursor false int 游标。表示从结果的第几条开始，如果省略默认为1，即从第一条开始。
limit false int 每次请求返回的条目数量。
states false int array 任务状态数组。
user_types false int array 任务发起者类型数组。
types false int array 任务类型数组。
verbose false int 详细级别。
object_id false string 对象标识，获取单个对象的所有任务列表。与object_id_list参数二选一。
object_id_list false string array 对象标识列表，获取多个对象的最新任务列表。若此参数与object_id都未指定，则表示获取机构任务列表。

注意事项

无

返回结果

正常结果：

  1. {
  2. "total":10,
  3. "cursor":3,
  4. "limit":2,
  5. "result":[$TaskInfo,...]
  6. }

异常结果：

  1. {
  2. "request":"API名",
  3. "error":"错误类型",
  4. "error_code":"错误编码",
  5. }

根据异常结果中的error_code（错误代码），参照错误代码表进行修改。

返回值字段说明

返回值字段字段类型字段说明
total int 结果总数。
cursor int 游标。表示从结果的第几条开始。
limit int 返回的结果数目。
result object array 返回的任务信息对象
$TaskInfo object 任务信息

其他

无

获取任务信息列表（POST）

URL

  1. http://$AUTHSERVER/api2/tasks/list

支持格式

JSON

HTTP请求方式

POST

是否需要登录

是

访问授权限制

  • 访问级别: [高级接口]
  • 频次限制: [是]
  • 访问权限: [readTaskreadTask]

请求参数

请求参数必选类型及范围说明
access_token true string OAuth授权后获得。注：通过HTTP认证头携带时省略。
oid false string 机构标识，仅系统用户调用时指定。
cursor false int 游标。表示从结果的第几条开始，如果省略默认为1，即从第一条开始。
limit false int 每次请求返回的条目数量。
states false int array
user_types false int array 任务发起者类型数组。
types false int array 任务类型数组。
verbose false int 详细级别。
object_id false string 对象标识，获取单个对象的所有任务列表。与object_id_list参数二选一。
object_id_list false string array 对象标识列表，获取多个对象的最新任务列表。若此参数与object_id都未指定，则表示获取机构任务列表。

请求消息内容

  1. JSON示例
  2. {
  3. "resourceIds":["02385038503","82375932459"]
  4. }

请求消息字段说明

返回值字段字段类型字段说明
resourceIds string array 用户允许访问的任务的标识数组。

注意事项

无

返回结果

正常结果：

  1. {
  2. "total":10,
  3. "cursor":3,
  4. "limit":2,
  5. "result":[$TaskInfo,...]
  6. }

异常结果：

  1. {
  2. "request":"API名",
  3. "error":"错误类型",
  4. "error_code":"错误编码",
  5. }

根据异常结果中的error_code（错误代码），参照错误代码表进行修改。

返回值字段说明

返回值字段字段类型字段说明
total Int 结果总数。
cursor Int 游标。表示从结果的第几条开始。
limit Int 返回的结果数目。
result object array 返回的任务信息对象
$TaskInfo object 任务信息

其他

无

创建任务

URL

  1. http://$APISERVER/api2/tasks

支持格式

JSON

HTTP请求方式

POST

是否需要登录

是

访问授权限制

  • 访问级别: [高级接口]
  • 频次限制: [是]
  • 访问权限: [writeTask]

请求参数

请求参数必选类型及范围说明
access_token true string OAuth授权后获得。注：通过HTTP认证头携带时省略。
oid false string 机构标识，仅系统用户调用时指定。
verbose false int 详细级别。

请求消息内容

$TaskInfo

请求信息字段说明

请求信息字段必选字段类型字段说明
$TaskInfo true object 任务信息，userType, name, type, priority字段必填。

注意事项

无

返回结果

正常结果：

  1. {
  2. "result": $TaskInfo
  3. }

异常结果：

  1. {
  2. "request":"API名",
  3. "error":"错误类型",
  4. "error_code":"错误编码",
  5. }

根据异常结果中的error_code（错误代码），参照错误代码表进行修改。

返回值字段说明

返回值字段字段类型字段说明
Result object 返回的结果对象
$TaskInfo object 任务信息

其他

无

获取任务信息

URL

  1. http://$APISERVER/api2/tasks/$id

支持格式

JSON

HTTP请求方式

GET

是否需要登录

是

访问授权限制

  • 访问级别: [高级接口]
  • 频次限制: [是]
  • 访问权限: [readTask]

请求参数

请求参数必选类型及范围说明
access_token true string OAuth授权后获得。注：通过HTTP认证头携带时省略。  
$id true string 任务标识。
oid false string 机构标识，仅系统用户调用时指定。
verbose false int 详细级别。

注意事项

无

返回结果

正常结果：

  1. {
  2. "result": $TaskInfo
  3. }

异常结果：

  1. {
  2. "request":"API名",
  3. "error":"错误类型",
  4. "error_code":"错误编码",
  5. }

根据异常结果中的error_code（错误代码），参照错误代码表进行修改。

返回值字段说明

返回值字段字段类型字段说明
result object 返回的结果对象
$TaskInfo object 任务信息对象。

其他

无

更新任务信息

URL

  1. http://$APISERVER/api2/tasks/$id

支持格式

JSON

HTTP请求方式

PUT

是否需要登录

是

访问授权限制

  • 访问级别: [高级接口]
  • 频次限制: [是]
  • 访问权限: [writeTask]

请求参数

请求参数必选类型及范围说明
access_token True string OAuth授权后获得。注：通过HTTP认证头携带时省略。
$id True string 任务标识。
oid false string 机构标识，仅系统用户调用时指定。
verbose false int 详细级别。

请求消息内容

$TaskInfo

请求信息字段说明

请求信息字段必选字段类型字段说明
$TaskInfo True object 任务信息，可填字段：name,state,priority,desc。

注意事项

无

返回结果

正常结果：

  1. {
  2. "result": $TaskInfo
  3. }

异常结果：

  1. {
  2. "request":"API名",
  3. "error":"错误类型",
  4. "error_code":"错误编码",
  5. }

根据异常结果中的error_code（错误代码），参照错误代码表进行修改。

返回值字段说明

返回值字段字段类型字段说明
Result object 返回的结果对象
$TaskInfo object 任务信息

其他

无

暂停/恢复任务

URL

  1. http://$APISERVER/api2/tasks/$id/status

支持格式

JSON

HTTP请求方式

PUT

是否需要登录

是

访问授权限制

  • 访问级别: [高级接口]
  • 频次限制: [是]
  • 访问权限: [writeTask]

请求参数

请求参数必选类型及范围说明
access_token True string OAuth授权后获得。注：通过HTTP认证头携带时省略。
$id True string 任务标识。
oid false string 机构标识，仅系统用户调用时指定。
verbose false int 详细级别。
status true int 任务状态。取值范围：4，5，0。

注意事项

无

返回结果

正常结果：

  1. {
  2. "result": $TaskInfo
  3. }

异常结果：

  1. {
  2. "request":"API名",
  3. "error":"错误类型",
  4. "error_code":"错误编码",
  5. }

根据异常结果中的error_code（错误代码），参照错误代码表进行修改。

返回值字段说明

返回值字段字段类型字段说明
Result object 返回的结果对象
$TaskInfo object 任务信息

其他

无

取消任务

URL

  1. http://$APISERVER/api2/tasks/$ID

支持格式

JSON

HTTP请求方式

DELETE

是否需要登录

是

访问授权限制

  • 访问级别: [普通接口]
  • 频次限制: [是]
  • 访问权限: [writeTask]

请求参数

请求参数必选类型及范围说明
access_token true string OAuth授权后获得。注：通过HTTP认证头携带时省略。
$ID true int 任务标识。
oid false string 机构标识，仅系统用户调用时指定。
verbose false int 详细级别。

注意事项

无

返回结果

正常结果：

{ "result": $TaskInfo }

异常结果：

  1. {
  2. "request":"API名",
  3. "error":"错误类型",
  4. "error_code":"错误编码",
  5. }

根据异常结果中的error_code（错误代码），参照错误代码表进行修改。

返回值字段说明

返回值字段字段类型字段说明
result object 返回的结果对象
$TaskInfo object 任务详细信息。

其他

无

取消对象的所有任务

URL

  1. http://$APISERVER/api2/tasks

支持格式

JSON

HTTP请求方式

DELETE

是否需要登录

是

访问授权限制

  • 访问级别: [高级接口]
  • 频次限制: [是]
  • 访问权限: [writeTask]

请求参数

请求参数必选类型及范围说明
access_token true string OAuth授权后获得。注：通过HTTP认证头携带时省略。
Object_id true string 对象标识，如设备标识。
oid false string 机构标识，仅系统用户调用时指定。
types true int array 任务类型数组

注意事项

无

返回结果

正常结果：

  1. {
  2. "result":"ok"
  3. }

异常结果：

  1. {
  2. "request":"API名",
  3. "error":"错误类型",
  4. "error_code":"错误编码",
  5. }

根据异常结果中的error_code（错误代码），参照错误代码表进行修改。

返回值字段说明

返回值字段字段类型字段说明
result string 返回的结果"ok"。

其他

无

获取下一个任务

URL

  1. http://$APISERVER/papi/tasks/next

支持格式

JSON

HTTP请求方式

GET

是否需要登录

是

访问授权限制

  • 访问级别: [高级接口]
  • 频次限制: [是]
  • 访问权限: [readTask]

请求参数

请求参数必选类型及范围说明
access_token true string 任务执行模块的身份标识。
object_id false string 对象标识，如设备标识，缺省为机构标识。
oid true string 机构标识。
type true int 任务类型。

注意事项

无

返回结果

正常结果：

  1. {
  2. "result": $TaskInfo
  3. }

异常结果：

  1. {
  2. "request":"API名",
  3. "error":"错误类型",
  4. "error_code":"错误编码",
  5. }

根据异常结果中的error_code（错误代码），参照错误代码表进行修改。

返回值字段说明

返回值字段字段类型字段说明
result object 返回的结果对象
$TaskInfo object 任务信息对象，包括任务信息的所有字段。

其他

无