1、荔枝云-PaaS 平臺統一管理規范(V1.2)江蘇省廣播電視總臺北京新奧特云視科技2015 年 7 月目錄第 1 章包規范8包81 . 1屬性說明8屬性格式91 . 2 基本信息9屬性說明9屬性格式10信息類型101 . 3屬性說明10屬性格式11文件類型111 . 4屬性說明11屬性格式131 . 5 音頻文件類型14屬性說明14屬性格式151 . 6 圖片文件類型16屬性說明16屬性格式171 . 7 圖形文件類型17屬性說明17屬性格式181 . 8 文稿類型19屬性說明19屬性格式201 . 9 其他文件類型20屬性說明20屬性格式211 . 10 視音頻出入點類型22屬性說明22屬性

2、格式221 . 11 TAG類型22屬性說明22屬性格式231 . 12 擴展屬性類型23屬性說明23屬性格式23第 2 章 調用說明242 . 1 概述242 . 2 請求結構說明24請求地址24公共參數25地址示例252 . 3 返回結果25第 3 章 接口認證263 . 1 獲取令牌26功能描述26接口地址26請求參數26返回參數26請求示例26返回示例27服務狀態碼列表273 . 2第 4 章 媒資服務28注入284 . 1FTP 上傳28斷點續傳28上傳進度4 . 2. 32功能描述32接口地址32參數說明32返回參數33請求示例33返回示例334 . 3. 34功能描述34接口地址

3、34參數說明34返回參數35請求示例35返回示例364 . 4. 37功能描述37接口地址37參數說明37返回參數37請求示例37返回示例384 . 5 按條件. 40功能描述40接口地址40參數說明40返回參數40請求示例41返回示例414 . 6 刪除. 43功能描述43接口地址43參數說明43返回參數44請求示例44返回示例444 . 7 更新包信息45功能描述45接口地址45參數說明45返回參數45請求示例45返回示例464 . 8 更新多文件信息新增47功能描述47接口地址47參數說明47返回參數48請求示例48返回示例494 . 9 更新多文件信息刪除49功能描述49接口地址50參

4、數說明50返回參數50請求示例50返回示例514 . 10. 51功能描述51接口地址51參數說明52返回參數52請求示例52返回示例52取消4 . 11. 53功能描述53接口地址53參數說明53返回參數53請求示例53返回示例54的用戶列表544 . 12功能描述54接口地址55參數說明55返回參數55請求示例55返回示例564 . 13 媒資服務狀態碼列表56第1章包規范本文檔中的所涉及的接口的主要是提供對于的云端處理服務，為了更好的實現統一管理和調度，荔枝云平臺遵照全臺網 2.0 的要求對于格式進行了統一的規范，本文檔中所涉及到云的服務都將遵從包規范的內容來實現。請在進行服務對接前，先

5、需要了解包的定義規范，以免影響您的工作進行。1.1包屬性說明包屬性含義包括對象、集合、屬性。一個包在進行構造時，必須根據“是否必填屬性”說明進行構造；一個包必須指定加入一個 baseInfo 屬性；其他屬性字段，根據具體業務參數進行構造即可。包構造時，對應的屬性需要根據屬性類型和屬性說明進行構造。屬性含義類型說明必填materialPackage對象無素材內容信息是baseInfo對象baseInfoType包基本信息是copyrightInfo對象copyrightInfoType信息否contentFiles對象無多文件信息否Files集合FileType文件信息否audioFiles集合

6、audioFileType音頻文件信息否imageFiles集合imageFileType圖片文件信息否graphFiles集合graphFileType圖形文件信息否scriptFiles集合scriptFileType文稿對象信息否otherFiles集合otherFileType其他文件信息否tagItems集合tagItemTypeTag集合否extendAttributes集合extentionAttributeType擴展屬性信息否屬性格式1.2 基本信息屬性說明屬性含義類型說明必填baseInfo對象無包基本信息是pkGUID屬性string包唯一標識否title屬性string

