荔枝云paas平臺基礎(chǔ)服務(wù)能力管理調(diào)用v_第1頁
荔枝云paas平臺基礎(chǔ)服務(wù)能力管理調(diào)用v_第2頁
荔枝云paas平臺基礎(chǔ)服務(wù)能力管理調(diào)用v_第3頁
荔枝云paas平臺基礎(chǔ)服務(wù)能力管理調(diào)用v_第4頁
荔枝云paas平臺基礎(chǔ)服務(wù)能力管理調(diào)用v_第5頁
已閱讀5頁,還剩57頁未讀, 繼續(xù)免費(fèi)閱讀

下載本文檔

版權(quán)說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請進(jìn)行舉報(bào)或認(rèn)領(lǐng)

文檔簡介

1、目錄第 1 章 調(diào)用說明101 . 1 概述101 . 2 請求結(jié)構(gòu)說明10請求地址10公共參數(shù)10地址示例111 . 3 返回結(jié)果11第 2 章 接口認(rèn)證122 . 1 獲取令牌12功能描述12接口地址12請求參數(shù)12返回參數(shù)12請求示例12返回示例13服務(wù)狀態(tài)碼列表132 . 2第 3 章 轉(zhuǎn)碼服務(wù)相關(guān)接口143 . 1 創(chuàng)建轉(zhuǎn)碼任務(wù)14功能描述14接口地址14請求參數(shù)14返回參數(shù)14回調(diào)參數(shù)15請求示例15返回示例163 . 2 轉(zhuǎn)碼狀態(tài). 16功能描述16接口地址16請求參數(shù)17返回參數(shù)17請求示例17返回示例173 . 3 轉(zhuǎn)碼任務(wù)重試18功能描述18接口地址18請求參數(shù)18請求示例

2、18返回示例193 . 4 轉(zhuǎn)碼模板. 19功能描述19接口地址19請求參數(shù)19返回參數(shù)20請求示例21返回示例213 . 5 轉(zhuǎn)碼服務(wù)狀態(tài)碼列表22第 4 章 技審服務(wù)相關(guān)接口234 . 1 創(chuàng)建技審任務(wù)23功能描述23接口地址23請求參數(shù)23返回參數(shù)24回調(diào)參數(shù)24請求示例24返回示例254 . 2 技審任務(wù). 25功能描述25接口地址26請求參數(shù)26返回參數(shù)26請求示例26返回示例274 . 3 技審任務(wù)重試27功能描述27接口地址27請求參數(shù)27請求示例28返回示例284 . 4 技審服務(wù)狀態(tài)碼列表28第 5 章 截圖服務(wù)相關(guān)接口295 . 1 關(guān)鍵幀截圖29功能描述29接口地址29請

3、求參數(shù)29返回參數(shù)29回調(diào)參數(shù)30狀態(tài)碼30請求示例31返回示例315 . 2 定時(shí)截圖31功能描述31接口地址32請求參數(shù)32返回參數(shù)32回調(diào)參數(shù)32狀態(tài)碼33請求示例33返回示例345 . 3 定點(diǎn)截圖34功能描述34接口地址34請求參數(shù)34返回參數(shù)35回調(diào)參數(shù)35狀態(tài)碼35請求示例36返回示例365 . 4 定量截圖37功能描述37接口地址37請求參數(shù)37返回參數(shù)37回調(diào)參數(shù)37狀態(tài)碼38請求示例38返回示例395 . 5 截圖服務(wù)狀態(tài)碼列表39第 6 章 收錄服務(wù)相關(guān)接口406 . 1 任務(wù)添加40功能描述40接口地址40請求參數(shù)40返回參數(shù)41回調(diào)參數(shù)41請求示例41返回示例426

4、. 2 模板列表. 42功能描述42接口地址42請求參數(shù)42返回參數(shù)42請求示例43返回示例436 . 3 模板參數(shù). 44功能描述44接口地址44請求參數(shù)44返回參數(shù)44請求示例45返回示例456 . 4 任務(wù). 46功能描述46接口地址46請求參數(shù)46返回參數(shù)46請求示例47返回示例476 . 5 收錄服務(wù)狀態(tài)碼列表47第 7 章服務(wù)相關(guān)接口487 . 1 頻道開通(推流模式)48功能描述48接口地址48請求參數(shù)48返回參數(shù)49請求示例49返回示例497 . 2 頻道開通(拉流模式)50功能描述50接口地址50請求參數(shù)50返回參數(shù)50請求示例51返回示例517 . 3 頻道關(guān)閉接口52功能

