荔枝云-paas平台公有和私有数据迁移调用测试

1、荔枝云-PaaS公有云和私有云数据迁移调用规范(测试)江苏省广播电视总台新奥特云视科技2015 年 7 月目录第 1 章 调用说明51.1 概述51.2 请求结构说明51.2.1 请求地址51.2.2 公共参数61.2.3 地址示例61.3 返回结果6第 2 章 接口认证72.1 获取令牌72.1.1功能描述72.1.2接口地址7请求参数72.1.3返回参数72.1.4请求示例.6返回示例82.2 服务状态码列表8第 3 章 公有云和私有云数据迁移相关接口93.1 新建任务93.1.1 功能描述93.1.2 接口地址93.1.3 请求参数93.1.4 返回参数113.1.5

2、通知说明113.1.6 回调说明123.2 查询任务123.2.1 功能说明123.2.2 接口地址133.2.3 请求参数133.2.4 返回参数133.3 暂停、继续153.3.1 功能描述153.3.2 接口地址153.3.3 请求参数153.3.4 返回参数153.4 取消任务163.4.1 功能描述163.4.2 接口地址163.4.3 请求参数163.4.4 返回参数163.5 修改任务优先级173.5.1 功能描述173.5.2 接口地址173.5.3 请求参数173.5.4 返回参数17第1章 调用说明 概述欢迎使用荔枝云 6GG9云服务。用户可以使用本文档介绍的 6/ 对荔枝

3、云 6GG9云服务进行相关操作。对于接口的首先要获取令牌，每次请求都需要验证令牌信息，如果超过两个小时没有使用，令牌信息将过期，需要重新申领令牌。对荔枝云 6GG9接口调用是通过向荔枝云 6GG9的服务端地址发送 .:6: 请求，并按照接口说明在请求中加入相应请求参数；根据请求的处理情况，系统会返回处理结果。 请求结构说明 请求地址荔枝云 6GG9的服务接入地址规则 http:/公共参数接口地址地址由三部分组成:域名:服务所提供的内容。公共参数:参考公共参数说明中的内容说明，由系统进行分配，用户调用接口时按分配的内容进行填写。接口地址:服务提供的内容。注:所有参数项必须传递，非必填项的值可为空

4、，所有参数区分大小写。请求及返回结果都使用 UTF-8 字符集进行编码。1.2.2 公共参数1.2.3 地址示例获取令牌的接口地址。http:/apppanyId/userId/serviceCode/auth/token/getAcsToken/【第一部分】【第二部分】接口地址分为两个部分，第一部分是公共请求参数，必含项。第二部分是具体服务的接口地址。1.3 返回结果code:,#状态码, 参照附录属性含义类型说明必填appCode应用标识String应用唯一标识（由荔枝云是verId版本号String接口版本号，当前版本号为V1是companyId企业标识String企业唯一标识（由荔枝云

5、是userId用户标识String用户唯一标识（用户填充）是serviceCode服务类型标识String服务类型唯一标识（由荔枝云提供）是message:,#描述信息 data:key:value,key:value#结果数据，详情查看各接口返回参数第2章 接口认证2.1 获取令牌2.1.1 功能描述荔枝云-PaaS的服务会对每个的请求进行验证，需要在请求中带上令牌信息。此接口是以 OAuth2.0 模式实现认证和。令牌的获取方式:用户传递的应用标识、版本号、企业标识、服务标识、密钥和时间戳生成相应的令牌，该令牌有效时长为 2 小时。2.1.2 接口地址auth/token/getAcsTo

6、ken/2.1.3 请求参数2.1.4 返回参数属性含义类型说明acsToken令牌String有时效性的属性含义类型说明必填acsKey密钥String密钥（此密钥由荔枝云提供，需）是timeSt时间戳String请求接口时，请求方当前时间毫秒数是 请求示例 返回示例a IUJK 状态码 SKYYGMK 成功 JGZG a GIY:UQKT + * * + * ( + , * (* + + cc: GVVVGT_/J YKX/J YKXOIK)UJK GZN ZUQKT MKZIY:UQKT ;YKX MKTZ IXR E XKJNOT MT ROHIXR 5VKT992 G ROH ROH

7、OJT 6XGMSG TU IGINKIIKVZ .UYZ )UTZKTZ :_VK GVVROIGZOUT LUXS XRKTIUJKJ)UTZKTZ 2KTMZNGIY1K_# * (* + + ZOSK9Z#2.2服务状态码列表第3章 公有云和私有云数据迁移相关接口3.1 新建任务3.1.1 功能描述根据已设定好的任务流程创建公有云和私有云的迁移任务。3.1.2 接口地址move/task/create/3.1.3 请求参数参数含义格式说明必填acsToken令牌String获取令牌接口返回的是timeSt时间戳String请求接口时，请求方当前时间，毫秒数是name任务名称String

8、任务名称否priority任务的优先级任务优先级，值越大优先级越高。取值范围 0-10。否to_url目标应用String目标应用的 url，迁移通过高安全区后程序是状态码说明0操作成功1pass级别错误其他安全区系统级别错误GIY:UQKT# ZOSK9Z# JGZG#a TGSK 任务名称$ VXOUXOZ_ 任务优先级$ TUZOLOIGZOUTEXKWKYZ 任务完成后通知目标版块的请求数据$ ZUEXR 目标应用的XR$ IGRRHGIQEXR 任务回调XR$ OTVZ a JKYZEYKIZOUTEOJ 目标版块/*$ 的 XR要请求的 XR。详见 通知说明 。TUZOLOIGZO

