1. 接口描述
接口请求域名: dlc.tencentcloudapi.com 。
本接口(DescribeNotebookSessionStatementSqlResult)用于获取statement运行结果。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeNotebookSessionStatementSqlResult。 |
Version | 是 | String | 公共参数,本接口取值:2021-01-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
TaskId | 是 | String | 任务唯一ID 示例值:fdd9c5fa21ca11eca6fb5254006c64af |
MaxResults | 否 | Integer | 返回结果的最大行数,范围0~1000,默认为1000. 示例值:1000 |
NextToken | 否 | String | 上一次请求响应返回的分页信息。第一次可以不带,从头开始返回数据,每次返回MaxResults字段设置的数据量。 示例值:nextMarker=\u0026nextKey=test/DLCQueryResults/2021/10/15/2c60388 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 任务Id 示例值:20210521195919442157 |
ResultSet | String | 结果数据 示例值:[["allen","27"],["tim","20"]] |
ResultSchema | Array of Column | schema 示例值:{"query_id":"q202108191952hzb9d11f040173825","columns":[{"c_cust |
NextToken | String | 分页信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:objectListMarker={marker}&lastReadFile={filename}&lastReadOffset |
OutputPath | String | 存储结果地址 注意:此字段可能返回 null,表示取不到有效值。 示例值:cosn://xxx |
UseTime | Integer | 引擎计算耗时 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
AffectRows | Integer | 结果条数 注意:此字段可能返回 null,表示取不到有效值。 示例值:100 |
DataAmount | Integer | 数据扫描量 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取statement运行结果
本接口用于获取statement运行结果。
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNotebookSessionStatementSqlResult
<公共请求参数>
{
"TaskId": "20210521195919442157",
"MaxResults": 100,
"NextToken": "objectListMarker={marker}&lastReadFile={filename}&lastReadOffset"
}
输出示例
{
"Response": {
"TaskId": "abc",
"ResultSet": "abc",
"ResultSchema": [
{
"Name": "abc",
"Type": "abc",
"Comment": "abc",
"Precision": 0,
"Scale": 0,
"Nullable": "abc",
"Position": 0,
"CreateTime": "abc",
"ModifiedTime": "abc",
"IsPartition": true
}
],
"NextToken": "abc",
"OutputPath": "abc",
"RequestId": "abc",
"UseTime": 10,
"AffectRows": 10
}
}
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 | 操作失败。 |
InternalError | 内部错误。 |
InternalError.InternalSystemException | 业务系统异常,请重试或提工单联系我们。 |
InvalidParameter | 参数错误。 |
InvalidParameter.InvalidMaxResults | 无效的最大结果数。 |
InvalidParameter.ParameterBase64DecodeFailed | 指定参数Base64解析失败 |
InvalidParameter.ParameterNotFoundOrBeNone | 找不到参数或参数为空 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.SessionNotFound | session不存在。 |
ResourceNotFound.SessionStateDead | session已消亡。 |