5、描述52接口地址52請求參數(shù)52請求示例52返回示例527 . 4 模板接口53功能描述53接口地址53請求參數(shù)53返回參數(shù)53請求示例53返回示例547 . 5 模板參數(shù)接口54功能描述54接口地址55請求參數(shù)55返回參數(shù)55請求示例55返回示例567 . 6 頻道狀態(tài)接口57功能描述57接口地址57請求參數(shù)57返回參數(shù)57請求示例57返回示例58服務(wù)狀態(tài)碼列表587 . 7第 8 章 語音識別服務(wù)相關(guān)接口588 . 1 提交任務(wù)接口59功能描述59接口地址59請求參數(shù)59返回參數(shù)59回調(diào)參數(shù)59請求示例60返回示例60任務(wù)接口618 . 2功能描述61接口地址61請求參數(shù)61返回參數(shù)61請

6、求示例61返回示例628 . 3 語音識別服務(wù)狀態(tài)碼列表62第1章 調(diào)用說明1.1 概述歡迎使用荔枝云-PaaS 平臺云服務(wù)。用戶可以使用本文檔的 API 對荔枝云-PaaS 平臺云服務(wù)進(jìn)行相關(guān)操作。對于接口的首先要獲取令牌,每次請求都需要令牌信息,如果超過兩個(gè)小時(shí)沒有使用,令牌信息將過期,需要重新申領(lǐng)令牌。對荔枝云-PaaS 平臺接口調(diào)用是通過向荔枝云-PaaS 平臺的服務(wù)端地址HTTPPOST 請求,并按照接口說明在請求中加入相應(yīng)請求參數(shù);根據(jù)請求的處理情況,系統(tǒng)會返回處理結(jié)果。1.2 請求結(jié)構(gòu)說明請求地址荔枝云-PaaS 平臺的服務(wù)接入地址規(guī)則:http:/公共參數(shù)接口地址地址由三部分組

7、成:域名:服務(wù)所提供的內(nèi)容。公共參數(shù):參考公共參數(shù)說明中的內(nèi)容說明,進(jìn)行分配,用戶調(diào)用接口時(shí)按分配的內(nèi)容進(jìn)行填寫。接口地址:服務(wù)提供的內(nèi)容。注:所有參數(shù)項(xiàng)必須傳遞,非必填項(xiàng)的值可為空,所有參數(shù)區(qū)分大小寫。請求及返回結(jié)果都使用 UTF-8 字符集進(jìn)行編碼。公共參數(shù)屬性含義類型說明必填地址示例獲取令牌的接口地址。http:/appCode/versionId/companyId/userId/serviceCode/auth/token/getAccessToken/【第一部分】【第二部分】接口地址分為兩個(gè)部分,第一部分是公共請求參數(shù),必含項(xiàng)。第二部分是具體服務(wù)的接口地址。1.3 返回結(jié)果“cod

8、e”:”,#狀態(tài)碼, 參照附錄“message”:”,#描述信息“data”:“key”:”value”,“key”:”value”#結(jié)果數(shù)據(jù),詳情查看各接口返回參數(shù)appCode應(yīng)用標(biāo)識String應(yīng)用唯一標(biāo)識(由荔枝云平臺提供)是versionId版本號String接口版本號,當(dāng)前版本號為 V1是companyId企業(yè)標(biāo)識String企業(yè)唯一標(biāo)識(由荔枝云平臺提供)是userId用戶標(biāo)識String用戶唯一標(biāo)識(用戶填充)是serviceCode服務(wù)類型標(biāo)識String服務(wù)類型唯一標(biāo)識(由荔枝云平臺提供)是第2章 接口認(rèn)證2.1 獲取令牌功能描述荔枝云-PaaS 平臺的服務(wù)會對每個(gè)的請求進(jìn)

9、行,需要在請求中帶上令牌信息。此接口是以 OAuth2.0 模式實(shí)現(xiàn)認(rèn)證和。令牌的獲取方式:用戶傳遞的應(yīng)用標(biāo)識、版本號、企業(yè)標(biāo)識、服務(wù)標(biāo)識、密鑰和時(shí)間戳生成相應(yīng)的令牌,該令牌有效時(shí)長為 2 小時(shí)。接口地址auth/token/getAccessToken/請求參數(shù)返回參數(shù)請求示例POST/appCode/versionId/companyId/userId/serviceCode/auth/token/getAccessTok en/User-Agent: curl/7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1屬性含義類型說明accessTok

