一、功能描述
获取数据集(Dataset)列表。
二、使用限制
使用该接口时,请先确认相关限制条件。详情请参见 使用限制。
三、请求示例
GET /datasets?maxresults=2&prefix=test&nexttoken=xxxx HTTP/1.1Host: <AppId>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: Auth StringAccept: 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 | 数据集信息。同创建数据集接口中响应体的 Dataset | Container Array |
| NextToken | 翻页标记。当任务列表总数大于设置的 MaxResults 时,用于翻页的 Token。符合条件的任务列表未全部返回时,此参数才有值。下一次列出任务列表时将此值作为 NextToken 传入,将后续的任务列表返回。 | String |
| RequestId | 请求 ID。 | String |