简介
列出数据集功能是由 数据万象(Cloud Infinite,CI)提供的,数据万象将处理能力与 COS SDK 完全结合,您可以直接按照本篇文档指引进行使用。
本文档提供关于列出数据集的相关 API 概览以及 SDK 示例代码。
注意:
API | 操作描述 |
列出数据集 |
列出数据集
功能说明
获取数据集(Dataset)列表。
方法原型
public DescribeDatasetsResponse describeDatasets(DescribeDatasetsRequest customRequest)
请求示例
DescribeDatasetsRequest request = new DescribeDatasetsRequest();request.setAppId("1234567890");//设置本次返回数据集的最大个数,取值范围为0~200。不设置此参数或者设置为0时,则默认值为100。;是否必传:否request.setMaxresults(100);//设置翻页标记。当文件总数大于设置的MaxResults时,用于翻页的Token。从NextToken开始按字典序返回文件信息列表。填写上次查询返回的值,首次使用时填写为空。;是否必传:否request.setNexttoken("下一页");//设置数据集名称前缀。;是否必传:否request.setPrefix("数据集前缀");DescribeDatasetsResponse response = client.describeDatasets(request);
参数说明
Request: 中的具体数据描述如下:
参数名称 | 描述 | 类型 | 是否必传 |
AppId | String | 是 | |
maxresults | 本次返回数据集的最大个数,取值范围为0~200。不设置此参数或者设置为0时,则默认值为100。 | Integer | 否 |
nexttoken | 翻页标记。当文件总数大于设置的 MaxResults 时,用于翻页的 Token。从 NextToken 开始按字典序返回文件信息列表。填写上次查询返回的值,首次使用时填写为空。 | String | 否 |
prefix | 数据集名称前缀。 | String | 否 |
响应参数说明:
DescribeDatasetsResponse 中的具体数据描述如下:
参数名称 | 描述 | 类型 |
requestId | 请求ID | String |
datasets | 数据集信息 | Container Array |
nextToken | 翻页标记。当任务列表总数大于设置的 MaxResults 时,用于翻页的 Token。符合条件的任务列表未全部返回时,此参数才有值。下一次列出任务列表时将此值作为 NextToken 传入,将后续的任务列表返回。 | String |
Dataset 中的具体数据描述如下:
参数名称 | 描述 | 类型 |
Region | 园区信息 | String |
templateId | 检索模板 | String |
description | 数据集描述信息 | String |
createTime | 数据集创建时间的时间戳,格式为 RFC3339Nano | String |
updateTime | 数据集修改时间的时间戳,格式为 RFC3339Nano 创建数据集后,如果未更新过数据集,则数据集修改时间的时间戳和数据集创建时间的时间戳相同 | String |
bindCount | 数据集当前绑定的 COS Bucket 数量 | Integer |
fileCount | 数据集中已建立元数据索引的文件数量,存在10分钟延迟,如需查看最新数据请使用查询数据集接口 | Integer |
totalFileSize | 数据集中已建立元数据索引的文件总大小,单位为字节,存在10分钟延迟,如需查看最新数据请使用查询数据集接口 | Integer |
datasetName | 数据集名称 | String |
返回结果说明
成功:返回 DescribeDatasetsResponse 对象响应信息。
失败:发生错误(如 Bucket 不存在),抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理。