API概覽 - - 阿里雲

本文為您介紹了點播服務的所有API列表。

說明

建議您使用服務端SDK來調用API。使用API時，接入地址請參見點播中心和訪問網域名稱，使用限制，請參見使用限制。

媒體上傳

API	描述
CreateUploadVideo	調用CreateUploadVideo擷取視頻上傳地址和憑證，並建立視頻資訊。
RefreshUploadVideo	調用RefreshUploadVideo用於視頻檔案上傳逾時後重新擷取視頻上傳憑證
CreateUploadImage	調用CreateUploadImage擷取圖片上傳地址和憑證。
CreateUploadAttachedMedia	調用CreateUploadAttachedMedia擷取輔助媒資上傳地址和憑證，輔助媒資包括浮水印、字幕檔案等。
UploadMediaByURL	調用UploadMediaByURL基於源檔案URL，批量拉取媒體檔案進行上傳。
GetURLUploadInfos	調用GetURLUploadInfos擷取URL上傳資訊。
DeleteMultipartUpload	調用DeleteMultipartUpload立即刪除上傳中產生的片段檔案。
GetUploadDetails	調用GetUploadDetails通過媒資ID（支援批量）擷取媒資上傳詳情，如上傳時間、已上傳比例、上傳來源等資訊。
RegisterMedia	調用RegisterMedia進行媒資註冊。

音視頻播放

API	描述
GetPlayInfo	調用GetPlayInfo通過視頻ID直接擷取媒體檔案（可使用視訊和音頻）的播放地址。
GetVideoPlayAuth	調用GetVideoPlayAuth擷取視頻播放時所需的播放憑證。

媒資管理

媒資搜尋

API	描述
SearchMedia	調用SearchMedia搜尋媒資資訊（視頻、音頻、圖片、輔助媒資等）。

媒資分類

API	描述
AddCategory	調用AddCategory建立視頻分類。最大支援三級分類，每個分類最多支援建立100個子分類。
UpdateCategory	調用UpdateCategory修改視頻分類。
DeleteCategory	調用DeleteCategory刪除視頻分類，同時會刪除其下級分類（包括二級分類和三級分類），請謹慎操作。
GetCategories	調用GetCategories擷取指定的分類資訊，及其子分類（即下一級分類）的列表。

音視頻管理

API	描述
GetVideoInfo	調用GetVideoInfo通過視頻ID擷取視頻的基本資料，包括：視頻標題、描述、時間長度、封面URL、狀態、建立時間、大小、截圖、分類和標籤等資訊。
UpdateVideoInfo	調用UpdateVideoInfo修改視頻資訊。
UpdateVideoInfos	調用UpdateVideoInfos批量修改視頻資訊。
DeleteMezzanines	調用DeleteMezzanines大量刪除源檔案資訊及儲存。
DeleteStream	調用DeleteStream刪除媒體流（視頻流，音頻流）資訊及隱藏檔，並且支援大量刪除。
DeleteVideo	調用DeleteVideo刪除完整視頻（包括其源檔案、轉碼後的流檔案、封面截圖等），支援大量刪除。
GetMezzanineInfo	調用GetMezzanineInfo擷取音視頻的源檔案資訊，包括檔案地址、解析度、碼率等。
GetVideoList	調用GetVideoList擷取視頻資訊列表。
GetVideoInfos	調用GetVideoInfos批量擷取視頻資訊。

圖片管理

API	描述
DeleteImage	調用DeleteImage刪除使用者上傳的圖片及視頻自動截圖。
GetImageInfo	調用GetImageInfo擷取圖片的基本資料。
UpdateImageInfos	調用UpdateImageInfos批量修改圖片資訊。
ListSnapshots	調用ListSnapshots查詢指定媒體截圖。

輔助媒資管理

API	描述
GetAttachedMediaInfo	調用GetAttachedMediaInfo批量擷取輔助媒資的基本資料，包括標題、類型、標籤、建立時間等。
UpdateAttachedMediaInfos	調用UpdateAttachedMediaInfos批量修改輔助媒資資訊。
DeleteAttachedMedia	調用DeleteAttachedMedia刪除輔助媒資，支援大量刪除。

動圖管理

API	描述
ListDynamicImage	調用ListDynamicImage查詢視頻截動圖列表。
DeleteDynamicImage	調用DeleteDynamicImage刪除動圖資訊。

ApsaraVideo for Media Processing

發起處理

API	描述
SubmitTranscodeJobs	調用SubmitTranscodeJobs提交媒體轉碼作業，開始非同步轉碼處理。
SubmitSnapshotJob	調用SubmitSnapshotJob提交視頻截圖作業，開始非同步截圖處理。支援普通截圖和雪碧圖截圖。
SubmitDynamicImageJob	調用SubmitDynamicImageJob提交媒體動圖作業，開始非同步處理。
SubmitPreprocessJobs	調用SubmitPreprocessJobs提交導播台視頻預先處理。
SubmitWorkflowJob	調用SubmitWorkflowJob，可對音視頻發起點播工作流程處理。

