すべてのプロダクト
Search
ドキュメントセンター

:ListDatasetFileMetas

最終更新日:Sep 09, 2026

データセットファイルのリストを照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

paidataset:ListDatasetFileMetas

list

*すべてのリソース。

*

なし なし

リクエスト構文

GET /api/v1/datasets/{DatasetId}/datasetfilemetas HTTP/1.1

パスパラメーター

パラメーター

型

必須 / 任意

説明

例

DatasetId

string

必須

データセットの ID。データセット ID を取得する方法については、「 ListDatasets 」を参照してください。

d-rbvg5*****jhc9ks92

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

DatasetVersion

string

必須

データセットのバージョン名。

v1

WorkspaceId

string

必須

データセットのワークスペース ID。ワークスペース ID を取得する方法については、「 ListWorkspaces 」を参照してください。

105173

QueryType

string

任意

取得タイプ。有効な値:

  • MIX: ハイブリッド取得 (デフォルト)。

  • TAG: タグのみの取得。

  • VECTOR: AISearch のみの取得。

列挙値:

  • TAG :

    TAG。

  • MIX :

    MIX。

  • VECTOR :

    VECTOR。

MIX

QueryText

string

任意

検索するテキストコンテンツ。

A fallen water

TopK

integer

任意

返される結果の最大値。上位 K 件の結果のみが返されます。

説明

このパラメーターは、QueryType が VECTOR または MIX に設定されている場合にのみ有効です。

100

ScoreThreshold

number

任意

類似度スコアのしきい値。ScoreThreshold より大きいスコアを持つ結果のみが返されます。

説明

このパラメーターは、QueryType が VECTOR または MIX に設定されている場合にのみ有効です。

0.6

PageSize deprecated

integer

任意

1 ページあたりのエントリ数。MaxResults も指定されている場合は、MaxResults が優先されます。

説明

このパラメーターはまもなく廃止されます。ページングクエリを実行するには、NextToken と MaxResults を使用してください。

10

NextToken

string

任意

ページネーショントークン。

説明

このパラメーターが指定されていない場合は、データの最初のページが返されます。このパラメーターに対して値が返された場合は、さらにページが存在します。返された NextToken 値をリクエストパラメーターとして渡して次のページを取得します。NextToken 値が返されなくなるまでこれを繰り返すと、すべてのデータが取得されたことを示します。

90a6ee35-****-4cd4-927e-1f45e1cb8b62_1729644433000

SortBy

string

任意

ページングクエリのソートフィールド。デフォルトでは、結果は取得の関連性に基づいて降順でソートされます。その他の有効な値:

  • FileCreateTime: ファイル作成時間によるソート。

  • FileUpdateTime: ファイル最終更新時間によるソート。

列挙値:

  • FileCreateTime :

    FileCreateTime。

  • FileUpdateTime :

    FileUpdateTime。

FileCreateTime

Order

string

任意

ページングクエリで指定されたソートフィールドのソート順序。SortBy と一緒に使用します。デフォルト値: DESC。有効な値:

  • ASC: 昇順。

  • DESC: 降順。

列挙値:

  • ASC :

    ASC。

  • DESC :

    DESC。

DESC

EndFileUpdateTime

string

任意

クエリのファイル更新時間の範囲の開始時刻。値は ISO 8601 フォーマットの協定世界時 (UTC) タイムスタンプです。

2025-01-12T14:36:01.000Z

StartFileUpdateTime

string

任意

クエリのファイル更新時間の範囲の終了時刻。値は ISO 8601 フォーマットの協定世界時 (UTC) タイムスタンプです。

2025-01-12T14:36:01.000Z

QueryImage

string

任意

イメージ検索用のイメージ情報。

  • パブリックネットワークアクセスを持つ OSS URL がサポートされています。フォーマット: oss://{bucket_name}/{object_path}。bucket_name はバケット名、object_path はバケット内のファイルパスです。

