SearchMedia API で VOD メディアアセットを大量検索 - VOD - Alibaba Cloud - ApsaraVideo VOD

ApsaraVideo VOD で生成された動画、音声ファイル、イメージなどのメディアアセット情報を検索します。この操作では、メディアアセット検索プロトコルを使用して、返却フィールドの指定、完全一致、あいまい検索、多値クエリ、有効値クエリ、ソートフィールドなど、ApsaraVideo VOD での多次元検索を実行できます。

操作説明

完全一致およびあいまい検索をサポートするフィールドについて、他のクエリメソッドが使用された場合、返される結果はそのフィールドでサポートされているクエリメソッドに従います。たとえば、あるフィールドがあいまい検索のみをサポートしている場合、多値クエリを通じて取得される結果もあいまい検索に基づきます。

取得可能なデータ Record 数の制限は以下のとおりです。

メソッド 1: ページネーション走査

一致した検索結果に対して、ページネーションパラメーター PageNo (ページ番号) および PageSize (1 ページあたりの Record 数) を設定することで、最大 5,000 Record を走査できます。検索結果が 5,000 Record を超える場合は、検索条件を調整して結果の有効値を絞り込みます。この方法では、データセット全体を走査することはできません。より多くのデータを走査するには、メソッド 2 を参照してください。
メソッド 2: 全件走査 (音声および動画検索のみ)

このメソッドは動画および音声コンテンツの検索に適用され、最大 200 万件の検索結果の走査をサポートします。検索結果が 200 万件を超える場合は、フィルター条件を追加して結果数を減らしてください。このメソッドを使用する場合、PageNo および PageSize に加えて、ページネーション用に ScrollToken パラメーターを使用する必要があります。各リクエストでは、前方に最大 100 Record の走査がサポートされています。 PageSize を 20 とした場合のページネーションロジックは以下のとおりです。
- PageNo が 1 の場合、次の 5 ページ分のデータまでクエリできます。
- PageNo が 2 の場合、次の 6 ページ分のデータまでクエリできます。

ページネーションパラメーターを適切に設定し、結果セットのサイズに応じて適切な走査メソッドを選択してください。1,000 Record を超えるページネーションが必要な場合は、より高速かつ便利なデータ処理のためにメソッド 2 を使用してください。

今すぐお試しください

この 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:SearchMedia

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SearchType	string	任意	検索するメディアアセットのタイプ。有効な値: video (デフォルト): 動画。 audio: 音声。 image: イメージ。 attached: 補助メディアアセット。説明このパラメーターが video または audio に設定されており、検索条件に一致するすべてのデータを走査する必要がある場合は、ScrollToken パラメーターを設定する必要があります。	video。
Fields	string	任意	検索結果で返すメディアアセットフィールド。デフォルトでは、基本的なメディアアセットフィールドのみが返されます。追加のメディアアセットフィールドを指定して返すことができます。詳細については、「使用例」を参照してください。	Title,CoverURL。
Match	string	任意	フィルター条件。構文ルールについては、「検索プロトコル構文」を参照してください。	フィールド = 値。
SortBy	string	任意	ソートフィールドとソート順序。複数の値はコンマ (,) で区切ります。有効な値: CreationTime:Desc (デフォルト): 作成時間の降順でソートします。 CreationTime:Asc: 作成時間の昇順でソートします。説明ソートフィールドの例については、「ソートフィールド」を参照してください。検索結果の最初の 5,000 Record を取得する場合、最大 3 つのソートフィールドがサポートされています。検索条件に一致するすべてのデータを取得する場合、1 つのソートフィールドのみがサポートされています。	CreationTime:Desc。
PageNo	integer	任意	ページ番号。デフォルト値: 1。説明このパラメーターが 200 を超える場合は、ScrollToken パラメーターも設定してください。	1
PageSize	integer	任意	1 ページあたりの Record 数。デフォルト値: 10。最大値: 100。	10
ScrollToken	string	任意	ページネーショントークン。値は 32 文字の文字列です。最初の検索リクエストではこのパラメーターを設定する必要はありません。検索リクエストがデータに一致すると、サーバーはこのパラメーター値を返し、検索データの現在位置を記録します。返された値をフォローし、以下の要件または推奨事項に基づいて次の検索リクエストでこのパラメーターを設定してください。 SearchType が video または audio に設定されており、検索条件に一致するすべてのデータを走査する必要がある場合、このパラメーターは必須です。 PageNo が 200 を超える場合、検索パフォーマンスを最適化するためにこのパラメーターを設定してください。	24e0fba7188fae707e146esa54****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	3E0CEF83-FB09-4E34-BA1451814B03****
Total	integer	検索条件に一致するメディアアセットの総数。	10
ScrollToken	string	ページネーショントークン。	24e0fba7188fae707e146esa54****
MediaList	array<object>	メディアアセット情報のリスト。
	array<object>	メディアアセットの詳細。
