荔枝云-paas平臺(tái)公有和私有數(shù)據(jù)遷移調(diào)用測(cè)試

1、荔枝云-PaaS公有云和私有云數(shù)據(jù)遷移調(diào)用規(guī)范(測(cè)試)江蘇省廣播電視總臺(tái)新奧特云視科技2015 年 7 月目錄第 1 章 調(diào)用說明51.1 概述51.2 請(qǐng)求結(jié)構(gòu)說明51.2.1 請(qǐng)求地址51.2.2 公共參數(shù)61.2.3 地址示例61.3 返回結(jié)果6第 2 章 接口認(rèn)證72.1 獲取令牌72.1.1功能描述72.1.2接口地址7請(qǐng)求參數(shù)72.1.3返回參數(shù)72.1.4請(qǐng)求示例.6返回示例82.2 服務(wù)狀態(tài)碼列表8第 3 章 公有云和私有云數(shù)據(jù)遷移相關(guān)接口93.1 新建任務(wù)93.1.1 功能描述93.1.2 接口地址93.1.3 請(qǐng)求參數(shù)93.1.4 返回參數(shù)113.1.5

2、通知說明113.1.6 回調(diào)說明123.2 查詢?nèi)蝿?wù)123.2.1 功能說明123.2.2 接口地址133.2.3 請(qǐng)求參數(shù)133.2.4 返回參數(shù)133.3 暫停、繼續(xù)153.3.1 功能描述153.3.2 接口地址153.3.3 請(qǐng)求參數(shù)153.3.4 返回參數(shù)153.4 取消任務(wù)163.4.1 功能描述163.4.2 接口地址163.4.3 請(qǐng)求參數(shù)163.4.4 返回參數(shù)163.5 修改任務(wù)優(yōu)先級(jí)173.5.1 功能描述173.5.2 接口地址173.5.3 請(qǐng)求參數(shù)173.5.4 返回參數(shù)17第1章 調(diào)用說明 概述歡迎使用荔枝云 6GG9云服務(wù)。用戶可以使用本文檔介紹的 6/ 對(duì)荔枝

3、云 6GG9云服務(wù)進(jìn)行相關(guān)操作。對(duì)于接口的首先要獲取令牌，每次請(qǐng)求都需要驗(yàn)證令牌信息，如果超過兩個(gè)小時(shí)沒有使用，令牌信息將過期，需要重新申領(lǐng)令牌。對(duì)荔枝云 6GG9接口調(diào)用是通過向荔枝云 6GG9的服務(wù)端地址發(fā)送 .:6: 請(qǐng)求，并按照接口說明在請(qǐng)求中加入相應(yīng)請(qǐng)求參數(shù)；根據(jù)請(qǐng)求的處理情況，系統(tǒng)會(huì)返回處理結(jié)果。 請(qǐng)求結(jié)構(gòu)說明 請(qǐng)求地址荔枝云 6GG9的服務(wù)接入地址規(guī)則 http:/公共參數(shù)接口地址地址由三部分組成:域名:服務(wù)所提供的內(nèi)容。公共參數(shù):參考公共參數(shù)說明中的內(nèi)容說明，由系統(tǒng)進(jìn)行分配，用戶調(diào)用接口時(shí)按分配的內(nèi)容進(jìn)行填寫。接口地址:服務(wù)提供的內(nèi)容。注:所有參數(shù)項(xiàng)必須傳遞，非必填項(xiàng)的值可為空

4、，所有參數(shù)區(qū)分大小寫。請(qǐng)求及返回結(jié)果都使用 UTF-8 字符集進(jìn)行編碼。1.2.2 公共參數(shù)1.2.3 地址示例獲取令牌的接口地址。http:/apppanyId/userId/serviceCode/auth/token/getAcsToken/【第一部分】【第二部分】接口地址分為兩個(gè)部分，第一部分是公共請(qǐng)求參數(shù)，必含項(xiàng)。第二部分是具體服務(wù)的接口地址。1.3 返回結(jié)果code:,#狀態(tài)碼, 參照附錄屬性含義類型說明必填appCode應(yīng)用標(biāo)識(shí)String應(yīng)用唯一標(biāo)識(shí)（由荔枝云是verId版本號(hào)String接口版本號(hào)，當(dāng)前版本號(hào)為V1是companyId企業(yè)標(biāo)識(shí)String企業(yè)唯一標(biāo)識(shí)（由荔枝云

