CreateOasOutlineTask - 发起 Outline 绑定任务

发起 Outline 绑定任务。

接口说明

任务绑定采用异步执行机制,您可通过 DescribeOutlineBinding 接口查询绑定结果。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID

ob317v4uif****
TenantIdstring

租户 ID

ob2mr3oae0****
SqlTextstring

SQL 文本

SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC
DatabaseNamestring

数据库名

test_data
TableNamestring

表名

test_1
SqlIdstring

SQL ID

8D6E84****0B8FB1823D199E2CA1****
IsConcurrentLimitboolean

是否为限流

true
DynamicSqlboolean

是否为动态 SQL

false
UIdstring

OceanBase 数据库用户标识符

139*************
PlanDatastring

执行计划

********
IndexNamestring

索引名

idx_a
MaxConcurrentinteger

限流数值

2
StartTimestring

开始时间

2025-05-13T15:40:43Z
EndTimestring

结束时间

2025-05-13T16:40:43Z
StatementIdstring

SQL 模版 ID

********
BySqlIdboolean

判断是通过 SQLID/SQLText 绑定,默认为 true

true
  • 发起限流:IsConcurrentLimit 和 MaxConcurrent 不能为空
  • 绑定索引:TableName 和 IndexName 不能为空
  • 绑定执行计划:PlanData 不能为空

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
Successboolean

是否调用成功。

true
Messagestring

错误描述。

successful

示例

正常返回示例

JSON格式

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "Success": true,
  "Message": "successful"
}

错误码

访问错误中心查看更多错误码。