指定されたパラメーターに一致するメディアアセットの基本情報を返します。
操作説明
-
includeFileBasicInfoフィールドをtrueに設定した場合、レスポンスにはソースファイルの持続時間やファイルサイズなどの基本情報も含まれます。 -
一致するメディアアセットを最大 100 件返します。
-
結果は、指定された空でないすべてのフィルターフィールドと完全に一致する必要があります。 メディアアセットタイプ、ソース、メディアアセットのビジネスタイプ、カテゴリ、リソースステータスのフィールドは完全一致をサポートしています。
-
結果セットが大きすぎて 1 回のレスポンスで返しきれない場合、API は
nextTokenを提供します。 このトークンを使用して、結果の次のページを取得できます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ice:ListMediaBasicInfos |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| StartTime |
string |
任意 |
クエリ対象の時間範囲の開始時刻。 クエリはメディアアセットの作成時間 (
|
2020-12-20T12:00:00Z |
| EndTime |
string |
任意 |
クエリ対象の時間範囲の終了時刻。 クエリはメディアアセットの作成時間 (
|
2020-12-20T13:00:00Z |
| MediaType |
string |
任意 |
メディアアセットのタイプ。 有効値:
|
video |
| BusinessType |
string |
任意 |
メディアアセットのビジネスタイプ。 有効値:
|
opening |
| Source |
string |
任意 |
メディアアセットのソース。 有効値:
|
oss |
| Status |
string |
任意 |
メディアアセットのステータス。 有効値:
|
Normal |
| NextToken |
string |
任意 |
次のリクエストで結果の新しいページを取得するために使用されるページネーショントークン。 このパラメーターが空の場合、すべての結果が返されます。 |
pSa1SQ0wCe5pzVrQ6mWZEw== |
| MaxResults |
integer |
任意 |
各ページで返すエントリの最大数。 最大値: 100。 デフォルト値: 10。 |
5 |
| SortBy |
string |
任意 |
|
desc |
| IncludeFileBasicInfo |
boolean |
任意 |
レスポンスにファイルの基本情報を含めるかどうかを指定します。 値 |
true |
| MediaId |
string |
任意 |
メディアアセットの ID。 |
****019b82e24b37a1c2958dec38**** |
| AuthTimeout |
integer |
任意 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンススキーマ。 |
||
| RequestId |
string |
リクエスト ID。 |
******B7-7F87-4792-BFE9-63CD21****** |
| TotalCount |
integer |
返されたエントリの総数。 |
4 |
| MediaInfos |
array<object> |
要件を満たすメディアアセットのコレクション。 |
|
|
array<object> |
|||
| MediaId |
string |
メディアアセットの ID。 |
****019b82e24b37a1c2958dec38**** |
| MediaBasicInfo |
object |
メディアアセットの基本情報。 |
|
| MediaId |
string |
メディアアセットの ID。 |
****019b82e24b37a1c2958dec38**** |
| InputURL |
string |
対応するシステムに登録されるメディアアセットのアドレス。 |
https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 |
| MediaType |
string |
メディアアセットのタイプ。 |
video |
| BusinessType |
string |
メディアアセットのビジネスタイプ。 |
opening |
| Source |
string |
メディアアセットのソース。 |
oss |
| Title |
string |
メディアアセットのタイトル。 |
title标题 |
| Description |
string |
メディアアセットの説明。 |
desc 描述 |
| Category |
string |
メディアアセットのカテゴリ。 |
分类 category |
| MediaTags |
string |
メディアアセットのタグ。 |
tags,tags2 |
| CoverURL |
string |
カバーの URL。 |
http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires= |
| UserData |
string |
ユーザーデータ。 |
userData |
| Snapshots |
string |
スナップショット。 |
[{"bucket":"example-bucket","count":"3","iceJobId":"******f48f0e4154976b2b8c45******","location":"oss-cn-beijing","snapshotRegular":"example.jpg","templateId":"******e6a6440b29eb60bd7c******"}] |
| Status |
string |
リソースのステータス。 |
Normal |
| TranscodeStatus |
string |
トランスコードステータス。 |
Init |
| CreateTime |
string |
メディアアセットが作成された時刻。 |
2021-01-08T16:52:04Z |
| ModifiedTime |
string |
メディアアセットが変更された時刻。 |
2021-01-08T16:52:07Z |
| DeletedTime |
string |
メディアアセットが削除された時刻。 |
2021-01-08T16:52:07Z |
| SpriteImages |
string |
スプライトイメージ。 |
[{"bucket":"example-bucket","count":"32","iceJobId":"******83ec44d58b2069def2e******","location":"oss-cn-shanghai","snapshotRegular":"example/example-{Count}.jpg","spriteRegular":"example/example-{TileCount}.jpg","templateId":"******e438b14ff39293eaec25******","tileCount":"1"}] |
| CateId |
integer |
カテゴリの ID。 |
3049 |
| Biz |
string |
メディアアセットが属するビジネス。 |
ICE |
| UploadSource |
string |
メディアアセットがアップロードされたソース。 |
general |
| ReferenceId |
string |
各ユーザーに固有のカスタム ID。 値には、文字、数字、ハイフン (-)、アンダースコア (_) を含めることができ、長さは 6〜64 文字である必要があります。 |
123-123 |
| FileInfoList |
array<object> |
ファイル情報。 |
|
|
array<object> |
|||
| FileBasicInfo |
object |
持続時間やサイズなど、ファイルの基本情報。 |
|
| FileName |
string |
ファイルの名前。 |
example.mp4 |
| FileStatus |
string |
ファイルのステータス。 |
Normal |
| FileType |
string |
ファイルのタイプ。 |
source_file |
| FileSize |
string |
ファイルのサイズ。 単位: バイト。 |
14340962 |
| FileUrl |
string |
ファイルの OSS URL。 |
http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4?Expires= |
| Region |
string |
ファイルが保存されているリージョン。 |
cn-shanghai |
| FormatName |
string |
コンテナフォーマット。 |
mov,mp4,m4a,3gp,3g2,mj2 |
| Duration |
string |
持続時間。 |
60.00000 |
| Bitrate |
string |
ビットレート。 |
1912.13 |
| Width |
string |
幅。 |
1280 |
| Height |
string |
高さ。 |
720 |
| CreateTime |
string |
ファイルが作成された時刻。 |
2021-01-08T16:52:04Z |
| ModifiedTime |
string |
ファイルが変更された時刻。 |
2021-01-08T16:52:07Z |
| NextToken |
string |
結果の次のページを取得するために使用されるトークン。 このパラメーターが指定されていない場合、すべての結果が返されます。 |
8EqYpQbZ6Eh7+Zz8DxVYoQ== |
| MaxResults |
integer |
現在のページで返されるエントリの最大数。 |
2 |
例
成功レスポンス
JSONJSON
{
"RequestId": "******B7-7F87-4792-BFE9-63CD21******",
"TotalCount": 4,
"MediaInfos": [
{
"MediaId": "****019b82e24b37a1c2958dec38****",
"MediaBasicInfo": {
"MediaId": "****019b82e24b37a1c2958dec38****",
"InputURL": "https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4",
"MediaType": "video",
"BusinessType": "opening",
"Source": "oss",
"Title": "title标题",
"Description": "desc 描述",
"Category": "分类 category",
"MediaTags": "tags,tags2",
"CoverURL": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=",
"UserData": "userData",
"Snapshots": "[{\"bucket\":\"example-bucket\",\"count\":\"3\",\"iceJobId\":\"******f48f0e4154976b2b8c45******\",\"location\":\"oss-cn-beijing\",\"snapshotRegular\":\"example.jpg\",\"templateId\":\"******e6a6440b29eb60bd7c******\"}]",
"Status": "Normal",
"TranscodeStatus": "Init",
"CreateTime": "2021-01-08T16:52:04Z",
"ModifiedTime": "2021-01-08T16:52:07Z",
"DeletedTime": "2021-01-08T16:52:07Z",
"SpriteImages": "[{\"bucket\":\"example-bucket\",\"count\":\"32\",\"iceJobId\":\"******83ec44d58b2069def2e******\",\"location\":\"oss-cn-shanghai\",\"snapshotRegular\":\"example/example-{Count}.jpg\",\"spriteRegular\":\"example/example-{TileCount}.jpg\",\"templateId\":\"******e438b14ff39293eaec25******\",\"tileCount\":\"1\"}]",
"CateId": 3049,
"Biz": "ICE",
"UploadSource": "general",
"ReferenceId": "123-123"
},
"FileInfoList": [
{
"FileBasicInfo": {
"FileName": "example.mp4",
"FileStatus": "Normal",
"FileType": "source_file",
"FileSize": "14340962",
"FileUrl": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token=",
"Region": "cn-shanghai",
"FormatName": "mov,mp4,m4a,3gp,3g2,mj2",
"Duration": "60.00000",
"Bitrate": "1912.13",
"Width": "1280",
"Height": "720",
"CreateTime": "2021-01-08T16:52:04Z",
"ModifiedTime": "2021-01-08T16:52:07Z"
}
}
]
}
],
"NextToken": "8EqYpQbZ6Eh7+Zz8DxVYoQ==",
"MaxResults": 2
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。