7、標題是origin屬性string來源否owner屬性string所有者是creator屬性string創建者是useRange屬性string使用范圍否language屬性string語種否version屬性string版本否#包格式“baseInfo”: 包基本信息 , “copyrightInfo”: 信息 , “contentFiles”: “Files”: 文件集合, “audioFiles”: 音頻文件集合, “imageFiles”: 圖片文件集合, “graphFiles”: 圖形文件集合, “scriptFiles”: 文稿集合, “otherFiles”: 其他文件集合“t

8、agItems”: 集合, “extendAttributes”: 擴展屬性集合屬性格式1.3信息類型屬性說明屬性含義類型說明必填#包基本信息“pkGUID”：”string”, “title”: “string”,“origin”: “string”,“owner”: “string”,“creator”: “string”, “useRange”: “string”, “language”: “string”, “version”: “string”, “createTime”: “string”, “revisionTime”: “string”, “status”: “string”,

9、 “mainFileGUID”: “string”, “mainFileType”: “string”, “description”: “string”createTime屬性string創建時間否revisionTime屬性string修訂時間否status屬性string包的狀態否mainFileGUID屬性string包中的主文件標識否mainFileType屬性string包中的主文件類型：、Audio、Image、Graph、Script、Other否description屬性string包整體描述否屬性格式1.4文件類型屬性說明屬性含義類型說明必填FileType對象無文件類型是r

10、elationCode屬性string關系標識（AndAudio、KeyFrame、HighLowBit 等）否#信息格式“materialOrigin”: “string”, “property”: “string”, “copyrightGrade”: “string”, “broadcastRights”: “string”, “distributionRights”: “string”, “period”: “string”copyrightInfo對象無信息類型是materialOrigin屬性string素材來源：、委托制作、制作、國內采購、海外引進、交流、其他否property屬

11、性string屬性：、合作、僅有權、衍生否copyrightGrade屬性string等級：一級：可可作素材可開發：可可作素材、三級：否broadcastRights屬性string權：地面頻道（有線、無線）、頻道、數字頻道、網絡寬頻、電視、移動電視、航空、其他否distributionRights屬性string權：國內模擬頻道（有線、無線、）、國內新、國際模擬頻道、國際新否period屬性string年限否relationType屬性string關系類型（/音頻、/關鍵幀、高碼/低碼等）否md5屬性string文件 MD5 值是terminalType屬性string終端類型（包含 pc、

12、mb、ott）等否GUID屬性string文件唯一標識否Name屬性string文件名稱是URL屬性string文件地址是Format屬性string文件格式否mediaType屬性string格式否Type集合string類型：高碼、低碼否column屬性string所屬欄目否compression屬性string壓縮格式否bitRate屬性string壓縮碼率(Kbps)否frameWidth屬性string畫面寬度否frameHeight屬性string畫面高度否resolution屬性string畫面寬高比（分辨率）否size屬性string素材大小(字節)否frames屬性strin

13、g素材長度(幀)否frameRate屬性string幀率(fps)否startPoint屬性string有效內容的起始時間否duration屬性string持續時間（時長）否Quality屬性string畫面質量，如：標清、超清否samplesFormat屬性string采樣格式否bitsPerPixel屬性string每像素位數否pixelFormat屬性string像素格式否dataRate屬性string數據碼率否scanMode屬性string掃描模式否gopSize屬性stringIBP 素材的 GOP 長度否bFrameCount屬性stringB 幀個數否pFrameCount屬

14、性stringP 幀個數否natureSound屬性string同期聲否status屬性string文件狀態否dataContent屬性string內容描述否isRelatedAudio屬性boolean是否有強關聯的音頻文件否isRelatedFrame屬性boolean是否有關鍵幀否markInfo集合markInfoType出入點集合否屬性格式#文件格式“relationCode”：”string”, “relationType”：”string”, “md5”：”string”, “terminalType”：“string”, “GUID”: “string”,“Name”: “st