5、是userId用戶標(biāo)識(shí)String用戶唯一標(biāo)識(shí)（用戶填充）是serviceCode服務(wù)類型標(biāo)識(shí)String服務(wù)類型唯一標(biāo)識(shí)（由荔枝云提供）是message:,#描述信息 data:key:value,key:value#結(jié)果數(shù)據(jù)，詳情查看各接口返回參數(shù)第2章 接口認(rèn)證2.1 獲取令牌2.1.1 功能描述荔枝云-PaaS的服務(wù)會(huì)對(duì)每個(gè)的請(qǐng)求進(jìn)行驗(yàn)證，需要在請(qǐng)求中帶上令牌信息。此接口是以 OAuth2.0 模式實(shí)現(xiàn)認(rèn)證和。令牌的獲取方式:用戶傳遞的應(yīng)用標(biāo)識(shí)、版本號(hào)、企業(yè)標(biāo)識(shí)、服務(wù)標(biāo)識(shí)、密鑰和時(shí)間戳生成相應(yīng)的令牌，該令牌有效時(shí)長(zhǎng)為 2 小時(shí)。2.1.2 接口地址auth/token/getAcsTo

6、ken/2.1.3 請(qǐng)求參數(shù)2.1.4 返回參數(shù)屬性含義類型說明acsToken令牌String有時(shí)效性的屬性含義類型說明必填acsKey密鑰String密鑰（此密鑰由荔枝云提供，需）是timeSt時(shí)間戳String請(qǐng)求接口時(shí)，請(qǐng)求方當(dāng)前時(shí)間毫秒數(shù)是 請(qǐng)求示例 返回示例a IUJK 狀態(tài)碼 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服務(wù)狀態(tài)碼列表第3章 公有云和私有云數(shù)據(jù)遷移相關(guān)接口3.1 新建任務(wù)3.1.1 功能描述根據(jù)已設(shè)定好的任務(wù)流程創(chuàng)建公有云和私有云的遷移任務(wù)。3.1.2 接口地址move/task/create/3.1.3 請(qǐng)求參數(shù)參數(shù)含義格式說明必填acsToken令牌String獲取令牌接口返回的是timeSt時(shí)間戳String請(qǐng)求接口時(shí)，請(qǐng)求方當(dāng)前時(shí)間，毫秒數(shù)是name任務(wù)名稱String

8、任務(wù)名稱否priority任務(wù)的優(yōu)先級(jí)任務(wù)優(yōu)先級(jí)，值越大優(yōu)先級(jí)越高。取值范圍 0-10。否to_url目標(biāo)應(yīng)用String目標(biāo)應(yīng)用的 url，遷移通過高安全區(qū)后程序是狀態(tài)碼說明0操作成功1pass級(jí)別錯(cuò)誤其他安全區(qū)系統(tǒng)級(jí)別錯(cuò)誤GIY:UQKT# ZOSK9Z# JGZG#a TGSK 任務(wù)名稱$ VXOUXOZ_ 任務(wù)優(yōu)先級(jí)$ TUZOLOIGZOUTEXKWKYZ 任務(wù)完成后通知目標(biāo)版塊的請(qǐng)求數(shù)據(jù)$ ZUEXR 目標(biāo)應(yīng)用的XR$ IGRRHGIQEXR 任務(wù)回調(diào)XR$ OTVZ a JKYZEYKIZOUTEOJ 目標(biāo)版塊/*$ 的 XR要請(qǐng)求的 XR。詳見 通知說明 。TUZOLOIGZO

