ListDatasetFileMetas - 获取数据集文件元数据列表

查询数据集文件列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
paidataset:ListDatasetFileMetaslist
*全部资源
*

请求语法

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

请求参数

名称类型必填描述示例值
DatasetIdstring

数据集 ID。如何获取数据集 ID,详情请参见 ListDatasets

d-rbvg5*****jhc9ks92
DatasetVersionstring

数据集版本名。

v1
WorkspaceIdstring

数据集所在工作空间 ID。如何获取工作空间 ID,请参见 ListWorkspaces

105173
QueryTypestring

检索类型。

  • MIX:混合检索(默认值)。
  • TAG:仅标签检索。
  • VECTOR:仅向量检索。
MIX
QueryTextstring

待搜索文本内容。

倒地的水马
TopKinteger

检索结果返回数量,最多只返回 TopK 个检索结果。

说明 当 QueryType=VECTOR 或 MIX 时有效。
100
ScoreThresholdfloat

相似度分数过滤。只返回大于 ScoreThreshold 的结果。

说明 当 QueryType=VECTOR 或 MIX 时有效。
0.6
PageSizedeprecatedinteger

每页数量。如果同时传入 MaxResults,则以 MaxResults 数量为准。

说明 该参数即将下线,推荐您使用 NextToken 与 MaxResults 完成分页查询操作。
10
NextTokenstring

分页游标标识。

说明 如果不设置该参数,则表示获取第一页的数据。当该参数有返回值时,说明还有下一页,您可以将返回的 NextToken 作为参数再次请求获得下一页的数据,直到返回为 Null 为止,表示获取到了所有的数据。
90a6ee35-****-4cd4-927e-1f45e1cb8b62_1729644433000
SortBystring

分页查询时的排序字段,缺省时按检索时相关性由高到低排序。其他取值如下。

  • FileCreateTime:按文件创建时间。
  • FileUpdateTime:按文件最后修改时间。
FileCreateTime
Orderstring

分页查询时,对指定的排序字段进行升序或降序,与 SortBy 结合使用。默认 DESC。

  • ASC:升序。
  • DESC:降序。
DESC
EndFileUpdateTimestring

用于指定查询的起始文件更新时间。ISO 8601 格式的 UTC 时间戳。

2025-01-12T14:36:01.000Z
StartFileUpdateTimestring

用于指定查询的结束文件更新时间。ISO 8601 格式的 UTC 时间戳。

2025-01-12T14:36:01.000Z
QueryImagestring

以图搜图时,该参数传入图片的信息。

  • 支持传入图片的可公网访问的 oss url 格式。格式为:oss://{bucket_name}/{object_path}。其中 bucket_name 为 bucket 名称,object_path 为文件在 bucket 中的路径。
说明 当 QueryType=VECTOR 或 MIX 时有效。
oss://test-xxx-oss/car/0001.png
ThumbnailModestring

图片缩略图的模式,当前仅 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_{height},h_{height},color_{RGB}, m_pad 表示图片缩放为指定 w 与 h 的矩形内的最大图片,RGB 表示指定居中填充空白部分的颜色,若不设置该参数,默认用白色填充。width 表示期望的图片宽度,height 表示期望的图片高度。width 和 height 的取值范围都为[1,16384]。示例:
  • 固定宽高,居中裁剪:m_fill,w_{width},h_{height}。m_fill 表示图片等比缩放为延伸出指定 w 与 h 的矩形框外的最小图片,超出的部分进行居中裁剪。width 表示期望的图片宽度,height 表示期望的图片高度。width 和 height 的取值范围都为[1,16384]示例:m_fill,w_100,h_100 表示将图片宽度和高度都固定为 100 像素进行居中裁剪缩放。
  • 强制宽高缩放: m_fixed,w_{height},h_{height},width 表示期望的图片宽度,height 表示期望的图片高度。width 和 height 的取值范围都为[1,16384]。示例:m_fixed,w_100,h_100 表示将图片宽度和高度都固定为 100 像素进行强制宽高缩放。
w_100
QueryTagsIncludeAllarray