10、en令牌String有時(shí)效性的令牌屬性含義類型說明必填accessKey密鑰String密鑰(此密鑰由荔枝云平臺提供,需)是timeStamp時(shí)間戳String請求接口時(shí),請求方當(dāng)前時(shí)間毫秒數(shù)是返回示例2.2服務(wù)狀態(tài)碼列表代碼描述說明0Success操作1Authorization fail獲取失敗“code”:“0”,“message”:“”, “data”: “accessToken”:”05784E32D86340D976677714905E6D53B2E041F124A3D1603BAAD66E21880E E5”O(jiān)penSSL/0.9.7a zlib/ libidn/0

11、.5.6 Pragma: no-cacheAccept: */* Host:Content-Type:application/x-www-form-urlencoded Content-Length:XaccessKey=0A3D1603BAAD66E21880EE5&timeStamp=1435642027第3章 轉(zhuǎn)碼服務(wù)相關(guān)接口荔枝云 轉(zhuǎn)碼服務(wù)可以支持不同格式的視音頻轉(zhuǎn)碼,支持一入多出、模板方式等快捷的轉(zhuǎn)碼形式。利用集群優(yōu)勢,使用切片轉(zhuǎn)碼方式可以極大的提高轉(zhuǎn)碼效率。轉(zhuǎn)碼服務(wù)提供任務(wù)創(chuàng)建、轉(zhuǎn)碼狀態(tài)、任務(wù)重試和模板接口。3.1 創(chuàng)建轉(zhuǎn)碼任務(wù)功能描述創(chuàng)建轉(zhuǎn)碼任務(wù)前需要通過接口認(rèn)證,獲取令牌。根據(jù)

12、請求參數(shù)創(chuàng)建轉(zhuǎn)碼任務(wù),后返回對應(yīng)的轉(zhuǎn)碼任務(wù) ID。接口地址transcode/task/create/請求參數(shù)返回參數(shù)參數(shù)含義格式說明taskId任務(wù) IdString創(chuàng)建轉(zhuǎn)碼任務(wù)時(shí),產(chǎn)生的唯一標(biāo)識destUrl文件生成路徑Array返回文件生成路徑,文件生成數(shù)量跟轉(zhuǎn)碼輸出模板參數(shù)含義格式說明必填accessToken令牌String獲取令牌接口返回的令牌是timeStamp時(shí)間戳String請求接口時(shí),請求方當(dāng)前 UTC 時(shí)間,毫秒數(shù)是srcFileUrl源文件地址String源文件地址是callbackUrl回調(diào)地址String回調(diào)通知地址否priority優(yōu)先級Int優(yōu)先級,由低到高,取

13、值(1-10)否fixedInfo固定信息String回調(diào)時(shí)該字符串保持原值返回給用戶否output文件輸出集合Array轉(zhuǎn)碼輸出模板 ID 數(shù)組是isSplit是否切片Boolean是否切片,默認(rèn)值是 false否回調(diào)參數(shù)轉(zhuǎn)碼任務(wù)結(jié)束后,由轉(zhuǎn)碼服務(wù)發(fā)起調(diào)用,回調(diào)地址為 callbackUrl參數(shù)見下表的值,具體調(diào)用回調(diào)請求示例:請求示例POST/appCode/versionId/companyId/userId/serviceCode/transcode/task/create/ User-Agent: curl/7.12.1 (x86_64-redhat-linux-gnu) libcu

14、rl/7.12.1OpenSSL/0.9.7a zlib/ libidn/0.5.6 Pragma: no-cacheAccept: */* Host:POST /callback/restUser-Agent: curl/7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1 OpenSSL/0.9.7a zlib/ libidn/0.5.6Pragma: no-cache Accept: */*Host:Content-Type:application/x-www-form-urlencoded Content-Lengt

15、h:XtaskId = task-id&status =2&fixedInfo=abc參數(shù)含義格式說明必填taskId任務(wù) IdString創(chuàng)建轉(zhuǎn)碼任務(wù)時(shí),產(chǎn)生的唯一標(biāo)識是status任務(wù)結(jié)果狀態(tài)Int轉(zhuǎn)碼任務(wù)結(jié)果狀態(tài),-1(失敗),2()是fixedInfo固定信息String回調(diào)時(shí)該字符串保持原值返回給用戶否數(shù)相等,生成的文件名跟模板 ID 一致。注意:只有在回調(diào)通知任務(wù)執(zhí)行后此地址才能正常訪問,任務(wù)執(zhí)行過程中此 URL 無效返回示例3.2 轉(zhuǎn)碼狀態(tài)功能描述令牌。根據(jù)轉(zhuǎn)碼任務(wù) ID,任務(wù)前需要通過接口認(rèn)證,獲取當(dāng)前轉(zhuǎn)碼任務(wù)狀態(tài)。接口地址transcode/task/query/“code”

16、:0 , #狀態(tài)碼“message”:”,#描述信息“data”:“taskId”: “task-id”# 任務(wù)ID“destUrl”: “” #文件路徑Content-Type:application/x-www-form-urlencoded Content-Length:XaccessToken=78888gfd×tamp=&srcFileUrl=m/callback/rest&priority=1&fixedInfo=&output=hd_h264,sd_h264&isSplit=tr ue請求參數(shù)返回參數(shù)請求示例返回示例“code”:0 , #狀態(tài)碼“message”:”,

17、#描述信息POST / appCode/versionId/companyId/userId/serviceCode/ transcode/task/query/User-Agent: curl/7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1 OpenSSL/0.9.7a zlib/ libidn/0.5.6Pragma: no-cache Accept: */*Host:Content-Type:application/x-www-form-urlencoded Content-Length:XaccessToken=78888g