CreationTime	string	メディアアセットが作成された時間。時間は yyyy-MM-ddTHH:mm:ssZ フォーマット (協定世界時 (UTC)) です。	2018-07-19T03:45:25Z
MediaType	string	メディアタイプ。有効な値: video: 動画。 audio: 音声。 image: イメージ。 attached: 補助メディアアセット。	video。
MediaId	string	メディア ID。	a82a2cd7d4e147bbed6c1ee372****
Video	object	動画情報。
Status	string	ステータス。有効値： Uploading：動画はアップロード中です。 UploadFail：動画のアップロードに失敗しました。 UploadSucc：動画はアップロードされました。 Transcoding：動画はトランスコード中です。 TranscodeFail：動画のトランスコードに失敗しました。 Blocked：動画はブロックされています。 Normal：動画は通常状態です。	UploadSucc
CreationTime	string	動画情報が作成された時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式の UTC です。	2018-07-19T03:45:25Z
StorageLocation	string	ストレージリージョン。	outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com
CateId	integer	カテゴリ ID。	10000123
Tags	string	動画タグ。	tag1
ModificationTime	string	動画情報が最後に更新された時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式の UTC です。	2018-07-19T03:48:25Z
MediaSource	string	ソース。有効値： general：VOD アップロード。 short_video：ショートビデオ SDK。 editing：動画編集および制作。 live：ライブストリーム録画。	general
Description	string	動画の説明。	Alibaba Cloud VOD video description
AppId	string	アプリケーション ID。	app-****
CoverURL	string	サムネイル URL。	https://example.aliyundoc.com/image01.png
VideoId	string	動画 ID。	a82a2asdasqadaf3faa0ed6c1ee372****
DownloadSwitch	string	ダウンロードスイッチ。オフラインダウンロードは、スイッチがオンの場合にのみ許可されます。有効値： on：初期状態。オフラインダウンロードが許可されます。 off：オフラインダウンロードは無効です。	on
CateName	string	カテゴリ名。	video1
TranscodeMode	string	トランスコードモード。有効値： FastTranscode (通常のトランスコード)：デフォルトモード。アップロード完了後すぐにトランスコードが開始されます。トランスコード完了後に再生が可能です。 NoTranscode (トランスコードなしで配信)：アップロード完了後にトランスコードは実行されません。すぐに再生が可能です。 AsyncTranscode (アップロード時に配信し、非同期でトランスコード)：アップロード完了後すぐに再生が可能です。トランスコードは非同期で実行されます。	FastTranscode
PreprocessStatus	string	前処理ステータス。有効値： UnPreprocess：前処理されていません。 Preprocessing：前処理中。 PreprocessSucceed：前処理に成功しました。 PreprocessFailed：前処理に失敗しました。	Preprocessing
RestoreExpiration	string	解凍されたメディアアセットの有効期限。	2023-03-30T10:14:14Z
RestoreStatus	string	メディアアセットの解凍状態。有効値： Processing：解凍中。 Success：解凍済み。 Failed：解凍に失敗しました。	Success
StorageClass	string	メディアアセットのストレージクラス。有効値： Standard：標準。 IA：低頻度アクセス (IA)。 Archive：アーカイブ。 ColdArchive：コールドアーカイブ。 SourceIA：ソース IA。 SourceArchive：ソースアーカイブ。 SourceColdArchive：ソースコールドアーカイブ。 Changing：ストレージクラスは変更中です。 SourceChanging：ソースファイルのストレージクラスは変更中です。	Standard
Size	integer	動画サイズ。	123
Duration	number	動画の長さ。単位：秒。	123
Title	string	動画のタイトル。	Alibaba Cloud VOD Video Title
SpriteSnapshots	array	スプライトのリスト。
	string	スプライトのリスト。	{“http://example.aliyundoc.com/image02.jpg”}
Snapshots	array	自動的にキャプチャされたスナップショットのリスト。
	string	自動的にキャプチャされたスナップショットのリスト。	{“http://example.aliyundoc.com/image03.jpg”}
ReferenceId	string	カスタム ID。小文字、大文字、数字、ハイフン (-)、アンダースコア (_) を含めることができます。ID は 6〜64 文字の長さで、ユーザーごとに一意である必要があります。	123-123
Audio	object	音声情報。
Status	string	ステータス。有効値： Uploading：音声はアップロード中です。 Normal：音声は通常状態です。 UploadFail：音声のアップロードに失敗しました。 Deleted：音声は削除されました。	Normal
CreationTime	string	音声が作成された時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式の UTC です。	2018-07-19T03:45:25Z
StorageLocation	string	ストレージリージョン。	outin-aaa*****aa.oss-cn-shanghai.aliyuncs.com
CateId	integer	カテゴリ ID。	10000123
Tags	string	タグ。	tag1,tag2
ModificationTime	string	音声が最後に更新された時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式の UTC です。	2018-07-19T03:48:25Z
MediaSource	string	ソース。有効値： general (VOD アップロード)：ファイルは通常の方法でアップロードされます。 short_video (ショートビデオ SDK)：ファイルはショートビデオ SDK を使用して VOD にアップロードされます。詳細については、「ショートビデオ SDK」をご参照ください。 editing (オンライン編集)：ファイルはオンライン編集を使用して合成された後、VOD にアップロードされます。詳細については、「動画合成」をご参照ください。 live (ライブストリーム録画)：ファイルはライブストリームから録画された後、VOD にアップロードされます。	general
Description	string	説明。	Alibaba Cloud VOD Audio Description
AppId	string	アプリケーション ID。	app-****
CoverURL	string	サムネイル URL。	http://example.com/image04.jpg
AudioId	string	音声 ID。	a82a2cd7d4e147bbed6c1ee372****
DownloadSwitch	string	ダウンロードスイッチ。オフラインダウンロードは、スイッチがオンの場合にのみ許可されます。有効値： on：初期状態。オフラインダウンロードが許可されます。 off：オフラインダウンロードは無効です。	on
CateName	string	カテゴリ名。	cate1
TranscodeMode	string	トランスコードモード。有効値： FastTranscode (通常のトランスコード、デフォルト)：アップロード完了後すぐにトランスコードが開始されます。トランスコード完了後に再生が可能です。 NoTranscode (トランスコードなしで配信)：アップロード完了後にトランスコードは実行されません。すぐに再生が可能です。 AsyncTranscode (アップロード時に配信し、非同期でトランスコード)：アップロード完了後すぐに再生が可能です。トランスコードは非同期で実行されます。	FastTranscode
PreprocessStatus	string	前処理ステータス。前処理された音声ファイルのみがライブストリームディレクティングに使用できます。有効値： UnPreprocess：前処理されていません。 Preprocessing：前処理中。 PreprocessSucceed：前処理に成功しました。 PreprocessFailed：前処理に失敗しました。	UnPreprocess
RestoreExpiration	string	解凍されたメディアアセットの有効期限。	2023-03-30T10:14:14Z
RestoreStatus	string	メディアアセットの解凍状態。有効値： Processing：解凍中。 Success：解凍済み。 Failed：解凍に失敗しました。	Success
StorageClass	string	メディアアセットのストレージクラス。有効値： Standard：標準。 IA：IA。 Archive：アーカイブ。 ColdArchive：コールドアーカイブ。 SourceIA：ソース IA。 SourceArchive：ソースアーカイブ。 SourceColdArchive：ソースコールドアーカイブ。 Changing：ストレージクラスは変更中です。	Standard
Size	integer	サイズ。	123
Duration	number	期間。	123
Title	string	タイトル。	Alibaba Cloud VOD Audio Title
SpriteSnapshots	array	スプライトのリスト。
	string	スプライトのリスト。	{“http://example.aliyundoc.com/image02.jpg”}
Snapshots	array	自動的にキャプチャされたスナップショットのリスト。
	string	自動的にキャプチャされたスナップショットのリスト。	{“http://example.aliyundoc.com/image03.jpg”}
ReferenceId	string	カスタム ID。小文字、大文字、数字、ハイフン (-)、アンダースコア (_) を含めることができます。ID は 6〜64 文字の長さで、ユーザーごとに一意である必要があります。	123-123
Image	object	イメージ情報。
StorageLocation	string	ストレージリージョン。	outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com
CreationTime	string	画像が作成された時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式の UTC です。	2018-07-19T03:45:25Z
Status	string	画像ステータス。 Uploading：初期状態。画像はアップロード中です。 Normal：画像はアップロードされました。 UploadFail：画像のアップロードに失敗しました。	Uploading
CateId	integer	カテゴリ ID。	1000123
Tags	string	タグ。	tag1
ModificationTime	string	画像が最後に更新された時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式の UTC です。	2018-07-19T03:48:25Z
CateName	string	カテゴリ名。	cate1
Description	string	説明。	Alibaba Cloud VOD Image Description
AppId	string	アプリケーション ID。	app-****
URL	string	画像 URL。	https://example.com/****.png
Title	string	タイトル。	Alibaba Cloud VOD Image Title
ImageId	string	画像 ID。	11130843741se99wqmoes****
AttachedMedia	object	補助メディアアセット情報。
CreationTime	string	アセットが作成された時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式の UTC です。	2018-07-19T03:45:25Z
Status	string	ステータス。有効値： Uploading：初期状態。補助メディアアセットはアップロード中です。 Normal：補助メディアアセットはアップロードされました。 UploadFail：補助メディアアセットのアップロードに失敗しました。	Normal
StorageLocation	string	ストレージリージョン。	outin-bfefbb90a47c11*****7426.oss-cn-shanghai.aliyuncs.com
Tags	string	タグ。	tag1
ModificationTime	string	アセットが最後に更新された時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式の UTC です。	2018-07-19T03:48:25Z
MediaId	string	補助メディアアセット ID。	a82a2cd7d4e147ba0ed6c1ee372****
BusinessType	string	ビジネスタイプ。有効値： watermark：ウォーターマーク。 subtitle：字幕。 material：素材。	watermark
Description	string	説明。	Alibaba Cloud VOD-assisted media asset description
AppId	string	アプリケーション ID。	app-****
URL	string	補助メディアアセットの URL。	https://example.com/****.png
Title	string	タイトル。	Alibaba Cloud VOD-assisted media asset Title
Categories	array<object>	カテゴリ ID のリスト。
	object	カテゴリの詳細。
ParentId	integer	親ノード ID。	-1
CateName	string	カテゴリ名。	cate1
CateId	integer	カテゴリ ID。	10027394
Level	integer	カテゴリレベル。	1
AiData		AI の詳細。
AiRoughData		AI まとめデータ。

例

成功レスポンス

JSONJSON

{
  "RequestId": "3E0CEF83-FB09-4E34-BA1451814B03****",
  "Total": 10,
  "ScrollToken": "24e0fba7188fae707e146esa54****",
  "MediaList": [
    {
      "CreationTime": "2018-07-19T03:45:25Z",
      "MediaType": "video",
      "MediaId": "a82a2cd7d4e147bbed6c1ee372****",
      "Video": {
        "Status": "UploadSucc",
        "CreationTime": "2018-07-19T03:45:25Z",
        "StorageLocation": "outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com",
        "CateId": 10000123,
        "Tags": "tag1",
        "ModificationTime": "2018-07-19T03:48:25Z",
        "MediaSource": "general",
        "Description": "Alibaba Cloud VOD video description",
        "AppId": "app-****",
        "CoverURL": "https://example.aliyundoc.com/image01.png",
        "VideoId": "a82a2asdasqadaf3faa0ed6c1ee372****",
        "DownloadSwitch": "on",
        "CateName": "video1",
        "TranscodeMode": "FastTranscode",
        "PreprocessStatus": "Preprocessing",
        "RestoreExpiration": "2023-03-30T10:14:14Z",
        "RestoreStatus": "Success",
        "StorageClass": "Standard",
        "Size": 123,
        "Duration": 123,
        "Title": "Alibaba Cloud VOD Video Title",
        "SpriteSnapshots": [
          "{“http://example.aliyundoc.com/image02.jpg”}"
        ],
        "Snapshots": [
          "{“http://example.aliyundoc.com/image03.jpg”}"
        ],
        "ReferenceId": "123-123"
      },
      "Audio": {
        "Status": "Normal",
        "CreationTime": "2018-07-19T03:45:25Z",
        "StorageLocation": "outin-aaa*****aa.oss-cn-shanghai.aliyuncs.com",
        "CateId": 10000123,
        "Tags": "tag1,tag2",
        "ModificationTime": "2018-07-19T03:48:25Z",
        "MediaSource": "general",
        "Description": "Alibaba Cloud VOD Audio Description",
        "AppId": "app-****",
        "CoverURL": "http://example.com/image04.jpg",
        "AudioId": "a82a2cd7d4e147bbed6c1ee372****",
        "DownloadSwitch": "on",
        "CateName": "cate1",
        "TranscodeMode": "FastTranscode",
        "PreprocessStatus": "UnPreprocess",
        "RestoreExpiration": "2023-03-30T10:14:14Z",
        "RestoreStatus": "Success",
        "StorageClass": "Standard",
        "Size": 123,
        "Duration": 123,
        "Title": "Alibaba Cloud VOD Audio Title",
        "SpriteSnapshots": [
          "{“http://example.aliyundoc.com/image02.jpg”}"
        ],
        "Snapshots": [
          "{“http://example.aliyundoc.com/image03.jpg”}"
        ],
        "ReferenceId": "123-123"
      },
      "Image": {
        "StorageLocation": "outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com",
        "CreationTime": "2018-07-19T03:45:25Z",
        "Status": "Uploading",
        "CateId": 1000123,
        "Tags": "tag1",
        "ModificationTime": "2018-07-19T03:48:25Z",
        "CateName": "cate1",
        "Description": "Alibaba Cloud VOD Image Description",
        "AppId": "app-****",
        "URL": "https://example.com/****.png",
        "Title": "Alibaba Cloud VOD Image Title",
        "ImageId": "11130843741se99wqmoes****"
      },
      "AttachedMedia": {
        "CreationTime": "2018-07-19T03:45:25Z",
        "Status": "Normal",
        "StorageLocation": "outin-bfefbb90a47c11*****7426.oss-cn-shanghai.aliyuncs.com",
        "Tags": "tag1",
        "ModificationTime": "2018-07-19T03:48:25Z",
        "MediaId": "a82a2cd7d4e147ba0ed6c1ee372****",
        "BusinessType": "watermark",
        "Description": "Alibaba Cloud VOD-assisted media asset description",
        "AppId": "app-****",
        "URL": "https://example.com/****.png",
        "Title": "Alibaba Cloud VOD-assisted media asset Title",
        "Categories": [
          {
            "ParentId": -1,
            "CateName": "cate1",
            "CateId": 10027394,
            "Level": 1
          }
        ]
      }
    }
  ]
}

エラーコード

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

変更履歴

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