表示“同时包含以下标签”检索条件。用户可以选择多个标签,查询结果必须同时满足这些标签。如果为空,则不应用此条件。数组使用逗号分隔。

说明 当 QueryType=TAG 或 MIX 时有效。当 QueryType=TAG 时会将 QueryText 加入到该条件下。
string

标签名。

车道线
QueryTagsIncludeAnyarray

表示“包含以下任意标签”检索条件。 用户可以选择多个标签,查询结果只需满足其中一个即可。 如果为空,则不应用此条件。数组使用逗号分隔。

说明 当 QueryType=TAG 或 MIX 时有效。
string

标签名。

车道线
QueryTagsExcludearray

表示“排除以下标签”检索条件。用户可以选择多个标签,查询结果中不能包含这些标签。如果为空,则不应用此条件。

说明 当 QueryType=TAG 或 MIX 时有效。
string

标签名。

车道线
QueryFileNamestring

文件名检索条件。支持模糊检索。

shuima
QueryFileDirstring

文件目录检索条件。支持模糊检索。

cars/20250221/
QueryFileTypeIncludeAnyarray

表示“包含以下任意文件类型”检索条件。用户可以选择多个文件类型,查询结果只需满足其中一个即可。如果为空,则不应用此条件。数组使用逗号分隔。

string

文件类型。

image
StartTagUpdateTimestring

用于指定查询的起始标签最后更新时间。ISO 8601 格式的 UTC 时间戳。

2025-01-12T14:36:01.000Z
EndTagUpdateTimestring

用于指定查询的结束标签最后更新时间。ISO 8601 格式的 UTC 时间戳。

2025-01-12T14:36:01.000Z
MaxResultsinteger

使用 NextToken 方式查询时,每次最多返回的结果数。取值范围:1~100。默认值:10。

10

返回参数

名称类型描述示例值
object

请求结果。

TotalCountinteger

返回数据总条数

123
PageSizedeprecatedinteger

当前页大小。

30
NextTokenstring

分页游标的标识。如果匹配查询条件的返回结果超过了分页大小,则会返回这个分页游标。如果需要获取下一页数据,将返回的游标值作为请求参数即可,直到无游标值返回,表示已经获取了全部数据。

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

数据集文件元数据详情列表。

datasetFileMetaDatasetFileMeta

数据集文件元数据详情。

DatasetIdstring

数据集 ID。

d-rbvg5*****jhc9ks92
WorkspaceIdstring

工作空间 ID。

105173
DatasetVersionstring

数据集版本名。

v1
MaxResultsinteger

使用 NextToken 方式查询时,每次最多返回的结果数。

10

示例

正常返回示例

JSON格式

{
  "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\n",
      "FileUpdateTime": "2025-01-12T14:36:01Z",
      "Tags": {
        "ai": [
          "车道线",
          "水马",
          "晴天"
        ],
        "user": [
          "EverettLi",
          "智能驾驶数据集1",
          "阴天"
        ],
        "user-delete-ai-tags": [
          "晴天"
        ]
      },
      "ThumbnailUrl": "https://test-bucket.oss-cn-shanghai.aliyuncs.com/dataset/cat.png?Expires=171280****&OSSAccessKeyId=LTAI************&Signature=****jZcXOn7FHMCT1DLE22NuNjs%3D",
      "MetaAttributes": {
        "ImageHeight": 400,
        "ImageWidth": 800
      },
      "SyncTime": "2021-01-12T14:36:01.000Z",
      "TagUpdateTime": "2021-01-12T14:36:01.000Z",
      "SemanticIndexJobId": "dsjob-klfwtjto****scvt3",
      "SemanticIndexUpdateTime": "2021-01-12T14:36:01.000Z",
      "FileCreateTime": "2021-01-12T14:36:01.000Z",
      "FileType": "image",
      "ContentType": "image/jpeg"
    }
  ],
  "DatasetId": "d-rbvg5*****jhc9ks92\n",
  "WorkspaceId": 105173,
  "DatasetVersion": "v1",
  "MaxResults": 10
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2025-04-17OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情