18、fd×tamp=&taskId=task-id參數(shù)含義格式說明status任務(wù)狀態(tài)Int任務(wù)當(dāng)前狀態(tài),-1(任務(wù)出錯(cuò))、0(任務(wù)排隊(duì))、1(任務(wù)正在執(zhí)行)、2(任務(wù)完成)progress任務(wù)進(jìn)度Int進(jìn)度值,0-100 整數(shù)參數(shù)含義格式說明必填accessToken令牌String獲取令牌接口返回的令牌是timeStamp時(shí)間戳String請求接口時(shí),請求方當(dāng)前 UTC 時(shí)間,毫秒數(shù)是taskId任務(wù) IDString任務(wù) ID是3.3 轉(zhuǎn)碼任務(wù)重試功能描述令牌。根據(jù)轉(zhuǎn)碼任務(wù) ID,重新啟動(dòng)轉(zhuǎn)碼轉(zhuǎn)碼重試前需要通過接口認(rèn)證,獲取任務(wù),主要用于轉(zhuǎn)碼任務(wù)失敗時(shí),可以調(diào)用該接口來做重新轉(zhuǎn)碼。

19、接口地址transcode/task/retry/請求參數(shù)請求示例POST /appCode/versionId/companyId/userId/serviceCode/ transcode/task/retry/User-Agent: curl/7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1 OpenSSL/0.9.7a zlib/ libidn/0.5.6參數(shù)含義格式說明必填accessToken令牌String獲取令牌接口返回的令牌是timeStamp時(shí)間戳String請求接口時(shí),請求方當(dāng)前 UTC 時(shí)間,毫秒數(shù)是taskI

20、d任務(wù) IDString任務(wù) ID是“data”:“status”: 0,“progress” : 50返回示例3.4 轉(zhuǎn)碼模板功能描述轉(zhuǎn)碼模板前需要通過接口認(rèn)證,獲取令牌。接口地址transcode/template/query/請求參數(shù)參數(shù)含義格式說明必填accessToken令牌String獲取令牌接口返回的令牌是timeStamp時(shí)間戳String請求接口時(shí),請求方當(dāng)前 UTC 時(shí)間,毫秒數(shù)是“code”:0 , #狀態(tài)碼“message”:”,#描述信息“data”:Pragma: no-cache Accept: */*Host:Content-Type:application/x

