GetDataset-阿里云帮助中心

Retrieves detailed information about a specified Dataset, including its creation time, DatasetConfig, and other configurations like the backward-compatible WorkflowParameters. You can also include the total file count and total file size in the response by setting withStatistics=true.

Usage notes

An Alibaba Cloud account can query a Dataset by default. A RAM user requires the oss:MetaQuery permission to perform this query.
Before calling this API, metadata management must be enabled for the bucket by calling OpenMetaQuery.
If the specified Dataset does not exist, the API returns a DatasetNotExist error with an HTTP 404 status code.
Setting withStatistics=true triggers an additional query to count files, which slightly increases response latency. If you do not need these statistics, keep the default value (false) to minimize latency.

Request syntax

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

Request headers

This operation uses only common request headers. For more information, see Common Request Headers.

Request elements

Parameter

Type

Required

Example

Description

datasetName

String

Yes

photos-2026

The name of the Dataset to query.

withStatistics

Boolean

true

Specifies whether to include file statistics for the Dataset in the response. Valid values:

true: The response includes the FileCount and TotalFileSize elements.
false (default): The response includes only the Dataset configuration information.

Response headers

This operation uses only common response headers. For more information, see Common Response Headers.

Response elements

Parameter

Type

Required

Example

Description

GetDatasetResponse

container

Yes

N/A

The root container for the API response.

child node: Dataset

Dataset

container

Yes

N/A

The container for the complete information about the Dataset. For more information about the fields, see Dataset data structure.

parent node: GetDatasetResponse

Examples

Request example

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

Response example

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>Photo gallery for 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>