轉碼模板

API	描述
AddTranscodeTemplateGroup	調用AddTranscodeTemplateGroup添加轉碼配置資訊，可建立新的轉碼模板組，或者向指定模板組中添加新的轉碼模板。
UpdateTranscodeTemplateGroup	調用UpdateTranscodeTemplateGroup修改轉碼配置資訊，可修改轉碼模板組下指定的轉碼模板配置。
DeleteTranscodeTemplateGroup	調用DeleteTranscodeTemplateGroup刪除轉碼配置資訊，可刪除轉碼模板組下的部分轉碼模板，也可強制移除整個轉碼模板組。
ListTranscodeTemplateGroup	調用ListTranscodeTemplateGroup查詢轉碼模板配置列表。
SetDefaultTranscodeTemplateGroup	調用SetDefaultTranscodeTemplateGroup設定預設轉碼模板配置。
GetTranscodeTemplateGroup	調用GetTranscodeTemplateGroup根據轉碼模板組ID查詢轉碼配置的詳細資料。

視頻浮水印

API	描述
AddWatermark	調用AddWatermark添加浮水印資料。
UpdateWatermark	調用UpdateWatermark更新浮水印資料。
DeleteWatermark	調用DeleteWatermark刪除浮水印。
ListWatermark	調用ListWatermark查詢使用者浮水印資料列表。
GetWatermark	調用GetWatermark查詢單個浮水印資料。
SetDefaultWatermark	調用SetDefaultWatermark設定預設浮水印。

截圖模板

API	描述
AddVodTemplate	調用AddVodTemplate添加截圖模板。
UpdateVodTemplate	調用UpdateVodTemplate修改截圖模板。
DeleteVodTemplate	調用DeleteVodTemplate刪除截圖模板。
ListVodTemplate	調用ListVodTemplate查詢截圖模板列表。
GetVodTemplate	調用GetVodTemplate查詢單個截圖模板。

轉碼任務

API	描述
GetTranscodeSummary	調用GetTranscodeSummary根據視頻ID查詢視頻轉碼摘要，包括視頻轉碼狀態、轉碼進展等匯總資訊。由於可能存在多次轉碼，故該介面只返回最近一次的轉碼摘要。
ListTranscodeTask	調用ListTranscodeTask根據視頻ID查詢視頻歷史轉碼任務資訊，該介面不返回具體的作業資訊。
GetTranscodeTask	調用GetTranscodeTask根據轉碼任務ID查詢轉碼作業詳細資料。

視訊剪輯（雲剪輯）

剪輯合成

API	描述
ProduceEditingProjectVideo	調用ProduceEditingProjectVideo將一個或多個視頻合成為成品。

剪輯工程管理

API	描述
AddEditingProject	調用AddEditingProject建立雲剪輯工程（視頻編輯任務）。
UpdateEditingProject	調用UpdateEditingProject修改雲剪輯工程（視頻編輯任務）。
DeleteEditingProject	調用DeleteEditingProject刪除雲剪輯工程，支援大量刪除。
GetEditingProject	調用GetEditingProject擷取雲剪輯工程（視頻編輯任務）的詳細資料。
SearchEditingProject	調用SearchEditingProject搜尋雲剪輯工程（視頻編輯列表）。
SetEditingProjectMaterials	調用SetEditingProjectMaterials設定雲剪輯工程的待剪輯素材。
GetEditingProjectMaterials	調用GetEditingProjectMaterials擷取雲剪輯工程的待剪輯素材列表。

媒體審核

審核設定

API	描述
SetAuditSecurityIp	調用SetAuditSecurityIp設定審核安全IP。
ListAuditSecurityIp	調用ListAuditSecurityIp擷取審核安全IP列表。

人工審核

API	描述
CreateAudit	調用CreateAudit進行人工審核，可用於審核視頻、音頻等媒體資訊。
GetAuditHistory	調用GetAuditHistory擷取人工審核的記錄。

直播轉點播

API	描述
ListLiveRecordVideo	調用ListLiveRecordVideo擷取直播轉點播視訊列表。

點播CDN

資料監控

API	描述
DescribeVodDomainTrafficData	調用DescribeVodDomainTrafficData擷取加速網域名稱的網路流量監控資料，單位：byte。
DescribeVodDomainBpsData	調用DescribeVodDomainBpsData擷取加速網域名稱的網路頻寬監控資料。

網域名稱管理

API	描述
AddVodDomain	調用AddVodDomain添加點播加速網域名稱。每次只能提交一個加速網域名稱，一個使用者最多添加20個網域名稱。
UpdateVodDomain	調用UpdateVodDomain修改加速網域名稱。
DeleteVodDomain	調用DeleteVodDomain刪除已添加的點播加速網域名稱。
BatchStartVodDomain	調用BatchStartVodDomain啟用狀態為“停用”的點播加速網域名稱，將DomainStatus變更為online。
BatchStopVodDomain	調用BatchStopVodDomain批量停用點播加速網域名稱，將DomainStatus變更為Offline。
DescribeVodUserDomains	調用DescribeVodUserDomains查詢使用者名稱下所有的點播加速網域名稱列表。
DescribeVodDomainDetail	調用DescribeVodDomainDetail擷取指定點播網域名稱配置的基本資料。