21、-www-form-urlencoded Content-Length:XaccessToken=78888gfd×tamp=&taskId=task-id返回參數(shù)參數(shù)含義格式說明templateId模板 IdString轉(zhuǎn)碼模板 IdtemplateName模板名稱String轉(zhuǎn)碼模板名稱vCodec編碼格式String編碼格式( dv、h263、h264、mpeg1、mpeg2、mpeg4、ms1、rv10、rv20、rv30、rv40、wmv1、wmv2、wmv3)vBitrate碼率Int編碼碼率,kb/sfps幀率Float幀率,fpsgop圖像組Int圖像組,I 幀間隔w

22、idth圖像寬Int圖像寬度height圖像高Int圖像高度aspect圖像比例StringpixelFormat圖像格式String圖像格式picUrl圖片 UrlStringLogo 或水印的 url 路徑,用于疊加 logo 或水印到圖像上picX圖片 x 坐標(biāo)IntLogo 或水印疊加在圖像上 x 坐標(biāo)(圖像左上角為坐標(biāo)原點(diǎn))picY圖像 y 坐標(biāo)IntLogo 或水印疊加在圖像上 y 坐標(biāo)(圖像左上角為坐標(biāo)原點(diǎn))picWidth圖片寬Int疊加到圖像上的 Logo 或水印的寬picHeight圖片高Int疊加到圖像上的 Logo 或水印的高vProfile概述String概述,用于

23、h264 編碼使用vLevel級別String級別,用于 h264 編碼使用subtitleUrl字幕 UrlString字幕 UrlaCodec音頻編碼格式String音頻編碼格式( aac、aac_latm、ac3、amr_nb、amr_wb、mp2、mp3、opus、pcm_alaw、pcm_f32be、pcm_f32le、pcm_f64be、pcm_f64le、pcm_s16be、pcm_s16le、pcm_s24be、pcm_s24le、pcm_s32be、pcm_s32le、pcm_s8、pcm_u16be、pcm_u16le、pcm_u24be、pcm_u24le、pcm_u32

24、be、pcm_u32le、pcm_u8、ra_144、wmapro、wmav1、wmav2、Vorbis)aBitrate音頻碼率Int音頻編碼碼率channel音頻聲道Int音頻編碼聲道請求示例返回示例“code”:0 , #狀態(tài)碼“message”:”,#描述信息“data”:“templates”: “templateId”: “uf879940”, “templateName” : “hd_h264”, “vCodec” : “h264”, “vBitrate” : 1500,“fps” : 25.0,POST/appCode/versionId/companyId/userId/se

25、rviceCode/transcode/template/quer y/User-Agent: curl/7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1 OpenSSL/0.9.7a zlib/ libidn/0.5.6Pragma: no-cache Accept: */*Host:Content-Type:application/x-www-form-urlencoded Content-Length:XaccessToken=78888gfd×tamp=sampleRate采樣率Int音頻采樣率,HzextraPar

26、am擴(kuò)展參數(shù)String擴(kuò)展參數(shù)format打包格式String輸出打包格式(asf、avi、dv、flv、mp4、swf、mxf、rm、mov、m4v、h261、h263、h264、mpg、ts、3gp、mkv、wmv、vob)extraInfo附加信息String文件附加信息3.5 轉(zhuǎn)碼服務(wù)狀態(tài)碼列表代碼描述說明0Success操作60001Source File Not Found源文件地址無效60002Input Parameter Invalid輸入?yún)?shù)不合法60003Inner Error系統(tǒng)內(nèi)部錯(cuò)誤60004Unknow Error未知錯(cuò)誤60005TaskId Is Not E

27、xist任務(wù) id 不“gop” : 100,“width” : 1280,“height” : 720,“aspect” : “16:9”, “pixelFormat” : “yuv420p”, “picUrl” : “”,“picX” : 0,“picY” : 0,“picWidth” : 0,“picHeight” : 0, “vProfile” : “”,“vLevel” : 3.1,“subtitleUrl” : “”,“aCodec” : “aac”, “aBitrate” : 128,“channel” : 2,“sampleRate” : 44100, “extraParam”

28、 : “”,“format” : “flv”,“extraInfo” : “”第4章 技審服務(wù)相關(guān)接口技審服務(wù)是對視音頻通過自動(dòng)檢測,來發(fā)現(xiàn)視音頻文件中是否黑場、彩場、靜幀、彩條、靜音、聲音過高、聲音過低故障。本服務(wù)提供任務(wù)創(chuàng)建、任務(wù)、任務(wù)重試接口。4.1 創(chuàng)建技審任務(wù)功能描述創(chuàng)建技審任務(wù)前需要通過接口認(rèn)證,獲取令牌。根據(jù)請求參數(shù)創(chuàng)建技審任務(wù),后返回對應(yīng)的技審任務(wù) ID。接口地址techeye/task/create/請求參數(shù)附表:檢測參數(shù)參數(shù)類型必填說明detectTypeInt是0(黑場);1(靜幀);2(彩條);3(彩場);4(靜音);5(聲音過高);6(聲音過低)thresholdFl

29、oat是檢測閾值continueValueInt是持續(xù)發(fā)生某一故障的時(shí)長,毫秒。參數(shù)含義格式說明必填accessToken令牌String獲取令牌接口返回的是timeStamp時(shí)間戳String請求接口時(shí),請求方當(dāng)前 UTC 時(shí)間,毫秒數(shù)是srcFileUrl源文件地址String需要技審的源文件地址是callbackUrl回調(diào)地址String技審結(jié)束,回調(diào)通知地址否priority優(yōu)先級Int優(yōu)先級,由低到高,取值(1-10)否fixedInfo固定信息String回調(diào)時(shí)該字符串保持原值返回給用戶否detectParams技審參數(shù)Array技審檢測參數(shù)數(shù)組,具體檢測參數(shù)見附表是返回參數(shù)回調(diào)參

30、數(shù)技審任務(wù)結(jié)束后,由技審服務(wù)發(fā)起調(diào)用,回調(diào)地址為callbackUrl的值,具體調(diào)用參數(shù)見下表回調(diào)請求示例:請求示例POST/appCode/versionId/companyId/userId/serviceCode/techeye/task/create/ User-Agent: curl/7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1OpenSSL/0.9.7a zlib/ libidn/0.5.6 Pragma: no-cacheAccept: */*POST /callback/rest/User-Agent: curl/