15、ring”,“URI”: “string”,“Format”: “string”, “mediaType”: “string”, “Type”： “string”,“column”: “string”, “compression”: “string”, “bitRate”: “string”, “frameWidth”: “string”, “frameHeight”: “string”, “resolution”: “string”, “size”: “string”,“frames”: “string”, “frameRate”: “string”, “startPoint”: “stri

16、ng”, “duration”: “string”,“Quality”: “string”, “samplesFormat”: “string”, “bitsPerPixel”: “string”, “pixelFormat”: “string”,tagItems集合tagItemTypeTag集合否extendAttribute s集合extentionAttrib uteType擴展屬性集合否1.5 音頻文件類型屬性說明屬性含義類型說明必填audioFileType對象無音頻文件類型是relationCode屬性string關系標識（AndAudio、KeyFrame、HighLowBit

17、 等）否relationType屬性string關系類型（/音頻、/關鍵幀、高碼/低碼/轉碼等）否md5屬性string文件 MD5 值是audioGUID屬性string音頻文件唯一標識否audioName屬性string音頻文件名稱是audioURL屬性string音頻文件地址是audioFormat屬性string音頻文件格式否mediaType屬性string格式否column屬性string所屬欄目否size屬性string素材大小(字節)否“dataRate”: “string”, “scanMode”: “string”, “gopSize”: “string”, “bFrame

18、Count”: “string”, “pFrameCount”: “string”, “natureSound”: “string”, “status”: “string”, “dataContent”: “string”, “isRelatedAudio”: boolean, “isRelatedFrame”: boolean, “markInfo”: 出入點集合,“tagItems”: 集合, “extendAttributes”: 擴展屬性集合屬性格式#音頻文件格式“relationCode”：”string”, “relationType”：”string”, “md5”：”strin

19、g”, “audioGUID”: “string”, “audioName”: “string”, “audioURI”: “string”, “audioFormat”: “string”, “mediaType”: “string”, “column”: “string”,“size”: “string”, “startPoint”: “string”, “duration”: “string”, “channelNumber”: “string”, “samplesRate”: “string”, “bitsPerSample”: “string”, “status”: “string”

20、, “dataContent”: “string”, “markInfo”: 音頻出入點集合,startPoint屬性string有效內容起始時間否duration屬性string持續時間（時長）否channelNumber屬性string聲道數否samplesRate屬性string音頻采樣率否bitsPerSample屬性string量化位數否status屬性string音頻文件狀態否dataContent屬性string內容描述否markInfo集合markInfoType音頻出入點集合否tagItems集合tagItemTypeTag集合否extendAttribute s集合exte

21、ntionAttributeType擴展屬性集合否1.6 圖片文件類型屬性說明屬性含義類型說明必填imageFileType對象無圖片文件類型是relationCode屬性string關系標識（AndAudio、KeyFrame、HighLowBit 等）否relationType屬性string關系類型（/音頻、/關鍵幀、高碼/低碼/轉碼等）否md5屬性string文件 MD5 值是imageGUID屬性string圖片文件唯一標識否imageName屬性string圖片文件名稱是imageURL屬性string圖片文件地址是imageFormat屬性string圖片文件格式否mediaTy

22、pe屬性string格式否imageWidth屬性string畫面寬度否imageHeight屬性string畫面高度否resolution屬性string分辨率否size屬性string圖片大小(字節)否DPI屬性string打印分辨率否bitDepth屬性string位深度否dataContent屬性string內容描述否tagItems集合TagItemTypeTag集合否extendAttribute s集合ExtentionAttributeType擴展屬性集合否“tagItems”: 集合, “extendAttributes”: 擴展屬性集合屬性格式1.7 圖形文件類型屬性說明屬

