发起 Outline 绑定任务。
接口说明
任务绑定采用异步执行机制，您可通过 DescribeOutlineBinding 接口查询绑定结果。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
实例 ID |
ob317v4uif**** |
| TenantId |
string |
是 |
租户 ID |
ob2mr3oae0**** |
| SqlText |
string |
是 |
SQL 文本 |
SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC |
| DatabaseName |
string |
是 |
数据库名 |
test_data |
| TableName |
string |
否 |
表名 |
test_1 |
| SqlId |
string |
否 |
SQL ID |
8D6E84****0B8FB1823D199E2CA1**** |
| IsConcurrentLimit |
boolean |
否 |
是否为限流 |
true |
| DynamicSql |
boolean |
否 |
是否为动态 SQL |
false |
| UId |
string |
否 |
OceanBase 数据库用户标识符 |
139************* |
| PlanData |
string |
否 |
执行计划 |
******** |
| IndexName |
string |
否 |
索引名 |
idx_a |
| MaxConcurrent |
integer |
否 |
限流数值 |
2 |
| StartTime |
string |
否 |
开始时间 |
2025-05-13T15:40:43Z |
| EndTime |
string |
否 |
结束时间 |
2025-05-13T16:40:43Z |
| StatementId |
string |
否 |
SQL 模版 ID |
******** |
| BySqlId |
boolean |
否 |
判断是通过 SQLID/SQLText 绑定，默认为 true |
true |
发起限流：IsConcurrentLimit 和 MaxConcurrent 不能为空
绑定索引：TableName 和 IndexName 不能为空
绑定执行计划：PlanData 不能为空
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C |
| Success |
boolean |
是否调用成功。 |
true |
| Message |
string |
错误描述。 |
successful |
示例
正常返回示例
JSON格式
{
"RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
"Success": true,
"Message": "successful"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。