9、UTEXKWKYZ攜帶數(shù)據(jù)9ZXOTM通知目標(biāo)版塊時(shí)所攜帶數(shù)據(jù)。詳見 通知說明 。否IGRRHGIQEXR回調(diào)參數(shù)9ZXOTM任務(wù)完成后的回調(diào) XR。詳見 回調(diào)說明 。否OTVZ任務(wù)的輸入U(xiǎn)HPKIZ任務(wù)的輸入是OTVZ JKYZEYKIZOUTEOJ目標(biāo)版塊/*9ZXOTM遷移任務(wù)的目標(biāo)版塊/*測(cè)試暫時(shí)用 HH LGL KI HL LG H L L 否/TVUTZOTKEUTEKXXUX失敗是否繼續(xù)任務(wù)部分文件失敗是否繼續(xù)任務(wù)，默認(rèn)為 LGRYK否OTVZ GIZOUTEOLEKOYZY文件已存在應(yīng)該采取的操作目標(biāo)文件已存在應(yīng)該采取的操作， 失敗 覆蓋 重命名否/TVZ ZXGTYLKXY遷

10、移文件信息數(shù)組UHPKIZ遷移文件信息數(shù)組否3.1.4 返回參數(shù)code:0,message:成功, data:id:任務(wù)id參數(shù)含義格式說明id任務(wù) IdString任務(wù) idcontinue_on_error:, action_if_exists:, transfers: src_file: , user: ,password: , dest_file: ， md5 : 通知說明任務(wù)執(zhí)行完成后，如果任務(wù)成功，并且配置了參數(shù) to_url 則會(huì)調(diào)用該url，以T形式請(qǐng)求該url 來通知目標(biāo)版塊。T 請(qǐng)求的數(shù)據(jù)格式如下:在獲得該 url 的響應(yīng)后，如果任務(wù)還設(shè)置了回調(diào)，該響應(yīng)會(huì)通過回調(diào)再返回給

11、任務(wù)a ZGYQEOJ 任務(wù)/*$ TUZOLOIGZOUTEXKWKYZ 任務(wù)完成后通知目標(biāo)版塊的請(qǐng)求數(shù)據(jù)$ ZXGTYLKXY Aa YXIELORK 源文件路徑$ JKYZELORK 目標(biāo)文件路徑$ KXXUX 該文件傳輸錯(cuò)誤碼，成功為 $ SKYYGMK 該文件傳輸錯(cuò)誤的原因，成功為空$c Cccc發(fā)起方。 回調(diào)說明任務(wù)執(zhí)行完后，如果任務(wù)配置了 callback_url，無論任務(wù)成功或失敗，都會(huì)調(diào)用該url 進(jìn)行回調(diào)?；卣{(diào)以T 形式發(fā)送?；卣{(diào)格式如下:a OJ 任務(wù)/*$ VXOUXOZ_ 任務(wù)優(yōu)先級(jí)$ HKMOTEZOSK 任務(wù)開始時(shí)間$ KTJEZOSK 任務(wù)結(jié)束時(shí)間$ YY 任務(wù)

12、狀態(tài)$ VKXIKTZ 任務(wù)進(jìn)度百分比$ SKYYGMK 任務(wù)處理信息$ TUJKY A 任務(wù)節(jié)點(diǎn) $ 任務(wù)節(jié)點(diǎn) $ C TUJKEOTJK 任務(wù)所處節(jié)點(diǎn)在流程中的索引$ TUJKEVKXIKTZ 任務(wù)所處節(jié)點(diǎn)的進(jìn)度百分比$ TUZOLOIGZOUTEYY 通知目標(biāo)版塊后得到的.:6 9Y )UJK$ TUZOLOIGZOUTEXKYVUTYK 通知目標(biāo)版塊后得到的.:6響應(yīng)$c3.2 查詢?nèi)蝿?wù)3.2.1 功能說明根據(jù)任務(wù)ID 獲取任務(wù)信息3.2.2 接口地址move/task/query/3.2.3 請(qǐng)求參數(shù)3.2.4 返回參數(shù)參數(shù)含義格式說明acsToken= &timeSt=&data=

13、taskId: 參數(shù)含義格式說明必填acsToken令牌String獲取令牌接口返回的令牌是timeSt時(shí)間戳String請(qǐng)求接口時(shí)，請(qǐng)求方當(dāng)前時(shí)間，毫秒數(shù)是taskId任務(wù) IdString通過 Id 查詢?nèi)蝿?wù)所需的任務(wù) Id是a IUJK SKYYGMK 成功 id任務(wù)IdString任務(wù)IDname任務(wù)名稱String任務(wù)名稱priority任務(wù)優(yōu)先級(jí)任務(wù)優(yōu)先級(jí)，值越大優(yōu)先級(jí)越高。取值范圍 0-10begin_time開始時(shí)間String任務(wù)開始時(shí)間戳end_time結(jié)束時(shí)間String任務(wù)結(jié)束時(shí)間戳sus任務(wù)狀態(tài)String任務(wù)狀態(tài):paused 暫停, running 執(zhí)行中 , c

14、anceled 取消 , failed 失敗 , succeeded 成功canceling是否正在取消任務(wù)是否正在取消任務(wù)pausing是否正在暫停任務(wù)是否正在暫停任務(wù)percent任務(wù)完成百分比String任務(wù)完成的百分比message進(jìn)度描述String任務(wù)當(dāng)前進(jìn)度描述信息nodes要經(jīng)歷的處理節(jié)點(diǎn)array任務(wù)要經(jīng)歷的處理節(jié)點(diǎn)node_index所處索引String任務(wù)當(dāng)前所處流程節(jié)點(diǎn)在整個(gè)流程中的索引node_percent當(dāng)前節(jié)點(diǎn)百分比String任務(wù)當(dāng)前所處流程節(jié)點(diǎn)的百分比進(jìn)度 暫停、繼續(xù) 功能描述根據(jù)任務(wù) id 對(duì)當(dāng)前正在執(zhí)行的任務(wù)進(jìn)行人工干預(yù)。 接口地址move/task/c

15、hange/ JGZG a OJ 任務(wù)/*$ VXOUXOZ_ 任務(wù)優(yōu)先級(jí)$ HKMOTEZOSK 任務(wù)開始時(shí)間$ KTJEZOSK 任務(wù)結(jié)束時(shí)間$ YY 任務(wù)狀態(tài)$ IGTIKROTM 是否正在取消$ VGYOTM 是否正在暫停$ VKXIKTZ 任務(wù)進(jìn)度百分比$ SKYYGMK 任務(wù)處理信息$ TUJKY A 任務(wù)節(jié)點(diǎn) $ 任務(wù)節(jié)點(diǎn) $ C TUJKEOTJK 任務(wù)所處節(jié)點(diǎn)在流程中的索引$ TUJKEVKXIKTZ 任務(wù)所處節(jié)點(diǎn)的進(jìn)度百分比$ cc3.3.3 請(qǐng)求參數(shù)3.3.4 返回參數(shù)code: 0,message: 成功,data: acsToken=11&timeSt=2015&da

16、ta=taskId: , flag:參數(shù)含義格式說明必填acsToken令牌String獲取令牌接口返回的令牌是timeSt時(shí)間戳String請(qǐng)求接口時(shí)，請(qǐng)求方當(dāng)前時(shí)間，毫秒數(shù)是taskId任務(wù) IDString任務(wù) ID是flag任務(wù)狀態(tài)為true 表示暫停，為 false 表示取消是3.4 取消任務(wù)3.4.1 功能描述根據(jù)任務(wù) id 刪除任務(wù)。3.4.2 接口地址move/task/delete/3.4.3 請(qǐng)求參數(shù)3.4.4 返回參數(shù)code: 0,acsToken=11&timeSt=2015&data=taskId:參數(shù)含義格式說明必填acsToken令牌String獲取令牌接口返回的令牌是timeSt時(shí)間戳String請(qǐng)求接口時(shí)，請(qǐng)求方當(dāng)前時(shí)間，毫秒數(shù)是taskId任務(wù) IDString任務(wù) ID是3.5 修改任務(wù)優(yōu)先級(jí)3.5.1 功能描述根據(jù)任務(wù) id 修改正在遷移任務(wù)的優(yōu)先級(jí)。3.5