1. 接口描述
接口请求域名: dlc.tencentcloudapi.com 。
查询任务结果,仅支持30天以内的任务查询结果,且返回数据大小超过近50M会进行截断。
默认接口请求频率限制:40次/秒。
此接口支持如下压缩格式返回:gzip
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeTaskResult。 |
Version | 是 | String | 公共参数,本接口取值:2021-01-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-nanjing, ap-shanghai, ap-shanghai-fsi, ap-singapore, eu-frankfurt, na-ashburn, na-siliconvalley 。 |
TaskId | 是 | String | 任务唯一ID,仅支持30天内的任务 示例值:fdd9c5fa21ca11eca6fb5254006c64af |
NextToken | 否 | String | 上一次请求响应返回的分页信息。第一次可以不带,从头开始返回数据,每次返回MaxResults字段设置的数据量。 示例值:nextMarker=\u0026nextKey=test/DLCQueryResults/2021/10/15/2c60388 |
MaxResults | 否 | Integer | 返回结果的最大行数,范围0~1000,默认为1000. 示例值:500 |
IsTransformDataType | 否 | Boolean | 是否转化数据类型 示例值:false |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskInfo | TaskResultInfo | 查询的任务信息,返回为空表示输入任务ID对应的任务不存在。只有当任务状态为成功(2)的时候,才会返回任务的结果。 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询任务结果
查询任务结果,每次返回1000行数据
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTaskResult
<公共请求参数>
{
"TaskId": "9e20f9c021cb11ec835f5254006c64af",
"NextToken": ""
}
输出示例
{
"Response": {
"RequestId": "9328049f-30bc-4feb-aecf-e3b4ff2d1b00",
"TaskInfo": {
"TaskId": "9e20f9c021cb11ec835f5254006c64af",
"DatasourceConnectionName": "CosDataCatalog",
"DatabaseName": "auth_test",
"SQL": "SELECT * FROM `auth_test`.`hive_test` LIMIT 10",
"SQLType": "DQL",
"State": 2,
"DataAmount": 850363,
"UsedTime": 1761,
"TotalTime": 2000,
"OutputPath": "cosn://dlc-nj-1258469122/test/DLCQueryResults/2021/09/30/9e20f9c021cb11ec835f5254006c64af/",
"CreateTime": "1632991895728",
"OutputMessage": "success",
"RowAffectInfo": "59378 rows affected (1.761000 seconds)",
"ResultSchema": [
{
"Name": "a",
"Type": "integer",
"Comment": "",
"Precision": 0,
"Scale": 0,
"Nullable": "NULLABLE",
"Position": 0,
"CreateTime": "abc",
"ModifiedTime": "abc",
"IsPartition": true
},
{
"Name": "b",
"Type": "varchar",
"Comment": "",
"Precision": 0,
"Scale": 0,
"Nullable": "NULLABLE",
"Position": 0,
"CreateTime": "abc",
"ModifiedTime": "abc",
"IsPartition": true
}
],
"ResultSet": "[[\"3\",\"kk\"],[\"3\",\"kk\"],[\"9143\",\" \\\"28992\\\"\"],[\"19048\",\" \\\"11266\\\"\"],[\"16711\",\" \\\"17422\\\"\"],[\"3816\",\" \\\"18501\\\"\"],[\"16428\",\" \\\"13774\\\"\"],[\"30190\",\" \\\"5177\\\"\"],[\"24824\",\" \\\"19479\\\"\"],[\"9709\",\" \\\"5532\\\"\"]]",
"NextToken": "",
"Percentage": 100,
"ProgressDetail": "[{\"jobId\":\"0\",\"stages\":[{\"stageId\":\"0\",\"schedule\":1},{\"stageId\":\"1\",\"schedule\":1},{\"stageId\":\"2\",\"schedule\":1},{\"stageId\":\"3\",\"schedule\":1}],\"jobState\":\"\"}]",
"DisplayFormat": "table"
}
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.HttpClientDoRequestFailed | HTTP客户端请求失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.InvalidMaxResults | 无效的最大结果数。 |
InvalidParameter.InvalidSQLTaskMaxResults | 单次获取SQL任务结果数量需大于0条,小于1000条 |
InvalidParameter.InvalidTaskId | 无效的taskid。 |
InvalidParameter.MaxResultOnlySupportHundred | 您当前仅允许查看100条结果数据,若需调整,请与我们联系 |