test-download

更新時間：2022-05-24 09:27:17

簡介

標題：點播API介面文件

簡介：點播系統對外 API 介面文件

聯絡人

介面路徑：/v2/api-docs

上傳影片介面

介面說明:上傳影片介面(登記影片資訊，並以 POST 方式上傳影片)

介面位址:/vod/v1/video/upload/post

請求方式：post

consumes:["multipart/form-data"]

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必須	類型
appId	應用ID	query	true	string
audioBitRate	音訊碼率：Kbps	query	false	integer
audioChannelLayout	音訊聲道：stereo	query	false	string
audioChannels	音訊聲道數：2	query	false	integer
audioCodecName	音訊解碼庫：aac	query	false	string
audioProfile	音訊配置：HE-AAC	query	false	string
audioSampleFmt	音訊取樣格式：fltp	query	false	string
audioSampleRate	音訊取樣率：22050	query	false	integer
categoryId	所屬分類ID	query	false	integer
coverBucketName	封面圖片所在的空間或群組名稱	query	false	string
coverFileName	封面圖片檔案名稱	query	false	string
coverStorageSystem	封面圖片使用的儲存系統	query	false	string
deptId	所屬部門ID	query	false	integer
description	影片描述	query	false	string
displayAspectRatio	顯示寬高比：16:9	query	false	string
duration	播放時長：秒	query	false	integer
extJson	擴充資訊，JSON格式	query	false	string
file	影片檔案	formData	true	file
gmtCreate	建立時間	query	false	string
gmtModified	最後修改時間	query	false	string
id	主鍵ID	query	false	integer
isAudio	是否純音訊	query	false	boolean
isDeleted	是否已刪除：0、1	query	false	boolean
isEncrypted	是否需要加密	query	false	boolean
isScreen	是否錄屏優化	query	false	boolean
isTranscoding	是否需要轉碼	query	false	boolean
originalDefinition	原始解析度：1280x720	query	false	string
originalHeight	原始影片解析度：高	query	false	integer
originalWidth	原始影片解析度：寬	query	false	integer
sign	簽名驗證的參數，生成規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
sourceExtension	原始檔案副檔名	query	false	string
sourceFileName	原始檔案名稱	query	false	string
sourceFileSize	原始檔案大小：Bytes	query	false	integer
sourceMd5sum	原始檔案MD5校驗碼	query	false	string
status	影片狀態	query	false	string
tag1	標籤1	query	false	string
tag2	標籤2	query	false	string
tag3	標籤3	query	false	string
timestamp	13位時間戳	query	true	string
title	影片標題	query	false	string
transGroupId	使用的轉碼模板群組ID	query	false	integer
transGroupName	使用的轉碼模板群組名稱	query	false	string
uploadChannel	上傳渠道	query	false	string
uploadClient	上傳客戶端IP	query	false	string
uploadServer	上傳伺服器	query	false	string
uploadTime	上傳時間	query	false	string
userId	所屬使用者ID	query	false	integer
vid	影片字串ID	query	false	string
videoAvgFrameRate	影片平均幀率，	query	false	string
videoBitRate	影片碼率：Kbps	query	false	integer
videoCodecName	影片解碼庫：h264	query	false	string
videoLevel	影片編碼level：	query	false	integer
videoNbFrames	影片總幀數	query	false	integer
videoProfile	影片編碼配置：high	query	false	string
videoRotate	旋轉角度	query	false	string

回應資料:

{
    "code": 0,
    "data": {
        "audioBitRate": 0,
        "audioChannelLayout": "",
        "audioChannels": 0,
        "audioCodecName": "",
        "audioProfile": "",
        "audioSampleFmt": "",
        "audioSampleRate": 0,
        "categoryId": 0,
        "coverBucketName": "",
        "coverFileName": "",
        "coverStorageSystem": "",
        "deptId": 0,
        "description": "",
        "displayAspectRatio": "",
        "duration": 0,
        "extJson": "",
        "gmtCreate": "",
        "gmtModified": "",
        "id": 0,
        "isAudio": true,
        "isDeleted": true,
        "isEncrypted": true,
        "isScreen": true,
        "isTranscoding": true,
        "originalDefinition": "",
        "originalHeight": 0,
        "originalWidth": 0,
        "sourceExtension": "",
        "sourceFileName": "",
        "sourceFileSize": 0,
        "sourceMd5sum": "",
        "status": "",
        "tag1": "",
        "tag2": "",
        "tag3": "",
        "title": "",
        "transGroupId": 0,
        "transGroupName": "",
        "uploadChannel": "",
        "uploadClient": "",
        "uploadServer": "",
        "uploadTime": "",
        "userId": 0,
        "vid": "",
        "videoAvgFrameRate": "",
        "videoBitRate": 0,
        "videoCodecName": "",
        "videoLevel": 0,
        "videoNbFrames": 0,
        "videoProfile": "",
        "videoRotate": ""
    },
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型	schema
code	HTTP 回應狀態碼.	int32
data	成功回傳資料.	string	Video
message	錯誤訊息.	string
status	請求狀態，成功："success"，失敗："fail", 錯誤："error".	string

schema 屬性說明 Video

參數名稱	說明	類型
audioBitRate	音訊碼率：Kbps 欄位：audio_bit_rate	int32
audioChannelLayout	音訊聲道：stereo 欄位：audio_channel_layout	string
audioChannels	音訊聲道數：2 欄位：audio_channels	int32
audioCodecName	音訊解碼庫：aac 欄位：audio_codec_name	string
audioProfile	音訊配置：HE-AAC 欄位：audio_profile	string
audioSampleFmt	音訊取樣格式：fltp 欄位：audio_sample_fmt	string
audioSampleRate	音訊取樣率：22050 欄位：audio_sample_rate	int32
categoryId	所屬分類ID 欄位：category_id	int64
coverBucketName	封面圖片所在的空間或群組名稱欄位：cover_bucket_name	string
coverFileName	封面圖片檔案名稱欄位：cover_file_name	string
coverStorageSystem	封面圖片使用的儲存系統欄位：cover_storage_system	string
deptId	所屬部門ID 欄位：dept_id	int64
description	影片描述欄位：description	string
displayAspectRatio	顯示寬高比：16:9 欄位：display_aspect_ratio	string
duration	播放時長：秒欄位：duration	int32
extJson	擴充資訊，JSON格式欄位：ext_json	string
gmtCreate	建立時間欄位：gmt_create	date-time
gmtModified	最後修改時間欄位：gmt_modified	date-time
id	主鍵ID 欄位：id	int64
isAudio	是否純音訊欄位：is_audio	boolean
isDeleted	是否已刪除：0、1 欄位：is_deleted	boolean
isEncrypted	是否需要加密欄位：is_encrypted	boolean
isScreen	是否錄屏優化欄位：is_screen	boolean
isTranscoding	是否需要轉碼欄位：is_transcoding	boolean
originalDefinition	原始解析度：1280x720 欄位：original_definition	string
originalHeight	原始影片解析度：高欄位：original_height	int32
originalWidth	原始影片解析度：寬欄位：original_width	int32
sourceExtension	原始檔案副檔名欄位：source_extension	string
sourceFileName	原始檔案名稱欄位：source_file_name	string
sourceFileSize	原始檔案大小：Bytes 欄位：source_file_size	int64
sourceMd5sum	原始檔案MD5校驗碼欄位：source_md5sum	string
status	影片狀態欄位：status	string
tag1	標籤1 欄位：tag1	string
tag2	標籤2 欄位：tag2	string
tag3	標籤3 欄位：tag3	string
title	影片標題欄位：title	string
transGroupId	使用的轉碼模板群組ID 欄位：trans_group_id	int64
transGroupName	使用的轉碼模板群組名稱欄位：trans_group_name	string
uploadChannel	上傳渠道欄位：upload_channel	string
uploadClient	上傳客戶端IP 欄位：upload_client	string
uploadServer	上傳伺服器欄位：upload_server	string
uploadTime	上傳時間欄位：upload_time	date-time
userId	所屬使用者ID 欄位：user_id	int64
vid	影片字串ID 欄位：vid	string
videoAvgFrameRate	影片平均幀率， "30000/1001", 欄位：video_avg_frame_rate	string
videoBitRate	影片碼率：Kbps 欄位：video_bit_rate	int32
videoCodecName	影片解碼庫：h264 欄位：video_codec_name	string
videoLevel	影片編碼level： 31 欄位：video_level	int32
videoNbFrames	影片總幀數欄位：video_nb_frames	int32
videoProfile	影片編碼配置：high 欄位：video_profile	string
videoRotate	旋轉角度欄位：video_rotate	string

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2«Video»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

上傳影片介面

介面說明:上傳影片介面(登記影片資訊，並以 POST 的方式上傳影片)

介面位址:/vod/v1/video/upload/post

請求方式：options

consumes:["multipart/form-data"]

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必須	類型
appId	應用ID	query	true	string
audioBitRate	音訊碼率：Kbps	query	false	integer
audioChannelLayout	音訊聲道：stereo	query	false	string
audioChannels	音訊聲道數：2	query	false	integer
audioCodecName	音訊解碼庫：aac	query	false	string
audioProfile	音訊配置：HE-AAC	query	false	string
audioSampleFmt	音訊取樣格式：fltp	query	false	string
audioSampleRate	音訊取樣率：22050	query	false	integer
categoryId	所屬分類ID	query	false	integer
coverBucketName	封面圖片所在的空間或群組名稱	query	false	string
coverFileName	封面圖片檔案名稱	query	false	string
coverStorageSystem	封面圖片使用的儲存系統	query	false	string
deptId	所屬部門ID	query	false	integer
description	影片描述	query	false	string
displayAspectRatio	顯示寬高比：16:9	query	false	string
duration	播放時長：秒	query	false	integer
extJson	擴充資訊，JSON格式	query	false	string
file	影片檔案	formData	true	file
gmtCreate	建立時間	query	false	string
gmtModified	最後修改時間	query	false	string
id	主鍵ID	query	false	integer
isAudio	是否純音訊	query	false	boolean
isDeleted	是否已刪除：0、1	query	false	boolean
isEncrypted	是否需要加密	query	false	boolean
isScreen	是否錄屏優化	query	false	boolean
isTranscoding	是否需要轉碼	query	false	boolean
originalDefinition	原始解析度：1280x720	query	false	string
originalHeight	原始影片解析度：高	query	false	integer
originalWidth	原始影片解析度：寬	query	false	integer
sign	簽名驗證的參數，生成規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
sourceExtension	原始檔案副檔名	query	false	string
sourceFileName	原始檔案名稱	query	false	string
sourceFileSize	原始檔案大小：Bytes	query	false	integer
sourceMd5sum	原始檔案MD5校驗碼	query	false	string
status	影片狀態	query	false	string
tag1	標籤1	query	false	string
tag2	標籤2	query	false	string
tag3	標籤3	query	false	string
timestamp	13位時間戳	query	true	string
title	影片標題	query	false	string
transGroupId	使用的轉碼模板群組ID	query	false	integer
transGroupName	使用的轉碼模板群組名稱	query	false	string
uploadChannel	上傳渠道	query	false	string
uploadClient	上傳客戶端IP	query	false	string
uploadServer	上傳伺服器	query	false	string
uploadTime	上傳時間	query	false	string
userId	所屬使用者ID	query	false	integer
vid	影片字串ID	query	false	string
videoAvgFrameRate	影片平均幀率，	query	false	string
videoBitRate	影片碼率：Kbps	query	false	integer
videoCodecName	影片解碼庫：h264	query	false	string
videoLevel	影片編碼level：	query	false	integer
videoNbFrames	影片總幀數	query	false	integer
videoProfile	影片編碼配置：high	query	false	string
videoRotate	旋轉角度	query	false	string

回應資料:

{
    "code": 0,
    "data": {
        "audioBitRate": 0,
        "audioChannelLayout": "",
        "audioChannels": 0,
        "audioCodecName": "",
        "audioProfile": "",
        "audioSampleFmt": "",
        "audioSampleRate": 0,
        "categoryId": 0,
        "coverBucketName": "",
        "coverFileName": "",
        "coverStorageSystem": "",
        "deptId": 0,
        "description": "",
        "displayAspectRatio": "",
        "duration": 0,
        "extJson": "",
        "gmtCreate": "",
        "gmtModified": "",
        "id": 0,
        "isAudio": true,
        "isDeleted": true,
        "isEncrypted": true,
        "isScreen": true,
        "isTranscoding": true,
        "originalDefinition": "",
        "originalHeight": 0,
        "originalWidth": 0,
        "sourceExtension": "",
        "sourceFileName": "",
        "sourceFileSize": 0,
        "sourceMd5sum": "",
        "status": "",
        "tag1": "",
        "tag2": "",
        "tag3": "",
        "title": "",
        "transGroupId": 0,
        "transGroupName": "",
        "uploadChannel": "",
        "uploadClient": "",
        "uploadServer": "",
        "uploadTime": "",
        "userId": 0,
        "vid": "",
        "videoAvgFrameRate": "",
        "videoBitRate": 0,
        "videoCodecName": "",
        "videoLevel": 0,
        "videoNbFrames": 0,
        "videoProfile": "",
        "videoRotate": ""
    },
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型	schema
code	HTTP 回應狀態碼。	int32
data	成功回傳資料。	string	Video
message	錯誤訊息。	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error"。	string

schema 屬性說明 Video

參數名稱	說明	類型
audioBitRate	音訊碼率：Kbps 欄位：audio_bit_rate	int32
audioChannelLayout	音訊聲道：stereo 欄位：audio_channel_layout	string
audioChannels	音訊聲道數：2 欄位：audio_channels	int32
audioCodecName	音訊解碼庫：aac 欄位：audio_codec_name	string
audioProfile	音訊設定檔：HE-AAC 欄位：audio_profile	string
audioSampleFmt	音訊取樣格式：fltp 欄位：audio_sample_fmt	string
audioSampleRate	音訊取樣率：22050 欄位：audio_sample_rate	int32
categoryId	所屬分類ID 欄位：category_id	int64
coverBucketName	封面圖片所在的空間或群組名稱欄位：cover_bucket_name	string
coverFileName	封面圖片檔案名稱欄位：cover_file_name	string
coverStorageSystem	封面圖片使用的儲存系統欄位：cover_storage_system	string
deptId	所屬部門ID 欄位：dept_id	int64
description	影片描述欄位：description	string
displayAspectRatio	顯示寬高比：16:9 欄位：display_aspect_ratio	string
duration	播放長度：秒欄位：duration	int32
extJson	擴充資訊，JSON格式欄位：ext_json	string
gmtCreate	建立時間欄位：gmt_create	date-time
gmtModified	最後修改時間欄位：gmt_modified	date-time
id	主鍵ID 欄位：id	int64
isAudio	是否純音訊欄位：is_audio	boolean
isDeleted	是否已刪除：0、1 欄位：is_deleted	boolean
isEncrypted	是否需要加密欄位：is_encrypted	boolean
isScreen	是否錄製螢幕優化欄位：is_screen	boolean
isTranscoding	是否需要轉碼欄位：is_transcoding	boolean
originalDefinition	原始解析度：1280x720 欄位：original_definition	string
originalHeight	原始影片解析度：高欄位：original_height	int32
originalWidth	原始影片解析度：寬欄位：original_width	int32
sourceExtension	原始檔案副檔名欄位：source_extension	string
sourceFileName	原始檔案名稱欄位：source_file_name	string
sourceFileSize	原始檔案大小：Bytes 欄位：source_file_size	int64
sourceMd5sum	原始檔案MD5校驗碼欄位：source_md5sum	string
status	影片狀態欄位：status	string
tag1	標籤1 欄位：tag1	string
tag2	標籤2 欄位：tag2	string
tag3	標籤3 欄位：tag3	string
title	影片標題欄位：title	string
transGroupId	使用的轉碼模板群組ID 欄位：trans_group_id	int64
transGroupName	使用的轉碼模板群組名稱欄位：trans_group_name	string
uploadChannel	上傳管道欄位：upload_channel	string
uploadClient	上傳客戶端IP 欄位：upload_client	string
uploadServer	上傳伺服器欄位：upload_server	string
uploadTime	上傳時間欄位：upload_time	date-time
userId	所屬使用者ID 欄位：user_id	int64
vid	影片字串ID 欄位：vid	string
videoAvgFrameRate	影片平均幀率， "30000/1001", 欄位：video_avg_frame_rate	string
videoBitRate	影片碼率：Kbps 欄位：video_bit_rate	int32
videoCodecName	影片解碼庫：h264 欄位：video_codec_name	string
videoLevel	影片編碼等級： 31 欄位：video_level	int32
videoNbFrames	影片總幀數欄位：video_nb_frames	int32
videoProfile	影片編碼設定檔：high 欄位：video_profile	string
videoRotate	旋轉角度欄位：video_rotate	string

回應狀態碼說明：

狀態碼	說明	schema
200	OK	WrappedResponseV2«Video»
204	無內容
401	未經授權
403	禁止存取

子帳號管理相關介面

新增子帳號

介面說明:

介面位址:/vod/v1/account/add

請求方式：post

consumes:["application/json"]

produces:["*/*"]

請求參數：

參數名稱	說明	in	是否必須	類型
appId	應用ID	query	true	string
email	子帳號電子郵件	query	true	string
name	子帳號名稱	query	true	string
password	子帳號密碼	query	true	string
roleId	角色ID	query	true	integer
sign	簽名驗證的參數，生成規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
status	狀態（Y/N）	query	true	string
timestamp	13位時間戳	query	true	string
viewAllVideosEnabled	是否有全部影片權限（Y/N）	query	true	string

回應資料:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型
code	HTTP 回應狀態碼.	int32
data	成功回傳資料.	object
message	錯誤訊息.	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error".	string

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

刪除子帳號

介面說明:

介面位址:/vod/v1/account/delete

請求方式：post

consumes:["application/json"]

produces:["*/*"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用ID	query	true	string
childUserId	要刪除的子帳號ID	body	false	integer
sign	簽章驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
timestamp	13位元時間戳	query	true	string

回應資料:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型
code	HTTP 回應狀態碼.	int32
data	成功回傳資料.	object
message	錯誤訊息.	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error".	string

回應狀態碼說明：

狀態碼	說明	schema
200	OK	WrappedResponseV2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

根據子帳號ID取得子帳號資訊

介面說明:

介面位址:/vod/v1/account/get

請求方式：get

consumes:``

produces:["*/*"]

請求參數：

參數名稱	說明	in	是否必須	類型
appId	應用ID	query	true	string
childUserId	子帳號ID	query	true	integer
sign	簽章驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典順序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
timestamp	13位時間戳	query	true	string

回應資料:

{
    "code": 0,
    "data": {
        "childEmail": "",
        "childUserId": 0,
        "childUsername": "",
        "createdTime": "",
        "lastModified": "",
        "roleId": 0,
        "roleName": "",
        "status": "",
        "userId": 0,
        "viewAllVideosEnabled": ""
    },
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型	schema
code	HTTP 回應狀態碼.	int32
data	成功回傳資料.	string	UserChildrenDTO
message	錯誤訊息.	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error".	string

schema 屬性說明 UserChildrenDTO

參數名稱	說明	類型
childEmail	子帳號電子郵件	string
childUserId	子帳號使用者 ID	int64
childUsername	子帳號名稱	string
createdTime	建立時間	date-time
lastModified	更新時間	date-time
roleId	角色 ID	int64
roleName	角色名稱	string
status	帳號狀態(Y/N)	string
userId	主帳號使用者 ID	int64
viewAllVideosEnabled	是否顯示全部影片(Y/N)	string

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2«UserChildrenDTO»
401	Unauthorized
403	Forbidden
404	Not Found

分頁取得子帳號列表

介面說明:

介面位址:/vod/v1/account/list

請求方式：get

consumes:``

produces:["*/*"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用ID	query	true	string
page	頁碼	query	false	integer
pageSize	每頁大小	query	false	integer
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典順序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
timestamp	13位時間戳	query	true	string

回應資料:

{
    "code": 0,
    "data": {
        "contents": [
            {
                "childEmail": "",
                "childUserId": 0,
                "childUsername": "",
                "createdTime": "",
                "lastModified": "",
                "roleId": 0,
                "roleName": "",
                "status": "",
                "userId": 0,
                "viewAllVideosEnabled": ""
            }
        ],
        "endRow": 0,
        "firstPage": true,
        "lastPage": true,
        "limit": 0,
        "nextPageNumber": 0,
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 0,
        "prePageNumber": 0,
        "startRow": 0,
        "totalItems": 0,
        "totalPages": 0
    },
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型	schema
code	HTTP 回應狀態碼.	int32
data	成功回傳資料.	string	Paginator«UserChildrenDTO»
message	錯誤訊息.	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error".	string

schema 屬性說明

Paginator«UserChildrenDTO»

參數名稱	說明	類型	schema
contents	當前頁的內容。	array	UserChildrenDTO
endRow	結束行。	int32
firstPage	是否為第一頁	boolean
lastPage	是否為最後一頁	boolean
limit	資料庫的 limit	int32
nextPageNumber	下一頁頁標。	int32
offset	資料庫的 offset	int32
pageNumber	當前頁。	int32
pageSize	每頁最多顯示的記錄數。	int32
prePageNumber	上一頁頁標。	int32
startRow	開始行。	int32
totalItems	總記錄數。	int32
totalPages	總頁數	int32

UserChildrenDTO

參數名稱	說明	類型
childEmail	子帳號電子郵件	string
childUserId	子帳號使用者 ID	int64
childUsername	子帳號名稱	string
createdTime	建立時間	date-time
lastModified	更新時間	date-time
roleId	角色 ID	int64
roleName	角色名稱	string
status	帳號狀態(Y/N)	string
userId	主帳號使用者 ID	int64
viewAllVideosEnabled	是否顯示全部影片(Y/N)	string

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2«Paginator«UserChildrenDTO»»
401	未授權
403	禁止存取
404	找不到資源

取得角色列表

介面說明:

介面位址:/vod/v1/account/role/list

請求方式：get

consumes:``

produces:["*/*"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用ID	query	true	string
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
timestamp	13位時間戳	query	true	string

回應資料:

{
    "code": 0,
    "data": [
        {
            "id": 0,
            "name": ""
        }
    ],
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型	schema
code	HTTP 回應狀態碼.	int32
data	成功回傳資料.	array	角色物件
message	錯誤訊息.	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error".	string

schema 屬性說明

角色物件

參數名稱	說明	類型	schema
id	角色ID	int64
name	角色名稱	string

回應狀態碼說明：

狀態碼	說明	schema
200	OK	WrappedResponseV2«List«角色物件»»
401	未授權
403	禁止存取
404	找不到

更新子帳號資訊

介面說明:

介面位址:/vod/v1/account/update

請求方式：post

consumes:["application/json"]

produces:["*/*"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用ID	query	true	string
childUserId	子帳號用戶ID	body	true	integer
isChangePassword	是否修改密碼	body	true	string
name	子帳號名稱	body	true	string
password	密碼	body	false	string
roleId	角色ID	body	false	integer
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
status	狀態（Y/N）	body	false	string
timestamp	13位時間戳	query	true	string
viewAllVideosEnabled	是否有全部影片權限（Y/N）	body	false	string

回應資料:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型
code	HTTP 回應狀態碼。	int32
data	成功回傳資料。	object
message	錯誤訊息。	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error"。	string

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2
201	已建立
401	未經授權
403	禁止存取
404	找不到資源

字幕上傳介面

刪除字幕

介面說明：刪除字幕介面

介面位址:/vod/v1/video/srt/delete

請求方式：post

consumes:["application/json"]

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用ID	query	true	string
id	字幕ID	query	true	string
sign	簽章驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
timestamp	13位時間戳	query	true	string
videoId	影片ID	query	true	integer

回應資料:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型
code	HTTP 回應狀態碼。	int32
data	成功回傳資料。	object
message	錯誤訊息。	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error"。	string

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

修改字幕名稱介面

介面說明：修改字幕名稱介面

接口地址:/vod/v1/video/srt/edit

請求方式：post

consumes:["application/json"]

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用ID	query	true	string
id	字幕ID	query	true	string
name	字幕名稱	query	true	string
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
timestamp	13位時間戳	query	true	string
videoId	影片ID	query	true	integer

回應資料:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型
code	HTTP 回應狀態碼。	int32
data	成功回傳資料。	object
message	錯誤訊息。	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error"。	string

回應狀態碼說明：

狀態碼	說明	schema
200	OK	WrappedResponseV2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

取得字幕列表介面

介面說明:取得字幕列表介面

介面位址:/vod/v1/video/srt/list

請求方式：get

consumes:``

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用ID	query	true	string
sign	簽章驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
timestamp	13位時間戳	query	true	string
videoId	影片ID	query	true	integer

回應資料:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型
code	HTTP 回應狀態碼。	int32
data	成功回傳資料。	object
message	錯誤訊息。	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error"。	string

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2
401	Unauthorized
403	Forbidden
404	Not Found

字幕上傳介面

介面說明：字幕上傳介面

介面位址:/vod/v1/video/srt/upload

請求方式：post

consumes:["multipart/form-data"]

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用ID	query	true	string
file	檔案	formData	true	file
name	字幕名稱	query	true	string
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
timestamp	13位時間戳	query	true	string
videoId	影片ID	query	true	integer

回應資料:

{
    "code": 0,
    "data": [
        {
            "id": "",
            "name": "",
            "url": ""
        }
    ],
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型	schema
code	HTTP 回應狀態碼。	int32
data	成功回傳資料。	array	SrtDTO
message	錯誤訊息。	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error"。	string

schema 屬性說明

SrtDTO

參數名稱	說明	類型
id	字幕ID	string
name	字幕名稱	string
url	字幕位址	string

回應狀態碼說明：

狀態碼	說明	schema
200	OK	WrappedResponseV2«List«SrtDTO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

廣告管理介面

刪除廣告介面

介面說明：刪除廣告介面

介面位址:/vod/v1/advert/delete

請求方式：post

consumes:["application/json"]

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必須	類型
adid	廣告ID	query	true	string
appId	應用ID	query	true	string
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
timestamp	13位時間戳	query	true	string

回應資料:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型
code	HTTP 回應狀態碼。	int32
data	成功回傳資料。	object
message	錯誤訊息。	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error"。	string

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

取得廣告詳情介面

介面說明:取得廣告詳細資訊介面

介面位址:/vod/v1/advert/detail

請求方式：get

consumes:``

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必填	類型
adid	廣告ID	query	true	string
appId	應用ID	query	true	string
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
timestamp	13位時間戳	query	true	string

回應資料:

{
    "code": 0,
    "data": {
        "addrurl": "",
        "adid": "",
        "cataids": "",
        "createdtime": "",
        "height": 0,
        "location": "",
        "matterurl": "",
        "poplocation": 0,
        "popuptime": "",
        "size": 0,
        "skipenabled": "",
        "skiptime": 0,
        "status": 0,
        "title": "",
        "width": 0
    },
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型	schema
code	HTTP 回應狀態碼.	int32
data	成功回傳資料.	string	AdvertDTO
message	錯誤訊息.	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error".	string

schema 屬性說明

AdvertDTO

參數名稱	說明	類型
addrurl	連結位址：廣告需要跳轉的目標位址	string
adid	主鍵ID	string
cataids	影片分類ID。多個以英文逗號分隔	string
createdtime	建立時間	date-time
height	原生影片高度	int32
location	廣告位置：廣告展示的位置，1:片頭，2:暫停，3:片尾	string
matterurl	廣告素材：廣告展示物料，可上傳或外鏈廣告，支援圖片	string
poplocation	顯示位置	int32
popuptime	顯示時間	string
size	素材大小：可自訂廣告顯示的時間	int64
skipenabled	是否開啟跳過片頭廣告（Y/N）	string
skiptime	允許跳過廣告的時間，單位秒	int32
status	狀態：已上線10，待上線1，已下線0，刪除-1	int32
title	廣告名稱：廣告的標題	string
width	原生影片寬度	int32

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2«AdvertDTO»
401	Unauthorized
403	Forbidden
404	Not Found

查詢廣告介面

介面說明：查詢廣告介面

介面位址:/vod/v1/advert/list

請求方式：get

consumes:``

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用 ID	query	true	string
page	第幾頁（預設顯示第一頁）	query	false	integer
pageSize	每頁顯示幾筆（預設顯示）	query	false	integer
sign	簽章驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加 secretKey，最後進行 MD5 加密轉大寫，即為 sign 的值	query	true	string
timestamp	13 位時間戳	query	true	string
title	廣告名稱（模糊查詢）	query	true	string

回應資料:

{
    "code": 0,
    "data": {
        "contents": [
            {
                "addrurl": "",
                "adid": "",
                "cataids": "",
                "createdtime": "",
                "height": 0,
                "location": "",
                "matterurl": "",
                "poplocation": 0,
                "popuptime": "",
                "size": 0,
                "skipenabled": "",
                "skiptime": 0,
                "status": 0,
                "title": "",
                "width": 0
            }
        ],
        "endRow": 0,
        "firstPage": true,
        "hasNextPage": true,
        "hasPreviousPage": true,
        "lastPage": true,
        "limit": 0,
        "nextPageNumber": 0,
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 0,
        "previousPageNumber": 0,
        "startRow": 0,
        "totalItems": 0,
        "totalPages": 0
    },
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型	schema
code	HTTP 回應狀態碼。	int32
data	成功回傳資料。	string	Page«AdvertDTO»
message	錯誤訊息。	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error"。	string

schema 屬性說明

Page«AdvertDTO»

參數名稱	說明	類型	schema
contents	當前頁的內容。	array	AdvertDTO
endRow		int64
firstPage		boolean
hasNextPage		boolean
hasPreviousPage		boolean
lastPage		boolean
limit		int64
nextPageNumber		int32
offset		int64
pageNumber	當前頁。	int32
pageSize	每頁最多顯示的記錄數。	int32
previousPageNumber		int32
startRow		int64
totalItems	總記錄數。	int64
totalPages		int32

AdvertDTO

參數名稱	說明	類型
addrurl	連結位址：廣告需要跳轉的目標位址	string
adid	主鍵ID	string
cataids	影片分類ID。多個以英文逗號分隔	string
createdtime	建立時間	date-time
height	原生影片高度	int32
location	廣告位置：廣告展示的位置，1:片頭，2:暫停，3:片尾	string
matterurl	廣告素材：廣告展示物料，可上傳或外鏈廣告，支援圖片	string
poplocation	顯示位置	int32
popuptime	顯示時間	string
size	素材大小：可自訂廣告顯示的時間	int64
skipenabled	是否開啟跳過片頭廣告（Y/N）	string
skiptime	允許跳過廣告的時間，單位秒	int32
status	狀態：已上線10，待上線1，已下線0，刪除-1	int32
title	廣告名稱：廣告的標題	string
width	原生影片寬度	int32

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2«Page«AdvertDTO»»
401	未經授權
403	禁止存取
404	找不到資源

新增或修改廣告介面

介面說明：新增或修改廣告介面

接口地址:/vod/v1/advert/save

請求方式：post

consumes:["application/json"]

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必填	類型
addrurl	連結位址：廣告需要跳轉的目標位址	query	false	string
adid	主鍵ID	query	false	string
appId	應用ID	query	true	string
cataids	影片分類ID。多個以英文逗號分隔	query	false	string
height	原生影片高度	query	false	integer
location	廣告位置：廣告展示的位置，片頭、暫停、片尾	query	false	string
matterurl	廣告素材：廣告展示物料，可上傳或外鏈廣告，支援圖片	query	false	string
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
size	素材大小：可自訂廣告顯示的大小	query	false	integer
skipenabled	是否開啟跳過片頭廣告	query	false	string
skiptime	允許跳過廣告的時間，單位秒	query	false	integer
status	已上線10,待上線1,已下線0,刪除-1	query	false	integer
timestamp	13位時間戳	query	true	string
title	廣告名稱：廣告的標題	query	false	string
width	原生影片寬度	query	false	integer

回應資料:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型
code	HTTP 回應狀態碼.	int32
data	成功回傳資料.	object
message	錯誤訊息.	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error".	string

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

提供分類管理相關介面

新增子分類介面

介面說明：新增子分類

介面位址:/vod/v1/category/create-child

請求方式：post

consumes:["application/json"]

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必須	類型
appId	應用ID	query	true	string
name	新增的分類名稱	query	true	string
parentId	父分類ID	query	true	integer
sign	簽章驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
timestamp	13位時間戳	query	true	string

回應資料:

{
    "code": 0,
    "data": {
        "css": "",
        "gmtCreate": "",
        "gmtModified": "",
        "icon": "",
        "id": 0,
        "isDeleted": true,
        "name": "",
        "ordered": 0,
        "path": "",
        "playerId": 0,
        "playerName": "",
        "transGroupId": 0,
        "transGroupName": "",
        "userId": 0
    },
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型	schema
code	HTTP 回應狀態碼。	int32
data	成功回傳資料。	string	Category
message	錯誤訊息。	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error"。	string

schema 屬性說明

Category

參數名稱	說明	類型
css	顯示時的CSS類別名稱欄位：css	string
gmtCreate	建立時間欄位：gmt_create	date-time
gmtModified	最後修改時間欄位：gmt_modified	date-time
icon	分類的圖示欄位：icon	string
id	主鍵ID 欄位：id	int64
isDeleted	是否已刪除：0、1 欄位：is_deleted	boolean
name	分類名稱欄位：name	string
ordered	同層排序，由小到大欄位：ordered	int32
path	分類ID路徑欄位：path	string
playerId	播放器ID 欄位：player_id	int64
playerName	播放器名稱欄位：player_name	string
transGroupId	轉碼模板群組ID 欄位：trans_group_id	int64
transGroupName	轉碼模板群組名稱欄位：trans_group_name	string
userId	所屬使用者ID 欄位：user_id	int64

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2«Category»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

deleteCategory

介面說明：刪除指定的分類

介面位址:/vod/v1/category/delete

請求方式：post

consumes:["application/json"]

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必須	類型
appId	應用ID	query	true	string
categoryId	分類ID	query	true	integer
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
timestamp	13位時間戳	query	true	string

回應資料:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型
code	HTTP 回應狀態碼。	int32
data	成功回傳資料。	object
message	錯誤訊息。	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error"。	string

回應狀態碼說明：

狀態碼	說明	schema
200	OK	WrappedResponseV2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

獲取影片分類介面

介面說明:取得影片分類介面

介面位址:/vod/v1/category/list

請求方式：get

consumes:``

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用 ID	query	true	string
cataId	要查詢的分類 ID，不提交時表示取得所有分類	query	false	integer
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加 secretKey，最後進行 MD5 加密轉大寫，即為 sign 的值	query	true	string
timestamp	13 位時間戳	query	true	string

回應資料:

{
    "code": 0,
    "data": [
        {
            "cataId": 0,
            "cataName": "",
            "children": {
                "childrenList": [
                    {}
                ],
                "subTotal": 0
            },
            "level": 0,
            "parentId": 0
        }
    ],
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型	schema
code	HTTP 回應狀態碼.	int32
data	成功回傳資料.	array	CataNode
message	錯誤訊息.	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error".	string

schema 屬性說明

CataNode

參數名稱	類型	schema
cataId	int64
cataName	string
children	string	CataChildren
level	int32
parentId	int64

CataChildren

參數名稱	說明	類型	schema
childrenList		array	CataNode
subTotal		int32

回應狀態碼說明：

狀態碼	說明	schema
200	OK	WrappedResponseV2«List«CataNode»»
401	未經授權
403	禁止存取
404	找不到資源

修改分類名稱接口

介面說明：修改分類名稱

接口地址:/vod/v1/category/update

請求方式：post

consumes:["application/json"]

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必須	類型
appId	應用ID	query	true	string
categoryId	分類ID	query	true	integer
name	修改後的分類名稱	query	true	string
sign	簽章驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
timestamp	13位時間戳	query	true	string

回應資料:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型
code	HTTP 回應狀態碼。	int32
data	成功回傳資料。	object
message	錯誤訊息。	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error"。	string

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

提供影片管理相關介面

根據影片 vid 取得影片資訊介面

介面說明:根據影片vid取得影片資訊的介面

介面位址:/vod/v1/video/get-videos-info

請求方式：get

consumes:``

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用ID	query	true	string
filters	需要取得的資訊，不提交表示取得所有，取值為： basicInfo:基本資訊，metaData:原始影片資訊，transcodeInfo:轉碼資訊，snapshotInfo:截圖資訊	query	false	string
sign	簽章驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
timestamp	13位時間戳	query	true	string
vids	需要查詢的影片ID，多個ID(用英文逗號隔開)	query	false	string

回應資料:

{
    "code": 0,
    "data": [
        {
            "basicInfo": {
                "cateId": 0,
                "cateName": "",
                "coverUrl": "",
                "createdTime": 0,
                "description": "",
                "duration": 0,
                "size": 0,
                "status": "",
                "statusText": "",
                "tags": "",
                "title": "",
                "updateTime": 0,
                "uploader": "",
                "vid": ""
            },
            "metaData": {
                "bitrate": 0,
                "codec": "",
                "duration": 0,
                "format": "",
                "fps": "",
                "height": 0,
                "size": 0,
                "width": 0
            },
            "snapshotInfo": [],
            "transcodeInfo": [
                {
                    "bitrate": 0,
                    "definition": "",
                    "definitionText": "",
                    "duration": 0,
                    "encrypt": true,
                    "encryptType": "",
                    "format": "",
                    "height": 0,
                    "playUrl": "",
                    "size": 0,
                    "status": "",
                    "width": 0
                }
            ],
            "vid": ""
        }
    ],
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型	schema
code	HTTP 回應狀態碼.	int32
data	成功回傳資料.	array	VideoDetailInfoModel
message	錯誤訊息.	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error".	string

schema 屬性說明

VideoDetailInfoModel

參數名稱	說明	類型	schema
basicInfo	影片資訊	string	VideoBasicInfo
metaData	影片元資訊	string	VideoMetaData
snapshotInfo	影片截圖列表	array
transcodeInfo	影片轉碼資訊列表	array	VideoTranscodeInfo
vid	影片VID	string

VideoBasicInfo

參數名稱	說明	類型
cateId	分類ID	int64
cateName	分類名稱	string
coverUrl	封面圖URL	string
createdTime	建立時間 13位時間戳	int64
description		string
duration	影片長度，單位秒	float
size	原始檔案大小單位 Bytes	int64
status	影片狀態，取值參考： CREATED 已建立 UPLOADING 上傳中 UPLOAD_FAIL 上傳失敗 UPLOAD_SUCCESS 上傳成功 TRANSCODING 轉碼中 TRANSCODE_FAIL 轉碼失敗 CHECKING 審核中 BLOCKED 封鎖 NORMAL 正常	string
statusText	影片狀態中文描述值	string
tags	影片標籤，多個標籤用英文逗號","分隔	string
title	影片標題	string
updateTime	修改時間 13位時間戳	int64
uploader	上傳人員帳號	string
vid	影片vid	string

VideoMetaData

參數名稱	說明	類型
bitrate	影片碼率，單位 bps	int32
codec	編碼格式，如 h264、h265	string
duration	影片時長，單位秒	float
format	影片格式，如 mp4、flv	string
fps	影片幀率格式：25/1	string
height	影片解析度高度，單位 px	int32
size	原始檔案大小單位 Bytes	int64
width	影片解析度寬度，單位 px	int32

VideoTranscodeInfo

參數名稱	說明	類型
bitrate	影片碼率，單位 bps	int32
definition	影片清晰度，取值為： SOURCE 原始檔案 LD 流暢 SD 標清 HD 高清 FHD 超清 OD 原畫 4K 4K SQ 普通音質 HQ 高音質	string
definitionText	影片清晰度中文描述	string
duration	影片時長，單位秒	int64
encrypt	是否加密	boolean
encryptType	加密類型	string
format	影片格式	string
height	影片解析度高，單位 px	int32
playUrl	影片流播放位址	string
size	原始檔案大小	int64
status	影片流狀態，取值：normal 正常；unavailable 不可用	string
width	影片解析度寬，單位 px	int32

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2«List«VideoDetailInfoModel»»
401	未經授權
403	禁止存取
404	找不到資源

搜尋影片介面

介面說明:搜尋影片介面根據條件搜尋取得包含影片基本資訊的分頁列表

介面位址:/vod/v1/video/search-videos

請求方式：get

consumes:``

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用ID	query	true	string
categoryIdList	影片所屬分類ID，多個ID用英文逗號分隔	query	false	integer
endTime	結束時間。格式為：yyyy-MM-dd	query	false	string
includingDeleted	是否包含已刪除的影片。	query	false	boolean
keyword	搜尋關鍵字。	query	false	string
order	排序條件，取值：create_asc	query	false	string
page	分頁顯示：目前第幾頁	query	false	integer
pageSize	分頁顯示：每頁最多顯示多少筆記錄，預設為25	query	false	integer
sign	簽章驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典順序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
startTime	開始時間。格式為：yyyy-MM-dd	query	false	string
status	影片狀態。取值參考：	query	false	string
timestamp	13位時間戳	query	true	string
uploadServer	上傳者信箱帳號	query	false	string
vid	影片VID。	query	false	string

回應資料:

{
    "code": 0,
    "data": {
        "contents": [
            {
                "cateId": 0,
                "cateName": "",
                "coverUrl": "",
                "createdTime": 0,
                "description": "",
                "duration": 0,
                "size": 0,
                "status": "",
                "statusText": "",
                "tags": "",
                "title": "",
                "updateTime": 0,
                "uploader": "",
                "vid": ""
            }
        ],
        "endRow": 0,
        "firstPage": true,
        "hasNextPage": true,
        "hasPreviousPage": true,
        "lastPage": true,
        "limit": 0,
        "nextPageNumber": 0,
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 0,
        "previousPageNumber": 0,
        "startRow": 0,
        "totalItems": 0,
        "totalPages": 0
    },
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型	schema
code	HTTP 回應狀態碼。	int32
data	成功回傳資料。	string	Page«VideoBasicInfo»
message	錯誤訊息。	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error"。	string

schema 屬性說明

Page«VideoBasicInfo»

參數名稱	說明	類型	schema
contents	當前頁的內容。	array	VideoBasicInfo
endRow		int64
firstPage		boolean
hasNextPage		boolean
hasPreviousPage		boolean
lastPage		boolean
limit		int64
nextPageNumber		int32
offset		int64
pageNumber	當前頁。	int32
pageSize	每頁最多顯示的記錄數。	int32
previousPageNumber		int32
startRow		int64
totalItems	總記錄數。	int64
totalPages		int32

VideoBasicInfo

參數名稱	說明	類型
cateId	分類ID	int64
cateName	分類名稱	string
coverUrl	封面圖URL	string
createdTime	建立時間 13位時間戳	int64
description		string
duration	影片長度，單位秒	float
size	原始檔案大小單位 Bytes	int64
status	影片狀態，取值參考： CREATED 已建立 UPLOADING 上傳中 UPLOAD_FAIL 上傳失敗 UPLOAD_SUCCESS 上傳成功 TRANSCODING 轉碼中 TRANSCODE_FAIL 轉碼失敗 CHECKING 審核中 BLOCKED 封鎖 NORMAL 正常	string
statusText	影片狀態中文描述值	string
tags	影片標籤，多個標籤用英文逗號","分隔	string
title	影片標題	string
updateTime	修改時間 13位時間戳	int64
uploader	上傳人員帳號	string
vid	影片vid	string

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2«Page«VideoBasicInfo»»
401	未經授權
403	禁止存取
404	找不到資源

播放域名統計相關介面

取得域名統計介面

介面說明:取得域名統計介面。

接口地址:/vod/v1/statistic/domain

請求方式：get

consumes:``

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用ID	query	true	string
end	查詢結束日期（時間格式：yyyy-MM-dd）	query	false	string
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
start	查詢開始日期（時間格式：yyyy-MM-dd）	query	false	string
timestamp	13位時間戳	query	true	string

回應資料:

{
    "code": 0,
    "data": [
        {
            "createdTime": "",
            "currentDay": "",
            "currentMonth": "",
            "currentWeek": "",
            "domain": "",
            "lastModified": "",
            "mobileFlowSize": 0,
            "mobilePlayDuration": 0,
            "mobileUniqueViewer": 0,
            "mobileVideoView": 0,
            "pcFlowSize": 0,
            "pcPlayDuration": 0,
            "pcUniqueViewer": 0,
            "pcVideoView": 0,
            "userId": ""
        }
    ],
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型	schema
code	HTTP 回應狀態碼.	int32
data	成功回傳資料.	array	DomainDailyStats
message	錯誤訊息.	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error".	string

schema 屬性說明

DomainDailyStats

參數名稱	說明	類型
createdTime	建立時間	date-time
currentDay	當天	string
currentMonth	當週	string
currentWeek	當週	string
domain	網域名稱	string
lastModified	更新時間	date-time
mobileFlowSize	行動端流量	int64
mobilePlayDuration	行動端觀看時長	int64
mobileUniqueViewer	行動端觀看不重複人數	int32
mobileVideoView	行動端觀看次數	int32
pcFlowSize	PC端流量	int64
pcPlayDuration	PC端播放時長	int64
pcUniqueViewer	PC端觀看不重複人數	int32
pcVideoView	PC端觀看次數	int32
userId	使用者ID	string

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2«List«DomainDailyStats»»
401	未經授權
403	禁止存取
404	找不到資源

匯出域名統計介面

介面說明:匯出域名統計介面。

介面位址:/vod/v1/statistic/domain/export

請求方式：get

consumes:``

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用ID	query	true	string
end	查詢結束日期（時間格式：yyyy-MM-dd）	query	false	string
sign	簽名驗證的參數，生成規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
start	查詢開始日期（時間格式：yyyy-MM-dd）	query	false	string
timestamp	13位時間戳	query	true	string

回應資料:

回應參數說明:

目前無

回應狀態碼說明:

狀態碼	說明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

播放時長的統計數據相關介面

查詢播放時長統計介面

介面說明：查詢播放時長統計介面。

介面位址:/vod/v1/statistic/playduration

請求方式：get

consumes:``

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用ID	query	true	string
end	查詢結束日期（時間格式：yyyy-MM-dd）	query	false	string
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
start	查詢開始日期（時間格式：yyyy-MM-dd）	query	false	string
timestamp	13位時間戳	query	true	string
vid	影片ID	query	false	string

回應資料:

{
    "code": 0,
    "data": [
        {
            "currentDay": "",
            "mobilePerAveragePlayDuration": 0,
            "mobilePlayDuration": 0,
            "mobileVideoAveragePlayDuration": 0,
            "pcPerAveragePlayDuration": 0,
            "pcPlayDuration": 0,
            "pcVideoAveragePlayDuration": 0
        }
    ],
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型	schema
code	HTTP 回應狀態碼.	int32
data	成功回傳資料.	array	PlayDurationStatsModel
message	錯誤訊息.	string
status	請求狀態，成功："success"，失敗："fail", 錯誤："error".	string

schema 屬性說明

PlayDurationStatsModel

參數名稱	說明	類型
currentDay	當天	string
mobilePerAveragePlayDuration	行動裝置人均觀看時長	int64
mobilePlayDuration	行動裝置播放時長	int64
mobileVideoAveragePlayDuration	行動裝置影片平均觀看時長	int64
pcPerAveragePlayDuration	電腦人均觀看時長	int64
pcPlayDuration	電腦端播放時長	int64
pcVideoAveragePlayDuration	電腦影片平均觀看時長	int64

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2«List«PlayDurationStatsModel»»
401	未經授權
403	禁止存取
404	找不到資源

匯出播放時長統計介面

介面說明:匯出播放時長統計介面。

介面位址:/vod/v1/statistic/playduration/export

請求方式：get

consumes:``

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必須	類型
appId	應用ID	query	true	string
end	查詢結束日期（時間格式：yyyy-MM-dd）	query	false	string
sign	簽名驗證的參數，生成規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
start	查詢開始日期（時間格式：yyyy-MM-dd）	query	false	string
timestamp	13位時間戳	query	true	string
vid	影片ID	query	false	string

回應資料:

回應參數說明:

目前無

回應狀態碼說明:

狀態碼	說明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

播放量統計相關介面

播放量列表介面

介面說明:播放量列表介面。

介面位址:/vod/v1/statistic/visitor

請求方式：get

consumes:``

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用ID	query	true	string
end	查詢結束日期（時間格式：yyyy-MM-dd）	query	false	string
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
start	查詢開始日期（時間格式：yyyy-MM-dd）	query	false	string
timestamp	13位時間戳	query	true	string
vid	影片ID	query	false	string

回應資料:

{
    "code": 0,
    "data": [
        {
            "createdTime": "",
            "currentDay": "",
            "currentMonth": "",
            "currentWeek": "",
            "lastModified": "",
            "mobileFlowSize": 0,
            "mobilePlayDuration": 0,
            "mobileUniqueViewer": 0,
            "mobileVideoView": 0,
            "pcFlowSize": 0,
            "pcPlayDuration": 0,
            "pcUniqueViewer": 0,
            "pcVideoView": 0,
            "percent10": 0,
            "percent100": 0,
            "percent20": 0,
            "percent30": 0,
            "percent40": 0,
            "percent50": 0,
            "percent60": 0,
            "percent70": 0,
            "percent80": 0,
            "percent90": 0,
            "userId": ""
        }
    ],
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型	schema
code	HTTP 回應狀態碼.	int32
data	成功回傳資料.	array	UserDailyStats
message	錯誤訊息.	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error".	string

schema 屬性說明

UserDailyStats

參數名稱	說明	類型
createdTime	建立時間	date-time
currentDay	當天	string
currentMonth	當月	string
currentWeek	當週	string
lastModified	更新時間	date-time
mobileFlowSize	行動端流量	int64
mobilePlayDuration	行動端觀看時長	int64
mobileUniqueViewer	行動端觀看唯一數	int32
mobileVideoView	行動端觀看數	int32
pcFlowSize	PC端流量	int64
pcPlayDuration	PC端播放時長	int64
pcUniqueViewer	PC端觀看唯一數	int32
pcVideoView	PC端觀看數	int32
percent10	觀看10%的比例	int32
percent100	觀看100%的比例	int32
percent20	觀看20%的比例	int32
percent30	觀看30%的比例	int32
percent40	觀看40%的比例	int32
percent50	觀看50%的比例	int32
percent60	觀看60%的比例	int32
percent70	觀看70%的比例	int32
percent80	觀看80%的比例	int32
percent90	觀看90%的比例	int32
userId	使用者ID	string

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2«List«UserDailyStats»»
401	未經授權
403	禁止存取
404	找不到資源

匯出播放量介面

介面說明:匯出播放量介面。

介面位址:/vod/v1/statistic/visitor/export

請求方式：get

consumes:``

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用ID	query	true	string
end	查詢結束日期（時間格式：yyyy-MM-dd）	query	false	string
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
start	查詢開始日期（時間格式：yyyy-MM-dd）	query	false	string
timestamp	13位時間戳	query	true	string
vid	影片ID	query	false	string

回應資料:

回應參數說明:

目前無

回應狀態碼說明：

狀態碼	說明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

播放量排行榜 API

介面說明:播放量排行榜介面（前100名）。

接口地址:/vod/v1/statistic/visitor/rank/top

請求方式：get

consumes:``

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用ID	query	true	string
end	查詢結束日期（時間格式：yyyy-MM-dd）	query	false	string
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
start	查詢開始日期（時間格式：yyyy-MM-dd）	query	false	string
timestamp	13位時間戳	query	true	string

回應資料:

{
    "code": 0,
    "data": {
        "totalVideoView": 0,
        "videoViewModels": [
            {
                "duration": 0,
                "imageUrl": "",
                "title": "",
                "videoId": "",
                "videoView": 0
            }
        ]
    },
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型	schema
code	HTTP 回應狀態碼。	int32
data	成功回傳資料。	string	VideoViewTopModel
message	錯誤訊息。	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error"。	string

schema 屬性說明

VideoViewTopModel

參數名稱	說明	類型	schema
totalVideoView	總播放數	int32
videoViewModels	播放列表排行	array	VideoViewModelBean

VideoViewModelBean

參數名稱	說明	類型
duration	時長	int32
imageUrl	頭圖	string
title	標題	string
videoId	影片ID	string
videoView	播放量	int32

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2«VideoViewTopModel»
401	未經授權
403	禁止存取
404	找不到資源

匯出彙總播放量排行介面

介面說明：匯出彙總播放量排行介面（前100名）。

介面位址:/vod/v1/statistic/visitor/rank/top/export

請求方式：get

consumes:``

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用ID	query	true	string
end	查詢結束日期（時間格式：yyyy-MM-dd）	query	false	string
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
start	查詢開始日期（時間格式：yyyy-MM-dd）	query	false	string
timestamp	13位時間戳	query	true	string

回應資料:

回應參數說明:

目前無

回應狀態碼說明:

狀態碼	說明	schema
200	OK
401	未經授權
403	禁止存取
404	找不到資源

整體數據概況相關介面

資料彙總介面

介面說明:資料彙總介面。

接口地址:/vod/v1/statistic/overview

請求方式：get

consumes:``

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必須	類型
appId	應用ID	query	true	string
end	查詢結束日期（時間格式：yyyy-MM-dd）	query	false	string
sign	簽名驗證的參數，生成規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
start	查詢開始日期（時間格式：yyyy-MM-dd）	query	false	string
timestamp	13位時間戳	query	true	string
vid	影片ID	query	false	string

回應資料:

{
    "code": 0,
    "data": {
        "mobileFlowSize": 0,
        "mobilePlayDuration": 0,
        "mobileUniqueViewer": 0,
        "mobileVideoView": 0,
        "pcFlowSize": 0,
        "pcPlayDuration": 0,
        "pcUniqueViewer": 0,
        "pcVideoView": 0,
        "userId": ""
    },
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型	schema
code	HTTP 回應狀態碼。	int32
data	成功回傳資料。	string	StatsSummary
message	錯誤訊息。	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error"。	string

schema 屬性說明

StatsSummary

參數名稱	說明	類型
mobileFlowSize	行動端流量	int64
mobilePlayDuration	行動端播放分鐘數	int64
mobileUniqueViewer	行動端不重複觀看人數	int32
mobileVideoView	行動端觀看次數	int32
pcFlowSize	PC端流量	int64
pcPlayDuration	PC端觀看分鐘數	int64
pcUniqueViewer	PC端不重複觀眾數	int32
pcVideoView	PC端觀看次數	int32
userId	使用者ID	string

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2«StatsSummary»
401	未經授權
403	禁止存取
404	找不到資源

概覽資料彙總介面

介面說明:概覽資料彙總介面。

介面位址:/vod/v1/statistic/overview/summary

請求方式：get

consumes:``

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用ID	query	true	string
sign	簽章驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典順序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
timestamp	13位時間戳	query	true	string

回應資料:

{
    "code": 0,
    "data": {
        "totalPlayDuration": 0,
        "totalSpace": 0,
        "totalVideo": 0,
        "totalVideoView": 0
    },
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型	schema
code	HTTP 回應狀態碼.	int32
data	成功回傳資料.	string	StatsTotalSummary
message	錯誤訊息.	string
status	請求狀態，成功："success"，失敗："fail", 錯誤："error".	string

schema 屬性說明

StatsTotalSummary

參數名稱	說明	類型
totalPlayDuration	總播放時長	int64
totalSpace	空間大小（單位：byte）	int64
totalVideo	影片總數	int32
totalVideoView	總觀看次數	int32

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2«StatsTotalSummary»
401	未經授權
403	禁止存取
404	找不到資源

終端設備統計相關介面

取得終端設備統計介面

介面說明:終端設備統計介面。

接口地址:/vod/v1/statistic/device

請求方式：get

consumes:``

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用ID	query	true	string
end	查詢結束日期（時間格式：yyyy-MM-dd）	query	false	string
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
start	查詢開始日期（時間格式：yyyy-MM-dd）	query	false	string
timestamp	13位時間戳	query	true	string

回應資料:

{
    "code": 0,
    "data": {
        "end": "",
        "start": "",
        "stats": {
            "createdTime": "",
            "currentDay": "",
            "currentMonth": "",
            "currentWeek": "",
            "lastModified": "",
            "mobileFlowSize": 0,
            "mobilePlayDuration": 0,
            "mobileUniqueViewer": 0,
            "mobileVideoView": 0,
            "pcFlowSize": 0,
            "pcPlayDuration": 0,
            "pcUniqueViewer": 0,
            "pcVideoView": 0,
            "percent10": 0,
            "percent100": 0,
            "percent20": 0,
            "percent30": 0,
            "percent40": 0,
            "percent50": 0,
            "percent60": 0,
            "percent70": 0,
            "percent80": 0,
            "percent90": 0,
            "userId": ""
        },
        "totalVideoView": 0
    },
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型	schema
code	HTTP 回應狀態碼。	int32
data	成功回傳資料。	string	StatsSummaryModel«UserDailyStats»
message	錯誤訊息。	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error"。	string

schema 屬性說明

StatsSummaryModel«UserDailyStats»

參數名稱	說明	類型	schema
end	結束時間	string
start	開始時間	string
stats	播放清單排行	string	UserDailyStats
totalVideoView	總播放數	int32

UserDailyStats

參數名稱	說明	類型
createdTime	建立時間	date-time
currentDay	當天	string
currentMonth	當月	string
currentWeek	當週	string
lastModified	更新時間	date-time
mobileFlowSize	行動端流量	int64
mobilePlayDuration	行動端觀看時長	int64
mobileUniqueViewer	行動端觀看唯一數	int32
mobileVideoView	行動端觀看數	int32
pcFlowSize	PC端流量	int64
pcPlayDuration	PC端播放時長	int64
pcUniqueViewer	PC端觀看唯一數	int32
pcVideoView	PC端觀看數	int32
percent10	觀看10%的比例	int32
percent100	觀看100%的比例	int32
percent20	觀看20%的比例	int32
percent30	觀看30%的比例	int32
percent40	觀看40%的比例	int32
percent50	觀看50%的比例	int32
percent60	觀看60%的比例	int32
percent70	觀看70%的比例	int32
percent80	觀看80%的比例	int32
percent90	觀看90%的比例	int32
userId	使用者ID	string

回應狀態碼說明：

狀態碼	說明	schema
200	OK	WrappedResponseV2«StatsSummaryModel«UserDailyStats»»
401	未經授權
403	禁止存取
404	找不到資源

瀏覽器統計介面

介面說明：瀏覽器統計介面。

介面位址:/vod/v1/statistic/device/browser

請求方式：get

consumes:``

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用ID	query	true	string
end	查詢結束日期（時間格式：yyyy-MM-dd）	query	false	string
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
start	查詢開始日期（時間格式：yyyy-MM-dd）	query	false	string
timestamp	13位時間戳	query	true	string

回應資料:

{
    "code": 0,
    "data": {
        "end": "",
        "start": "",
        "stats": [
            {
                "browser": "",
                "createdTime": "",
                "currentDay": "",
                "currentMonth": "",
                "currentWeek": "",
                "lastModified": "",
                "mobileFlowSize": 0,
                "mobilePlayDuration": 0,
                "mobileUniqueViewer": 0,
                "mobileVideoView": 0,
                "pcFlowSize": 0,
                "pcPlayDuration": 0,
                "pcUniqueViewer": 0,
                "pcVideoView": 0,
                "userId": ""
            }
        ],
        "totalVideoView": 0
    },
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型	schema
code	HTTP 回應狀態碼。	int32
data	成功回傳資料。	string	StatsSummaryModel«List«BrowserDailyStats»»
message	錯誤訊息。	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error"。	string

schema 屬性說明

StatsSummaryModel«List«BrowserDailyStats»»

參數名稱	說明	類型	schema
end	結束時間	string
start	開始時間	string
stats	播放清單排行	array	BrowserDailyStats
totalVideoView	總播放數	int32

BrowserDailyStats

參數名稱	說明	類型
browser	瀏覽器	string
createdTime	建立時間	date-time
currentDay	當天	string
currentMonth	當月	string
currentWeek	當週	string
lastModified	更新時間	date-time
mobileFlowSize	行動端流量	int64
mobilePlayDuration	行動端觀看時長	int64
mobileUniqueViewer	行動端觀看唯一數	int32
mobileVideoView	行動端觀看數	int32
pcFlowSize	PC端流量	int64
pcPlayDuration	PC端播放時長	int64
pcUniqueViewer	PC端觀看唯一數	int32
pcVideoView	PC端觀看數	int32
userId	使用者ID	string

回應狀態碼說明：

狀態碼	說明	schema
200	OK	WrappedResponseV2«StatsSummaryModel«List«BrowserDailyStats»»»
401	未經授權
403	禁止存取
404	找不到資源

匯出瀏覽器統計介面

介面說明:匯出瀏覽器統計介面。

介面位址:/vod/v1/statistic/device/browser/export

請求方式：get

consumes:``

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必須	類型
appId	應用ID	query	true	string
end	查詢結束日期（時間格式：yyyy-MM-dd）	query	false	string
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
start	查詢開始日期（時間格式：yyyy-MM-dd）	query	false	string
timestamp	13位時間戳	query	true	string

回應資料:

回應參數說明:

目前無

回應狀態碼說明：

狀態碼	說明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

匯出終端設備統計介面

介面說明:匯出終端設備統計介面。

介面位址:/vod/v1/statistic/device/export

請求方式：get

consumes:``

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用 ID	query	true	string
end	查詢結束日期（時間格式：yyyy-MM-dd）	query	false	string
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加 secretKey，最後進行 MD5 加密轉大寫，即為 sign 的值	query	true	string
start	查詢開始日期（時間格式：yyyy-MM-dd）	query	false	string
timestamp	13 位時間戳	query	true	string

回應資料:

回應參數說明:

目前無

回應狀態碼說明:

狀態碼	說明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

作業系統統計資料

介面說明:作業系統統計資料。

介面位址:/vod/v1/statistic/device/os

請求方式：get

consumes:``

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必須	類型
appId	應用ID	query	true	string
end	查詢結束日期（時間格式：yyyy-MM-dd）	query	false	string
sign	簽名驗證的參數，生成規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
start	查詢開始日期（時間格式：yyyy-MM-dd）	query	false	string
timestamp	13位時間戳	query	true	string

回應資料:

{
    "code": 0,
    "data": {
        "end": "",
        "start": "",
        "stats": [
            {
                "createdTime": "",
                "currentDay": "",
                "currentMonth": "",
                "currentWeek": "",
                "lastModified": "",
                "mobileFlowSize": 0,
                "mobilePlayDuration": 0,
                "mobileUniqueViewer": 0,
                "mobileVideoView": 0,
                "operatingSystem": "",
                "pcFlowSize": 0,
                "pcPlayDuration": 0,
                "pcUniqueViewer": 0,
                "pcVideoView": 0,
                "userId": ""
            }
        ],
        "totalVideoView": 0
    },
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型	schema
code	HTTP 回應狀態碼.	int32
data	成功回傳資料.	string	StatsSummaryModel«List«OsDailyStats»»
message	錯誤訊息.	string
status	請求狀態，成功："success"，失敗："fail", 錯誤："error".	string

schema 屬性說明

StatsSummaryModel«List«OsDailyStats»»

參數名稱	說明	類型	schema
end	結束時間	string
start	開始時間	string
stats	播放列表排行	array	OsDailyStats
totalVideoView	總播放數	int32

OsDailyStats

參數名稱	說明	類型
createdTime	建立時間	date-time
currentDay	當天	string
currentMonth	當月	string
currentWeek	當週	string
lastModified	更新時間	date-time
mobileFlowSize	行動端流量	int64
mobilePlayDuration	行動端觀看時長	int64
mobileUniqueViewer	行動端觀看唯一數	int32
mobileVideoView	行動端觀看數	int32
operatingSystem	作業系統	string
pcFlowSize	PC端流量	int64
pcPlayDuration	PC端播放時長	int64
pcUniqueViewer	PC端觀看唯一數	int32
pcVideoView	PC端觀看數	int32
userId	使用者ID	string

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2«StatsSummaryModel«List«OsDailyStats»»»
401	未經授權
403	禁止存取
404	找不到資源

匯出作業系統統計介面

介面說明:匯出作業系統統計介面。

接口地址:/vod/v1/statistic/device/os/export

請求方式：get

consumes:``

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用ID	query	true	string
end	查詢結束日期（時間格式：yyyy-MM-dd）	query	false	string
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
start	查詢開始日期（時間格式：yyyy-MM-dd）	query	false	string
timestamp	13位時間戳	query	true	string

回應資料:

回應參數說明:

暫無

回應狀態碼說明:

狀態碼	說明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

觀眾地理位置統計相關介面

查詢地域分佈統計介面

介面說明:查詢地域分佈統計介面。

接口地址:/vod/v1/statistic/geo

請求方式：get

consumes:``

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用ID	query	true	string
end	查詢結束日期（時間格式：yyyy-MM-dd）	query	false	string
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
start	查詢開始日期（時間格式：yyyy-MM-dd）	query	false	string
timestamp	13位時間戳	query	true	string

回應資料:

{
    "code": 0,
    "data": [
        {
            "createdTime": "",
            "currentDay": "",
            "currentMonth": "",
            "currentWeek": "",
            "lastModified": "",
            "mobileFlowSize": 0,
            "mobilePlayDuration": 0,
            "mobileUniqueViewer": 0,
            "mobileVideoView": 0,
            "pcFlowSize": 0,
            "pcPlayDuration": 0,
            "pcUniqueViewer": 0,
            "pcVideoView": 0,
            "province": "",
            "userId": ""
        }
    ],
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型	schema
code	HTTP 回應狀態碼。	int32
data	成功回傳資料。	array	ProvinceDailyStats
message	錯誤訊息。	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error"。	string

schema 屬性說明

ProvinceDailyStats

參數名稱	說明	類型
createdTime	建立時間	date-time
currentDay	當天	string
currentMonth	當週	string
currentWeek	當週	string
lastModified	更新時間	date-time
mobileFlowSize	行動端流量	int64
mobilePlayDuration	行動端觀看時長	int64
mobileUniqueViewer	行動端觀看不重複人數	int32
mobileVideoView	行動端觀看次數	int32
pcFlowSize	PC端流量	int64
pcPlayDuration	PC端播放時長	int64
pcUniqueViewer	PC端觀看不重複人數	int32
pcVideoView	PC端觀看次數	int32
province	省份	string
userId	使用者ID	string

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2«List«ProvinceDailyStats»»
401	未經授權
403	禁止存取
404	找不到資源

匯出地域分佈統計介面

介面說明:匯出地域分佈統計介面。

介面位址:/vod/v1/statistic/geo/export

請求方式：get

consumes:``

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用ID	query	true	string
end	查詢結束日期（時間格式：yyyy-MM-dd）	query	false	string
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
start	查詢開始日期（時間格式：yyyy-MM-dd）	query	false	string
timestamp	13位時間戳	query	true	string

回應資料:

回應參數說明:

目前無

回應狀態碼說明：

狀態碼	說明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

影片安全

獲取播放域名設定資訊介面

介面說明:取得播放網域設定資訊

介面位址:/vod/v1/play-safe/info

請求方式：get

consumes:``

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必須	類型
appId	應用ID	query	true	string
sign	簽章驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
timestamp	13位時間戳	query	true	string

回應資料:

{
    "code": 0,
    "data": {
        "blackList": "",
        "securitySetting": "",
        "userId": "",
        "whiteList": ""
    },
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型	schema
code	HTTP 回應狀態碼。	int32
data	成功回傳資料。	string	PlayDomainDTO
message	錯誤訊息。	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error"。	string

schema 屬性說明

PlayDomainDTO

參數名稱	說明	類型
blackList	黑名單，可新增多個用逗號分隔	string
securitySetting	播放限制設定選項， none：無限制，white：白名單，black：黑名單	string
userId	使用者ID	string
whiteList	白名單，可新增多個用逗號分隔	string

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2«PlayDomainDTO»
401	Unauthorized
403	Forbidden
404	Not Found

新增或修改播放域名限制接口

介面說明：新增或修改播放域名限制介面

介面位址:/vod/v1/play-safe/save

請求方式：post

consumes:["application/json"]

produces:["application/json;charset=UTF-8"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用 ID	query	true	string
blackList	黑名單，可新增多個用逗號分隔	query	false	string
securitySetting	播放限制設定選項，none：無限制，white：白名單，black：黑名單	query	true	string
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加 secretKey，最後進行 MD5 加密轉大寫，即為 sign 的值	query	true	string
timestamp	13 位時間戳	query	true	string
whiteList	白名單，可新增多個用逗號分隔	query	false	string

回應資料:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型
code	HTTP 回應狀態碼。	int32
data	成功回傳資料。	object
message	錯誤訊息。	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error"。	string

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

影片浮水印管理相關介面

新增浮水印設定介面

介面說明：新增浮水印設定

介面位址:/vod/v1/transcoding/create

請求方式：post

consumes:["application/json"]

produces:["*/*"]

請求參數：

參數名稱	說明	in	是否必須	類型
appId	應用ID	query	true	string
bucketName	圖片浮水印檔案儲存所在的空間或群組名稱	query	false	string
content	文字浮水印的內容	query	false	string
fileName	浮水印素材的檔案名稱	query	false	string
fontAlpha	透明度：0-1	query	false	number
fontColor	文字浮水印的顏色	query	false	string
fontName	文字浮水印的字型	query	false	string
fontSize	文字浮水印的字號：像素	query	false	integer
gmtCreate	建立時間	query	false	string
gmtModified	最後修改時間	query	false	string
id	主鍵ID	query	false	integer
imageDxUnit	圖片浮水印水平偏移的單位：像素-pixel，百分比-percentage	query	false	string
imageDxValue	圖片浮水印水平偏移：值	query	false	integer
imageDyUnit	圖片浮水印垂直偏移的單位：像素-pixel，百分比-percentage	query	false	string
imageDyValue	圖片浮水印垂直偏移：值	query	false	integer
imageHeightUnit	圖片浮水印高度的單位：像素-pixel，百分比-percentage	query	false	string
imageHeightValue	圖片浮水印高度：值	query	false	integer
imagePosition	圖片浮水印的位置：左上、左下、右下、右上	query	false	string
imageWidthUnit	圖片浮水印寬度的單位：像素-pixel，百分比-percentage	query	false	string
imageWidthValue	圖片浮水印的寬度：值	query	false	integer
isDefault	是否為預設浮水印	query	false	boolean
isDeleted	是否已刪除	query	false	boolean
name	浮水印名稱	query	false	string
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
storageSystem	圖片浮水印檔案所在的儲存系統：FastDFS、AliyunOSS、Local	query	false	string
textDx	水平偏移：像素	query	false	integer
textDy	垂直偏移：像素	query	false	integer
timestamp	13位時間戳	query	true	string
type	浮水印類型：圖片	query	false	string

回應資料:

{
    "code": 0,
    "data": {
        "bucketName": "",
        "content": "",
        "fileName": "",
        "fontAlpha": 0,
        "fontColor": "",
        "fontName": "",
        "fontSize": 0,
        "gmtCreate": "",
        "gmtModified": "",
        "id": 0,
        "imageDxUnit": "",
        "imageDxValue": 0,
        "imageDyUnit": "",
        "imageDyValue": 0,
        "imageHeightUnit": "",
        "imageHeightValue": 0,
        "imagePosition": "",
        "imageWidthUnit": "",
        "imageWidthValue": 0,
        "isDefault": true,
        "isDeleted": true,
        "name": "",
        "storageSystem": "",
        "textDx": 0,
        "textDy": 0,
        "type": ""
    },
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型	schema
code	HTTP 回應狀態碼。	int32
data	成功回傳資料。	string	TranscodingWatermark
message	錯誤訊息。	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error"。	string

schema 屬性說明

TranscodingWatermark

參數名稱	說明	類型
bucketName	圖片浮水印檔案儲存所在的空間或群組名稱欄位：bucket_name	string
content	文字浮水印的內容欄位：content	string
fileName	浮水印素材的檔案名稱欄位：file_name	string
fontAlpha	透明度：0-1 欄位：font_alpha	number
fontColor	文字浮水印的顏色欄位：font_color	string
fontName	文字浮水印的字型欄位：font_name	string
fontSize	文字浮水印的字型大小：像素欄位：font_size	int32
gmtCreate	建立時間欄位：gmt_create	date-time
gmtModified	最後修改時間欄位：gmt_modified	date-time
id	主鍵ID 欄位：id	int64
imageDxUnit	圖片浮水印水平偏移的單位：像素-pixel，百分比-percentage 欄位：image_dx_unit	string
imageDxValue	圖片浮水印水平偏移：值欄位：image_dx_value	int32
imageDyUnit	圖片浮水印垂直偏移的單位：像素-pixel，百分比-percentage 欄位：image_dy_unit	string
imageDyValue	圖片浮水印垂直偏移：值欄位：image_dy_value	int32
imageHeightUnit	圖片浮水印高度的單位：像素-pixel，百分比-percentage 欄位：image_height_unit	string
imageHeightValue	圖片浮水印高度：值欄位：image_height_value	int32
imagePosition	圖片浮水印的位置：左上、左下、右下、右上欄位：image_position	string
imageWidthUnit	圖片浮水印寬度的單位：像素-pixel，百分比-percentage 欄位：image_width_unit	string
imageWidthValue	圖片浮水印的寬度：值欄位：image_width_value	int32
isDefault	是否為預設浮水印欄位：is_default	boolean
isDeleted	是否已刪除欄位：is_deleted	boolean
name	浮水印名稱欄位：name	string
storageSystem	圖片浮水印檔案所在的儲存系統：FastDFS、AliyunOSS、Local 欄位：storage_system	string
textDx	水平偏移：像素欄位：text_dx	int32
textDy	垂直偏移：像素欄位：text_dy	int32
type	浮水印類型：圖片 - image、文字 - text 欄位：type	string

回應狀態碼說明：

狀態碼	說明	schema
200	OK	WrappedResponseV2«TranscodingWatermark»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

刪除浮水印設定介面

介面說明：刪除浮水印設定

介面位址:/vod/v1/transcoding/delete

請求方式：post

consumes:["application/json"]

produces:["*/*"]

請求參數：

參數名稱	說明	in	是否必須	類型
appId	應用ID	query	true	string
id	需要刪除的水印設定ID	query	true	integer
sign	簽章驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
timestamp	13位時間戳	query	true	string

回應資料:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型
code	HTTP 回應狀態碼.	int32
data	成功回傳資料.	object
message	錯誤訊息.	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error".	string

回應狀態碼說明：

狀態碼	說明	schema
200	OK	WrappedResponseV2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

透過ID獲取浮水印設定介面

介面說明:透過ID取得浮水印設定

介面位址:/vod/v1/transcoding/get

請求方式：get

consumes:``

produces:["*/*"]

請求參數：

參數名稱	說明	in	是否必須	類型
appId	應用ID	query	true	string
id	取得浮水印設定ID	query	true	integer
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
timestamp	13位時間戳	query	true	string

回應資料:

{
    "code": 0,
    "data": {
        "bucketName": "",
        "content": "",
        "fileName": "",
        "fontAlpha": 0,
        "fontColor": "",
        "fontName": "",
        "fontSize": 0,
        "gmtCreate": "",
        "gmtModified": "",
        "id": 0,
        "imageDxUnit": "",
        "imageDxValue": 0,
        "imageDyUnit": "",
        "imageDyValue": 0,
        "imageHeightUnit": "",
        "imageHeightValue": 0,
        "imagePosition": "",
        "imageWidthUnit": "",
        "imageWidthValue": 0,
        "isDefault": true,
        "isDeleted": true,
        "name": "",
        "storageSystem": "",
        "textDx": 0,
        "textDy": 0,
        "type": ""
    },
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型	schema
code	HTTP 回應狀態碼。	int32
data	成功回傳資料。	string	TranscodingWatermark
message	錯誤訊息。	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error"。	string

schema 屬性說明

TranscodingWatermark

參數名稱	說明	類型
bucketName	圖片浮水印檔案儲存所在的空間或群組名稱欄位：bucket_name	string
content	文字浮水印的內容欄位：content	string
fileName	浮水印素材的檔案名稱欄位：file_name	string
fontAlpha	透明度：0-1 欄位：font_alpha	number
fontColor	文字浮水印的顏色欄位：font_color	string
fontName	文字浮水印的字型欄位：font_name	string
fontSize	文字浮水印的字號：像素欄位：font_size	int32
gmtCreate	建立時間欄位：gmt_create	date-time
gmtModified	最後修改時間欄位：gmt_modified	date-time
id	主鍵ID 欄位：id	int64
imageDxUnit	圖片浮水印水平偏移的單位：像素-pixel，百分比-percentage 欄位：image_dx_unit	string
imageDxValue	圖片浮水印水平偏移：值欄位：image_dx_value	int32
imageDyUnit	圖片浮水印垂直偏移的單位：像素-pixel，百分比-percentage 欄位：image_dy_unit	string
imageDyValue	圖片浮水印垂直偏移：值欄位：image_dy_value	int32
imageHeightUnit	圖片浮水印高度的單位：像素-pixel，百分比-percentage 欄位：image_height_unit	string
imageHeightValue	圖片浮水印高度：值欄位：image_height_value	int32
imagePosition	圖片浮水印的位置：左上、左下、右下、右上欄位：image_position	string
imageWidthUnit	圖片浮水印寬度的單位：像素-pixel，百分比-percentage 欄位：image_width_unit	string
imageWidthValue	圖片浮水印的寬度：值欄位：image_width_value	int32
isDefault	是否為預設浮水印欄位：is_default	boolean
isDeleted	是否已刪除欄位：is_deleted	boolean
name	浮水印名稱欄位：name	string
storageSystem	圖片浮水印檔案所在的儲存系統：FastDFS、AliyunOSS、Local 欄位：storage_system	string
textDx	水平偏移：像素欄位：text_dx	int32
textDy	垂直偏移：像素欄位：text_dy	int32
type	浮水印類型：圖片 - image、文字 - text 欄位：type	string

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2«TranscodingWatermark»
401	未經授權
403	禁止存取
404	找不到資源

取得浮水印設定列表介面

介面說明：取得浮水印設定列表

介面位址:/vod/v1/transcoding/list

請求方式：get

consumes:``

produces:["*/*"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用 ID	query	true	string
page	頁碼	query	false	integer
pageSize	每頁大小	query	false	integer
sign	簽章驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典順序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加 secretKey，最後進行 MD5 加密轉大寫，即為 sign 的值	query	true	string
timestamp	13 位時間戳	query	true	string

回應資料:

{
    "code": 0,
    "data": [
        {
            "bucketName": "",
            "content": "",
            "fileName": "",
            "fontAlpha": 0,
            "fontColor": "",
            "fontName": "",
            "fontSize": 0,
            "gmtCreate": "",
            "gmtModified": "",
            "id": 0,
            "imageDxUnit": "",
            "imageDxValue": 0,
            "imageDyUnit": "",
            "imageDyValue": 0,
            "imageHeightUnit": "",
            "imageHeightValue": 0,
            "imagePosition": "",
            "imagePositionDesc": "",
            "imageUrl": "",
            "imageWidthUnit": "",
            "imageWidthValue": 0,
            "isDefault": true,
            "isDeleted": true,
            "name": "",
            "storageSystem": "",
            "textDx": 0,
            "textDy": 0,
            "type": ""
        }
    ],
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型	schema
code	HTTP 回應狀態碼。	int32
data	成功回傳資料。	array	TranscodingWatermarkDTO
message	錯誤訊息。	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error"。	string

schema 屬性說明

TranscodingWatermarkDTO

參數名稱	說明	類型
bucketName	圖片浮水印檔案儲存所在的空間或群組名稱欄位：bucket_name	string
content	文字浮水印的內容欄位：content	string
fileName	浮水印素材的檔案名稱欄位：file_name	string
fontAlpha	透明度：0-1 欄位：font_alpha	number
fontColor	文字浮水印的顏色欄位：font_color	string
fontName	文字浮水印的字型欄位：font_name	string
fontSize	文字浮水印的字號：像素欄位：font_size	int32
gmtCreate	建立時間欄位：gmt_create	date-time
gmtModified	最後修改時間欄位：gmt_modified	date-time
id	主鍵ID 欄位：id	int64
imageDxUnit	圖片浮水印水平偏移的單位：像素-pixel，百分比-percentage 欄位：image_dx_unit	string
imageDxValue	圖片浮水印水平偏移：值欄位：image_dx_value	int32
imageDyUnit	圖片浮水印垂直偏移的單位：像素-pixel，百分比-percentage 欄位：image_dy_unit	string
imageDyValue	圖片浮水印垂直偏移：值欄位：image_dy_value	int32
imageHeightUnit	圖片浮水印高度的單位：像素-pixel，百分比-percentage 欄位：image_height_unit	string
imageHeightValue	圖片浮水印高度：值欄位：image_height_value	int32
imagePosition	圖片浮水印的位置：左上、左下、右下、右上欄位：image_position	string
imagePositionDesc	浮水印位置的中文描述	string
imageUrl	浮水印圖片的存取URL	string
imageWidthUnit	圖片浮水印寬度的單位：像素-pixel，百分比-percentage 欄位：image_width_unit	string
imageWidthValue	圖片浮水印的寬度：值欄位：image_width_value	int32
isDefault	是否為預設浮水印欄位：is_default	boolean
isDeleted	是否已刪除欄位：is_deleted	boolean
name	浮水印名稱欄位：name	string
storageSystem	圖片浮水印檔案所在的儲存系統：FastDFS、AliyunOSS、Local 欄位：storage_system	string
textDx	水平偏移：像素欄位：text_dx	int32
textDy	垂直偏移：像素欄位：text_dy	int32
type	浮水印類型：圖片 - image、文字 - text 欄位：type	string

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2«List«TranscodingWatermarkDTO»»
401	Unauthorized
403	Forbidden
404	Not Found

分頁取得浮水印設定列表介面

介面說明：分頁取得浮水印設定列表

介面位址:/vod/v1/transcoding/list-by-page

請求方式：get

consumes:``

produces:["*/*"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用ID	query	true	string
page	頁碼	query	false	integer
pageSize	每頁大小	query	false	integer
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
timestamp	13位時間戳	query	true	string

回應資料:

{
    "code": 0,
    "data": {
        "contents": [
            {
                "bucketName": "",
                "content": "",
                "fileName": "",
                "fontAlpha": 0,
                "fontColor": "",
                "fontName": "",
                "fontSize": 0,
                "gmtCreate": "",
                "gmtModified": "",
                "id": 0,
                "imageDxUnit": "",
                "imageDxValue": 0,
                "imageDyUnit": "",
                "imageDyValue": 0,
                "imageHeightUnit": "",
                "imageHeightValue": 0,
                "imagePosition": "",
                "imageWidthUnit": "",
                "imageWidthValue": 0,
                "isDefault": true,
                "isDeleted": true,
                "name": "",
                "storageSystem": "",
                "textDx": 0,
                "textDy": 0,
                "type": ""
            }
        ],
        "endRow": 0,
        "firstPage": true,
        "hasNextPage": true,
        "hasPreviousPage": true,
        "lastPage": true,
        "limit": 0,
        "nextPageNumber": 0,
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 0,
        "previousPageNumber": 0,
        "startRow": 0,
        "totalItems": 0,
        "totalPages": 0
    },
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型	schema
code	HTTP 回應狀態碼.	int32
data	成功回傳資料.	string	Page«TranscodingWatermark»
message	錯誤訊息.	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error".	string

schema 屬性說明

Page«TranscodingWatermark»

參數名稱	說明	類型	schema
contents	當前頁的內容。	array	TranscodingWatermark
endRow		int64
firstPage		boolean
hasNextPage		boolean
hasPreviousPage		boolean
lastPage		boolean
limit		int64
nextPageNumber		int32
offset		int64
pageNumber	當前頁。	int32
pageSize	每頁最多顯示的記錄數。	int32
previousPageNumber		int32
startRow		int64
totalItems	總記錄數。	int64
totalPages		int32

TranscodingWatermark

參數名稱	說明	類型
bucketName	圖片浮水印檔案儲存所在的空間或群組名稱欄位：bucket_name	string
content	文字浮水印的內容欄位：content	string
fileName	浮水印素材的檔案名稱欄位：file_name	string
fontAlpha	透明度：0-1 欄位：font_alpha	number
fontColor	文字浮水印的顏色欄位：font_color	string
fontName	文字浮水印的字型欄位：font_name	string
fontSize	文字浮水印的字號：像素欄位：font_size	int32
gmtCreate	建立時間欄位：gmt_create	date-time
gmtModified	最後修改時間欄位：gmt_modified	date-time
id	主鍵ID 欄位：id	int64
imageDxUnit	圖片浮水印水平偏移的單位：像素-pixel，百分比-percentage 欄位：image_dx_unit	string
imageDxValue	圖片浮水印水平偏移：值欄位：image_dx_value	int32
imageDyUnit	圖片浮水印垂直偏移的單位：像素-pixel，百分比-percentage 欄位：image_dy_unit	string
imageDyValue	圖片浮水印垂直偏移：值欄位：image_dy_value	int32
imageHeightUnit	圖片浮水印高度的單位：像素-pixel，百分比-percentage 欄位：image_height_unit	string
imageHeightValue	圖片浮水印高度：值欄位：image_height_value	int32
imagePosition	圖片浮水印的位置：左上、左下、右下、右上欄位：image_position	string
imageWidthUnit	圖片浮水印寬度的單位：像素-pixel，百分比-percentage 欄位：image_width_unit	string
imageWidthValue	圖片浮水印的寬度：值欄位：image_width_value	int32
isDefault	是否為預設浮水印欄位：is_default	boolean
isDeleted	是否已刪除欄位：is_deleted	boolean
name	浮水印名稱欄位：name	string
storageSystem	圖片浮水印檔案所在的儲存系統：FastDFS、AliyunOSS、Local 欄位：storage_system	string
textDx	水平偏移：像素欄位：text_dx	int32
textDy	垂直偏移：像素欄位：text_dy	int32
type	浮水印類型：圖片 - image、文字 - text 欄位：type	string

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2«Page«TranscodingWatermark»»
401	未經授權
403	禁止存取
404	找不到資源

設定為預設浮水印介面

介面說明：設定浮水印為預設浮水印

接口地址:/vod/v1/transcoding/set-default

請求方式：post

consumes:["application/json"]

produces:["*/*"]

請求參數：

參數名稱	說明	in	是否必填	類型
appId	應用ID	query	true	string
id	需要設定預設的水印設定ID	query	true	integer
sign	簽章驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典順序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
timestamp	13位時間戳	query	true	string

回應資料:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型
code	HTTP 回應狀態碼。	int32
data	成功回傳資料。	object
message	錯誤訊息。	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error"。	string

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

修改浮水印設定介面

介面說明：修改浮水印設定

介面位址:/vod/v1/transcoding/update

請求方式：post

consumes:["application/json"]

produces:["*/*"]

請求參數：

參數名稱	說明	in	是否必須	類型
appId	應用ID	query	true	string
bucketName	圖片浮水印檔案儲存所在的空間或群組名稱	query	false	string
content	文字浮水印的內容	query	false	string
fileName	浮水印素材的檔案名稱	query	false	string
fontAlpha	透明度：0-1	query	false	number
fontColor	文字浮水印的顏色	query	false	string
fontName	文字浮水印的字型	query	false	string
fontSize	文字浮水印的字號：像素	query	false	integer
gmtCreate	建立時間	query	false	string
gmtModified	最後修改時間	query	false	string
id	主鍵ID	query	false	integer
imageDxUnit	圖片浮水印水平偏移的單位：像素-pixel，百分比-percentage	query	false	string
imageDxValue	圖片浮水印水平偏移：值	query	false	integer
imageDyUnit	圖片浮水印垂直偏移的單位：像素-pixel，百分比-percentage	query	false	string
imageDyValue	圖片浮水印垂直偏移：值	query	false	integer
imageHeightUnit	圖片浮水印高度的單位：像素-pixel，百分比-percentage	query	false	string
imageHeightValue	圖片浮水印高度：值	query	false	integer
imagePosition	圖片浮水印的位置：左上、左下、右下、右上	query	false	string
imageWidthUnit	圖片浮水印寬度的單位：像素-pixel，百分比-percentage	query	false	string
imageWidthValue	圖片浮水印的寬度：值	query	false	integer
isDefault	是否為預設浮水印	query	false	boolean
isDeleted	是否已刪除	query	false	boolean
name	浮水印名稱	query	false	string
sign	簽名驗證的參數，產生規則：將請求介面提交的其他所有參數（不包括非空參數），按照首字母字典序排序後，再按照「參數參數值參數參數值」的方式排列，然後在首尾添加secretKey，最後進行MD5加密轉大寫，即為sign的值	query	true	string
storageSystem	圖片浮水印檔案所在的儲存系統：FastDFS、AliyunOSS、Local	query	false	string
textDx	水平偏移：像素	query	false	integer
textDy	垂直偏移：像素	query	false	integer
timestamp	13位時間戳	query	true	string
type	浮水印類型：圖片	query	false	string

回應資料:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

回應參數說明:

參數名稱	說明	類型
code	HTTP 回應狀態碼。	int32
data	成功回傳資料。	object
message	錯誤訊息。	string
status	請求狀態，成功："success"，失敗："fail"，錯誤："error"。	string

回應狀態碼說明:

狀態碼	說明	schema
200	OK	WrappedResponseV2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found