説明

このパラメーターは、QueryType が VECTOR または MIX に設定されている場合にのみ有効です。

oss://test-xxx-oss/car/0001.png

ThumbnailMode

string

任意

イメージのサムネイルモード。現在、サムネイルをサポートしているのは OSS ファイルのみです:

  • 比例スケーリング: p_{percentage}。percentage は目的のスケーリング比率を指定します。有効な値: [1, 100]。例: p_50 は、元のファイルサイズの 50% をサムネイルとして使用します。

  • 幅固定、高さ自動調整: w_{width}。width は目的のイメージの幅を指定します。有効な値: [1, 16384]。例: w_200 はイメージの幅を 200 ピクセルに固定し、高さを自動調整します。

  • 高さ固定、幅自動調整: h_{height}。height は目的のイメージの高さを指定します。有効な値: [1, 16384]。例: h_100 はイメージの高さを 100 ピクセルに固定し、幅を自動調整します。

  • 寸法固定、パディングあり: m_pad,w_{width},h_{height},color_{RGB}。m_pad は、指定された幅と高さの長方形内に収まる最大サイズにイメージをスケーリングします。RGB は空白領域の塗りつぶし色を指定します。このパラメーターが指定されていない場合、デフォルトで白が使用されます。width は目的のイメージの幅を指定し、height は目的のイメージの高さを指定します。width と height の有効な値: [1, 16384]。例:

  • 寸法固定、中央クロップ: m_fill,w_{width},h_{height}。m_fill は、指定された幅と高さの長方形を超える最小サイズにイメージを比例スケーリングし、余分な部分を中央でクロップします。width は目的のイメージの幅を指定し、height は目的のイメージの高さを指定します。width と height の有効な値: [1, 16384]。例: m_fill,w_100,h_100 は、幅と高さの両方を 100 ピクセルに固定し、中央クロップします。

  • 寸法強制: m_fixed,w_{width},h_{height}。width は目的のイメージの幅を指定し、height は目的のイメージの高さを指定します。width と height の有効な値: [1, 16384]。例: m_fixed,w_100,h_100 は、幅と高さの両方を 100 ピクセルに強制します。

w_100

DatasetFileMetaIds

array

任意

クエリ対象のメタデータ ID のリスト。

string

任意

メタデータ ID。

5dc037c8ec0a6fc4e15741328e531bbee036exxxxxxxxx722eff66c38a90e08c

QueryTagsIncludeAll

array

任意

「以下のすべてのタグを含む」の検索条件。複数のタグを選択でき、クエリ結果はすべてのタグと一致する必要があります。このパラメーターが空の場合、この条件は適用されません。配列要素はカンマで区切られます。

説明

このパラメーターは、QueryType が TAG または MIX に設定されている場合にのみ有効です。QueryType が TAG に設定されている場合、QueryText の値がこの条件に追加されます。

string

任意

タグ名。

Lane line

QueryTagsIncludeAny

array

任意

「以下のいずれかのタグを含む」の検索条件。複数のタグを選択でき、クエリ結果はそのうちの 1 つと一致している必要があります。このパラメーターが空の場合、この条件は適用されません。配列要素はカンマで区切られます。

説明

このパラメーターは、QueryType が TAG または MIX に設定されている場合にのみ有効です。

string

任意

タグ名。

Lane line

QueryTagsExclude

array

任意

「以下のタグを除外する」の検索条件。複数のタグを選択でき、クエリ結果にはそのいずれも含めることはできません。このパラメーターが空の場合、この条件は適用されません。

説明

このパラメーターは、QueryType が TAG または MIX に設定されている場合にのみ有効です。

string

任意

タグ名。

Lane line

QueryFileName

string

任意

ファイル名の検索条件。あいまい一致がサポートされています。

car

QueryFileDir

string

任意

ファイルディレクトリの検索条件。あいまい一致がサポートされています。