23、性含義類型說明必填graphFileType對象無圖形文件類型是relationCode屬性string關系標識（AndAudio、KeyFrame、HighLowBit 等）否#圖片文件格式“relationCode”：”string”, “relationType”：”string”, “md5”：”string”, “imageGUID”: “string”, “imageName”: “string”, “imageURI”: “string”, “imageFormat”: “string”, “mediaType”: “string”, “imageWidth”: “string”

24、, “imageHeight”: “string”, “resolution”: “string”, “size”: “string”,“DPI”: “string”, “bitDepth”: “string”, “dataContent”: “string”, “tagItems”: 集合,“extendAttributes”: 擴展屬性集合屬性格式#圖形文件格式“relationCode”：”string”, “relationType”：”string”, “md5”：”string”, “graphGUID”: “string”, “graphName”: “string”, “gra

25、phURI”: “string”, “graphFormat”: “string”, “mediaType”: “string”, “size”: “string”, “dataContent”: “string”, “tagItems”: 集合, “extendAttributes”: 擴展屬性集合relationType屬性string關系類型（/音頻、/關鍵幀、高碼/低碼/轉碼等）否md5屬性string文件 MD5 值是graphGUID屬性string圖形文件唯一標識否graphName屬性string圖形文件名稱是graphURL屬性string圖形文件地址是graphFormat

26、屬性string圖形文件格式否mediaType屬性string格式否size屬性string圖片大小(字節)否dataContent屬性string內容描述否tagItems集合tagItemTypeTag集合否extendAttributes集合extentionAttributeType擴展屬性集合否1.8 文稿類型屬性說明屬性含義類型說明必填scriptFileType對象無文稿類型是relationCode屬性string關系標識（AndAudio、KeyFrame、HighLowBit等）否relationType屬性string關系類型（/音頻、/關鍵幀、高碼/低碼/轉碼等）否m

27、d5屬性string文件 MD5 值是scriptGUID屬性string稿件的唯一標識，可用 GUID 表示否scriptTitle屬性string稿件標題是scriptName屬性string稿件名稱是ScriptURL屬性string稿件地址是scriptFormat屬性string稿件格式否mediaType屬性string格式否size屬性long稿件大小(字節)是version屬性string稿件版本否type屬性string稿件類型：選題稿件、通稿、欄目稿件、空標題否source屬性string稿件來源：路透稿件、回傳稿件等否author屬性string發稿人否publishTi

28、me屬性string發稿時間否broadcastTime屬性string時間否wordCount屬性string字數否content屬性string稿件內容否tagItems集合tagItemTypeTag集合否extendAttribute s集合extentionAttribute Type擴展屬性集合否屬性格式1.9 其他文件類型屬性說明屬性含義類型說明必填otherFileType對象無其他文件類型是#文稿格式“relationCode”：”string”, “relationType”：”string”, “md5”：”string”, “scriptGUID”: “string”,

29、 “scriptTitle”: “string”, “scriptName”: “string”, “scriptURI”: “string”, “scriptFormat”: “string”, “mediaType”: “string”, “size”: long,“version”: “string”,“type”: “string”,“source”: “string”,“author”: “string”, “publishTime”: “string”, “broadcastTime”: “string”, “wordCount”: “string”, “content”: “st

30、ring”,“tagItems”: 集合, “extendAttributes”: 擴展屬性集合屬性格式#其他文件格式“relationCode”：”string”, “relationType”：”string”, “md5”：”string”, “fileGUID”: “string”, “fileName”: “string”, “fileURI”: “string”, “fileFormat”: “string”, “size”: “string”, “dataContent”: “string”, “tagItems”: 集合,“extendAttributes”: 擴展屬性集合re

31、lationCod e屬性string關系標識（AndAudio、KeyFrame、HighLowBit 等）否relationType屬性string關系類型（/音頻/關鍵幀、高碼/低碼/轉碼等）否md5屬性string文件 MD5 值是fileGUID屬性string文件唯一標識否fileName屬性string文件名稱是fileURL屬性string文件地址是fileFormat屬性string文件格式否size屬性string文件大小(字節)否dataContent屬性string內容描述否tagItems集合tagItemTypeTag集合否extendAttrib utes集合ex

