ListMediaBasicInfos でメディアアセットの基本情報をクエリ - IMS - Alibaba Cloud - Intelligent Media Services

指定されたパラメーターに一致するメディアアセットの基本情報を返します。

操作説明

includeFileBasicInfo フィールドを true に設定すると、応答には持続時間やファイルサイズなどの基本的なソースファイル情報も含まれます。
一致するメディアアセットを最大 100 件返します。
このクエリは、指定されたすべての空でないフィールドに完全に一致するメディアアセットのみを返します。完全一致をサポートするフィールドは、メディアタイプ、ソース、ビジネスタイプ、カテゴリ、リソースステータスです。
結果セットが単一の応答には大きすぎる場合は、返された nextToken を使用して結果の次のページを取得します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ice:ListMediaBasicInfos

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
StartTime	string	任意	クエリ範囲の開始時刻。作成時刻 (`utcCreated`) に基づきます。この時刻より後に作成された結果を返します (この時刻は含まれません)。時刻は協定世界時 (UTC) で、ISO 8601 規格に準拠している必要があります。フォーマットは `YYYY-MM-DD'T'HH:mm:ss'Z'` です。たとえば、`2017-01-11T12:00:00Z` は、2017 年 1 月 11 日の 20:00:00 (UTC+8) に相当します。	2020-12-20T12:00:00Z
EndTime	string	任意	クエリ範囲の終了時刻。作成時刻 (`utcCreated`) に基づきます。この時刻以前に作成された結果を返します (この時刻を含みます)。時刻は協定世界時 (UTC) で、ISO 8601 規格に準拠している必要があります。フォーマットは `YYYY-MM-DD'T'HH:mm:ss'Z'` です。たとえば、`2017-01-11T12:00:00Z` は、2017 年 1 月 11 日の 20:00:00 (UTC+8) に相当します。	2020-12-20T13:00:00Z
MediaType	string	任意	メディアタイプ。有効な値： `image`：イメージ `video`：ビデオ `audio`：オーディオ `text`：テキスト	video
BusinessType	string	任意	ビジネスタイプ。有効な値： `subtitles`：字幕 `watermark`：ウォーターマーク `opening`：オープニング `ending`：エンディング `general`：一般	opening
Source	string	任意	ソース。有効な値： `oss`：OSS `vod`：ビデオオンデマンド `live`：ライブストリーミング `general`：その他のソース (デフォルト)。	oss
Status	string	任意	メディアのステータス。有効な値： `Init`：ソースファイルが準備できていません。 `Preparing`：ソースファイルは準備中です。たとえば、アップロード中または合成中です。 `PrepareFail`：ソースファイルの準備に失敗しました。これは、たとえば、システムがソースファイルに関する情報の取得に失敗した場合に発生する可能性があります。 `Normal`：ソースファイルは準備完了です。	Normal
NextToken	string	任意	結果の次のページを取得するために使用されるページネーショントークン。空の値は、すべての結果が返されたことを示します。	pSa1SQ0wCe5pzVrQ6mWZEw==
MaxResults	integer	任意	1ページあたりに返す結果の最大数。最大値：100。デフォルト値：10。	5
SortBy	string	任意	作成時刻 (`utcCreated`) に基づく結果のソート順。デフォルトは降順です。有効な値： `desc`：降順 `asc`：昇順	desc
IncludeFileBasicInfo	boolean	任意	`true` に設定すると、応答に基本的なファイル情報が含まれます。	true
MediaId	string	任意	メディア ID。	**019b82e24b37a1c2958dec38**
AuthTimeout	integer	任意	認証の有効期限 (秒単位)。最小値：1。最大値：86400。デフォルト値：3600。	30

レスポンスフィールド

フィールド	型	説明	例
	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	メディアアセットのソース URL。	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=&OSSAccessKeyId=&Signature=&security-token=
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。 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	ファイルの Object Storage Service (OSS) URL。	http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token=
Region	string	ファイルが保存されているリージョン。	cn-shanghai
FormatName	string	コンテナフォーマット。	mov,mp4,m4a,3gp,3g2,mj2
Duration	string	ファイルの持続時間 (秒単位)。	60.00000
Bitrate	string	ファイルのビットレート (Kbit/s 単位)。	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	1ページあたりに返されるエントリの最大数。	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
}

エラーコード

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

変更履歴

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