cars/20250221/

QueryFileTypeIncludeAny

array

任意

「以下のいずれかのファイルタイプを含む」の検索条件。複数のファイルタイプを選択でき、クエリ結果はそのうちの 1 つと一致している必要があります。このパラメーターが空の場合、この条件は適用されません。配列要素はカンマで区切られます。

string

任意

ファイルタイプ。

イメージ

QueryContentTypeIncludeAny

array

任意

「以下のいずれかのコンテンツタイプを含む」の検索条件。複数のコンテンツタイプを選択でき、クエリ結果はそのうちの 1 つと一致している必要があります。このパラメーターが空の場合、この条件は適用されません。配列要素はカンマで区切られます。

string

任意

ファイルコンテンツタイプ。

イメージ/jpeg

StartTagUpdateTime

string

任意

クエリのタグ最終更新時間の範囲の開始時刻。値は ISO 8601 フォーマットの協定世界時 (UTC) タイムスタンプです。

2025-01-12T14:36:01.000Z

EndTagUpdateTime

string

任意

クエリのタグ最終更新時間の範囲の終了時刻。値は ISO 8601 フォーマットの協定世界時 (UTC) タイムスタンプです。

2025-01-12T14:36:01.000Z

MaxResults

integer

任意

NextToken ベースのページングを使用する場合の、リクエストごとに返される結果の最大値。有効な値: 1 から 100。デフォルト値: 10。

10

QueryExpression

string

任意

検索文 (DSL) は、複雑な取得条件を表現するためのレルム固有の言語です。グループ化、ブール値論理 (AND/OR/NOT)、範囲の比較 (>, >=, <, <=)、プロパティの存在チェック (HAS/NOT HAS)、トークン一致 (:)、完全に一致 (=) をサポートしており、高度な取得シナリオに適しています。 このパラメーターは、通常、複雑な高度な取得の条件文に使用されます。

重要 競合を避けるため、この検索文を設定した後は、他のクエリパラメーターと一緒に使用しないでください。

(FileUpdateTime > '2025-02-28T00:00:00Z' AND FileUpdateTime < '2025-05-30T09:27:29Z') AND FileDir:'blue_car' AND NOT FileName="toyota.jpg" AND (( Tags.all='lane line' AND Tags.all='barrier gate') OR NOT Tags.user='rainy days' ) AND HAS SemanticIndexJobId AND Content:'a fallen water horse' AND TopK=100 AND SignMode='PUBLIC'

Status

string

任意

クエリ対象のメタデータステータス。有効な値:

  • ACTIVE: 削除されていないデータのみを照会します (デフォルト)。

  • ALL: すべてのデータを照会します。

  • DELETED: 論理的に削除されたデータのみを照会します。

列挙値:

  • ALL :

    すべてのデータを照会します。

  • ACTIVE :

    削除されていないデータのみを照会します。

  • DELETED :

    論理的に削除されたデータのみを照会します。

ACTIVE

QueryVideo

string

任意

動画ベースの検索用の動画ファイル情報。

  • パブリックネットワークアクセスを持つ動画 OSS URL がサポートされています。フォーマット: oss://{bucket_name}/{object_path}。bucket_name はバケット名、object_path はバケット内のファイルパスです。

説明

このパラメーターは、QueryType が VECTOR または MIX に設定されている場合にのみ有効です。

oss://test-xxx-oss/car/0001.mp4

DSL クエリ構文

キーワード説明例
:トークン一致FileName:'lane line'
トークン化後にファイル名に "lane line" を含むデータを検索します。

NOT :トークン除外NOT FileName : 'lane line'
トークン化後にファイル名に "lane line" を含まないデータを検索します。

=完全に一致FileType='image'
ファイルタイプが完全に "image" であるデータを検索します。

NOT =完全除外NOT FileType = 'video'
FileType が "video" ではないすべてのデータを検索します。