網域名稱驗證

API	描述
VerifyVodDomainOwner	調用VerifyVodDomainOwner校正網域名稱歸屬。
DescribeVodVerifyContent	調用DescribeVodVerifyContent擷取歸屬校正內容。

網域名稱配置

API	描述
BatchSetVodDomainConfigs	調用BatchSetVodDomainConfigs大量設定加速網域名稱。
DescribeVodDomainConfigs	調用DescribeVodDomainConfigs查詢網域名稱配置，一次可查詢多個功能配置。
DeleteVodSpecificConfig	調用DeleteVodSpecificConfig刪除點播加速網域名稱的配置。
SetVodDomainCertificate	調用SetVodDomainCertificate設定某網域名稱下認證功能是否啟用及修改認證資訊。
DescribeVodCertificateList	調用DescribeVodCertificateList擷取認證列表資訊。
DescribeVodDomainCertificateInfo	調用DescribeVodDomainCertificateInfo擷取指定加速網域名稱的認證資訊。

重新整理預熱

API	描述
PreloadVodObjectCaches	調用PreloadVodObjectCaches將來源站點的內容主動預熱到L2 Cache節點上，首次訪問可直接命中緩衝，緩解來源站點壓力。支援post請求，參數用form表單。
RefreshVodObjectCaches	調用RefreshVodObjectCaches重新整理節點上的檔案內容。指定URL內容重新整理至Cache節點，支援URL批量重新整理。支援post請求，參數用form表單。
DescribeVodRefreshTasks	調用DescribeVodRefreshTasks查詢重新整理和預熱狀態是否生效。
DescribeVodRefreshQuota	調用DescribeVodRefreshQuota查詢重新整理預熱URL及目錄的最大限制數量和當日剩餘數量。

日誌管理

API	描述
DescribeVodDomainLog	調用DescribeVodDomainLog擷取指定網域名稱的CDN原始訪問日誌下載地址。

資料統計

用量資料

API	描述
DescribeVodDomainUsageData	調用DescribeVodDomainUsageData查詢加速流量或頻寬用量資料。
DescribeVodStorageData	調用DescribeVodStorageData查詢媒資管理（儲存空間、儲存流出流量）的用量資料。
DescribeVodTranscodeData	調用DescribeVodTranscodeData查詢轉碼用量資料。
DescribeVodAIData	調用DescribeVodAIData查詢AI處理（智能審核、視頻DNA等）的用量資料。

播放資料

API	描述
DescribePlayTopVideos	調用DescribePlayTopVideos擷取每日TOP視頻的播放資料統計（包括VV、UV和播放總時間長度）。
DescribePlayUserAvg	調用DescribePlayUserAvg擷取指定時間範圍內的每日播放資料均量統計。
DescribePlayUserTotal	調用DescribePlayUserTotal擷取指定時間範圍內的每日播放資料總量統計。
DescribePlayVideoStatis	調用DescribePlayVideoStatis擷取指定視頻在指定時間範圍內的每日播放統計資料。

多應用體系

應用管理

API	描述
CreateAppInfo	調用CreateAppInfo建立新的應用。
GetAppInfos	調用GetAppInfos通過應用ID查詢應用資訊，支援批量查詢。
ListAppInfo	調用ListAppInfo根據查詢條件擷取有許可權的應用資訊列表。
UpdateAppInfo	調用UpdateAppInfo更新應用資訊。
DeleteAppInfo	調用DeleteAppInfo刪除應用資訊。

授權管理

API	描述
AttachAppPolicyToIdentity	調用AttachAppPolicyToIdentity為指定身份（RAM使用者或角色）附加點播應用的存取權限。
ListAppPoliciesForIdentity	調用ListAppPoliciesForIdentity列出指定帳號身份（RAM子帳號或RAM角色）被授予的應用許可權的列表。
DetachAppPolicyFromIdentity	調用DetachAppPolicyFromIdentity為指定帳號身份（RAM子帳號或RAM角色）撤銷指定的應用授權。

資源遷移

API	描述
MoveAppResource	調用MoveAppResource將媒資等資源從一個應用遷移到另外一個應用。

全域配置

事件通知

API	描述
SetMessageCallback	調用SetMessageCallback設定事件通知的回調方式、回調地址、事件類型。
GetMessageCallback	調用GetMessageCallback查詢事件通知的回調方式、回調地址、事件類型。
DeleteMessageCallback	調用DeleteMessageCallback刪除事件通知的回調方式、回調地址、事件類型。

儲存管理

API	描述
SetCrossdomainContent	調用SetCrossdomainContent更新點播跨域檔案crossdomain.xml的內容。