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)。輔助媒資如浮水印、字幕等,透過呼叫本介面獲取上傳憑證並建立相應媒資資訊。 |
| UploadMediaByURL | URL 批次拉取上傳。 | 基於來源檔案 URL,拉取影音媒體檔案進行上傳,支援批次上傳。 |
| GetURLUploadInfos | 取得 URL 上傳資訊。 | 取得 URL 上傳資訊。 |
| CancelUrlUploadJobs | 取消 URL 上傳任務。 | 取消排隊中的 URL 上傳任務。 |
| UploadStreamByURL | 透過 URL 上傳轉碼流。 | 上傳外部儲存的轉碼流檔案並掛載到對應的隨選視訊媒體資源下。 |
| DeleteMultipartUpload | 刪除上傳中的碎片檔案。 | 刪除上傳中產生的碎片檔案。 |
| GetUploadDetails | 取得媒體上傳詳情。 | 透過媒體 ID 取得媒體上傳詳情(如上傳時間、已上傳比例、上傳來源等資訊),支援批次取得。 |
| RegisterMedia | 註冊媒體資源資訊。 | 進行媒體資源註冊,接入點播服務的 OSS 自有 Bucket 上的存量媒體資源檔案,需要進行媒體資源註冊以產生點播所需的關聯資料後,才能正常使用點播提供的轉碼、截圖等功能。 |
影音播放
|
API |
標題 |
API概述 |
| GetPlayInfo | 取得影音播放地址。 | 呼叫此介面並提供影音 ID 即可取得播放地址,隨後可使用阿里雲端播放器或第三方播放器(如系統原生、開源或自研播放器)播放影音內容。 |
| GetVideoPlayAuth | 取得影音播放憑證。 | 呼叫本介面取得影音的播放憑證(PlayAuth)。阿里雲端播放器 SDK 使用該憑證自動取得播放地址。由於播放憑證具有時效性,且與特定影音綁定,不可混用或重複使用,因此憑證過期或無效將導致無法播放。此播放方式適用於需要高安全性的影音播放場景。 |
媒體資產管理
|
API |
標題 |
API概述 |
| 媒體資產搜尋 | 媒體資產搜尋 | |
| SearchMedia | 搜尋媒體資訊。 | 本介面用於搜尋影片點播產生的影片、音訊和圖片等媒資資訊,呼叫本介面配合媒資搜尋協定可實現在影片點播中進行指定返回欄位、精確匹配、模糊匹配、多值查詢、範圍查詢、排序欄位等多方式多維度的搜尋查詢。 |
| 分級儲存 | 分級儲存 | |
| UpdateMediaStorageClass | 修改媒體資源儲存類型。 | 修改媒體資源儲存類型。 |
| RestoreMedia | 解凍媒體資源。 | 解凍媒體資源。 |
| 分類管理 | 分類管理 | |
| AddCategory | 建立分類。 | 透過呼叫本介面來建立分類,可以有效地對儲存在影片點播平台上的影音、圖片及短影片素材進行歸類,從而使得資源的尋找與管理變得更加高效便捷。 |
| UpdateCategory | 更新分類。 | 呼叫本介面對分類名稱進行修改更新。 |
| DeleteCategory | 刪除分類。 | 呼叫本介面刪除分類及其子分類。 |
| GetCategories | 取得分類及其子分類資訊。 | 呼叫本介面按 ID 或類型來篩選查詢指定的分類資訊,及其子分類(即下一級分類)的列表。 |
| 影音管理 | 影音管理 | |
| GetVideoInfo | 取得單個音訊/影片資訊。 | 呼叫本介面透過音訊/影片 ID 來取得單個音訊/影片的標題、描述、時長、封面 URL、狀態、建立時間、大小、截圖、分類和標籤等資訊。 |
| GetVideoInfos | 批次獲取音訊影片資訊。 | 呼叫本介面透過音訊/影片 ID 批次獲取多個音訊影片的標題、描述、時長、封面 URL、狀態、建立時間、大小、截圖、分類和標籤等資訊。 |
| GetVideoList | 取得影音資訊清單。 | 取得影片資訊清單。 |
| GetMezzanineInfo | 取得原始檔案資訊。 | 取得影音訊的原始檔案資訊,包括檔案位址、解析度、位元率等。 |
| UpdateVideoInfo | 修改單個音影片資訊。 | 修改單個音影片資訊。 |
| UpdateVideoInfos | 批次修改影音資訊。 | 批次修改影音資訊。 |
| DeleteMezzanines | 批次刪除影音來源檔案。 | 批次刪除影音來源檔案資訊。 |
| DeleteStream | 刪除媒體流。 | 刪除媒體流(影片流、音訊流)資訊及儲存檔案。 |
| DeleteVideo | 刪除完整影片。 | 刪除完整影片(包括影片原始檔案、轉碼後的串流檔案、封面截圖等)。 |
| BatchGetMediaInfos | 批量獲取媒體資源資訊。 | 批量獲取媒體資源基礎資訊和原始檔案資訊。 |
| DescribeMediaDistribution | 查詢媒體資源分佈。 | 查詢影音媒體資源資料按時間分佈。起止時間跨度最大 6 個月。 |
| 輔助媒體資產管理 | 輔助媒體資產管理 | |
| GetAttachedMediaInfo | 批次取得輔助媒體資源資訊。 | 當浮水印圖片、字幕檔案、素材等輔助媒體資源上傳到影片點播後,可以呼叫本介面傳入多個輔助媒體資源 ID 以批次取得輔助媒體資源的基本資訊及存取位址。 |
| UpdateAttachedMediaInfos | 批次更新輔助媒資資訊。 | 當將帶有浮水印的圖片、字幕檔案或其它素材等輔助媒體資源上傳至影片點播後,可以透過本介面依據這些輔助媒體的唯一識別碼(ID),批次更新它們的標題、描述、標籤及分類等資訊。 |
| DeleteAttachedMedia | 批量刪除輔助媒資。 | 當浮水印圖片、字幕檔案、素材等輔助媒體資源上傳至影片點播後,可以利用本介面進行單個或批量的刪除操作。 |
| 圖片管理 | 圖片管理 | |
| GetImageInfo | 取得單個圖片資訊。 | 圖片上傳至影片點播後,可呼叫本介面透過圖片 ID 取得其基本資訊及存取位址。 |
| GetImageInfos | 批次獲取圖片資訊。 | 圖片上傳到影片點播後,可以呼叫本介面透過傳入多個圖片 ID,批次獲取圖片的基本資訊及存取位址。 |
| UpdateImageInfos | 批次更新圖片資訊。 | 圖片上傳到影片點播後,可以呼叫本介面透過圖片 ID 批次修改圖片的標題、描述、標籤和分類資訊。 |
| ListSnapshots | 查詢影片截圖資料。 | 呼叫本介面可以查詢透過影片截圖作業產生的截圖,以及影片上傳時系統產生的封面截圖。 |
| DeleteImage | 刪除圖片或影片截圖。 | 呼叫本介面刪除使用者上傳的圖片或影片截圖產生的圖片。 |
| 動態圖管理 | 動態圖管理 | |
| ListDynamicImage | 查詢動圖清單。 | 呼叫此介面,透過影片 ID 查詢影片截動圖清單。 |
| DeleteDynamicImage | 刪除動圖資訊。 | 呼叫本介面刪除動圖資訊。 |
媒體處理
|
API |
標題 |
API概述 |
| 發起處理 | 發起處理 | |
| SubmitTranscodeJobs | 提交媒體轉碼作業。 | 呼叫本介面提交媒體轉碼作業,開始非同步轉碼處理。 |
| SubmitSnapshotJob | 提交媒體截圖作業。 | 呼叫本介面提交影片截圖作業,開始非同步截圖處理。 |
| SubmitPreprocessJobs | 導播台影片預處理。 | 呼叫此介面透過導播台對影片進行轉碼處理。 |
| SubmitDynamicImageJob | 提交媒體動圖作業。 | 呼叫本介面提交媒體動圖作業,開始非同步處理。 |
| SubmitWorkflowJob | 提交點播工作流程作業。 | 對影片發起點播工作流程處理。 |
| 轉碼範本 | 轉碼範本 | |
| AddTranscodeTemplateGroup | 建立轉碼範本群組。 | 呼叫本介面新增轉碼設定資訊,可建立新的轉碼範本群組,或者向指定範本群組中新增新的轉碼範本。 |
| UpdateTranscodeTemplateGroup | 修改轉碼設定。 | 呼叫本介面修改轉碼設定資訊,可修改轉碼範本群組下指定的轉碼範本設定。 |
| SetDefaultTranscodeTemplateGroup | 設定預設轉碼配置。 | 呼叫本介面設定預設轉碼範本配置。 |
| ListTranscodeTemplateGroup | 查詢轉碼設定清單。 | 呼叫本介面查詢轉碼範本設定清單。 |
| GetTranscodeTemplateGroup | 查詢轉碼設定詳情。 | 根據轉碼範本群組 ID 查詢轉碼設定的詳細資訊。 |
| DeleteTranscodeTemplateGroup | 刪除轉碼設定。 | 刪除轉碼設定資訊,可刪除轉碼範本群組下的部分轉碼範本,也可強制刪除整個轉碼範本群組。 |
| 截圖範本 | 截圖範本 | |
| AddVodTemplate | 新增截圖或動圖範本。 | 呼叫此介面新增截圖或動圖範本。 |
| UpdateVodTemplate | 修改截圖範本。 | 修改截圖範本。 |
| GetVodTemplate | 查詢單個截圖範本。 | 呼叫本介面查詢單個截圖範本。 |
| ListVodTemplate | 查詢截圖範本清單。 | 查詢截圖範本清單。 |
| DeleteVodTemplate | 刪除截圖範本。 | 呼叫本介面刪除截圖範本。 |
| 圖文浮水印範本 | 圖文浮水印範本 | |
| AddWatermark | 新增圖文浮水印範本。 | 為了簡化浮水印任務的處理過程,影片點播將複雜的浮水印位置、浮水印大小、浮水印文字的字型、顏色等浮水印參數固化成範本,並透過具有唯一性的浮水印範本 ID 來指代。呼叫本介面可以新增圖片浮水印範本或文字浮水印範本。 |
| UpdateWatermark | 修改圖文水印範本。 | 新增圖文水印範本後,可以呼叫此介面修改圖文水印範本的範本名稱和水印設定(WatermarkConfig)。 |
| DeleteWatermark | 刪除圖文水印範本。 | 呼叫此介面透過水印範本 ID 刪除圖片水印範本或文字水印範本。 |
| SetDefaultWatermark | 設定預設圖文浮水印範本。 | 呼叫本介面將指定浮水印範本設定為預設浮水印範本。 |
| GetWatermark | 查詢單個圖文水印範本。 | 呼叫本介面透過水印範本 ID 查詢單個圖片水印範本或文字水印範本的設定資訊,包括圖片水印的位置、大小、顯示時間,以及文字水印的內容、字型、顏色、位置等參數設定資訊。 |
| ListWatermark | 查詢圖文浮水印範本清單。 | 呼叫本介面查詢目前服務地域下已新增的所有圖片浮水印範本和文字浮水印範本的設定資訊,包括圖片浮水印的位置、大小、顯示時間,以及文字浮水印的內容、字型、顏色、位置等參數設定資訊。 |
| 轉碼任務 | 轉碼任務 | |
| GetTranscodeSummary | 查詢影音轉碼摘要。 | 呼叫本介面根據影音 ID 查詢影音轉碼摘要,包括影音轉碼狀態、轉碼進展等彙總資訊。 |
| ListTranscodeTask | 查詢轉碼任務列表。 | 呼叫本介面根據影音 ID 查詢影音歷史轉碼任務資訊,本介面不返回具體的作業資訊。 |
| GetTranscodeTask | 查詢轉碼任務詳情。 | 呼叫本介面根據轉碼任務 ID 查詢轉碼作業詳細資訊。 |
| 任務管理 | 任務管理 | |
| ListJobInfo | 查詢任務清單。 | 呼叫本介面根據媒資 ID 查詢歷史任務清單。 |
| GetJobDetail | 取得任務詳情。 | 呼叫本介面根據 jobId 查詢非同步任務詳情。 |
| GetWorkflowTask | 查詢工作流程任務執行資訊。 | 查詢工作流程執行任務資訊。 |
影片編輯(雲端剪輯)
|
API |
標題 |
API概述 |
| ProduceEditingProjectVideo | 影片合成。 | 將一個或多個影片合成為成品。可以透過時間線參數直接提交來源影片,也可以先建立雲端剪輯專案,再提交合成。 |
| 雲端剪輯工程管理 | 雲端剪輯工程管理 | |
| AddEditingProject | 建立雲端剪輯專案。 | 呼叫此介面建立雲端剪輯專案(影片編輯任務)。 |
| UpdateEditingProject | 修改雲端剪輯工程。 | 呼叫本介面修改雲端剪輯工程(影片編輯任務)。 |
| DeleteEditingProject | 刪除雲端剪輯工程。 | 呼叫此介面刪除雲端剪輯工程。 |
| SetEditingProjectMaterials | 設定雲端剪輯工程素材。 | 呼叫本介面設定雲端剪輯工程的待剪輯素材。 |
| GetEditingProject | 取得單一雲端剪輯工程。 | 呼叫本介面以取得雲端剪輯工程(影片編輯任務)的詳細資訊。 |
| GetEditingProjectMaterials | 取得雲端剪輯工程素材。 | 呼叫本介面取得雲端剪輯工程的待剪輯素材清單。 |
| SearchEditingProject | 搜尋雲端剪輯工程。 | 呼叫本介面搜尋雲端剪輯工程(影片編輯清單)。 |
| AddEditingProjectMaterials | 新增剪輯工程關聯素材。 | 將一個或多個素材新增至剪輯工程中。 |
| DeleteEditingProjectMaterials | 刪除雲端剪輯工程素材。 | 刪除雲端剪輯工程的待剪輯素材。 |
媒體審核
|
API |
標題 |
API概述 |
| 審核設定 | 審核設定 | |
| SetAuditSecurityIp | 設定審核安全 IP。 | 呼叫此介面設定審核安全 IP。 |
| ListAuditSecurityIp | 取得審核安全 IP 清單。 | 呼叫本介面取得審核安全 IP 清單。 |
| 智慧審核 | 智慧審核 | |
| SubmitAIMediaAuditJob | 提交影音智慧審核作業。 | 呼叫此介面提交影音智慧審核作業。作業在提交成功後會非同步執行,不保證介面返回時作業已處理完成。 |
| SubmitAIImageAuditJob | 提交圖片智慧審核作業。 | 呼叫本介面來提交圖片智慧審核任務,作業在提交成功後會非同步執行,不保證介面返回時作業已處理完成。 |
| GetAIMediaAuditJob | 查詢智慧審核作業。 | 呼叫此介面查詢智慧審核作業,在提交 AI 作業後,會進行非同步處理,透過此介面可以即時查詢作業資訊。 |
| GetMediaAuditResult | 取得智慧審核結果摘要。 | 呼叫本介面取得智慧審核結果摘要資訊。 |
| GetMediaAuditResultDetail | 取得智慧審核結果詳情。 | 呼叫本介面取得智慧審核結果詳情。透過此介面可即時查詢審核結果詳情。 |
| GetMediaAuditResultTimeline | 取得智慧審核結果時間軸。 | 呼叫本介面取得所有違規內容截圖的時間點。 |
| GetMediaAuditAudioResultDetail | 取得智慧音訊審核結果詳情。 | 呼叫本介面取得音訊審核詳情。 |
| 人工審核 | 人工審核 | |
| CreateAudit | 人工審核。 | 呼叫本介面進行人工審核,可用於審核影片、音訊等媒體資訊。 |
| 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 作業。 |
| GetMediaAiAnalysis | 取得影片 AI 分析結果資訊。 | 取得影片 AI 分析結果資訊。 |
| 影片 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 內容重新整理至快取節點,支援 URL 批次重新整理。 |
| RefreshMediaPlayUrls | 提交影音訊號重新整理或預熱任務。 | 呼叫此介面透過影音訊號 ID 發起影音訊號重新整理或預熱任務。 |
| GetMediaRefreshJobs | 查詢影片重新整理或預熱任務資訊。 | 呼叫本介面查詢影片重新整理或預熱任務的任務狀態、篩選策略等任務資訊。 |
| 日誌管理 | 日誌管理 | |
| DescribeVodDomainLog | 查詢網域日誌。 | 呼叫此介面取得指定網域的 CDN 原始存取日誌下載位址。 |
影片安全
|
API |
標題 |
API概述 |
| HLS 標準加密 | HLS 標準加密 | |
| GenerateKMSDataKey | 建立 KMS 資料金鑰。 | 透過呼叫本介面產生一個隨機的 KMS 資料金鑰,用於影片點播標準加密。 |
| DecryptKMSDataKey | 解密 KMS 資料金鑰密文。 | 透過呼叫本介面解密 KMS 資料金鑰中的 CiphertextBlob 密文。 |
| 數位浮水印 | 數位浮水印 | |
| 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 | 為子應用程式綁定儲存。 | 為影片點播的子應用程式綁定儲存 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概述 |
| ChangeResourceGroup | 資源轉組。 | 呼叫此介面將資源進行轉組。 |
| DescribeVodDomainMax95BpsData | 查詢 95 頻寬峰值。 | 呼叫本介面查詢加速域名 95 頻寬峰值監控資料。 |
| DescribeVodSSLCertificateList | 查詢憑證清單-按網域。 | 呼叫此介面按照網域查詢憑證清單資訊。 |
| SetVodDomainSSLCertificate | 設定點播網域憑證。 | 呼叫此介面用於設定某網域下憑證功能是否啟用及更新憑證資訊。 |
| DescribeVodEditingUsageData | 隨點雲端剪輯用量查詢。 | 呼叫 DescribeVodEditingUsageData 查詢隨點雲端剪輯用量。 |
| DescribeVodUserVipsByDomain | 查詢節點 IP 清單-L1 | 呼叫 DescribeVodUserVipsByDomain 查詢網域的 IP 清單。 |