HAS存在HAS SemanticIndexJobId
SemanticIndexJobId プロパティを持つすべてのデータを検索します。

NOT HAS非存在NOT HAS SemanticIndexJobId
SemanticIndexJobId プロパティを持たないすべてのデータを検索します。

""文字列値を囲む単一引用符と二重引用符は同じ効果を持ちます。
()グループ化(FileName:'black' AND ContentType='image/jpeg') OR (FileName:'white' AND ContentType='image/png')
FileName が "black" にあいまい一致し、ContentType が "image/jpeg" であるデータ、または FileName が "white" にあいまい一致し、ContentType が "image/png" であるデータを検索します。

>範囲クエリ:
より大きい

FileUpdateTime> '2025-01-16T11:52:56.000Z' AND DataSize >= 12345
最終変更済み時間が 2025-01-16T11:52:56.000Z 以降で、ファイルサイズが 12345 バイト以上のファイルを検索します。

>=範囲クエリ:
以上

上記と同じ。
<範囲クエリ:
より小さい

FileUpdateTime < '2025-01-16T11:52:56.000Z' AND DataSize <= 12345
最終変更済み時間が 2025-01-16T11:52:56.000Z 以前で、ファイルサイズが 12345 バイト以下のファイルを検索します。

<=範囲クエリ:
以下

上記と同じ。
AND論理 AND。
大文字と小文字は区別されません。

FileType='image' AND ContentType:'image/png'
ファイルタイプが "image" で、コンテンツフォーマットが "png" のイメージを検索します。

OR論理 OR。
大文字と小文字は区別されません。

FileType='image' OR FileType='video'
ファイルタイプが "image" または "video" のデータを検索します。

DSL クエリプロパティリファレンス

次の基本ファイルメタデータプロパティ、タグプロパティ、AISearch プロパティ、および一般取得プロパティがサポートされています。 すべてのプロパティは、クエリ条件ではオプションです。

タイプの説明:

  • KEYWORD: 等しい、等しくない、存在する、存在しないの 1 つ以上をサポートします。

  • TEXT: トークン一致、トークン除外、等しい、等しくない、存在する、存在しないの 1 つ以上をサポートします。

  • NUMBER: 範囲クエリ、等しい、存在する、存在しないの 1 つ以上をサポートします。

  • DATE: 範囲クエリ、存在する、存在しないの 1 つ以上をサポートします。

基本メタデータプロパティ

プロパティ内部タイプトークン一致トークン除外等しい等しくない存在する/存在しない範囲クエリAND 論理OR 論理
DatasetFileMetaIdKEYWORD--✅✅✅-✅✅
FileNameTEXT✅✅✅✅✅-✅✅
FileDirTEXT✅✅✅✅✅-✅✅
FileTypeKEYWORD--✅✅✅-✅✅
ContentTypeKEYWORD--✅✅✅-✅✅
DataSizeNUMBER--✅-✅✅✅✅
FileUpdateTimeDATE----✅✅✅✅
SyncTimeDATE----✅✅✅✅
TagUpdateTimeDATE----✅✅✅✅
SemanticIndexUpdateTimeDATE----✅✅✅✅
StatusKEYWORD--✅❌❌-✅❌

タグプロパティ

プロパティ内部タイプトークン一致トークン除外等しい等しくない存在する/存在しない範囲クエリAND 論理OR 論理
Tags.aiKEYWORD--✅✅✅-✅✅
Tags.userKEYWORD--✅✅✅-✅✅
Tags.allKEYWORD--✅✅✅-✅✅

ベクター検索プロパティ

プロパティ内部タイプトークン一致トークン除外等しい等しくない存在する/存在しない範囲クエリAND 論理OR 論理
ContentTEXT✅-❌❌❌-✅❌
TopKNUMBER--✅-❌❌✅❌
ScoreThresholdNUMBER--✅-❌❌✅❌

一般検索プロパティ