32、tentionAttribute Type擴展屬性集合否1.10 視音頻出入點類型屬性說明屬性格式1.11 Tag類型屬性說明屬性含義類型說明必填tagItemType對象無Tag類型是tagName屬性string名稱否keyword屬性string關鍵字否tagTime屬性string時間否description屬性string描述否#出入點信息格式“markIn”: “string”,“markOut”: “string”, “markContent”: “string”屬性含義類型說明必填markInfoType對象無出入點信息類型是markIn屬性string入點否markOut屬性

33、string出點否markContent屬性string標記內容否屬性格式1.12 擴展屬性類型屬性說明屬性格式#擴展屬性格式“itemCode”: “string”, “itemName”: “string”, “value”: “string”屬性含義類型說明必填extentionAttributeType對象無擴展屬性類型是itemCode屬性string擴展項標識否itemName屬性string擴展項名稱否value屬性string擴展項取值否#Tag格式“tagName”: “string”,“keyword”: “string”,“tagTime”: “string”, “des

34、cription”: “string”第2章 調用說明2.1 概述歡迎使用荔枝云-PaaS 平臺云服務。用戶可以使用本文檔介紹的 API 對荔枝云-PaaS 平臺云服務進行相關操作。對于接口的首先要獲取令牌，每次請求都需要驗證令牌信息，如果超過兩個小時沒有使用，令牌信息將過期，需要重新申領令牌。對荔枝云-PaaS 平臺接口調用是通過向荔枝云-PaaS 平臺的服務端地址HTTPPOST 請求，并按照接口說明在請求中加入相應請求參數；根據請求的處理情況，系統會返回處理結果。2.2 請求結構說明請求地址荔枝云-PaaS 平臺的服務接入地址規則：http:/公共參數接口地址地址由三部分組成：域名：服務

35、所提供的內容。公共參數：參考公共參數說明中的內容說明，由系統統一進行分配，用戶調用接口時按分配的內容進行填寫。接口地址：服務提供的內容。注：所有參數項必須傳遞，非必填項的值可為空，所有參數區分大小寫。請求及返回結果都使用 UTF-8 字符集進行編碼。公共參數地址示例獲取令牌的接口地址。http:/appCode/versionId/companyId/userId/serviceCode/auth/token/getAccessToken/【第一部分】【第二部分】接口地址分為兩個部分，第一部分是公共請求參數，必含項。第二部分是具體服務的接口地址。2.3 返回結果“code”:”,#狀態碼, 參

36、照附錄“message”:”,#描述信息“data”:“key”:”value”,“key”:”value”#結果數據，詳情查看各接口返回參數屬性含義類型說明必填appCode應用標識String應用唯一標識（由荔枝云平臺提供）是versionId版本號String接口版本號，當前版本號為 V1是companyId企業標識String企業唯一標識（由荔枝云平臺提供）是userId用戶標識String用戶唯一標識（用戶填充）是serviceCode服務類型標識String服務類型唯一標識（由荔枝云平臺提供）是第3章 接口認證3.1 獲取令牌功能描述荔枝云-PaaS 平臺的服務會對每個的請求進行驗

37、證，需要在請求中帶上令牌信息。此接口是以 OAuth2.0 模式實現認證和。令牌的獲取方式：用戶傳遞的應用標識、版本號、企業標識、服務標識、密鑰和時間戳生成相應的令牌，該令牌有效時長為 2 小時。接口地址auth/token/getAccessToken/請求參數返回參數請求示例POST屬性含義類型說明accessToken令牌String有時效性的令牌屬性含義類型說明必填accessKey密鑰String密鑰（此密鑰由荔枝云平臺提供，需）是timeStamp時間戳String請求接口時，請求方當前時間毫秒數是返回示例3.2服務狀態碼列表代碼描述說明0Success操作1Authorizati

