API標準及多語言預置SDK
本產品(vod/2017-03-21)的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK,開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求,可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜,需花費 5個工作日左右。因此建議加入我們的服務DingTalk群(147535001692),在專家指導下進行簽名對接。
在使用API前,您需要準備好身份帳號及存取金鑰(AccessKey),才能有效通過用戶端工具(SDK、CLI等)訪問API。細節請參見擷取AccessKey。
自訂簽名情境
若您的業務情境有特殊需求,需通過自簽名方式對接 API,建議優先諮詢我們的支援人員團隊(服務DingTalk群:147535001692),擷取專業指導以確保高效接入。
帳號與安全準備
阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露,所有相關資源都將面臨未經授權訪問的風險。為確保安全,建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey,同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下,才使用阿里雲帳號。
媒體上傳
|
API |
標題 |
API概述 |
| CreateUploadVideo | 擷取音視頻上傳地址和憑證 | 點播服務下發上傳地址和憑證以保障授權和安全,防止惡意上傳,並在下發時自動建立媒體ID(MediaId),也叫視頻ID(VideoId)用於管理。通過調用本介面可擷取上傳所需地址和憑證,並建立音視頻資訊。 |
| RefreshUploadVideo | 重新整理視頻上傳憑證 | 用於視頻檔案上傳逾時後重新擷取視頻上傳憑證。 |
| CreateUploadImage | 擷取圖片上傳地址和憑證 | 點播服務下發上傳地址和憑證以保障授權和安全,防止惡意上傳,並在下發時自動建立圖片ID(ImageId)用於管理。通過調用本介面可擷取上傳所需地址和憑證,並建立圖片資訊。 |
| CreateUploadAttachedMedia | 擷取輔助媒資上傳地址和憑證 | 上傳地址和憑證由點播服務提供,旨在解決授權與安全問題,防止惡意上傳,並自動建立用於管理和處理的媒資ID(Mediaid)。輔助媒資如浮水印、字幕等,通過調用本介面擷取上傳憑證並建立相應媒資資訊。 |
| CancelUrlUploadJobs | 取消URL上傳任務 | 清除佇列中的URL上傳任務。 |
| DeleteMultipartUpload | 刪除上傳中的片段檔案 | 刪除上傳中產生的片段檔案。 |
| GetUploadDetails | 擷取媒體上傳詳情 | 通過媒體ID擷取媒體上傳詳情(如上傳時間、已上傳比例、上傳來源等資訊),支援批量擷取。 |
| RegisterMedia | 註冊媒資資訊 | 進行媒資註冊,存取點播服務的OSS自有Bucket上的存量媒資檔案,需要進行媒資註冊產生點播需要的關聯資料後,才能正常使用點播提供的轉碼、截圖等功能。 |
影音播放
|
API |
標題 |
API概述 |
| GetVideoPlayAuth | 擷取音視頻播放憑證 | 調用本介面擷取音視頻的播放憑證(PlayAuth)。阿里雲播放器SDK使用該憑證自動擷取播放地址。由於播放憑證具有時效性,且與特定音視頻綁定,不可混用或重複使用,因此憑證到期或無效將導致無法播放。此播放方式適用於需要高安全性的音視頻播放情境。 |
媒資管理
|
API |
標題 |
API概述 |
| 分級儲存 | 分級儲存 | |
| UpdateMediaStorageClass | 修改媒資儲存類型 | 修改媒資儲存類型。 |
| RestoreMedia | 解凍媒資 | 解凍媒資。 |
| 影音管理 | 影音管理 | |
| GetVideoInfo | 擷取單個音視頻資訊 | 調用本介面通過音/視頻ID來擷取單個音視頻的標題、描述、時間長度、封面URL、狀態、建立時間、大小、截圖、分類和標籤等資訊。 |
| GetVideoInfos | 批量擷取音視頻資訊 | 調用本介面通過音/視頻ID批量擷取多個音視頻的標題、描述、時間長度、封面URL、狀態、建立時間、大小、截圖、分類和標籤等資訊。 |
| GetMezzanineInfo | 擷取源檔案資訊 | 擷取音視頻的源檔案資訊,包括檔案地址、解析度、碼率等。 |
| UpdateVideoInfo | 修改單個音視頻資訊 | 修改單個音視頻資訊。 |
| UpdateVideoInfos | 批量修改音視頻資訊 | 批量修改音視頻資訊。 |
| DeleteMezzanines | 大量刪除音視頻源檔案 | 大量刪除音視頻源檔案資訊。 |
| DeleteStream | 刪除媒體流 | 刪除媒體流(視頻流,音頻流)資訊及隱藏檔。 |
| DeleteVideo | 刪除完整視頻 | 刪除完整視頻(包括視頻源檔案、轉碼後的流檔案、封面截圖等)。 |
| DescribeMediaDistribution | 查詢媒資分布 | 查詢音視頻媒資資料按時間分布。起止時間跨度最大6個月。 |
| 輔助媒資管理 | 輔助媒資管理 | |
| GetAttachedMediaInfo | 批量擷取輔助媒資資訊 | 當浮水印圖片、字幕檔案、素材等輔助媒資上傳到ApsaraVideo for VOD後,可以調用本介面傳入多個輔助媒資ID批量擷取輔助媒資的基本資料及訪問地址。 |
| UpdateAttachedMediaInfos | 批次更新輔助媒資資訊 | 當將帶有浮水印的圖片、字幕檔案或其它素材等輔助媒體資源上傳至ApsaraVideo for VOD後,可以通過本介面依據這些輔助媒體的唯一識別碼(ID),批次更新它們的標題、描述、標籤及分類等資訊。 |
| DeleteAttachedMedia | 大量刪除輔助媒資 | 當浮水印圖片、字幕檔案、素材等輔助媒體資源上傳至ApsaraVideo for VOD後,可以利用本介面能進行單個或批量的刪除操作。 |
| 圖片管理 | 圖片管理 | |
| GetImageInfos | 批量擷取圖片資訊 | 圖片上傳到ApsaraVideo for VOD後,可以調用本介面通過傳入多個圖片ID,批量擷取圖片的基本資料及訪問地址。 |
| UpdateImageInfos | 批次更新圖片資訊 | 圖片上傳到ApsaraVideo for VOD後,可以調用本介面通過圖片ID批量修改圖片的標題、描述、標籤和分類資訊。 |
| ListSnapshots | 查詢視頻截圖資料 | 調用本介面可以查詢通過視頻截圖作業產生的截圖,以及視頻上傳時系統產生的封面截圖。 |
| 動態圖管理 | 動態圖管理 | |
| ListDynamicImage | 查詢動圖列表 | 調用本介面,通過視頻ID查詢視頻截動圖列表。 |
| DeleteDynamicImage | 刪除動圖資訊 | 調用本介面刪除動圖資訊。 |
媒體處理
|
API |
標題 |
API概述 |
| 發起處理 | 發起處理 | |
| SubmitTranscodeJobs | 提交媒體轉碼作業 | 調用本介面提交媒體轉碼作業,開始非同步轉碼處理。 |
| SubmitPreprocessJobs | 導播台視頻預先處理 | 調用本介面通過導播台對視頻進行轉碼處理。 |
| SubmitWorkflowJob | 提交點播工作流程作業 | 對視頻發起點播工作流程處理。 |
| 轉碼範本 | 轉碼範本 | |
| AddTranscodeTemplateGroup | 建立轉碼模板組 | 調用本介面添加轉碼配置資訊,可建立新的轉碼模板組,或者向指定模板組中添加新的轉碼模板。 |
| UpdateTranscodeTemplateGroup | 修改轉碼設定 | 調用本介面修改轉碼設定資訊,可修改轉碼範本群組下指定的轉碼範本設定。 |
| SetDefaultTranscodeTemplateGroup | 設定預設轉碼配置 | 調用本介面設定預設轉碼模板配置。 |
| ListTranscodeTemplateGroup | 查詢轉碼配置列表 | 調用本介面查詢轉碼模板配置列表。 |
| GetTranscodeTemplateGroup | 查詢轉碼配置詳情 | 根據轉碼模板組ID查詢轉碼配置的詳細資料。 |
| DeleteTranscodeTemplateGroup | 刪除轉碼配置 | 刪除轉碼配置資訊,可刪除轉碼模板組下的部分轉碼模板,也可強制移除整個轉碼模板組。 |
| 截圖範本 | 截圖範本 | |
| AddVodTemplate | 添加截圖或動圖模板 | 調用本介面添加截圖或動圖模板。 |
| UpdateVodTemplate | 修改截圖模板 | 修改截圖模板。 |
| GetVodTemplate | 查詢單個截圖模板 | 調用本介面查詢單個截圖模板。 |
| ListVodTemplate | 查詢截圖模板列表 | 查詢截圖模板列表。 |
| DeleteVodTemplate | 刪除截圖模板 | 調用本介面刪除截圖模板。 |
| 圖文浮水印範本 | 圖文浮水印範本 | |
| AddWatermark | 添加圖文浮水印模板 | 為了簡化浮水印任務的處理過程,ApsaraVideo for VOD將複雜的浮水印位置、浮水印大小、浮水印文字的字型、顏色等浮水印參數固化成模板,並通過具有唯一性的浮水印模板ID來指代。調用本介面可以添加圖片浮水印模板或文字浮水印模板。 |
| UpdateWatermark | 修改圖文浮水印模板 | 添加圖文浮水印模板後,可以調用本介面修改圖文浮水印模板的模板名稱和浮水印配置(WatermarkConfig)。 |
| DeleteWatermark | 刪除圖文浮水印模板 | 調用本介面通過浮水印模板ID刪除圖片浮水印模板或文字浮水印模板。 |
| SetDefaultWatermark | 設定預設圖文浮水印模板 | 調用本介面將指定浮水印模板設定為預設浮水印模板。 |
| GetWatermark | 查詢單個圖文浮水印模板 | 調用本介面通過浮水印模板ID查詢單個圖片浮水印模板或文字浮水印模板的配置資訊,包括圖片浮水印的位置、大小,展示時間,文字浮水印的內容、字型、顏色、位置等參數配置資訊。 |
| ListWatermark | 查詢圖文浮水印模板列表 | 調用本介面查詢當前服務地區下已添加的所有圖片浮水印模板和文字浮水印模板的配置資訊,包括圖片浮水印的位置、大小,展示時間,文字浮水印的內容、字型、顏色、位置等參數配置資訊。 |
| 轉碼任務 | 轉碼任務 | |
| GetTranscodeSummary | 查詢音視頻轉碼摘要 | 調用本介面根據音視頻ID查詢音視頻轉碼摘要,包括音視頻轉碼狀態、轉碼進展等匯總資訊。 |
| ListTranscodeTask | 查詢轉碼工作清單 | 調用本介面根據音視頻ID查詢音視頻歷史轉碼任務資訊,本介面不返回具體的作業資訊。 |
| GetTranscodeTask | 查詢轉碼任務詳情 | 調用本介面根據轉碼任務ID查詢轉碼作業詳細資料。 |
| 任務管理 | 任務管理 | |
| ListJobInfo | 查詢工作清單 | 調用本介面根據媒資ID查詢歷史工作清單。 |
| GetJobDetail | 擷取任務詳情 | 調用本介面根據jobId查詢非同步任務詳情。 |
影片編輯(雲端剪輯)
|
API |
標題 |
API概述 |
| ProduceEditingProjectVideo | 視頻合成 | 將一個或多個視頻合成為成品。可以通過時間軸參數直接提交源視頻,也可以先建立雲剪輯工程,再提交合成。 |
| 雲端剪輯工程管理 | 雲端剪輯工程管理 | |
| AddEditingProject | 建立雲剪輯工程 | 調用本介面建立雲剪輯工程(視頻編輯任務)。 |
| DeleteEditingProject | 刪除雲剪輯工程 | 調用本介面刪除雲剪輯工程。 |
| SetEditingProjectMaterials | 設定雲剪輯工程素材 | 調用本介面設定雲剪輯工程的待剪輯素材。 |
媒體審核
|
API |
標題 |
API概述 |
| 審核設定 | 審核設定 | |
| SetAuditSecurityIp | 設定審核安全IP | 調用本介面設定審核安全IP。 |
| ListAuditSecurityIp | 擷取審核安全IP列表 | 調用本介面擷取審核安全IP列表。 |
| 智慧審核 | 智慧審核 | |
| SubmitAIMediaAuditJob | 提交音視頻智能審核作業 | 調用本介面提交音視頻智能審核作業。作業在提交成功後會非同步執行,不保證介面返回時作業已處理完成。 |
| SubmitAIImageAuditJob | 提交圖片智能審核作業 | 調用本介面來提交圖片智能審核任務,作業在提交成功後會非同步執行,不保證介面返回時作業已處理完成。 |
| GetAIMediaAuditJob | 查詢智能審核作業 | 調用本介面查詢智能審核作業,在提交AI作業後,會進行非同步處理,通過此介面可以即時查詢作業資訊。 |
| GetMediaAuditResult | 擷取智能審核結果摘要 | 調用本介面擷取智能審核結果摘要資訊。 |
| GetMediaAuditResultDetail | 擷取智能審核結果詳情 | 調用本介面擷取智能審核結果詳情。通過此介面可即時查詢審核結果詳情。 |
| GetMediaAuditResultTimeline | 擷取智能審核結果時間軸 | 調用本介面擷取到所有違規內容截圖的時間點。 |
| GetMediaAuditAudioResultDetail | 擷取智能音頻審核結果詳情 | 調用本介面擷取音頻審核詳情。 |
| 人工審核 | 人工審核 | |
| GetAuditHistory | 擷取人工審核歷史 | 調用本介面擷取人工審核的記錄。 |
影片 AI
|
API |
標題 |
API概述 |
| AI 範本 | AI 範本 | |
| AddAITemplate | 添加AI模板 | 調用本介面添加智能審核和智能封面任務需要使用的AI模板。 |
| DeleteAITemplate | 刪除AI模板 | 調用本介面刪除AI模板。 |
| UpdateAITemplate | 修改AI模板 | 調用本介面修改AI模板。 |
| SetDefaultAITemplate | 設定預設AI模板 | 調用本介面設定預設AI模板。 |
| GetAITemplate | 查詢AI模板 | 調用本介面查詢AI模板。 |
| ListAITemplate | 查詢AI模板列表 | 調用本介面查詢AI模板列表。 |
| GetDefaultAITemplate | 查詢預設AI模板 | 調用本介面查詢預設AI模板。 |
| AI 作業 | AI 作業 | |
| ListAIJob | 查詢智能標籤或視頻DNA作業 | 調用本介面查詢智能標籤或視頻DNA作業。在提交智能標籤或視頻DNA作業後,會進行非同步處理,通過此介面可以即時查詢作業資訊。 |
| SubmitAIJob | 提交智能標籤或視頻DNA作業 | 調用本介面提交智能標籤或視頻DNA作業。 |
| 影片 DNA | 影片 DNA | |
| GetMediaDNAResult | 擷取視頻DNA結果 | 調用本介面擷取視頻DNA結果。視頻DNA作業完成後,可通過此介面即時查詢DNA結果。 |
| SubmitMediaDNADeleteJob | 刪除視頻DNA作業 | 調用本介面刪除視頻DNA作業。 |
| 智慧標籤 | 智慧標籤 | |
| GetAIVideoTagResult | 擷取智能標籤結果 | 調用本介面擷取智能標籤結果。 |
| 智慧封面 | 智慧封面 | |
| SubmitAIImageJob | 提交AI圖片任務 | 調用本介面提交AI圖片處理任務。 |
| GetAIImageJobs | 查詢AI圖片工作清單 | 調用本介面查詢AI圖片工作清單。 |
| ListAIImageInfo | 查詢智能封面資訊 | 調用本介面查詢指定視頻下的AI圖片資訊。 |
| DeleteAIImageInfos | 刪除AI圖片資訊 | 調用本介面刪除AI圖片資訊。 |
直播轉隨選視訊
|
API |
標題 |
API概述 |
| ListLiveRecordVideo | 擷取直播轉點播視訊列表 | 調用本介面擷取直播轉點播視訊列表。 |
隨選視訊 CDN
|
API |
標題 |
API概述 |
| 監控查詢 | 監控查詢 | |
| 資源存取資料 | 資源存取資料 | |
| DescribeVodDomainTrafficData | 查詢流量 | 調用本介面查詢加速網域名稱的流量資料,相比DescribeVodDomainRealTimeTrafficData介面,本介面支援可查詢的歷史資料時間範圍更長(最長可查詢最近366天的資料),但其資料時間粒紋更大(最小為5分鐘),資料延遲更高。 |
| DescribeVodDomainBpsData | 查詢頻寬 | 調用本介面查詢加速網域名稱的頻寬資料,相比DescribeVodDomainRealTimeBpsData介面,本介面支援可查詢的歷史資料時間範圍更長(最長可查詢最近366天的資料),但其資料時間粒紋更大(最小為5分鐘),資料延遲更高。 |
| DescribeVodDomainBpsDataByLayer | 查詢頻寬-按協議 | 調用本介面按協議類型查詢加速網域名稱的頻寬資料。 |
| DescribeVodDomainQpsData | 查詢QPS | 擷取5分鐘計算粒度加速網域名稱的每秒訪問次數QPS,支援擷取最近90天的資料。 |
| DescribeVodDomainHitRateData | 查詢位元組命中率 | 調用本介面查詢加速網域名稱的位元組命中率(命中位元組百分比)。 |
| DescribeVodDomainReqHitRateData | 查詢請求命中率 | 調用本介面查詢加速網域名稱的請求命中率(命中請求百分比)。 |
| DescribeVodRangeDataByLocateAndIspService | 查詢訪問資料-按電訊廠商和地區 | 調用本介面按電訊廠商或地區查詢加速網域名稱的訪問資料,包括頻寬、響應平均速率、頁面瀏覽量、快取命中率、請求命中率等資料。 |
| 資源回源資料 | 資源回源資料 | |
| DescribeVodDomainSrcTrafficData | 查詢回源流量 | 調用本介面查詢加速網域名稱的回源流量資料。 |
| DescribeVodDomainSrcBpsData | 查詢回源頻寬 | 調用本介面查詢加速網域名稱的回源頻寬資料。 |
| 即時存取資料 | 即時存取資料 | |
| DescribeVodDomainRealTimeTrafficData | 查詢即時資料流量 | 調用本介面查詢加速網域名稱的流量資料,相比DescribeVodDomainTrafficData介面,本介面支援查詢的資料時間粒紋更小(最小為1分鐘),資料延遲更低(最少為5分鐘),但可查詢的歷史資料時間範圍更短(最長可查詢最近186天的資料)。 |
| DescribeVodDomainRealTimeBpsData | 查詢即時頻寬 | 調用本介面查詢加速網域名稱的頻寬資料,相比DescribeVodDomainBpsData介面,本介面支援查詢的資料時間粒紋更小(最小為1分鐘),資料延遲更低(最少為5分鐘),但可查詢的歷史資料時間範圍更短(最長可查詢最近186天的資料)。 |
| DescribeVodDomainRealTimeHttpCodeData | 查詢即時HTTP狀態代碼 | 調用本介面查詢加速網域名稱HTTP狀態代碼的總數和佔比資料。本介面支援查詢的資料時間粒紋最小為1分鐘,資料延遲最少為5分鐘,最長可查詢最近186天的資料。 |
| DescribeVodDomainRealTimeQpsData | 查詢即時QPS | 調用本介面查詢加速網域名稱每秒訪問次數的資料。本介面支援查詢的資料時間粒紋最小為1分鐘,資料延遲最少為5分鐘,最長可查詢最近186天的資料。 |
| DescribeVodDomainRealTimeReqHitRateData | 查詢即時請求命中率 | 調用本介面查詢加速網域名稱的請求命中率資料。本介面支援查詢的資料時間粒紋最小為1分鐘,資料延遲最少為5分鐘,最長可查詢最近186天的資料。 |
| DescribeVodDomainRealTimeByteHitRateData | 查詢即時位元組命中率 | 調用本介面查詢加速網域名稱的位元組命中率資料。本介面支援查詢的資料時間粒紋最小為1分鐘,資料延遲最少為5分鐘,最長可查詢最近186天的資料。 |
| DescribeVodDomainRealTimeDetailData | 查詢即時訪問詳細資料 | 調用本介面查詢加速網域名稱的即時訪問資料,可查詢最近7天內的QPS、頻寬、HTTP狀態代碼資料。 |
| 網域管理 | 網域管理 | |
| AddVodDomain | 添加加速網域名稱 | 調用本介面添加點播加速網域名稱。 |
| DeleteVodDomain | 刪除加速網域名稱 | 調用本介面刪除已添加的點播加速網域名稱。 |
| UpdateVodDomain | 修改加速網域名稱 | 調用本介面修改加速網域名稱。 |
| DescribeVodUserDomains | 查詢加速網域名稱列表 | 調用本介面查詢使用者名稱下所有的點播加速網域名稱列表。 |
| DescribeVodDomainDetail | 查詢網域名稱基本資料 | 調用本介面擷取指定點播網域名稱配置的基本資料。 |
| BatchStartVodDomain | 啟用加速網域名稱 | 調用本介面啟用狀態為“停用”的加速網域名稱。 |
| BatchStopVodDomain | 停用加速網域名稱 | 調用本介面暫停網域名稱加速。 |
| 網域驗證 | 網域驗證 | |
| VerifyVodDomainOwner | 網域名稱歸屬權驗證 | 調用本介面驗證網域名稱歸屬權。 |
| DescribeVodVerifyContent | 擷取歸屬校正內容 | 調用本介面擷取歸屬校正內容。 |
| 網域設定 | 網域設定 | |
| DeleteVodSpecificConfig | 刪除網域名稱配置 | 調用本介面刪除點播加速網域名稱的配置。 |
| SetVodDomainCertificate | 設定網域名稱認證啟用及修改資訊 | 調用本介面設定某網域名稱下認證功能是否啟用及修改認證資訊。 |
| DescribeVodDomainConfigs | 查詢網域名稱配置 | 調用本介面查詢網域名稱配置,一次可查詢多個功能配置。 |
| DescribeVodCertificateList | 查詢認證列表 | 調用本介面擷取認證列表資訊。 |
| DescribeVodDomainCertificateInfo | 查詢網域名稱認證 | 調用本介面擷取指定加速網域名稱的認證資訊。 |
| BatchSetVodDomainConfigs | 大量設定網域名稱 | 調用本介面大量設定加速網域名稱。 |
| 重新整理預熱 | 重新整理預熱 | |
| DescribeVodRefreshTasks | 查詢重新整理和預熱狀態 | 調用本介面查詢重新整理和預熱狀態是否生效。 |
| DescribeVodRefreshQuota | 查詢重新整理預熱次數限制和餘量 | 調用本介面查詢重新整理預熱URL及目錄的最大限制數量和當日剩餘數量。 |
| PreloadVodObjectCaches | 預熱緩衝 | 調用本介面將來源站點的內容主動預熱到L2 Cache節點上,首次訪問可直接命中緩衝,緩解來源站點壓力。 |
| RefreshVodObjectCaches | 重新整理緩衝 | 調用本介面重新整理節點上的檔案內容。指定URL內容重新整理至Cache節點,支援URL批量重新整理。 |
| RefreshMediaPlayUrls | 提交音視頻重新整理或預熱任務 | 調用本介面通過音視頻ID發起音視頻重新整理或預熱任務。 |
| GetMediaRefreshJobs | 查詢視頻重新整理或預熱任務資訊 | 調用本介面查詢視頻重新整理或預熱任務的任務狀態、篩選策略等任務資訊。 |
| 日誌管理 | 日誌管理 | |
| DescribeVodDomainLog | 查詢網域名稱日誌 | 調用本介面擷取指定網域名稱的CDN原始訪問日誌下載地址。 |
影片安全
|
API |
標題 |
API概述 |
| 數位浮水印 | 數位浮水印 | |
| SubmitDigitalWatermarkExtractJob | 提交數字浮水印提取作業 | 通過調用本介面提交數字浮水印(著作權浮水印或溯源浮水印)提取作業,開始非同步提取著作權浮水印或溯源浮水印。 |
| GetDigitalWatermarkExtractResult | 查詢數字浮水印提取作業 | 通過調用本介面查詢數字浮水印(著作權浮水印或溯源浮水印)的提取作業結果,包括數字浮水印提取作業的狀態、成功提取出的浮水印文字等資訊。 |
| 安全下載(快取) | 安全下載(快取) | |
| GenerateDownloadSecretKey | 產生安全下載密鑰 | 阿里雲播放器SDK的安全下載功能,可使視頻下載到本地時經密鑰檔案進行加密,讓其僅能通過預先綁定的唯一App產生的密鑰檔案進行解密播放,可有效保護視頻內容,防止下載到本地的視頻被惡意播放或傳播。調用本介面可產生用於安全下載的密鑰。 |
資料統計
|
API |
標題 |
API概述 |
| 用量資料 | 用量資料 | |
| DescribeVodDomainUsageData | 查詢流量頻寬用量 | 調用本介面查詢加速流量或頻寬用量資料。 |
| DescribeVodStorageData | 查詢儲存用量 | 調用本介面查詢媒資管理(儲存空間、儲存流出流量)的用量。 |
| DescribeVodTranscodeData | 查詢轉碼用量資料 | 調用本介面查詢轉碼用量資料。 |
| DescribeVodAIData | 查詢AI處理用量資料 | 調用本介面查詢AI處理(智能審核、視頻DNA等)的用量資料。 |
| DescribeVodTieringStorageData | 查詢分級儲存的用量 | 查詢媒資管理分級儲存的用量。 |
| DescribeVodTieringStorageRetrievalData | 查詢分級儲存取回資料 | 查詢媒資管理分級儲存的取回資料用量。 |
| 播放品質(QOS/QOE) | 播放品質(QOS/QOE) | |
| DescribeVodPlayerMetricData | 播放器播放資料查詢 | 查詢播放器指標資料。 |
| DescribeVodPlayerCollectData | 播放器播放摘要資料查詢 | 查詢播放器播放匯總的資料。 |
| DescribeVodPlayerDimensionData | 播放器維度元資訊查詢 | 查詢播放器維度元資訊。 |
| 播放資料(新) | 播放資料(新) | |
| GetDailyPlayRegionStatis | 音視頻ID流量資料統計 | 擷取指定日期和地區的全量媒資流量資料。該資料基於CDN流量日誌產生,主要反映視頻的流量消耗情況。產生的CSV檔案中包含以下資訊:日期、視頻ID、網域名稱、流量、應用ID、分類ID等。您可以將檔案下載到本地,用於營運資料分析等情境。 |
| DescribeVodMediaPlayData | 音視頻播放資料統計 | 通過媒體ID(即音視頻ID)擷取音視頻在指定日期的播放資料,包括訪問使用者數、人均播放次數、播放總次數、人均播放時間長度、累計播放時間長度等資料。 |
| 播放資料(舊) | 播放資料(舊) | |
| DescribePlayTopVideos | TOP視頻播放資料統計 | 調用本介面擷取每日TOP視頻的播放資料統計,統計指標包括播放次數、播放使用者數和播放總時間長度。 |
| DescribePlayUserAvg | 播放資料均量統計 | 調用本介面擷取指定時間範圍內的每日播放資料均量統計,統計指標包括平均播放時間長度、平均播放次數。 |
| DescribePlayUserTotal | 播放資料總量統計 | 調用本介面擷取指定時間範圍內的每日播放資料總量統計,統計指標包括總播放次數、總播放使用者數、總播放時間長度、播放時間長度分布。 |
| DescribePlayVideoStatis | 單視頻播放資料統計 | 調用本介面查詢指定視頻在指定時間範圍內的每日播放統計資料,統計指標包括播放總時間長度、播放次數、播放使用者數和播放時間長度分布。 |
多應用程式體系
|
API |
標題 |
API概述 |
| 應用程式管理 | 應用程式管理 | |
| CreateAppInfo | 建立應用 | 調用本介面建立新的應用。 |
| DeleteAppInfo | 刪除應用 | 調用本介面刪除應用資訊。 |
| UpdateAppInfo | 更新應用資訊 | 調用本介面更新應用資訊。 |
| GetAppInfos | 查詢應用資訊 | 調用本介面通過應用ID查詢應用資訊。 |
| ListAppInfo | 擷取應用資訊列表 | 調用本介面根據查詢條件擷取有許可權的應用資訊列表。 |
| AddVodStorageForApp | 為子應用綁定儲存 | 為ApsaraVideo for VOD的子應用綁定儲存Bucket。 |
| 授權管理 | 授權管理 | |
| AttachAppPolicyToIdentity | 為身分實體附加應用授權 | 調用本介面為指定身分(RAM使用者或RAM角色)附加點播應用的存取權限。 |
| DetachAppPolicyFromIdentity | 為身份實體撤銷應用授權 | 調用本介面為指定帳號身份(RAM使用者或RAM角色)撤銷指定的應用授權。 |
| ListAppPoliciesForIdentity | 查詢身份實體被授予的應用許可權列表 | 調用本介面列出指定帳號身份(RAM使用者或RAM角色)被授予的應用許可權的列表。 |
| 資源遷移 | 資源遷移 | |
| MoveAppResource | 遷移資源到新應用 | 調用本介面將媒資等資源從一個應用遷移到另外一個應用。應用管理員可以直接轉移,RAM使用者或RAM角色需要對資源轉移前後的兩個應用擁有寫入權限,支援批量遷移。 |
| 播放金鑰 | 播放金鑰 | |
| GetAppPlayKey | 擷取應用播放密鑰 | 擷取應用播放密鑰。 |
| SetAppPlayKey | 設定應用播放密鑰 | 設定應用播放密鑰。 |
全域設定
|
API |
標題 |
API概述 |
| 儲存管理 | 儲存管理 | |
| SetCrossdomainContent | 更新跨域檔案 | 調用本介面更新點播跨域檔案crossdomain.xml的內容。 |
| 事件通知 | 事件通知 | |
| DeleteMessageCallback | 刪除事件通知配置 | 調用本介面刪除事件通知的回調方式、回調地址、事件類型。 |
| SetMessageCallback | 設定事件通知配置 | 調用本介面設定事件通知的回調方式、回調地址、事件類型。 |
| GetMessageCallback | 查詢事件通知配置 | 調用本介面查詢事件通知的回調方式、回調地址、事件類型。 |
其他
|
API |
標題 |
API概述 |
| DescribeVodDomainMax95BpsData | 查詢95頻寬峰值 | 調用本介面查詢加速網域名稱95頻寬峰值監控資料。 |
| DescribeVodSSLCertificateList | 查詢認證列表-按網域名稱 | 調用本介面按照網域名稱查詢認證列表資訊。 |
| SetVodDomainSSLCertificate | 設定點播網域名稱認證 | 調用本介面用於設定某網域名稱下認證功能是否啟用及更新認證資訊。 |
| DescribeVodEditingUsageData | 點播雲剪輯用量查詢 | 調用DescribeVodEditingUsageData查詢點播雲剪輯用量。 |
| DescribeVodUserVipsByDomain | 查詢節點IP列表-L1 | 調用DescribeVodUserVipsByDomain查詢網域名稱的IP列表。 |
Others
|
API |
標題 |
API概述 |
| AddCategory | 建立分類 | 通過調用本介面來建立分類,可以有效地對儲存在ApsaraVideo for VOD平台上的音視頻、圖片及短視頻素材進行歸類,從而使得資源的尋找與管理變得更加高效便捷。 |
| AddEditingProjectMaterials | 增加剪輯工程關聯素材 | 將一個或多個素材添加到剪輯工程中。 |
| BatchGetMediaInfos | 批量擷取媒資資訊 | 批量擷取媒資基礎資訊和源檔案資訊。 |
| ChangeResourceGroup | 資源轉組 | 調用本介面將資源進行轉組。 |
| CreateAudit | 人工審核 | 調用本介面進行人工審核,可用於審核視頻、音頻等媒體資訊。 |
| DecryptKMSDataKey | 解密KMS資料密鑰密文 | 通過調用本介面解密KMS資料密鑰中的CiphertextBlob密文。 |
| DeleteCategory | 刪除分類 | 調用本介面刪除分類及其子分類。 |
| DeleteEditingProjectMaterials | 刪除雲剪輯工程素材 | 刪除雲剪輯工程的待剪輯素材。 |
| DeleteImage | 刪除圖片或視頻截圖 | 調用本介面刪除使用者上傳的圖片或視頻截圖產生的圖片。 |
| GenerateKMSDataKey | 建立KMS資料密鑰 | 通過調用本介面產生一個隨機的KMS資料密鑰,用於ApsaraVideo for VOD標準加密。 |
| GetCategories | 擷取分類及其子分類資訊 | 調用本介面按ID或類型來篩選查詢指定的分類資訊,及其子分類(即下一級分類)的列表。 |
| GetEditingProject | 擷取單個雲剪輯工程 | 調用本介面進行擷取雲剪輯工程(視頻編輯任務)的詳細資料。 |
| GetEditingProjectMaterials | 擷取雲剪輯工程素材 | 調用本介面擷取雲剪輯工程的待剪輯素材列表。 |
| GetImageInfo | 擷取單個圖片資訊 | 圖片上傳至ApsaraVideo for VOD後,可調用本介面通過圖片ID擷取其基本資料及訪問地址。 |
| GetPlayInfo | 擷取音視頻播放地址 | 調用此介面並提供音視頻ID即可擷取播放地址,隨後可使用阿里雲播放器或第三方播放器(如系統原生、開源或自研播放器)播放音視頻內容。 |
| GetURLUploadInfos | 擷取URL上傳資訊 | 擷取URL上傳資訊。 |
| GetVideoList | 擷取音視頻資訊列表 | 擷取視頻資訊列表。 |
| SearchEditingProject | 搜尋雲剪輯工程 | 調用本介面搜尋雲剪輯工程(視頻編輯列表)。 |
| SearchMedia | 搜尋媒體資訊 | 本介面用於搜尋ApsaraVideo for VOD生產的視頻、音頻和圖片等媒資資訊,調用本介面配合媒資搜尋協議可實現在ApsaraVideo for VOD中進行指定返回欄位、精確匹配、模糊比對、多值查詢、範圍查詢、排序欄位等多方式多維度搜尋查詢。 |
| SubmitDynamicImageJob | 提交媒體動圖作業 | 調用本介面提交媒體動圖作業,開始非同步處理。 |
| SubmitSnapshotJob | 提交媒體截圖作業 | 調用本介面提交視頻截圖作業,開始非同步截圖處理。 |
| UpdateCategory | 更新分類 | 調用本介面對分類名稱進行修改更新。 |
| UpdateEditingProject | 修改雲剪輯工程 | 調用本介面修改雲剪輯工程(視頻編輯任務)。 |
| UploadMediaByURL | URL批量拉取上傳 | 基於源檔案URL,拉取音視頻媒體檔案進行上傳,支援批量上傳。 |
| UploadStreamByURL | 通過URL上傳轉碼流 | 上傳外部儲存的轉碼流檔案並掛載到對應的點播媒資下。 |