プロパティ内部タイプトークン一致トークン除外等しい等しくない存在する/存在しない範囲クエリAND 論理OR 論理
QueryTypeKEYWORD--✅❌❌-✅❌
SignModeKEYWORD--✅❌❌-✅❌
ThumbnailModeKEYWORD--✅❌❌-✅❌
SortByKEYWORD--✅❌❌-✅❌
OrderKEYWORD--✅❌❌-✅❌
NextTokenKEYWORD--✅❌❌-✅❌
MaxResultsNUMBER--✅-❌❌✅❌

レスポンスフィールド

フィールド

型

説明

例

object

応答。

TotalCount

integer

返されるエントリの総数。

123

PageSize deprecated

integer

現在のページサイズ。

30

NextToken

string

ページネーショントークン。クエリ条件に一致する結果の数がページサイズを超える場合、このページネーショントークンが返されます。データの次のページを取得するには、トークン値が返されなくなるまで、返されたトークン値をリクエストパラメーターとして渡します。トークン値が返されなくなった場合、すべてのデータが取得されたことを示します。

90******-f5c5-4cd4-927e-1f45e1cb8b62_1729644433000

DatasetFileMetas

array

データセットファイルメタデータ詳細のリスト。

DatasetFileMeta

データセットファイルメタデータの詳細。

DatasetId

string

データセットの ID。

d-rbvg5*****jhc9ks92

WorkspaceId

string

ワークスペースの ID。

105173

DatasetVersion

string

データセットのバージョン名。

v1

MaxResults

integer

NextToken ベースのページングを使用する場合の、リクエストごとに返される結果の最大値。

10

例

成功レスポンス

JSONJSON

{
  "TotalCount": 123,
  "PageSize": 30,
  "NextToken": "90******-f5c5-4cd4-927e-1f45e1cb8b62_1729644433000",
  "DatasetFileMetas": [
    {
      "DatasetFileMetaId": "07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6",
      "Uri": "oss://test-bucket/dataset/cat.png",
      "FileName": "cat.png",
      "DownloadUrl": "https://test-bucket.oss-cn-shanghai.aliyuncs.com/dataset/cat.png?Expires=171280****&OSSAccessKeyId=LTAI************&Signature=****jZcXOn7FHMCT1DLE22NuNjs%3D",
      "Score": 0.6,
      "DataSize": 120000,
      "FileFingerPrint": "D41D8CD98F*****E9800998ECF8",
      "FileUpdateTime": "2025-01-12T14:36:01Z",
      "Tags": "{\n    \"ai\":\n    [\n        \"Lane line\",\n        \"Water horse\",\n        \"Sunny day\"\n    ],\n    \"user\":\n    [\n        \"Everett\",\n        \"Intelligent driving Dataset 1\",\n        \"Cloudy day\"\n    ],\n    \"user-delete-ai-tags\":\n    [\n        \"Sunny day\"\n    ]\n}",
      "ThumbnailUrl": "https://test-bucket.oss-cn-shanghai.aliyuncs.com/dataset/cat.png?Expires=171280****&OSSAccessKeyId=LTAI************&Signature=****jZcXOn7FHMCT1DLE22NuNjs%3D",
      "MetaAttributes": "{     \"ImageHeight\": 400,     \"ImageWidth\": 800 }",
      "SemanticIndexJobId": "dsjob-klfwtjto****scvt3",
      "SemanticIndexUpdateTime": "2021-01-12T14:36:01.000Z",
      "FileCreateTime": "2021-01-12T14:36:01.000Z",
      "FileType": "イメージ",
      "ContentType": "image/jpeg",
      "Status": "ACTIVE"
    }
  ],
  "DatasetId": "d-rbvg5*****jhc9ks92",
  "WorkspaceId": "105173",
  "DatasetVersion": "v1",
  "MaxResults": 10
}

エラーコード

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

変更履歴

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