31、7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1 OpenSSL/0.9.7a zlib/ libidn/0.5.6Pragma: no-cache Accept: */*Host:Content-Type:application/x-www-form-urlencoded Content-Length:XtaskId = task-id&status =2&fixedInfo=參數(shù)含義格式說明必填taskId任務(wù) IdString創(chuàng)建技審任務(wù)時(shí),產(chǎn)生的唯一標(biāo)識是status任務(wù)結(jié)果狀態(tài)Int技審任務(wù)結(jié)果狀態(tài),-1(失敗),2()是f

32、ixedInfo固定信息String回調(diào)時(shí)該字符串保持原值返回給用戶否參數(shù)含義格式說明taskId任務(wù) IdString創(chuàng)建技審任務(wù)時(shí),產(chǎn)生的唯一標(biāo)識返回示例4.2 技審任務(wù)功能描述令牌。根據(jù)技審任務(wù) ID,任務(wù)前需要通過接口認(rèn)證,獲取技審任務(wù)內(nèi)容?!癱ode”:0 , #狀態(tài)碼“message”:”,#描述信息“data”:“taskId”:”task-id”# 任務(wù)IDHost:Content-Type:application/x-www-form-urlencoded Content-Length:XaccessToken=78888gfd×tamp=&taskId = tas

33、k-id&status =2&srcFileUrl=“detectType” : 0, “threshold” : 0.89,“continueValue” : 125,“detectType” : 1, “threshold” : 0.80,“continueValue” : 125,“detectType” : 2, “threshold” : 0.85,“continueValue” : 25,“detectType” : 3, “threshold” : 0.89,“continueValue” : 25,“detectType” : 4, “threshold” : 20,“cont

34、inueValue” : 441000,“detectType” : 5, “threshold” : 70,“continueValue” : 441000,“detectType” : 6, “threshold” :30, “continueValue” : 441000接口地址techeye/task/query/請求參數(shù)返回參數(shù)附表:檢測參數(shù)請求示例POST /appCode/versionId/companyId/userId/serviceCode/ techeye/task/query/User-Agent: curl/7.12.1 (x86_64-redhat-linux-g

35、nu) libcurl/7.12.1 OpenSSL/0.9.7a zlib/ libidn/0.5.6Pragma: no-cache Accept: */*Host:Content-Type:application/x-www-form-urlencoded Content-Length:X參數(shù)類型說明faultTypeInt0(黑場);1(靜幀);2(彩條);3(彩場);4(靜音);5(聲音過高);6(聲音過低)startTimeString故障開始時(shí)間,格式 00:00:00.000stopTimeString故障結(jié)束時(shí)間,格式 00:00:00.000參數(shù)含義格式說明s

