RefreshMediaPlayUrls - - Alibaba Cloud ドキュメントセンター

メディア ID に基づいて、メディアのリフレッシュタスクまたはプリフェッチタスクを送信します。

操作説明

ApsaraVideo VOD では、リソースのパージとプリフェッチが可能です。パージ機能は、POP (Point of Presence) にキャッシュされたリソースを強制的にクリアし、オリジンサーバーから最新のリソースを取得します。プリフェッチ機能は、オフピーク時に POP がオリジンサーバーから頻繁にアクセスされるリソースを取得できるようにします。これにより、キャッシュヒット率が向上します。
この操作を呼び出して、メディア ID に基づいてパージタスクまたはプリフェッチタスクを送信できます。また、ビジネス要件に応じて、パージまたはプリフェッチするメディアストリームのフォーマットと解像度を指定することもできます。
一度に最大 20 件のパージタスクまたはプリフェッチタスクを送信できます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

vod:RefreshMediaPlayUrls

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
MediaIds	string	必須	リフレッシュまたはプリフェッチするメディアファイルの ID。最大 20 個の ID を指定できます。複数の ID はコンマ (,) で区切ります。ID は、次のいずれかの方法で取得できます。 ApsaraVideo VOD コンソールにログインします。左側のナビゲーションウィンドウで、[メディアファイル] > [音声/動画] を選択します。「動画と音声」ページで、音声または動画ファイルの ID を表示します。この方法は、ApsaraVideo VOD コンソールを使用してアップロードされたファイルに適用されます。メディアファイルをアップロードするために呼び出す CreateUploadVideo 操作の応答から `VideoId` の値を取得します。メディアファイルがアップロードされた後にメディア ID をクエリするために呼び出す SearchMedia 操作の応答から `VideoId` の値を取得します。	ca3a8f6e4957b658067095869**, a6e49sfgd23p5g9ja7095863**
TaskType	string	必須	作成するタスクのタイプ。有効な値： Refresh Preload	Preload
Formats	string	任意	リフレッシュまたはプリフェッチするメディアストリームのフォーマット。複数のフォーマットを指定できます。複数のフォーマットはコンマ (,) で区切ります。このパラメーターを空のままにすると、デフォルトですべてのフォーマットのメディアストリームがリフレッシュまたはプリフェッチされます。有効な値： mp4 m3u8 mp3 flv webm ts	mp4,m3u8
Definitions	string	任意	リフレッシュまたはプリフェッチするメディアストリームの解像度を指定します。複数の解像度を指定できます。複数の解像度はコンマ (,) で区切ります。このパラメーターを空のままにすると、デフォルトですべての解像度のメディアストリームがリフレッシュまたはプリフェッチされます。説明値は、「メディアアセットのパラメーター」の「Definition」セクションでサポートされている必要があります。	HD, SD
StreamType	string	任意	リフレッシュまたはプリフェッチするメディアストリームのタイプを指定します。複数のタイプを指定できます。複数のタイプはコンマ (,) で区切ります。このパラメーターを空のままにすると、デフォルトですべてのタイプのメディアストリームがリフレッシュまたはプリフェッチされます。有効な値： video audio	video
ResultType	string	任意	リフレッシュまたはプリフェッチ操作のタイプを指定します。デフォルト値：Single。有効な値： Single：各解像度とフォーマットに対して、最新のトランスコードされたストリームが 1 つだけリフレッシュまたはプリフェッチされます。 Multiple：各解像度とフォーマットに対して、すべてのトランスコードされたストリームがリフレッシュまたはプリフェッチされます。	Single
SliceFlag	boolean	任意	M3U8 メディアストリームの TS ファイルの再生 URL をリフレッシュまたはプリフェッチするかどうかを指定します。デフォルト値：false。有効な値： false true	false
SliceCount	integer	任意	リフレッシュまたはプリフェッチする M3U8 メディアストリームの TS ファイルの再生 URL の数を指定します。このパラメーターを設定すると、最初の N 個の TS ファイルの再生 URL のみがリフレッシュまたはプリフェッチされます。有効な値：1～20。デフォルト値：5。	5
UserData	string	任意	コールバック構成やアップロードアクセラレーション構成などのカスタム構成。値は JSON 文字列である必要があります。詳細については、「リクエストパラメーター」トピックの「UserData: specifies the custom configurations for media upload」セクションをご参照ください。説明コールバック構成は、ApsaraVideo VOD コンソールで HTTP コールバック URL を指定し、特定のコールバックイベントを選択した後にのみ有効になります。ApsaraVideo VOD コンソールで HTTP コールバック設定を構成する方法の詳細については、「コールバック設定の構成」をご参照ください。アップロードアクセラレーション機能を有効にするには、チケットを送信してください。詳細については、「概要」をご参照ください。チケットの送信方法の詳細については、「お問い合わせ」をご参照ください。	{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"}, "Extend":{"localId":"xxx","test":"www"}}

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータ。
MediaRefreshJobId	string	リフレッシュタスクまたはプリフェッチタスクの ID。	41d465e31957****
NonExistMediaIds	string	存在しないメディアファイルの ID。	ca3a8f6e4957b658067095869****
ForbiddenMediaIds	string	操作できないメディアファイルの ID。ほとんどの場合、操作を実行する権限がないためにメディアファイルを操作できません。詳細については、「概要」をご参照ください。	a6e49sfgd23p5g9ja7095863****
RequestId	string	リクエストの ID。	25818875-5F78-4AF6-04D5-D7393642****

例

成功レスポンス

JSONJSON

{
  "MediaRefreshJobId": "41d465e31957****",
  "NonExistMediaIds": "ca3a8f6e4957b658067095869****",
  "ForbiddenMediaIds": "a6e49sfgd23p5g9ja7095863****",
  "RequestId": "25818875-5F78-4AF6-04D5-D7393642****"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。