9、UTEXKWKYZ携带数据9ZXOTM通知目标版块时所携带数据。详见 通知说明 。否IGRRHGIQEXR回调参数9ZXOTM任务完成后的回调 XR。详见 回调说明 。否OTVZ任务的输入UHPKIZ任务的输入是OTVZ JKYZEYKIZOUTEOJ目标版块/*9ZXOTM迁移任务的目标版块/*测试暂时用 HH LGL KI HL LG H L L 否/TVUTZOTKEUTEKXXUX失败是否继续任务部分文件失败是否继续任务，默认为 LGRYK否OTVZ GIZOUTEOLEKOYZY文件已存在应该采取的操作目标文件已存在应该采取的操作， 失败 覆盖 重命名否/TVZ ZXGTYLKXY迁

10、移文件信息数组UHPKIZ迁移文件信息数组否3.1.4 返回参数code:0,message:成功, data:id:任务id参数含义格式说明id任务 IdString任务 idcontinue_on_error:, action_if_exists:, transfers: src_file: , user: ,password: , dest_file: ， md5 : 通知说明任务执行完成后，如果任务成功，并且配置了参数 to_url 则会调用该url，以T形式请求该url 来通知目标版块。T 请求的数据格式如下:在获得该 url 的响应后，如果任务还设置了回调，该响应会通过回调再返回给

11、任务a ZGYQEOJ 任务/*$ TUZOLOIGZOUTEXKWKYZ 任务完成后通知目标版块的请求数据$ ZXGTYLKXY Aa YXIELORK 源文件路径$ JKYZELORK 目标文件路径$ KXXUX 该文件传输错误码，成功为 $ SKYYGMK 该文件传输错误的原因，成功为空$c Cccc发起方。 回调说明任务执行完后，如果任务配置了 callback_url，无论任务成功或失败，都会调用该url 进行回调。回调以T 形式发送。回调格式如下:a OJ 任务/*$ VXOUXOZ_ 任务优先级$ HKMOTEZOSK 任务开始时间$ KTJEZOSK 任务结束时间$ YY 任务

12、状态$ VKXIKTZ 任务进度百分比$ SKYYGMK 任务处理信息$ TUJKY A 任务节点 $ 任务节点 $ C TUJKEOTJK 任务所处节点在流程中的索引$ TUJKEVKXIKTZ 任务所处节点的进度百分比$ TUZOLOIGZOUTEYY 通知目标版块后得到的.:6 9Y )UJK$ TUZOLOIGZOUTEXKYVUTYK 通知目标版块后得到的.:6响应$c3.2 查询任务3.2.1 功能说明根据任务ID 获取任务信息3.2.2 接口地址move/task/query/3.2.3 请求参数3.2.4 返回参数参数含义格式说明acsToken= &timeSt=&data=

13、taskId: 参数含义格式说明必填acsToken令牌String获取令牌接口返回的令牌是timeSt时间戳String请求接口时，请求方当前时间，毫秒数是taskId任务 IdString通过 Id 查询任务所需的任务 Id是a IUJK SKYYGMK 成功 id任务IdString任务IDname任务名称String任务名称priority任务优先级任务优先级，值越大优先级越高。取值范围 0-10begin_time开始时间String任务开始时间戳end_time结束时间String任务结束时间戳sus任务状态String任务状态:paused 暂停, running 执行中 , c

14、anceled 取消 , failed 失败 , succeeded 成功canceling是否正在取消任务是否正在取消任务pausing是否正在暂停任务是否正在暂停任务percent任务完成百分比String任务完成的百分比message进度描述String任务当前进度描述信息nodes要经历的处理节点array任务要经历的处理节点node_index所处索引String任务当前所处流程节点在整个流程中的索引node_percent当前节点百分比String任务当前所处流程节点的百分比进度 暂停、继续 功能描述根据任务 id 对当前正在执行的任务进行人工干预。 接口地址move/task/c

15、hange/ JGZG a OJ 任务/*$ VXOUXOZ_ 任务优先级$ HKMOTEZOSK 任务开始时间$ KTJEZOSK 任务结束时间$ YY 任务状态$ IGTIKROTM 是否正在取消$ VGYOTM 是否正在暂停$ VKXIKTZ 任务进度百分比$ SKYYGMK 任务处理信息$ TUJKY A 任务节点 $ 任务节点 $ C TUJKEOTJK 任务所处节点在流程中的索引$ TUJKEVKXIKTZ 任务所处节点的进度百分比$ cc3.3.3 请求参数3.3.4 返回参数code: 0,message: 成功,data: acsToken=11&timeSt=2015&da

16、ta=taskId: , flag:参数含义格式说明必填acsToken令牌String获取令牌接口返回的令牌是timeSt时间戳String请求接口时，请求方当前时间，毫秒数是taskId任务 IDString任务 ID是flag任务状态为true 表示暂停，为 false 表示取消是3.4 取消任务3.4.1 功能描述根据任务 id 删除任务。3.4.2 接口地址move/task/delete/3.4.3 请求参数3.4.4 返回参数code: 0,acsToken=11&timeSt=2015&data=taskId:参数含义格式说明必填acsToken令牌String获取令牌接口返回的令牌是timeSt时间戳String请求接口时，请求方当前时间，毫秒数是taskId任务 IDString任务 ID是3.5 修改任务优先级3.5.1 功能描述根据任务 id 修改正在迁移任务的优先级。3.5