38、on fail獲取失敗“code”:“0”,“message”:“”, “data”：“accessToken”:”05784E32D86340D976677714905E6D53B2E041F124A3D1603BAAD66E21880EE5”/appCode/versionId/companyId/userId/serviceCode/auth/token/getAccessTok en/User-Agent: curl/7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1 OpenSSL/0.9.7a zlib/ libidn/0.

39、5.6Pragma: no-cache Accept: */*Host:Content-Type:application/x-www-form-urlencoded Content-Length:XaccessKey=0A3D1603BAAD66E21880EE5&timeStamp=1435642027第4章 媒資服務4.1注入FTP 上傳1)功能描述向用戶提供 ftp 服務，供用戶執行上傳多文件。ftp 服務信息由荔枝云平臺提供。用戶首先將、音頻、圖片、文稿等類型通過 ftp 方式上傳到指定目錄；在進行時，對應的地址填寫為 ftp路徑。2)接口地址ftp:/用戶名:ip3)參數說明

40、斷點續傳l 獲取令牌1)功能描述參數含義類型說明必填ftpUser用戶名StringFTP 服務的用戶名（由荔枝云平臺提供）是ftpPwdStringFTP 服務的（由荔枝云平臺提供）是ip服務器ip 地址StringFTP 服務器 ip 地址（由荔枝云平臺提供）是根據用戶提供的素材名稱、素材大小（字節數）、公共參數信息，獲取素材斷點續傳的上傳令牌 。獲取素材上傳令牌時，必須首先獲取令牌（見獲取令牌），令牌保證當前請求的有效性。2)接口地址rms/material/getUploadToken/3)參數說明4)返回參數5)請求示例POST/rms/upload/getUploadToken/U

41、ser-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: */*參數含義類型說明uploadToken上傳令牌String上傳令牌參數含義類型說明必填accessToken令牌String獲取令牌接口返回的令牌是timeStamp時間戳String請求接口時，請求方當前時間毫秒數是materialName素材名稱String名稱是materialLengt h素材大小String大小是appCod

42、e應用標識String應用標識（由荔枝云平臺提供）是versionId版本號String當前版本號（默認為 v1）是companyId標識String標識（由荔枝云平臺提供）是userId用戶標識String用戶標識是serviceCode服務標識String服務標識（由荔枝云平臺提供）是6)返回示例l 文件上傳1)功能描述進行文件上傳時，必須首先獲取請求的有效性。令牌（見獲取令牌），令牌保證當前其次調用斷點續傳之獲取上傳令牌協議（見斷點續傳）獲取上傳令牌。然后根據用戶提供的上傳令牌、公共參數信息與文件流，實現文件斷點續能。2)接口地址rms/material/uploadStream/3)參

43、數說明“code”:“0”,#狀態碼，參照附錄“message”:“”,#描述信息“data”：“uploadToken”:” a23ssdfg123456sdf4567s34523” #上傳令牌Host:Content-Type:application/x-www-form-urlencoded Content-Length:XaccessToken=05784E32D86340D976677714905E6D53B2E041F124A3D1603BAAD66E21880EE5&timeStamp=1435642027&materialName=中國歷史&materi

44、alLength=3041088&appCode=api&versionId=3.0&companyId=54c6f 3022a80fc1e70ff553b&userId=54c6f9582a80fc1e70ff5575&serviceCode=vms4)返回參數5)請求示例6)返回示例POST/rms/material/getUploadProgress/User-Agent: curl/7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1 OpenSSL/0.9.7a zlib/ libidn/

45、0.5.6Pragma: no-cache Accept: */*Host:Content-Type:multipart/form-data Content-Length:XaccessToken=05784E32D86340D976677714905E6D53B2E041F124A3D1603BAAD66E21880EE5&timeStamp=1435642027&uploadToken=A869055733_3041088_54c6f9582a80fc1e70ff5575&appCode=api&versionId=3.0&companyId=54c6