流计算 Oceanus
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 流计算 Oceanus > API 文档 > 作业接口 > 执行Statement

执行Statement

最近更新时间：2024-03-12 01:42:38

我的收藏

本页目录：

1. 接口描述

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

通过Sql gateway执行satement

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：RunSqlGatewayStatement。
Version 是 String 公共参数，本接口取值：2019-04-22。
Region 是 String 公共参数，详见产品支持的 地域列表。
ClusterId 是 String 集群ID
示例值：cluster-lq6dtnk5
Sql 是 String 需要执行的sql，该sql会被Sql Gateway执行，当前支持的是paimon修改需求，因此主要是DDL语句
示例值：select 1
SessionId 否 String Sql Gateway会话ID，可不填，如果不填则会自动创建一个会话ID，每个会话ID都有一个存活时间，测试环境为10分钟，线上默认是30分钟
示例值：b523f113-aa32-40cc-9665-5884a1dd480d

3. 输出参数

参数名称 类型 描述
ErrorMessage Array of String 错误信息
注意：此字段可能返回 null，表示取不到有效值。
SessionId String 会话id，若入参未传，则返回自动创建的会话id，若入参已经传递，则返回值与原传入值一致
示例值：b523f113-aa32-40cc-9665-5884a1dd480d
OperationHandleId String 返回执行id，可以根据该执行id和会话id获取执行结果
示例值：操作ID
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 执行Statement

执行Statement

输入示例

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

{
    "ClusterId": "abc",
    "SessionId": "abc",
    "Sql": "abc"
}

输出示例

{
    "Response": {
        "ErrorMessage": [
            "abc"
        ],
        "SessionId": "abc",
        "OperationHandleId": "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。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.FailedOperationCode_RunSqlGateway 运行SqlGateway失败，异常
中国站