流计算 Oceanus 查询Statement执行结果-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： oceanus.tencentcloudapi.com 。

查询Sql Gateway的Statement执行结果

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：FetchSqlGatewayStatementResult。
Version	是	String	公共参数，本接口取值：2019-04-22。
Region	是	String	公共参数，详见产品支持的地域列表。
ClusterId	是	String	集群ID 示例值：cluster-lq6dtnk5
SessionId	否	String	Sql Gateway会话ID 示例值：b523f113-aa32-40cc-9665-5884a1dd480d
OperationHandleId	否	String	sql的查询id 示例值：f613c399-e1c7-4ab9-a07f-ee08a782b546
ResultUri	否	String	下一条结果的获取url，首次获取执行结果时可以为空，当获取下一批查询结果时需要传递示例值：/v1/sessions/b523f113-aa32-40cc-9665-5884a1dd480d/operations/f613c399-e1c7-4ab9-a07f-ee08a782b546/result/1

3. 输出参数

参数名称	类型	描述
ErrorMessage	Array of String	错误信息注意：此字段可能返回 null，表示取不到有效值。
ResultType	String	返回类型注意：此字段可能返回 null，表示取不到有效值。示例值：PAYLOAD
IsQueryResult	Boolean	是否DQL结果注意：此字段可能返回 null，表示取不到有效值。示例值：false
ResultKind	String	结果类型注意：此字段可能返回 null，表示取不到有效值。示例值：SUCCESS
Results	StatementResult	结果注意：此字段可能返回 null，表示取不到有效值。
NextResultUri	String	下一次请求的uri 注意：此字段可能返回 null，表示取不到有效值。示例值：/v1/sessions/1c7a1105-4759-46d4-b35f-3a21f7a7cf8d/operations/a675de79-58c7-44cf-910f-bdae095041bf/result/1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询Statement执行结果

查询Statement执行结果

输入示例

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

{
    "ClusterId": "abc",
    "SessionId": "abc",
    "OperationHandleId": "abc",
    "ResultUri": "abc"
}

输出示例

{
    "Response": {
        "ErrorMessage": [
            "abc"
        ],
        "ResultType": "abc",
        "IsQueryResult": true,
        "ResultKind": "abc",
        "Results": {
            "Columns": [
                {
                    "Name": "abc",
                    "LogicalType": {
                        "Type": "abc",
                        "NullAble": true,
                        "Length": 0
                    },
                    "Comment": "abc"
                }
            ],
            "RowFormat": "abc",
            "Data": [
                {
                    "Kind": "abc",
                    "Fields": [
                        "abc"
                    ]
                }
            ]
        },
        "NextResultUri": "abc",
        "RequestId": "abc"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.FailedOperationCode_FetchSqlGatewayStatement	获取SqlGateway结果失败，异常