查询数据集

最近更新时间:2024-06-03 09:53:31

我的收藏

功能描述

查询一个数据集(Dataset)信息。

授权说明

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

请求

请求示例

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

请求头

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

请求参数

参数名称
描述
类型
是否必选
datasetname
数据集名称,同一个账户下唯一。
String
statistics
该参数用于指定是否需要立即统计一次数据集中最新的文件数量、大小等数据,参数有效值:
false:不立即统计,接口返回的文件总大小、数量等数据存在10分钟的延迟。
true:立即统计,接口返回的文件总大小、数量等统计数据为实时统计的,统计实时数据需要一定时间,请耐心等待。
默认值为 false。
Boolean

请求体

该请求无请求体。

响应

响应头

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

响应体

{
"Dataset": {
"BindCount": 0,
"CreateTime": "2023-12-25 15:16:20.692674978 +0800 CST",
"DatasetName": "test",
"Description": "test",
"FileCount": 0,
"TemplateId": "Official:COSBasicMeta",
"TotalFileSize": 0,
"UpdateTime": "2023-12-25 15:16:20.692675128 +0800 CST"
},
"RequestId": "NWFjMzQ0MDZfOTBmYTUwXzZkZV8z****"
}
响应包体具体数据内容如下:
参数名称
类型
描述
RequestId
string
请求 ID。
Dataset
Container
数据集信息。
Dataset 节点内容:
参数名称
类型
描述
DatasetName
String
数据集名称。
TemplateId
String
模板 ID。
Description
String
数据集描述信息。
CreateTime
String
数据集创建时间的时间戳,格式为 RFC3339Nano。
UpdateTime
String
数据集修改时间的时间戳,格式为 RFC3339Nano。
创建数据集后,如果未更新过数据集,则数据集修改时间的时间戳和数据集创建时间的时间戳相同。
BindCount
Long
数据集当前绑定的 COS Bucket 数量。
FileCount
Long
数据集中的文件数量。
TotalFileSize
Long
数据集中的文件总大小,单位为字节。