メディアリフレッシュまたはプリフェッチジョブのステータスやフィルター条件などの情報をクエリします。
操作説明
リフレッシュまたはプリフェッチジョブ内のすべてのメディアファイル、または特定のメディアファイルの情報をクエリできます。
QPS 制限
1 つのアカウントで、1 秒あたり最大 50 回この操作を呼び出すことができます。 この制限を超えたリクエストはドロップされ、サービスが中断されます。 この操作を呼び出す際は、この制限に注意することを推奨します。 詳細については、「ApsaraVideo VoD の API 操作における QPS 制限」をご参照ください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
vod:GetMediaRefreshJobs |
list |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| MediaRefreshJobId |
string |
必須 |
RefreshMediaPlayUrls 操作を呼び出したときに返される MediaRefreshJobId パラメーターの値である、リフレッシュまたはプリフェッチジョブの ID。 |
41d465e31957**** |
| MediaId |
string |
任意 |
RefreshMediaPlayUrls 操作を呼び出すときに指定する このパラメーターを空のままにした場合、 |
ca3a8f6e4957b658067095869**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
返されるデータ。 |
||
| RequestId |
string |
リクエストの ID。 |
25818875-5F78-4AF6-D7393642CA58**** |
| MediaRefreshJobs |
array<object> |
メディアリフレッシュまたはプリフェッチジョブ。 |
|
|
object |
メディアリフレッシュまたはプリフェッチジョブに関する情報。 |
||
| MediaRefreshJobId |
string |
ジョブの ID。 |
41d465e31957**** |
| MediaId |
string |
メディアファイルの ID。 |
ca3a8f6e4957b658067095869**** |
| TaskType |
string |
ジョブのタイプ。 有効な値:
|
Preload |
| FilterPolicy |
string |
ストリーム再生のフィルター条件。 値は JSON 文字列です。 このパラメーターは、RefreshMediaPlayUrls 操作のリクエストパラメーターとして使用されます。 |
{"Formats":"mp4,m3u8", "Definitions":"HD,SD", " StreamType":"video", "ResultType":"Single", " SliceFlag":false, "SliceCount": 3} |
| Status |
string |
ジョブのステータス。 有効な値:
|
success |
| SuccessPlayUrls |
string |
リフレッシュまたはプリフェッチされた再生 URL。 |
https://shenzhen.****.aliyuncdn.com/74401a4f546007bf845cd8840****.m3u8,https://shenzhen.****.aliyuncdn.com/24041e7d13582d86604d8****.m3u8 |
| TaskIds |
string |
メディアファイルの再生 URL のリフレッシュまたはプリフェッチタスクの ID。 1 つのタスクでリフレッシュまたはプリフェッチできる URL は 1 つだけです。 この値は、メディアファイルの再生 URL のリフレッシュまたはプリフェッチタスクのステータスをクエリする DescribeVodRefreshTasks 操作で使用されます。 |
70422****,9524**** |
| ErrorCode |
string |
エラーコード。 このパラメーターは、リフレッシュまたはプリフェッチタスクが失敗した場合に返されます。 |
PreloadQueueFull |
| ErrorMessage |
string |
エラーメッセージ。 このパラメーターは、リフレッシュまたはプリフェッチタスクが失敗した場合に返されます。 |
Preload queue is full, please try again later! |
| UserData |
string |
リフレッシュまたはプリフェッチタスクを送信するときに渡したユーザーデータ。 |
{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"}, "Extend":{"localId":"xxx","test":"www"}} |
| GmtCreate |
string |
タスクが作成された時間。 |
2022-05-20T08:23:22Z |
| GmtModified |
string |
タスクが変更された時間。 |
2022-05-21T08:23:22Z |
例
成功レスポンス
JSONJSON
{
"RequestId": "25818875-5F78-4AF6-D7393642CA58****",
"MediaRefreshJobs": [
{
"MediaRefreshJobId": "41d465e31957****",
"MediaId": "ca3a8f6e4957b658067095869****",
"TaskType": "Preload",
"FilterPolicy": "{\"Formats\":\"mp4,m3u8\", \"Definitions\":\"HD,SD\", \" StreamType\":\"video\", \"ResultType\":\"Single\", \" SliceFlag\":false, \"SliceCount\": 3}",
"Status": "success",
"SuccessPlayUrls": "https://shenzhen.****.aliyuncdn.com/74401a4f546007bf845cd8840****.m3u8,https://shenzhen.****.aliyuncdn.com/24041e7d13582d86604d8****.m3u8",
"TaskIds": "70422****,9524****",
"ErrorCode": "PreloadQueueFull",
"ErrorMessage": "Preload queue is full, please try again later!",
"UserData": "{\"MessageCallback\":{\"CallbackURL\":\"http://example.aliyundoc.com\"}, \"Extend\":{\"localId\":\"xxx\",\"test\":\"www\"}}",
"GmtCreate": "2022-05-20T08:23:22Z",
"GmtModified": "2022-05-21T08:23:22Z"
}
]
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。