API 標準および多言語対応の SDK
本製品 (vod/2017-03-21) の API は、RPC 標準に準拠した OpenAPI 仕様を採用しています。Alibaba Cloud には主要なプログラミング言語に対応した SDK が用意され、リクエスト署名のような手間がかかる手順を省略できます。そのため、開発者は HTTP 通信の詳細を意識することなく、各言語の構文で API を呼び出すことが可能になります。
カスタム署名
署名のカスタマイズが必要な場合、「署名メカニズム」を参照してリクエストに手動で署名できます。手動署名プロセスは非常に煩雑で、通常はおよそ 5 営業日かかります。詳細については、DingTalk サポート窓口 (グループチャット ID:147535001692) までお問い合わせください。
はじめに
Alibaba Cloud アカウント (root ユーザー) は最高レベルの管理権限を持ち、その AccessKey ペアが悪用されると、関連するすべてのリソースが不正にアクセスされ、重大なセキュリティリスクを引き起こす可能性があります。そのため、必要な場合以外は、Alibaba Cloud アカウントを使用しないでください。その代わりに、API のみでのアクセスを許可された Resource Access Management (RAM) ユーザーを作成し、RAM ポリシーを設定することで、最小権限の原則 (PoLP) を徹底してください。
API セキュリティを確保するには、以下を作成し、設定する必要があります。
RAM ユーザー
RAM ユーザー用の AccessKey ペア
メディアアップロード
|
API |
タイトル |
説明 |
| CreateUploadVideo | 音声またはビデオファイルのアップロード URL と認証情報を取得します。 | 音声またはビデオファイルのアップロード URL とアップロード認証情報を取得します。ApsaraVideo VOD は、権限付与とセキュリティを確保し、悪意のあるアップロードを防止するために、アップロード URL とアップロード認証情報を発行します。発行時に、管理用のメディア ID (MediaId)、別名ビデオ ID (VideoId) が自動的に作成されます。 |
| RefreshUploadVideo | 動画のアップロード認証情報をリフレッシュします。 | アップロードのタイムアウト後、動画ファイルのアップロード認証情報をリフレッシュします。 |
| CreateUploadImage | イメージアップロード用のアップロード URL および認証情報の取得。 | ApsaraVideo VOD にイメージをアップロードするためのアップロード URL およびアップロード認証情報を取得し、イメージ情報を作成します。ApsaraVideo VOD は、権限付与とセキュリティを確保し、悪意のあるアップロードを防ぐためにアップロード URL と認証情報を発行し、管理用のイメージ ID (ImageId) の自動作成をサポートしています。この操作を呼び出すことで、アップロード URL と認証情報を取得し、イメージ情報を作成できます。 |
| CreateUploadAttachedMedia | 補助メディアアセットのアップロード URL と認証情報を取得します。 | ApsaraVideo VOD が提供するアップロード URL と認証情報は、権限付与とセキュリティ上の懸念に対処し、悪意のあるアップロードを防止するとともに、管理および処理用のメディアアセット ID (MediaId) の自動作成を有効にします。ウォーターマークや字幕などの補助メディアアセットについては、この操作を呼び出してアップロード認証情報を取得し、対応するメディアアセット情報を作成してください。 |
| UploadMediaByURL | URL によるメディアファイルの一括プルおよびアップロード。 | ソースファイルの URL に基づいて、音声および動画メディアファイルをプルしてアップロードします。バッチアップロードがサポートされています。 |
| GetURLUploadInfos | URL アップロード情報の取得。 | URL アップロード情報を取得します。 |
| CancelUrlUploadJobs | URL アップロードタスクのキャンセル。 | キューにある URL アップロードタスクをキャンセルします。 |
| UploadStreamByURL | URL によるトランスコード済みストリームのアップロード。 | 外部ストレージからトランスコード済みストリームファイルをアップロードし、対応する ApsaraVideo VOD メディアアセットにマウントします。 |
| DeleteMultipartUpload | アップロード中のフラグメントファイルを削除します。 | アップロード中に生成されたフラグメントファイルを削除します。 |
| GetUploadDetails | メディアアップロード詳細の取得。 | メディア ID を指定して、アップロード時間、アップロード比率、アップロードソースなどのメディアアップロード詳細を取得します。バッチ取得もサポートされています。 |
| RegisterMedia | メディアアセット情報の登録。 | メディアアセットを登録します。ApsaraVideo VOD に接続された独自の OSS バケットに保存されている既存のメディアファイルは、トランスコード中やスナップショット作成などの VOD 特徴を使用する前に、VOD で必須の関連データを生成するために登録する必要があります。 |
オーディオおよびビデオ再生
|
API |
タイトル |
説明 |
| GetPlayInfo | 音声または動画の再生 URL を取得します。 | 音声または動画の ID を指定して再生 URL を取得します。取得した URL は、ApsaraVideo Player や、システムネイティブ、オープンソース、カスタムビルドなどのサードパーティプレーヤーで再生できます。 |
| GetVideoPlayAuth | 音声または動画の再生認証情報を取得します。 | 音声または動画ファイルの再生認証情報 (PlayAuth) を取得します。ApsaraVideo Player SDK はこの認証情報を使用して再生 URL を自動的に取得します。再生認証情報には有効期間があり、特定の音声または動画ファイルにバインドされているため、共有や再利用はできません。期限切れまたは無効な認証情報を使用すると、再生に失敗します。この再生メソッドは、高いセキュリティが求められる音声および動画の再生シナリオに適しています。 |
メディアアセット管理
|
API |
タイトル |
説明 |
| メディアアセット検索 | メディアアセット検索 | |
| SearchMedia | メディア情報の検索。 | ApsaraVideo VOD で生成された動画、音声ファイル、イメージなどのメディアアセット情報を検索します。この操作では、メディアアセット検索プロトコルを使用して、返却フィールドの指定、完全一致、あいまい検索、多値クエリ、有効値クエリ、ソートフィールドなど、ApsaraVideo VOD での多次元検索を実行できます。 |
| 階層型ストレージ | 階層型ストレージ | |
| UpdateMediaStorageClass | メディアアセットのストレージクラスを変更します。 | メディアアセットのストレージクラスを変更します。 |
| RestoreMedia | メディアアセットを解凍します。 | 凍結ストレージからメディアアセットを解凍します。 |
| カテゴリ管理 | カテゴリ管理 | |
| AddCategory | カテゴリの作成。 | ApsaraVideo VOD に保存されているオーディオ、ビデオ、イメージ、ショートビデオ素材を分類するカテゴリを作成し、リソース検出と管理を効率化します。 |
| UpdateCategory | カテゴリを更新します。 | カテゴリの名前を更新します。 |
| DeleteCategory | カテゴリを削除します。 | カテゴリおよびそのサブカテゴリを削除します。 |
| GetCategories | カテゴリおよびそのサブカテゴリを照会します。 | ID またはタイプを指定して分類情報を照会し、そのサブカテゴリ(次のレベルのカテゴリ)のリストを取得します。 |
| オーディオおよびビデオ管理 | オーディオおよびビデオ管理 | |
| GetVideoInfo | 単一のオーディオまたはビデオファイルの情報を取得します。 | オーディオまたはビデオ ID を指定して、タイトル、説明、持続時間、サムネイル URL、ステータス、作成時刻、サイズ、スナップショット、カテゴリ、タグなど、単一のオーディオまたはビデオファイルの情報を取得します。 |
| GetVideoInfos | オーディオおよびビデオ情報のバッチ取得。 | オーディオまたはビデオ ID を指定して、複数のオーディオおよびビデオファイルの情報を一度に取得します。取得される情報には、タイトル、説明、持続時間、サムネイル URL、ステータス、作成時間、サイズ、スナップショット、カテゴリ、タグが含まれます。 |
| GetVideoList | 音声および動画情報リストの取得。 | 音声および動画情報のリストを取得します。 |
| GetMezzanineInfo | ソースファイル情報の取得。 | 音声またはビデオファイルのソースファイル情報(ファイル URL、解像度、ビットレートなど)を取得します。 |
| UpdateVideoInfo | 単一のオーディオまたはビデオ情報を変更します。 | 単一のオーディオまたはビデオファイルの情報を変更します。 |
| UpdateVideoInfos | オーディオおよびビデオ情報の一括変更。 | 複数のオーディオおよびビデオファイルの情報を一度に変更します。 |
| DeleteMezzanines | オーディオおよびビデオのソースファイルのバッチ削除。 | 複数のオーディオおよびビデオのソースファイルを一度に削除します。 |
| DeleteStream | メディアストリームの削除。 | メディアストリーム (ビデオストリームまたは音声ストリーム) の情報およびストレージファイルを削除します。 |
| DeleteVideo | 完全な動画の削除。 | ビデオソースファイル、トランスコード済みストリームファイル、サムネイルを含む完全な動画を削除します。 |
| BatchGetMediaInfos | メディアアセット情報のバッチ取得。 | 複数のメディアアセットの基本情報およびソースファイル情報をバッチで取得します。 |
| DescribeMediaDistribution | メディアアセットのディストリビューションを照会します。 | 音声および動画メディアアセットの時間ベースのディストリビューションを照会します。開始時刻と終了時刻の間の最大スパンは 6 か月です。 |
| 補助メディアアセット管理 | 補助メディアアセット管理 | |
| GetAttachedMediaInfo | 補助メディアアセット情報のバッチ取得。 | ウォーターマーク画像、字幕ファイル、素材などのアセットを ApsaraVideo VOD にアップロードした後、その ID を指定して複数の補助メディアアセットの基本情報とアクセス URL をバッチで取得します。 |
| UpdateAttachedMediaInfos | 補助メディアアセット情報の一括更新。 | ApsaraVideo VOD にアップロード済みの補助メディアアセット(ウォーターマーク画像、字幕ファイル、その他の素材など)の一意の識別子(ID)を指定して、タイトル、説明、タグ、カテゴリなどの情報を一括更新します。 |
| DeleteAttachedMedia | 補助メディアアセットを一括削除します。 | ApsaraVideo VOD にアップロードされたウォーターマーク画像、字幕ファイル、素材などの補助メディアアセットを 1 つ以上削除します。 |
| イメージ管理 | イメージ管理 | |
| GetImageInfo | 単一イメージの情報を取得します。 | ApsaraVideo VOD にイメージがアップロードされた後、イメージ ID を指定してイメージの基本情報およびアクセス URL を取得します。 |
| GetImageInfos | イメージ情報のバッチ取得。 | ApsaraVideo VOD にアップロードされた複数のイメージの ID を指定して、基本情報およびアクセス URL を照会します。 |
| UpdateImageInfos | イメージ情報の一括更新。 | ApsaraVideo VOD にアップロードされたイメージのタイトル、説明、タグ、カテゴリ情報をイメージ ID ごとに一括更新します。 |
| ListSnapshots | ビデオスナップショットデータの照会。 | ビデオスナップショットジョブによって生成されたスナップショット、および動画のアップロード中にシステムによって自動生成されたサムネイルスナップショットを照会します。 |
| DeleteImage | イメージまたは動画スナップショットの削除。 | ユーザーがアップロードしたイメージ、または動画スナップショットから生成されたイメージを削除します。 |
| アニメーションステッカー管理 | アニメーションステッカー管理 | |
| ListDynamicImage | アニメーションイメージリストの照会。 | 動画 ID を指定して、動画のアニメーションイメージリストを照会します。 |
| DeleteDynamicImage | アニメーションステッカー情報の削除。 | アニメーションステッカー情報を削除します。 |
メディア処理
|
API |
タイトル |
説明 |
| 処理の開始 | 処理の開始 | |
| SubmitTranscodeJobs | メディアトランスコーディングジョブの送信。 | メディアトランスコーディングジョブを送信し、非同期トランスコーディングを開始します。 |
| SubmitSnapshotJob | メディアスナップショットジョブの送信。 | ビデオスナップショットジョブを送信し、非同期スナップショット処理を開始します。 |
| SubmitPreprocessJobs | 中国プロダクションスタジオ向けに動画を前処理します。 | 中国プロダクションスタジオの前処理用に動画をトランスコードします。 |
| SubmitDynamicImageJob | メディアアニメーションイメージタスクの送信。 | メディアアニメーションイメージタスクを非同期処理のために送信します。 |
| SubmitWorkflowJob | VOD ワークフロータスクを送信します。 | 動画の VOD ワークフローを開始します。 |
| トランスコーディングテンプレート | トランスコーディングテンプレート | |
| AddTranscodeTemplateGroup | トランスコーディングテンプレートグループの作成。 | トランスコードの構成を追加します。トランスコーディングテンプレートグループを作成するか、指定されたテンプレートグループにトランスコーディングテンプレートを追加できます。 |
| UpdateTranscodeTemplateGroup | トランスコーディング構成を変更します。 | トランスコーディング構成を変更します。トランスコーディングテンプレートグループ内の指定されたトランスコーディングテンプレートの構成を変更できます。 |
| SetDefaultTranscodeTemplateGroup | デフォルトトランスコーディング構成を設定します。 | デフォルトトランスコーディングテンプレートグループの構成を設定します。 |
| ListTranscodeTemplateGroup | トランスコーディング構成リストの照会。 | トランスコーディングテンプレート構成のリストを照会します。 |
| GetTranscodeTemplateGroup | トランスコーディング構成の詳細を照会します。 | トランスコーディングテンプレートグループ ID に基づいて、トランスコーディング構成の詳細を照会します。 |
| DeleteTranscodeTemplateGroup | トランスコーディング構成の削除。 | トランスコーディング構成を削除します。トランスコーディングテンプレートグループから特定のトランスコーディングテンプレートを削除するか、またはトランスコーディングテンプレートグループ全体を強制削除できます。 |
| スナップショットテンプレート | スナップショットテンプレート | |
| AddVodTemplate | スナップショットまたはアニメーションイメージテンプレートを追加します。 | スナップショットまたはアニメーションイメージテンプレートを追加します。 |
| UpdateVodTemplate | スナップショットテンプレートを変更します。 | スナップショットテンプレートを変更します。 |
| GetVodTemplate | 単一のスナップショットテンプレートを照会します。 | 単一のスナップショットテンプレートを照会します。 |
| ListVodTemplate | スナップショットテンプレートリストの照会。 | スナップショットテンプレートのリストを照会します。 |
| DeleteVodTemplate | スナップショットテンプレートを削除します。 | スナップショットテンプレートを削除します。 |
| イメージおよびテキストウォーターマークテンプレート | イメージおよびテキストウォーターマークテンプレート | |
| AddWatermark | イメージまたはテキストのウォーターマークテンプレートを追加します。 | イメージまたはテキストのウォーターマークテンプレートを追加します。ウォーターマークタスクの処理を簡素化するため、ApsaraVideo VOD は位置、サイズ、フォント、色などの複雑なウォーターマークパラメーターをテンプレートに統合し、各テンプレートは一意のウォーターマークテンプレート ID で識別されます。 |
| UpdateWatermark | イメージおよびテキストウォーターマークテンプレートを変更します。 | AddWatermark 操作を呼び出して追加されたイメージおよびテキストウォーターマークテンプレートの名前とウォーターマーク構成 (WatermarkConfig) を変更します。 |
| DeleteWatermark | ウォーターマークテンプレートの削除。 | ウォーターマークテンプレート ID を指定して、イメージウォーターマークテンプレートまたはテキストウォーターマークテンプレートを削除します。 |
| SetDefaultWatermark | デフォルトのウォーターマークテンプレートを設定します。 | 指定されたウォーターマークテンプレートをデフォルトのウォーターマークテンプレートとして設定します。 |
| GetWatermark | 単一のウォーターマークテンプレートを照会します。 | ウォーターマークテンプレート ID を指定して、単一のイメージウォーターマークテンプレートまたはテキストウォーターマークテンプレートのパラメータ設定を照会します。これには、イメージウォーターマークの位置、サイズ、表示時間、およびテキストウォーターマークの内容、フォント、色、位置が含まれます。 |
| ListWatermark | ウォーターマークテンプレートリストの照会。 | 現在のサービスリージョンに追加されているすべてのイメージウォーターマークテンプレートおよびテキストウォーターマークテンプレートのパラメータ設定を照会します。これには、イメージウォーターマークの位置、サイズ、表示時間、およびテキストウォーターマークの内容、フォント、色、位置などのパラメータ設定が含まれます。 |
| トランスコーディングタスク | トランスコーディングタスク | |
| GetTranscodeSummary | オーディオおよびビデオのトランスコーディングまとめを照会します。 | ID を指定して 1 つ以上のオーディオまたはビデオファイルの動画トランスコーディングまとめを照会します。これには、動画トランスコーディングのステータスとトランスコード中の進捗状況が含まれます。 |
| ListTranscodeTask | トランスコーディングジョブリストの照会。 | ID を指定して、オーディオまたはビデオファイルの過去のトランスコーディングジョブ情報を照会します。この操作では、特定のタスクの詳細は返されません。 |
| GetTranscodeTask | トランスコーディングタスクの詳細を照会します。 | トランスコーディングタスク ID に基づいてトランスコーディングジョブの詳細を照会します。 |
| タスク管理 | タスク管理 | |
| ListJobInfo | タスクリストの照会。 | メディアアセット ID に基づいて過去のタスクリストを照会します。 |
| GetJobDetail | タスク詳細の取得。 | タスク ID を指定して非同期タスクの詳細を照会します。 |
| GetWorkflowTask | ワークフロータスクの実行情報を照会します。 | ワークフロータスクの実行情報を照会します。 |
ビデオ編集 (オンライン編集)
|
API |
タイトル |
説明 |
| ProduceEditingProjectVideo | ビデオを生成する。 | 1 つ以上の動画を完成した動画に生成します。タイムラインパラメーターを使用してソース動画を直接送信するか、最初にオンライン編集プロジェクトを作成してから生成を送信できます。 |
| オンライン編集プロジェクト管理 | オンライン編集プロジェクト管理 | |
| AddEditingProject | オンライン編集プロジェクトを作成します。 | オンライン編集プロジェクト (ビデオ編集タスク) を作成します。 |
| UpdateEditingProject | オンライン編集プロジェクトを変更します。 | オンライン編集プロジェクト (ビデオ編集タスク) を変更します。 |
| DeleteEditingProject | オンライン編集プロジェクトを削除します。 | オンライン編集プロジェクトを削除します。 |
| SetEditingProjectMaterials | オンライン編集プロジェクトの素材を設定します。 | オンライン編集プロジェクトの編集対象素材を設定します。 |
| GetEditingProject | 単一のオンライン編集プロジェクトの取得。 | オンライン編集プロジェクト (ビデオ編集タスク) の詳細を取得します。 |
| GetEditingProjectMaterials | オンライン編集プロジェクトの素材を取得します。 | オンライン編集プロジェクトで編集対象の素材リストを取得します。 |
| SearchEditingProject | オンライン編集プロジェクトの検索。 | オンライン編集プロジェクト(ビデオ編集リスト)を検索します。 |
| AddEditingProjectMaterials | オンライン編集プロジェクトに素材を追加します。 | オンライン編集プロジェクトに 1 つ以上の素材を追加します。 |
| DeleteEditingProjectMaterials | オンライン編集プロジェクトの素材を削除します。 | オンライン編集プロジェクトから素材を削除します。 |
メディアレビュー
|
API |
タイトル |
説明 |
| レビュー設定 | レビュー設定 | |
| SetAuditSecurityIp | レビュー用セキュリティ IP アドレスを設定します。 | レビュー用セキュリティ IP アドレスを設定します。 |
| ListAuditSecurityIp | レビューセキュリティ IP リストの取得。 | レビューセキュリティ IP のリストを取得します。 |
| 自動レビュー | 自動レビュー | |
| SubmitAIMediaAuditJob | 音声および動画ファイルの自動レビュータスクを送信します。 | 音声および動画ファイルの自動レビュータスクを送信します。タスクは送信後に非同期で実行されるため、応答が返された時点ではタスクが完了していない場合があります。 |
| SubmitAIImageAuditJob | イメージの自動レビュージョブを送信します。 | イメージの自動レビュータスクを送信します。タスクは送信後に非同期で実行されます。応答が返された時点で、タスクが完了していない場合があります。 |
| GetAIMediaAuditJob | 自動レビュータスクの照会。 | 自動レビュータスクを照会します。AI タスクの送信後、タスクは非同期で処理されます。この操作を呼び出すことで、タスク情報をリアルタイムで取得できます。 |
| GetMediaAuditResult | 自動レビュー結果のまとめを取得します。 | 自動レビュー結果のまとめを取得します。 |
| GetMediaAuditResultDetail | 自動レビュー結果の詳細を取得します。 | 自動レビュー結果の詳細を取得します。この操作を呼び出すことで、レビュー結果の詳細をリアルタイムでクエリできます。 |
| GetMediaAuditResultTimeline | 自動レビュー結果のタイムラインを取得します。 | 違反を含むすべてのスクリーンショットのタイムスタンプを取得します。 |
| GetMediaAuditAudioResultDetail | 音声の自動レビュー結果の詳細を取得します。 | 音声の自動レビュー結果の詳細を取得します。 |
| 手動レビュー | 手動レビュー | |
| CreateAudit | 手動レビュー。 | 動画や音声ファイルなどのメディア情報をレビューするための手動レビューリクエストを送信します。 |
| GetAuditHistory | 手動レビュー履歴の取得。 | 手動レビュー Record の履歴を取得します。 |
Video AI
|
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 | インテリジェントタグ付けまたはメディアフィンガープリントのタスクを照会します。 | インテリジェントタグ付けまたはメディアフィンガープリントのタスクを照会します。インテリジェントタグ付けまたはメディアフィンガープリントのタスクを送信すると、タスクは非同期で処理されます。この操作を呼び出して、タスク情報をリアルタイムで照会できます。 |
| SubmitAIJob | インテリジェントタグ付けまたはメディアフィンガープリントのタスクを送信します。 | インテリジェントタグ付けまたはメディアフィンガープリントのタスクを送信します。 |
| GetMediaAiAnalysis | 動画 AI 分析結果の取得。 | 動画 AI 分析の結果を取得します。 |
| メディアフィンガープリント | メディアフィンガープリント | |
| GetMediaDNAResult | メディアフィンガープリントの結果を取得します。 | メディアフィンガープリントの結果を取得します。メディアフィンガープリントタスクの完了後、この操作を呼び出して結果をリアルタイムでクエリできます。 |
| SubmitMediaDNADeleteJob | メディアフィンガープリントタスクを削除します。 | メディアフィンガープリントタスクを削除します。 |
| スマートタグ付け | スマートタグ付け | |
| GetAIVideoTagResult | スマートタグ付け結果の取得。 | 動画のスマートタグ付けの結果を取得します。 |
| スマートサムネイル | スマートサムネイル | |
| SubmitAIImageJob | AI イメージタスクの送信。 | AI 画像処理タスクを送信します。 |
| GetAIImageJobs | AI 画像処理タスクの照会。 | AI 画像処理タスクのリストを照会します。 |
| ListAIImageInfo | スマートサムネイル情報の照会。 | 指定された動画の AI イメージ情報を照会します。 |
| DeleteAIImageInfos | AI イメージ情報の削除。 | AI イメージ情報を削除します。 |
ライブから VOD へ
|
API |
タイトル |
説明 |
| ListLiveRecordVideo | ライブから VOD への動画リストを取得します。 | ライブから VOD への動画リストを取得します。 |
VOD CDN
|
API |
タイトル |
説明 |
| モニタリングとクエリ | モニタリングとクエリ | |
| リソースアクセスデータ | リソースアクセスデータ | |
| DescribeVodDomainTrafficData | トラフィックのクエリ | アクセラレーションドメイン名のトラフィックデータを照会します。DescribeVodDomainRealTimeTrafficData 操作と比較して、この操作はより長い既存データのクエリ範囲(最大 366 日)をサポートしますが、データの時間の粒度が大きく(最小値 5 分)、データ遅延が高くなります。 |
| DescribeVodDomainBpsData | 帯域幅の照会。 | アクセラレーションドメイン名の帯域幅データを照会します。DescribeVodDomainRealTimeBpsData 操作と比較して、この操作は既存データのクエリにおいてより長い有効値(最大 366 日)をサポートしますが、データの時間の粒度が粗く(最小値 5 分)、データ遅延が大きくなります。 |
| DescribeVodDomainBpsDataByLayer | プロトコル別の帯域幅を照会します。 | プロトコルの種類別に、アクセラレーションドメイン名の帯域幅データを照会します。 |
| DescribeVodDomainQpsData | QPS の照会。 | アクセラレーションドメイン名の QPS (Queries Per Second) を 5 分粒度で照会します。過去 90 日間のデータがサポートされています。 |
| DescribeVodDomainHitRateData | バイトヒット率の照会。 | アクセラレーションドメイン名のバイトヒット率(ヒットしたバイト数の割合)を照会します。 |
| DescribeVodDomainReqHitRateData | リクエストヒット率の照会。 | アクセラレーションドメイン名のリクエストヒット率(ヒットしたリクエストの割合)を照会します。 |
| DescribeVodRangeDataByLocateAndIspService | ISP およびリージョン別のアクセスデータを照会します。 | ISP またはリージョン別に、アクセラレーションドメイン名のアクセスデータ(帯域幅、平均応答レート、ページビュー数、キャッシュヒット率、リクエストヒット率など)を照会します。 |
| リソースバックツーオリジンデータ | リソースバックツーオリジンデータ | |
| DescribeVodDomainSrcTrafficData | back-to-origin トラフィックのクエリ。 | アクセラレーションドメイン名の CDN back-to-origin アウトバウンドトラフィックデータを照会します。 |
| DescribeVodDomainSrcBpsData | オリジン帯域幅の照会。 | アクセラレーションドメイン名のオリジン帯域幅データを照会します。 |
| リアルタイムアクセスデータ | リアルタイムアクセスデータ | |
| DescribeVodDomainRealTimeTrafficData | リアルタイムトラフィックの照会。 | アクセラレーションドメイン名のリアルタイムトラフィックデータを照会します。DescribeVodDomainTrafficData 操作と比較して、この操作はより細かい時間の粒度(最小値 1 分)、より低いデータ遅延(最小値 5 分)をサポートしますが、既存データの有効値は短くなります(最大 186 日)。 |
| DescribeVodDomainRealTimeBpsData | リアルタイム帯域幅の照会。 | アクセラレーションドメイン名のリアルタイム帯域幅データを照会します。DescribeVodDomainBpsData 操作と比較して、この操作はより細かい時間の粒度(最小値 1 分)、より低いデータ遅延(最小値 5 分)をサポートしますが、既存データの時間有効値は短くなります(最大 186 日)。 |
| DescribeVodDomainRealTimeHttpCodeData | リアルタイム HTTP 状態コードの照会。 | アクセラレーションドメイン名の HTTP 状態コードの総数と割合を照会します。この操作は、最小値 1 分のデータの時間の粒度をサポートし、データ遅延は少なくとも 5 分です。過去 186 日間のデータのクエリが可能です。 |
| DescribeVodDomainRealTimeQpsData | リアルタイム QPS の照会。 | アクセラレーションドメイン名へのアクセスに関する 1 秒あたりのクエリ数 (QPS) データを照会します。この操作は、最小値として 1 分の時間の粒度をサポートし、データの遅延は最低 5 分です。過去 186 日間のデータのクエリが可能です。 |
| DescribeVodDomainRealTimeReqHitRateData | リアルタイムリクエストヒット率の照会。 | アクセラレーションドメイン名のリクエストヒット率データを照会します。この操作でデータのクエリに使用される時間の粒度の最小値は 1 分です。データ遅延は最低 5 分です。過去最大 186 日分のデータのクエリを実行できます。 |
| DescribeVodDomainRealTimeByteHitRateData | リアルタイムバイトヒット率の照会。 | アクセラレーションドメイン名のバイトヒット率データを照会します。この操作は最小値 1 分の時間の粒度をサポートし、データの遅延は少なくとも 5 分です。過去 186 日間のデータのクエリが可能です。 |
| DescribeVodDomainRealTimeDetailData | リアルタイムアクセスの詳細を照会します。 | 過去 7 日間のアクセラレーションドメイン名のリアルタイムアクセスデータ(QPS、帯域幅、HTTP 状態コードデータを含む)を照会します。 |
| ドメイン名管理 | ドメイン名管理 | |
| AddVodDomain | 高速化ドメイン名の追加。 | ApsaraVideo VOD に CDN 高速化用のドメイン名を追加します。 |
| DeleteVodDomain | アクセラレーションドメイン名の削除。 | ApsaraVideo VOD に追加されたアクセラレーションドメイン名を削除します。 |
| UpdateVodDomain | アクセラレーションドメイン名を変更します。 | アクセラレーションドメイン名を変更します。 |
| DescribeVodUserDomains | アクセラレーションドメイン名リストの照会。 | アカウント配下の ApsaraVideo VOD のすべてのアクセラレーションドメイン名のリストを照会します。 |
| DescribeVodDomainDetail | ドメイン名の基本情報を照会します。 | ビデオオンデマンド (VOD) アクセラレーションの指定されたドメイン名の基本構成情報を取得します。 |
| BatchStartVodDomain | 高速化ドメイン名を有効にします。 | 無効状態の高速化ドメイン名を有効にします。 |
| BatchStopVodDomain | アクセラレーションドメイン名の一時停止。 | ドメイン名のアクセラレーションを一時停止します。 |
| ドメイン名の検証 | ドメイン名の検証 | |
| VerifyVodDomainOwner | ドメイン名の所有権を確認します。 | ドメイン名の所有権を確認します。 |
| DescribeVodVerifyContent | ドメイン所有権の確認コンテンツを取得します。 | ドメイン所有権の確認コンテンツを取得します。 |
| ドメイン名設定 | ドメイン名設定 | |
| DeleteVodSpecificConfig | ドメイン名構成の削除。 | ApsaraVideo VOD の CDN アクセラレーション用ドメイン名の構成を削除します。 |
| SetVodDomainCertificate | ドメイン証明書のステータス設定および証明書情報の変更。 | 指定されたドメイン名の証明書機能を有効にするかどうかを設定し、証明書情報を変更します。 |
| DescribeVodDomainConfigs | ドメイン名の構成を照会します。 | ドメイン名の構成を照会します。1 回のリクエストで複数の特徴の構成を照会できます。 |
| DescribeVodCertificateList | 証明書リストの照会。 | 証明書リスト情報を照会します。 |
| DescribeVodDomainCertificateInfo | ドメイン名証明書の照会。 | 指定されたアクセラレーションドメイン名の証明書情報を取得します。 |
| BatchSetVodDomainConfigs | ドメイン名のバッチ構成。 | 複数のアクセラレーションドメイン名をバッチで構成します。 |
| パージとプリフェッチ | パージとプリフェッチ | |
| DescribeVodRefreshTasks | パージおよびプリフェッチステータスの照会。 | パージおよびプリフェッチタスクの効果が得られたかどうかを照会します。 |
| DescribeVodRefreshQuota | パージおよびプリフェッチのクォータと残数の照会。 | パージおよびプリフェッチ操作における URL およびディレクトリの最大値と日次割当クォータの残数を照会します。 |
| PreloadVodObjectCaches | キャッシュのプリフェッチ | オリジンサーバーから L2 キャッシュノードへコンテンツをプリフェッチし、初回アクセス時にキャッシュに直接ヒットするようにすることで、オリジンサーバーへのロードを軽減します。 |
| RefreshVodObjectCaches | キャッシュのパージ | ノード上のファイルコンテンツをパージします。キャッシュノード上でパージする URL コンテンツを指定でき、バッチでの URL パージをサポートしています。 |
| RefreshMediaPlayUrls | 音声または動画のリフレッシュまたはプリフェッチタスクの送信。 | 音声または動画 ID を指定して、音声または動画ファイルのリフレッシュまたはプリフェッチタスクを送信します。 |
| GetMediaRefreshJobs | 動画のパージまたはプリフェッチタスク情報の照会。 | 動画のパージまたはプリフェッチタスクのタスクステータスやフィルタリングポリシーなどのタスク情報を照会します。 |
| ログ管理 | ログ管理 | |
| DescribeVodDomainLog | ドメイン名ログの照会。 | 指定されたドメイン名の CDN 生アクセスログのダウンロード URL を取得します。 |
ビデオセキュリティ
|
API |
タイトル |
説明 |
| HLS 暗号化 | HLS 暗号化 | |
| GenerateKMSDataKey | KMS データキーを作成します。 | ApsaraVideo VOD の HLS 暗号化に使用するランダムな KMS データキー (DK) を生成します。 |
| DecryptKMSDataKey | KMS データキーの暗号文を復号します。 | Key Management Service (KMS) データキーの CiphertextBlob を復号します。 |
| 電子透かし | 電子透かし | |
| SubmitDigitalWatermarkExtractJob | 電子透かし抽出タスクの送信。 | 電子透かし(著作権ウォーターマークまたは追跡電子透かし)の抽出タスクを非同期で送信し、著作権ウォーターマークまたは追跡電子透かしを抽出します。 |
| GetDigitalWatermarkExtractResult | 電子透かし抽出タスクのクエリ。 | 電子透かし(著作権ウォーターマークまたは追跡電子透かし)の抽出タスクの結果を照会します。これには、タスクのステータスおよび正常に抽出されたウォーターマークテキストが含まれます。 |
| 安全なダウンロード (キャッシュ) | 安全なダウンロード (キャッシュ) | |
| GenerateDownloadSecretKey | 安全ダウンロードキーを生成します。 | 安全ダウンロード用のキーを生成します。ApsaraVideo Player SDK の安全ダウンロード機能は、キーファイルを使用してローカルデバイスにダウンロードされた動画を暗号化します。暗号化された動画は、事前にバインド可能な一意のアプリによって生成されたキーファイルを使用した場合のみ復号および再生できます。これにより、動画コンテンツが効果的に保護され、ダウンロードされた動画の不正な再生や配布を防止できます。 |
データ統計
|
API |
タイトル |
説明 |
| 使用量データ | 使用量データ | |
| DescribeVodDomainUsageData | トラフィックおよび帯域幅使用量の照会。 | アクセラレーショントラフィックまたは帯域幅使用量のデータを照会します。 |
| DescribeVodStorageData | ストレージ使用量の照会。 | ストレージ容量やアウトバウンドストレージトラフィックなど、メディアアセット管理の使用量を照会します。 |
| DescribeVodTranscodeData | トランスコード中の使用量データを照会します。 | トランスコード中の使用量データを照会します。 |
| DescribeVodAIData | AI 処理使用量データの照会。 | 自動レビューやメディアフィンガープリントなどの AI 処理サービスの使用量データを照会します。 |
| DescribeVodTieringStorageData | 階層型ストレージ使用量の照会。 | メディアアセット管理の階層型ストレージの使用量を照会します。 |
| DescribeVodTieringStorageRetrievalData | 階層型ストレージの取得データを照会します。 | メディアアセット管理における階層型ストレージの取得データ使用量を照会します。 |
| 再生品質 (QOS/QOE) | 再生品質 (QOS/QOE) | |
| DescribeVodPlayerMetricData | プレーヤーの再生データを照会します。 | プレーヤーのメトリックデータを照会します。 |
| DescribeVodPlayerCollectData | プレーヤーの再生集計データを照会します。 | プレーヤーの集計再生データを照会します。 |
| DescribeVodPlayerDimensionData | プレーヤーのディメンションメタデータを照会します。 | プレーヤーのディメンションメタデータを照会します。 |
| 再生データ (新) | 再生データ (新) | |
| GetDailyPlayRegionStatis | 音声および動画 ID 別のトラフィックデータ統計を照会します。 | 指定された日付およびリージョンのメディアアセットの完全なトラフィックデータを取得します。データは CDN トラフィックログに基づいて生成され、主に動画のトラフィック消費量を反映します。生成される CSV ファイルには、日付、動画 ID、ドメイン名、トラフィック、アプリケーション ID、カテゴリ ID の情報が含まれます。運用データの分析などのシナリオで、ファイルをローカルマシンにダウンロードできます。 |
| DescribeVodMediaPlayData | 音声および動画の再生統計情報を照会します。 | メディア ID(音声または動画 ID)を指定して、指定した日付の音声または動画ファイルの再生データを取得します。取得できるデータには、ユニークビジター数、ユーザーあたりの平均再生回数、総再生回数、ユーザーあたりの平均再生持続時間、総再生持続時間が含まれます。 |
| 再生データ (レガシ) | 再生データ (レガシ) | |
| DescribePlayTopVideos | 上位動画の再生統計を照会します。 | 上位動画の日次再生統計(再生回数、ユニーク視聴者数、総再生持続時間など)を取得します。 |
| DescribePlayUserAvg | 平均再生統計のクエリ。 | 指定された時間範囲の 1 日あたりの平均再生統計(平均再生持続時間および平均再生回数を含む)を取得します。 |
| DescribePlayUserTotal | 再生統計の合計を照会します。 | 指定された時間範囲内の日次再生統計の合計を取得します。これには、総再生回数、総ユニーク視聴者数、総再生持続時間、および再生持続時間のディストリビューションが含まれます。 |
| DescribePlayVideoStatis | 単一動画の再生統計情報を照会します。 | 指定された時間範囲内の、特定の動画の日次再生統計情報を照会します。統計情報には、総再生持続時間、再生回数、ユニーク視聴者数、および再生持続時間のディストリビューションが含まれます。 |
マルチアプリケーションシステム
|
API |
タイトル |
説明 |
| アプリケーション管理 | アプリケーション管理 | |
| CreateAppInfo | アプリケーションを作成します。 | アプリケーションを作成します。 |
| DeleteAppInfo | アプリケーションを削除します。 | アプリケーション情報を削除します。 |
| UpdateAppInfo | アプリケーション情報を更新します。 | アプリケーション情報を更新します。 |
| GetAppInfos | アプリケーション情報の照会。 | アプリケーション ID に基づいてアプリケーション情報を照会します。 |
| ListAppInfo | アプリケーション情報リストの照会。 | 指定されたフィルター条件に基づいて、アクセス権限のあるアプリケーションのリストを照会します。 |
| AddVodStorageForApp | ストレージをサブアプリケーションにバインドします | ストレージバケットを ApsaraVideo VOD のサブアプリケーションにバインドします。 |
| 権限付与管理 | 権限付与管理 | |
| AttachAppPolicyToIdentity | ID エンティティにアプリケーションの権限付与をアタッチします。 | 指定された ID (Resource Access Management (RAM) ユーザーまたは RAM ロール) に ApsaraVideo VOD アプリケーションのアクセス権限をアタッチします。 |
| DetachAppPolicyFromIdentity | ID エンティティからアプリケーションの権限を取り消します。 | 指定されたアカウント ID (Resource Access Management (RAM) ユーザーまたは RAM ロール) からアプリケーションの権限付与を取り消します。 |
| ListAppPoliciesForIdentity | ID エンティティに付与されたアプリケーション権限を一覧表示します。 | 指定された ID (Resource Access Management (RAM) ユーザーまたは RAM ロール) に付与されたアプリケーション権限を一覧表示します。 |
| リソース移行 | リソース移行 | |
| MoveAppResource | リソースを新しいアプリケーションに移行します。 | メディアアセットなどのリソースをあるアプリケーションから別のアプリケーションに移行します。アプリケーション管理者はリソースを直接転送できます。Resource Access Management (RAM) ユーザーまたは RAM ロールには、ソースおよび送信先の両方のアプリケーションに対する書き込み権限が必要です。バッチ移行がサポートされています。 |
| 再生キー | 再生キー | |
| GetAppPlayKey | アプリケーションの再生キーを取得します。 | アプリケーションの再生キーを取得します。 |
| SetAppPlayKey | アプリケーションの再生キーを設定します。 | アプリケーションの再生キーを設定します。 |
グローバル設定
|
API |
タイトル |
説明 |
| ストレージ管理 | ストレージ管理 | |
| SetCrossdomainContent | クロスドメインファイルの更新。 | ApsaraVideo VOD のクロスドメインファイル crossdomain.xml のコンテンツを更新します。 |
| イベント通知 | イベント通知 | |
| DeleteMessageCallback | イベント通知構成の削除。 | イベント通知のコールバックメソッド、コールバック URL、およびイベントタイプを削除します。 |
| SetMessageCallback | イベント通知設定の設定。 | イベント通知のコールバックメソッド、コールバック URL、およびイベントタイプを設定します。 |
| GetMessageCallback | イベント通知構成の照会。 | イベント通知のコールバックメソッド、コールバック URL、およびイベントタイプを照会します。 |
その他
|
API |
タイトル |
説明 |
| ChangeResourceGroup | リソースを別のリソースグループに転送します。 | リソースを別のリソースグループに転送します。 |
| DescribeVodDomainMax95BpsData | 95 パーセンタイル帯域幅の照会。 | アクセラレーションドメイン名の 95 パーセンタイル帯域幅モニタリングデータを照会します。 |
| DescribeVodSSLCertificateList | ドメイン名で証明書リストを照会します。 | ドメイン名で証明書リスト情報を照会します。 |
| SetVodDomainSSLCertificate | VOD ドメイン証明書の設定。 | 指定されたドメイン名の証明書機能を有効にするかどうかを設定し、証明書情報を更新します。 |
| DescribeVodEditingUsageData | オンライン編集の使用量データを照会します。 | ApsaraVideo VOD のオンライン編集の使用量データを照会します。 |
| DescribeVodUserVipsByDomain | ノード IP リストの照会 - L1 | ドメイン名の IP リストを照会します。 |