36、tatus任務(wù)狀態(tài)Int任務(wù)當(dāng)前狀態(tài),-1(任務(wù)出錯(cuò))、0(任務(wù)排隊(duì))、1(任務(wù)正在執(zhí)行)、2(任務(wù)完成)progress任務(wù)進(jìn)度Int進(jìn)度值,0-100 整數(shù)faults技審結(jié)果Array技審檢測結(jié)果,詳細(xì)見附表參數(shù)含義格式說明必填accessToken令牌String獲取令牌接口返回的令牌是timeStamp時(shí)間戳String請求接口時(shí),請求方當(dāng)前 UTC 時(shí)間,毫秒數(shù)是taskId任務(wù) IDString任務(wù) ID是返回示例4.3 技審任務(wù)重試功能描述令牌。根據(jù)技審任務(wù) ID,重新啟動(dòng)技審技審重試前需要通過接口認(rèn)證,獲取任務(wù),主要用于技審任務(wù)失敗時(shí),可以調(diào)用該接口來做重新技審。接口地址te

37、cheye/task/retry/請求參數(shù)參數(shù)含義格式說明必填accessToken令牌String獲取令牌接口返回的令牌是“code”:0 , #狀態(tài)碼“message”:”,#描述信息“data”:“status”: 0,“progress” : 50, “faults” : “detectType” : 0,“startTime” : “00:01:00.000”,“stopTime” : “00:01:01.960”accessToken=78888gfd×tamp=&taskId=task-id請求示例返回示例4.4 技審服務(wù)狀態(tài)碼列表代碼描述說明0Success操作700

38、01Source File Not Found源文件地址無效70002Input Parameter Invalid輸入?yún)?shù)不合法70003Inner Error系統(tǒng)內(nèi)部錯(cuò)誤“code”:0 , #狀態(tài)碼“message”:”,#描述信息“data”:POST/appCode/versionId/companyId/userId/serviceCode/techeye/task/retry/ User-Agent: curl/7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1OpenSSL/0.9.7a zlib/ libidn/0.5

39、.6 Pragma: no-cacheAccept: */* Host:Content-Type:application/x-www-form-urlencoded Content-Length:XaccessToken=78888gfd×tamp=&taskId=task-idtimeStamp時(shí)間戳String請求接口時(shí),請求方當(dāng)前 UTC 時(shí)間,毫秒數(shù)是taskId任務(wù) IDString任務(wù) ID是第5章 截圖服務(wù)相關(guān)接口截圖服務(wù)提供截圖功能,服務(wù)提供多種截圖方式,按關(guān)鍵幀自動(dòng)截圖、定時(shí)截圖、按數(shù)量截圖等方式,完成自動(dòng)截取中的圖片并保存到集中中,降低外部系統(tǒng)截取圖片和保存圖片的

40、復(fù)雜度。5.1 關(guān)鍵幀截圖功能描述調(diào)用關(guān)鍵幀截圖服務(wù)需要獲取令牌。通過參數(shù)中所傳遞的地址,關(guān)鍵幀截圖服務(wù)會自動(dòng)按照關(guān)鍵幀截取該的圖片。接口地址screenShot/shotByKeyFrame/請求參數(shù)返回參數(shù)參數(shù)含義格式說明taskId任務(wù) IdString創(chuàng)建截圖任務(wù)時(shí),產(chǎn)生的唯一標(biāo)識參數(shù)含義格式說明必填accessToken令牌String獲取令牌接口返回的令牌是timeStamp時(shí)間戳String請求接口時(shí),請求方當(dāng)前時(shí)間毫秒數(shù)是Url地址String地址是callBackUrl回調(diào)地址String截圖操作完成后回調(diào)地址是70004Unknow Error未知錯(cuò)誤70005TaskId

41、 Is Not Exist任務(wù) id 不回調(diào)參數(shù)截圖任務(wù)結(jié)束后,由截圖服務(wù)發(fā)起調(diào)用,回調(diào)地址為callbackUrl的值,具體調(diào)用參數(shù)見下表回調(diào)請求示例:狀態(tài)碼代碼描述說明0success操作80001Source file not found源文件地址無效80002Input parameter invalid輸入?yún)?shù)不合法80005Inner error系統(tǒng)內(nèi)部錯(cuò)誤80006Unknow error未知錯(cuò)誤POST /callback/rest/User-Agent: curl/7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1 OpenSSL/

42、0.9.7a zlib/ libidn/0.5.6Pragma: no-cache Accept: */*Host:Content-Type:application/x-www-form-urlencoded Content-Length:XtaskId = task-id&status =2&pointscreen=pointTime : 00:00:01.400, imageUrl: 參數(shù)含義格式說明必填taskId任務(wù) IdString創(chuàng)建截圖任務(wù)時(shí),產(chǎn)生的唯一標(biāo)識是status任務(wù)結(jié)果狀態(tài)String截圖任務(wù)結(jié)果狀態(tài),-1(失敗),2()是pointscreen截圖信息A

