GetDataset-对象存储(OSS)-阿里云帮助中心

调用 GetDataset 接口查询指定 Dataset 的详细信息,包括创建时间、DatasetConfig、兼容旧版本的 WorkflowParameters 等配置。可通过 withStatistics=true 额外返回文件总数与总字节数统计。

注意事项

阿里云账号默认拥有查询 Dataset 的权限。如需通过 RAM 用户查询,请确保 RAM 用户拥有 oss:MetaQuery 权限。
调用本接口前,Bucket 必须已通过 OpenMetaQuery 开启元数据管理。
指定 Dataset 不存在时,接口返回 DatasetNotExist(HTTP 404)。
withStatistics=true 会额外触发一次计数查询,响应延迟略高;不需要统计字段时建议保持默认 false。

请求语法

POST /?metaQuery&action=getDataset&datasetName=DatasetName HTTP/1.1
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue

请求头

此接口仅涉及公共请求头。更多信息,请参见公共请求头(Common Request Headers)。

请求元素

名称

类型

是否必选

示例值

描述

datasetName

字符串

是

photos-2026

待查询的 Dataset 名称。

withStatistics

布尔值

否

true

是否在响应中包含 Dataset 文件统计信息。取值如下:

true：响应额外包含 FileCount 与 TotalFileSize
false（默认）：仅返回 Dataset 配置信息

响应头

此接口仅涉及公共响应头。更多信息,请参见公共响应头(Common Response Headers)。

响应元素

名称

类型

是否必选

示例值

描述

GetDatasetResponse

容器

是

不涉及

接口响应的根容器。

子节点:Dataset

Dataset

容器

是

不涉及

Dataset 完整信息。详细字段见 Dataset 数据结构。

父节点:GetDatasetResponse

示例

请求示例

POST /?metaQuery&action=getDataset&datasetName=photos-2026&withStatistics=true HTTP/1.1
Host: examplebucket.oss-cn-hangzhou.aliyuncs.com
Date: Wed, 20 May 2026 08:30:00 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: 64C8B6F4E7C5A3A8B9D6E7F2
Date: Wed, 20 May 2026 08:30:01 GMT
Content-Type: application/xml
Server: AliyunOSS

<?xml version="1.0" encoding="UTF-8"?>
<GetDatasetResponse>
  <Dataset>
    <DatasetName>photos-2026</DatasetName>
    <Description>2026 年图库</Description>
    <CreateTime>2026-05-20T08:00: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>en</Language>
        <Image>
          <Caption>
            <Enable>True</Enable>
          </Caption>
        </Image>
      </Insights>
    </DatasetConfig>
    <FileCount>3456</FileCount>
    <TotalFileSize>10737418240</TotalFileSize>
  </Dataset>
</GetDatasetResponse>