有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

接口请求域名: tione.tencentcloudapi.com 。

查询数据集列表

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDatasets。
Version String 公共参数,本接口取值:2021-11-11。
Region String 公共参数,详见产品支持的 地域列表
DatasetIds.N Array of String 数据集id列表
示例值:['dataset_id_1']
Filters.N Array of Filter 数据集查询过滤条件,多个Filter之间的关系为逻辑与(AND)关系,过滤字段Filter.Name,类型为String
DatasetName,数据集名称
DatasetScope,数据集范围,SCOPE_DATASET_PRIVATE或SCOPE_DATASET_PUBLIC
TagFilters.N Array of TagFilter 标签过滤条件
Order String 排序值,支持Asc或Desc,默认Desc
示例值:Desc
OrderField String 排序字段,支持CreateTime或UpdateTime,默认CreateTime
示例值:CreateTime
Offset Integer 偏移值
示例值:0
Limit Integer 返回数据个数,默认20,最大支持200
示例值:100

3. 输出参数

参数名称 类型 描述
TotalCount Integer 数据集总量(名称维度)
注意:此字段可能返回 null,表示取不到有效值。
示例值:23
DatasetGroups Array of DatasetGroup 数据集按照数据集名称聚合的分组
注意:此字段可能返回 null,表示取不到有效值。
DatasetIdNums Integer 数据集ID总量
注意:此字段可能返回 null,表示取不到有效值。
示例值:100
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询数据集列表

输入示例

POST / HTTP/1.1
Host: tione.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDatasets
<公共请求参数>

{
    "DatasetIds": [
        "ds-c4lbz9gg"
    ]
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "DatasetIdNums": 1,
        "DatasetGroups": [
            {
                "DatasetId": "ds-c4lbz9gg",
                "DatasetName": "test",
                "Creator": "100007955047",
                "DatasetVersion": "v1",
                "DatasetType": "TYPE_DATASET_TEXT",
                "DatasetTags": [],
                "DatasetAnnotationTaskName": "",
                "DatasetAnnotationTaskId": "",
                "Process": 100,
                "DatasetStatus": "STATUS_DATASET_SUCCESS",
                "ErrorMsg": "",
                "CreateTime": "2022-01-15 15:01:57",
                "UpdateTime": "2022-01-15 15:01:57",
                "ExternalTaskType": "",
                "DatasetSize": "11.06 M",
                "FileNum": 4,
                "StorageDataPath": {
                    "Bucket": "test-gz-1256580188",
                    "Region": "ap-guangzhou",
                    "Paths": [
                        "train-dataset/"
                    ]
                },
                "StorageLabelPath": {
                    "Bucket": "test-gz-1256580188",
                    "Region": "ap-guangzhou",
                    "Paths": [
                        "train-output/"
                    ]
                },
                "AnnotationStatus": "STATUS_NON_ANNOTATED",
                "AnnotationType": "",
                "AnnotationFormat": "",
                "DatasetVersions": []
            }
        ],
        "RequestId": "f015eab9-1feb-4b1d-8ea0-85fff5b4ddc7"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure.CamException CAM系统异常。
AuthFailure.UnauthorizedOperation 未授权操作。
FailedOperation.DCCosClientErr cos client 内部错误。
FailedOperation.DCCreateAsyncTaskError 创建内部异步任务失败。
FailedOperation.DCCreateUserCosClientErr 创建cos client 失败。
FailedOperation.DCDataAnnotationRpcErr 数据标注 rpc 内部错误。
FailedOperation.DCDatarepoRpcErr 数据仓库 rpc 内部错误。
FailedOperation.DCDatasetExceedLimit 数据集操作超过上限。
FailedOperation.DCDatasetStatusNotReady 数据集状态未恢复。
FailedOperation.DCGetUserTemporarySecretErr 获取用户临时秘钥失败。
FailedOperation.DCMarshalDataErr 数据序列化错误。
FailedOperation.DCQueryDatasetContentErr 数据集获取文件内容异常。
FailedOperation.DCUnmarshalDataErr 数据反序列化错误。
FailedOperation.DCUnsupportedOperation 数据集操作不支持。
FailedOperation.ExecDatabaseFail 数据库执行错误。
FailedOperation.ExecTagFail 标签操作失败。
FailedOperation.QueryDatabaseFail 数据库查询错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.DCAnnotationType 不支持的标注类型。
InvalidParameterValue.DCCosPathInfo 存储桶参数错误。
InvalidParameterValue.DCDatasetAnnotationNotMatch 数据集标注状态不匹配。
InvalidParameterValue.DCDatasetIdNotExist 数据集Id不存在。
InvalidParameterValue.DCDatasetNameExist 数据集重名已存在。
InvalidParameterValue.DCDatasetType 不支持的数据集类型。
InvalidParameterValue.DCFilterValues 不支持的过滤参数。
MissingParameter 缺少参数错误。