43、rray包含 pointTime(截取圖片的時(shí)間點(diǎn))與imageUrl(對應(yīng)截圖存放的 Url)是請求示例返回示例5.2 定時(shí)截圖功能描述任務(wù)前需要通過接口認(rèn)證,獲取令牌?!癱ode”:0 , #狀態(tài)碼“message”:”,#描述信息“data”:taskid:POST/appCode/versionId/companyId/userId/serviceCode/screenShot/shotByKeyFra me/User-Agent: curl/7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1 OpenSSL/0.9.7azlib/1.2.1

44、.2 libidn/0.5.6Pragma: no-cache Accept: */*Host:Content-Type:application/x-www-form-urlencoded Content-Length:XaccessToken=0A3D1603BAAD66E21880EE5&timeStamp=1435642027&vi deoUrl=接口地址screenShot/shotByInterval/請求參數(shù)返回參數(shù)回調(diào)參數(shù)截圖任務(wù)結(jié)束后,由截圖服務(wù)發(fā)起調(diào)用,回調(diào)地址為callbackUrl 的值,具體調(diào)用參數(shù)見下表回調(diào)請求示例:POST /callback/rest/User-A

45、gent: curl/7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1 OpenSSL/0.9.7a zlib/ libidn/0.5.6Pragma: no-cache Accept: */*Host:參數(shù)含義格式說明必填taskId任務(wù) IdString創(chuàng)建截圖任務(wù)時(shí),產(chǎn)生的唯一標(biāo)識是status任務(wù)結(jié)果狀態(tài)String截圖任務(wù)結(jié)果狀態(tài),-1(失敗),2()是pointscreen截圖信息Array包含 pointTime(截取圖片的時(shí)間點(diǎn))與imageUrl(對應(yīng)截圖存放的 Url)是參數(shù)含義格式說明taskId任務(wù) IdStr

46、ing創(chuàng)建截圖任務(wù)時(shí),產(chǎn)生的唯一標(biāo)識參數(shù)含義格式說明必填accessToken令牌String獲取令牌接口返回的令牌是timeStamp時(shí)間戳String請求接口時(shí),請求方當(dāng)前時(shí)間毫秒數(shù)是Url地址String地址是interval偏移量Int時(shí)間間隔(:秒),默認(rèn)為 5 秒是callBackUrl回調(diào)地址String截圖操作完成后回調(diào)地址是狀態(tài)碼請求示例POST/appCode/versionId/companyId/userId/serviceCode/screenShot/shotByInterva l/User-Agent: curl/7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1 OpenSSL/0.9.7azlib/ libidn/0.5.6Pragma: no-cache Accept: */*Host:Content-Type:application/x-www-form-urlencoded Content-Length:XaccessToken=0A3D1603BAAD66E21880EE5&timeStamp=1435642027&vi deoUrl=代碼描述說明0success操作80001Source file

溫馨提示

  • 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會有圖紙預(yù)覽,若沒有圖紙預(yù)覽就沒有圖紙。
  • 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
  • 5. 人人文庫網(wǎng)僅提供信息存儲空間,僅對用戶上傳內(nèi)容的表現(xiàn)方式做保護(hù)處理,對用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對任何下載內(nèi)容負(fù)責(zé)。
  • 6. 下載文件中如有侵權(quán)或不適當(dāng)內(nèi)容,請與我們聯(lián)系,我們立即糾正。
  • 7. 本站不保證下載資源的準(zhǔn)確性、安全性和完整性, 同時(shí)也不承擔(dān)用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。

最新文檔

評論

0/150

提交評論