列出数据集

最近更新时间:2024-06-12 17:46:52

我的收藏

功能描述

获取数据集(Dataset)列表。

授权说明

授权策略中 action 设置为 ci:DescribeDatasets 。查看所有 action

请求

请求示例

GET /datasets?maxresults=2&prefix=test&nexttoken=xxxx HTTP/1.1
Host: <AppId>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: Auth String
Accept: application/json
说明:
Authorization: Auth String(详情请参见 请求签名 文档)。
通过子账号使用时,需要授予相关的权限,详情请参见 授权粒度详情 文档。

请求头

此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。

请求参数

参数名称
描述
类型
是否必选
maxresults
本次返回数据集的最大个数,取值范围为0~200。不设置此参数或者设置为0时,则默认值为100。
Long
nexttoken
翻页标记。当文件总数大于设置的 MaxResults 时,用于翻页的 Token。从 NextToken 开始按字典序返回文件信息列表。填写上次查询返回的值,首次使用时填写为空。
String
prefix
数据集名称前缀。
String

请求体

该请求无请求体。

响应

响应头

此接口仅返回公共响应头部,详情请参见 公共响应头部 文档。

响应体

{
"Datasets": [{
"BindCount": 0,
"CreateTime": "2023-12-25 15:12:27.139749816 +0800 CST",
"DatasetName": "test001",
"Description": "test001",
"FileCount": 0,
"TemplateId": "Official:DefaultEmptyId",
"TotalFileSize": 0,
"UpdateTime": "2023-12-25 15:12:27.139749953 +0800 CST"
}, {
"BindCount": 0,
"CreateTime": "2023-12-25 15:07:00.331922722 +0800 CST",
"DatasetName": "test002",
"Description": "test002",
"FileCount": 0,
"TemplateId": "Official:COSBasicMeta",
"TotalFileSize": 0,
"UpdateTime": "2023-12-25 15:41:41.978447866 +0800 CST"
}],
"NextToken": "2:1251668577:test",
"RequestId": "NWFjMzQ0MDZfOTBmYTUwXzZkZV8z****"

}
响应包体具体数据内容如下:
参数名称
类型
描述
Datasets
Container Array
数据集信息。
NextToken
String
翻页标记。当任务列表总数大于设置的 MaxResults 时,用于翻页的 Token。符合条件的任务列表未全部返回时,此参数才有值。下一次列出任务列表时将此值作为 NextToken 传入,将后续的任务列表返回。
RequestId
String
请求 ID。
Datasets 节点内容:
参数名称
类型
描述
BindCount
Long
数据集当前绑定的 COS 存储桶数量。
CreateTime
String
数据集创建时间的时间戳,格式为 RFC3339Nano。
DatasetName
String
数据集名称。
Description
String
数据集描述信息。
FileCount
Long
数据集中已建立元数据索引的文件数量,存在10分钟延迟,如需查看最新数据请使用查询数据集接口。
TemplateId
String
检索模板。
TotalFileSize
Long
数据集中已建立元数据索引的文件总大小,单位为字节,存在10分钟延迟,如需查看最新数据请使用查询数据集接口。
UpdateTime
String
数据集修改时间的时间戳,格式为 RFC3339Nano。
创建数据集后,如果未更新过数据集,则数据集修改时间的时间戳和数据集创建时间的时间戳相同。