UploadMediaByURL API は、ソース URL からオーディオまたはビデオファイルをアップロードします。バッチアップロードをサポートしており、ローカルサーバーやデバイスではなく、パブリック URL からファイルをアップロードする場合に最適です。
操作説明
説明
-
コールバックが設定されている場合、サービスは URL アップロードの完了時にイベント通知を送信します。API を呼び出して URL アップロード情報を取得し、アップロードステータスを照会できます。
-
アップロードジョブの送信が成功すると、システムはクラウド内に非同期タスクを作成し、実行キューに追加します。アップロードが完了すると、イベント通知 (メッセージコールバック) の URL とメディア ID を使用してレコードを更新できます。
制限事項
-
この API は、VOD ストレージへのファイルのアップロードのみをサポートしており、独自の Object Storage Service (OSS) バケットへのアップロードはサポートしていません。独自の OSS ストレージを使用するには、まずファイルをローカル デバイスにプルし、OSS SDK を使用して OSS にアップロードしてから、RegisterMediaInfo API を呼び出して OSS オブジェクトをメディアアセットライブラリに登録する必要があります。
-
この API は現在、China (Shanghai)、China (Beijing)、China (Shenzhen) リージョンでのみ利用可能です。
-
この API は、オーディオおよびビデオファイルのアップロードのみをサポートしています。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ice:UploadMediaByURL |
create |
*すべてのリソース
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| UploadURLs |
string |
任意 |
メディアファイルのソース URL。
|
https://diffurl.mp4 |
| AppId |
string |
任意 |
アプリケーション ID。 |
app-1000000 |
| UserData |
string |
任意 |
JSON 文字列形式のカスタム設定。このパラメータは、メッセージコールバックなどの設定をサポートします。 |
{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"xxx","test":"www"}} |
| UploadTargetConfig |
string |
任意 |
アップロード先のストレージロケーション。
|
{"StorageType":"oss","StorageLocation":"outin-***.oss-cn-shanghai.aliyuncs.com"} |
| MediaMetaData |
string |
任意 |
JSON 文字列形式のメディアファイルのメタデータ。
|
[{"SourceURL":"https://example.aliyundoc.com/video01.mp4","Title":"urlUploadTest"}] |
| PostProcessConfig |
string |
任意 |
メディアファイルのタイプが
|
{"ProcessType": "Workflow","ProcessID":"b72a06c6beeb4dcdb898feef067b1***"} |
| EntityId |
string |
任意 |
エンティティ ID。CreateEntity API を呼び出してエンティティを作成し、カスタム動的メタデータスキーマを定義できます。 |
d67281da3c8743b8823ad12976187*** |
UploadMetadata
| パラメータ | タイプ | 必須 | 説明 |
| SourceURL | string | はい | アップロードするメディアファイルのソース URL。 |
| Title | string | はい | メディアファイルのタイトル。最大長:128 バイト。UTF-8 でエンコードされている必要があります。 |
| FileSize | string | いいえ | ファイルのサイズ。 |
| Description | string | いいえ | メディアファイルの説明。最大長:1,024 バイト。UTF-8 でエンコードされている必要があります。 |
| CoverURL | string | いいえ | カスタムビデオカバーの URL。 |
| CateId | string | いいえ | カテゴリ ID。 |
| Tags | string | いいえ | メディアファイルのタグ。最大 16 個のタグを指定でき、各タグは最大 32 バイトです。複数のタグはカンマ (,) で区切ります。タグは UTF-8 でエンコードされている必要があります。 |
| WorkflowId | string | いいえ | ワークフロー ID。 |
| FileExtension | string | いいえ | メディアファイルの拡張子。 |
| DynamicMetaData | string | いいえ | 動的メタデータ。例:{"Uploader": "xxx"}。 |
| EntityId | string | いいえ | エンティティ ID。 |
-
WorkflowIdパラメータは非同期タスクをトリガーします。送信後、サービスはジョブを非同期実行のためにキューに追加するため、即座には完了しません。 -
UploadMetadataのパラメータ (Title、Description、Tagsなど) には絵文字を含めることはできません。 -
バッチでジョブを送信した場合、各
SourceURLに対して個別の通知が送信されます。バッチジョブを送信すると、サービスは
SourceURLごとに通知を送信します。 バッチ送信の場合、 SourceURL ごとに個別の通知が送信されます。
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
返される結果。 |
||
| RequestId |
string |
リクエスト ID。 |
****83B7-7F87-4792-BFE9-63CD2137**** |
| UploadJobs |
array<object> |
アップロードジョブの配列。 |
|
|
object |
アップロードジョブの詳細。 |
||
| JobId |
string |
アップロードジョブ ID。 |
20ce1e05dba64576b96e9683879f0*** |
| SourceURL |
string |
アップロードジョブに対応するソース URL。 |
http://example****.mp4 |
| MediaId |
string |
メディア ID。 |
f476988629f54a7b8a4ba90d1a6c7*** |
例
成功レスポンス
JSON JSON
{
"RequestId": "****83B7-7F87-4792-BFE9-63CD2137****",
"UploadJobs": [
{
"JobId": "20ce1e05dba64576b96e9683879f0***",
"SourceURL": "http://example****.mp4",
"MediaId": "f476988629f54a7b8a4ba90d1a6c7***"
}
]
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。