查询数据集文件列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
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 |
QueryText | string | 否 | 待搜索文本内容。 | 倒地的水马 |
TopK | integer | 否 | 检索结果返回数量,最多只返回 TopK 个检索结果。 说明
当 QueryType=VECTOR 或 MIX 时有效。
| 100 |
ScoreThreshold | float | 否 | 相似度分数过滤。只返回大于 ScoreThreshold 的结果。 说明
当 QueryType=VECTOR 或 MIX 时有效。
| 0.6 |
PageSizedeprecated | integer | 否 | 每页数量。如果同时传入 MaxResults,则以 MaxResults 数量为准。 说明
该参数即将下线,推荐您使用 NextToken 与 MaxResults 完成分页查询操作。
| 10 |
NextToken | string | 否 | 分页游标标识。 说明
如果不设置该参数,则表示获取第一页的数据。当该参数有返回值时,说明还有下一页,您可以将返回的 NextToken 作为参数再次请求获得下一页的数据,直到返回为 Null 为止,表示获取到了所有的数据。
| 90a6ee35-****-4cd4-927e-1f45e1cb8b62_1729644433000 |
SortBy | string | 否 | 分页查询时的排序字段,缺省时按检索时相关性由高到低排序。其他取值如下。
| FileCreateTime |
Order | string | 否 | 分页查询时,对指定的排序字段进行升序或降序,与 SortBy 结合使用。默认 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 | 否 | 以图搜图时,该参数传入图片的信息。
说明
当 QueryType=VECTOR 或 MIX 时有效。
| oss://test-xxx-oss/car/0001.png |
ThumbnailMode | string | 否 | 图片缩略图的模式,当前仅 OSS 文件支持缩略图:
| w_100 |
QueryTagsIncludeAll | array | 否 | 表示“同时包含以下标签”检索条件。用户可以选择多个标签,查询结果必须同时满足这些标签。如果为空,则不应用此条件。数组使用逗号分隔。 说明
当 QueryType=TAG 或 MIX 时有效。当 QueryType=TAG 时会将 QueryText 加入到该条件下。
| |
string | 否 | 标签名。 | 车道线 | |
QueryTagsIncludeAny | array | 否 | 表示“包含以下任意标签”检索条件。 用户可以选择多个标签,查询结果只需满足其中一个即可。 如果为空,则不应用此条件。数组使用逗号分隔。 说明
当 QueryType=TAG 或 MIX 时有效。
| |
string | 否 | 标签名。 | 车道线 | |
QueryTagsExclude | array | 否 | 表示“排除以下标签”检索条件。用户可以选择多个标签,查询结果中不能包含这些标签。如果为空,则不应用此条件。 说明
当 QueryType=TAG 或 MIX 时有效。
| |
string | 否 | 标签名。 | 车道线 | |
QueryFileName | string | 否 | 文件名检索条件。支持模糊检索。 | shuima |
QueryFileDir | string | 否 | 文件目录检索条件。支持模糊检索。 | cars/20250221/ |
QueryFileTypeIncludeAny | array | 否 | 表示“包含以下任意文件类型”检索条件。用户可以选择多个文件类型,查询结果只需满足其中一个即可。如果为空,则不应用此条件。数组使用逗号分隔。 | |
string | 否 | 文件类型。 | image | |
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 |
返回参数
示例
正常返回示例
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-17 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |