1. 接口描述
接口请求域名： tione.tencentcloudapi.com 。
查询结构化数据集详情
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDatasetDetailStructured。 |
| Version | 是 | String | 公共参数，本接口取值：2021-11-11。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| DatasetId | 是 | String | 数据集ID 示例值：rodftv7u3gg |
| Offset | 否 | Integer | 偏移值 示例值：0 |
| Limit | 否 | Integer | 返回数据条数，默认20，目前最大支持2000条数据 示例值：100 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 数据总数 注意：此字段可能返回 null，表示取不到有效值。 示例值：120 |
| ColumnNames | Array of String | 表格头信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：['name'] |
| RowItems | Array of RowItem | 表格内容 注意：此字段可能返回 null，表示取不到有效值。 示例值：['name'] |
| RowTexts | Array of String | 文本内容 注意：此字段可能返回 null，表示取不到有效值。 示例值：['name'] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询结构化数据集详情
输入示例
POST / HTTP/1.1
Host: tione.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDatasetDetailStructured
<公共请求参数>
{
"DatasetId": "ds-lpjvdzlj",
"Offset": 0,
"Limit": 10
}输出示例
{
"Response": {
"TotalCount": 36,
"ColumnNames": [
"RowId",
"Uuid",
"f_bool_1",
"f_bool_2",
"f_n_0",
"f_int_0"
],
"RowItems": [
{
"Values": [
{
"Name": "RowId",
"Value": "1"
},
{
"Name": "Uuid",
"Value": "35dvp3ziv2ww"
},
{
"Name": "f_bool_1",
"Value": "True"
},
{
"Name": "f_bool_2",
"Value": "False"
},
{
"Name": "f_n_0",
"Value": "59"
},
{
"Name": "f_int_0",
"Value": "1"
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
}
]
},
{
"Values": [
{
"Name": "RowId",
"Value": "2"
},
{
"Name": "Uuid",
"Value": "35dvp3ziv2wx"
},
{
"Name": "f_bool_1",
"Value": "True"
},
{
"Name": "f_bool_2",
"Value": "True"
},
{
"Name": "f_n_0",
"Value": "89"
},
{
"Name": "f_int_0",
"Value": "2"
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
}
]
},
{
"Values": [
{
"Name": "RowId",
"Value": "3"
},
{
"Name": "Uuid",
"Value": "35dvp3ziv2wy"
},
{
"Name": "f_bool_1",
"Value": "False"
},
{
"Name": "f_bool_2",
"Value": "True"
},
{
"Name": "f_n_0",
"Value": "28"
},
{
"Name": "f_int_0",
"Value": "3"
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
}
]
},
{
"Values": [
{
"Name": "RowId",
"Value": "4"
},
{
"Name": "Uuid",
"Value": "35dvp3ziv2wz"
},
{
"Name": "f_bool_1",
"Value": "True"
},
{
"Name": "f_bool_2",
"Value": "True"
},
{
"Name": "f_n_0",
"Value": "8"
},
{
"Name": "f_int_0",
"Value": "7"
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
}
]
},
{
"Values": [
{
"Name": "RowId",
"Value": "5"
},
{
"Name": "Uuid",
"Value": "35dvp3ziv2x0"
},
{
"Name": "f_bool_1",
"Value": "False"
},
{
"Name": "f_bool_2",
"Value": "True"
},
{
"Name": "f_n_0",
"Value": "90"
},
{
"Name": "f_int_0",
"Value": "4"
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
}
]
},
{
"Values": [
{
"Name": "RowId",
"Value": "6"
},
{
"Name": "Uuid",
"Value": "35dvp3ziv2x1"
},
{
"Name": "f_bool_1",
"Value": "False"
},
{
"Name": "f_bool_2",
"Value": "False"
},
{
"Name": "f_n_0",
"Value": "21"
},
{
"Name": "f_int_0",
"Value": "9"
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
}
]
},
{
"Values": [
{
"Name": "RowId",
"Value": "7"
},
{
"Name": "Uuid",
"Value": "35dvp3ziv2x2"
},
{
"Name": "f_bool_1",
"Value": "False"
},
{
"Name": "f_bool_2",
"Value": "False"
},
{
"Name": "f_n_0",
"Value": "10"
},
{
"Name": "f_int_0",
"Value": "5"
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
}
]
},
{
"Values": [
{
"Name": "RowId",
"Value": "8"
},
{
"Name": "Uuid",
"Value": "35dvp3ziv2x3"
},
{
"Name": "f_bool_1",
"Value": "True"
},
{
"Name": "f_bool_2",
"Value": "True"
},
{
"Name": "f_n_0",
"Value": "76"
},
{
"Name": "f_int_0",
"Value": "2"
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
}
]
},
{
"Values": [
{
"Name": "RowId",
"Value": "9"
},
{
"Name": "Uuid",
"Value": "35dvp3ziv2x4"
},
{
"Name": "f_bool_1",
"Value": "True"
},
{
"Name": "f_bool_2",
"Value": "False"
},
{
"Name": "f_n_0",
"Value": "53"
},
{
"Name": "f_int_0",
"Value": "2"
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
}
]
},
{
"Values": [
{
"Name": "RowId",
"Value": "10"
},
{
"Name": "Uuid",
"Value": "35dvp3ziv2x5"
},
{
"Name": "f_bool_1",
"Value": "False"
},
{
"Name": "f_bool_2",
"Value": "False"
},
{
"Name": "f_n_0",
"Value": "78"
},
{
"Name": "f_int_0",
"Value": "3"
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
},
{
"Name": "",
"Value": ""
}
]
}
],
"RowTexts": [],
"RequestId": "afb0bc4c-5cd0-480b-bde3-5fce48158ad7"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
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 | 数据库查询错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.DCAnnotationType | 不支持的标注类型。 |
| InvalidParameterValue.DCCosPathInfo | 存储桶参数错误。 |
| InvalidParameterValue.DCDatasetAnnotationNotMatch | 数据集标注状态不匹配。 |
| InvalidParameterValue.DCDatasetIdNotExist | 数据集Id不存在。 |
| InvalidParameterValue.DCDatasetNameExist | 数据集重名已存在。 |
| InvalidParameterValue.DCDatasetType | 不支持的数据集类型。 |
| InvalidParameterValue.DCFilterValues | 不支持的过滤参数。 |
| MissingParameter | 缺少参数错误。 |