调用 ListDatasets 接口列出指定 Bucket 下所有 Dataset 的基础信息。支持按名称前缀过滤与分页。
注意事项
阿里云账号默认拥有列出 Dataset 的权限。如需通过 RAM 用户调用,请确保 RAM 用户拥有
oss:MetaQuery权限。调用本接口前,Bucket 必须已通过 OpenMetaQuery 开启元数据管理。
单次最多返回 200 条,默认 100 条。多于此数需通过
nextToken翻页获取。列表项返回 Dataset 的所有字段,包括
DatasetConfig、兼容旧版本的WorkflowParameters、DatasetMaxFileCount等。详细字段见 Dataset 数据结构。
请求语法
POST /?metaQuery&action=listDatasets HTTP/1.1
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue请求头
此接口仅涉及公共请求头。更多信息,请参见公共请求头(Common Request Headers)。
请求元素
名称 | 类型 | 是否必选 | 示例值 | 描述 |
prefix | 字符串 | 否 | photos- | 按 Dataset 名称前缀过滤。包含非 ASCII 字符时需 URL 编码。 |
maxResults | 整型 | 否 | 50 | 单次返回的 Dataset 数量上限。取值范围 1 到 200。默认 100。 |
nextToken | 字符串 | 否 | MTIzNDU2 | 分页令牌。首次调用不传;后续调用使用上次响应中的 |
响应头
此接口仅涉及公共响应头。更多信息,请参见公共响应头(Common Response Headers)。
响应元素
名称 | 类型 | 是否必选 | 示例值 | 描述 |
ListDatasetsResponse | 容器 | 是 | 不涉及 | 接口响应的根容器。 子节点:Datasets、NextToken |
Datasets | 容器 | 是 | 不涉及 | Dataset 列表的容器。 子节点:Dataset 父节点:ListDatasetsResponse |
Dataset | 容器 | 否 | 不涉及 | 单个 Dataset 的完整信息。详细字段见 Dataset 数据结构。 父节点:Datasets |
NextToken | 字符串 | 否 | MTIzNDU2 | 下一页分页令牌。无更多结果时不返回或为空。 父节点:ListDatasetsResponse |
示例
请求示例
首次拉取列表:
POST /?metaQuery&action=listDatasets&maxResults=50 HTTP/1.1
Host: examplebucket.oss-cn-hangzhou.aliyuncs.com
Date: Wed, 20 May 2026 09:00:00 GMT
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20260520/cn-hangzhou/oss/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e翻页拉取:
POST /?metaQuery&action=listDatasets&maxResults=50&nextToken=MTIzNDU2 HTTP/1.1
Host: examplebucket.oss-cn-hangzhou.aliyuncs.com
Date: Wed, 20 May 2026 09:00:10 GMT
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20260520/cn-hangzhou/oss/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e返回示例
HTTP/1.1 200 OK
x-oss-request-id: 64C8B6F4E7C5A3A8B9D6E7F5
Date: Wed, 20 May 2026 09:00:01 GMT
Content-Type: application/xml
Server: AliyunOSS
<?xml version="1.0" encoding="UTF-8"?>
<ListDatasetsResponse>
<Datasets>
<Dataset>
<DatasetName>photos-default</DatasetName>
<Description></Description>
<CreateTime>2026-05-20T08:00:00.000+08:00</CreateTime>
<UpdateTime>2026-05-20T08:00:00.000+08:00</UpdateTime>
<DatasetMaxFileCount>100000000</DatasetMaxFileCount>
<DatasetMaxEntityCount>10000000000</DatasetMaxEntityCount>
<DatasetMaxRelationCount>100000000000</DatasetMaxRelationCount>
<DatasetMaxTotalFileSize>90000000000000000</DatasetMaxTotalFileSize>
</Dataset>
<Dataset>
<DatasetName>photos-2026</DatasetName>
<Description>2026 年图库</Description>
<CreateTime>2026-05-20T08:30:00.000+08:00</CreateTime>
<UpdateTime>2026-05-20T08:30:00.000+08:00</UpdateTime>
<DatasetMaxFileCount>100000000</DatasetMaxFileCount>
<DatasetMaxEntityCount>10000000000</DatasetMaxEntityCount>
<DatasetMaxRelationCount>100000000000</DatasetMaxRelationCount>
<DatasetMaxTotalFileSize>90000000000000000</DatasetMaxTotalFileSize>
<DatasetConfig>
<Insights>
<Language>zh-Hans</Language>
<Video>
<Caption>
<Enable>True</Enable>
</Caption>
</Video>
</Insights>
</DatasetConfig>
</Dataset>
</Datasets>
<NextToken>MTIzNDU2</NextToken>
</ListDatasetsResponse>