文档

DescribeOutlineBinding - 查询 Outline 绑定信息

更新时间:

根据 SQLID 查询一条 SQL 在数据库中被绑定的 Outline 信息或限流信息。

调试

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

授权信息

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

请求参数

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

租户 ID。

t2mr3oae0****
TableNamestring

租户名称。 长度为 2~20 个字符,支持英文字母、数字和下划线,区分大小写,必须以字母或下划线开头,不可设置为 sys。

pay_online
DatabaseNamestring

数据库名称。

testdb
SQLIdstring

SQLID。

8D6E84****0B8FB1823D199E2CA1****
IsConcurrentLimitboolean
  • 当值为 True 时,查询 SQLID 在数据库中的限流信息。
  • 当值为 False 时,查询 SQLID 在数据库中绑定索引或是绑定执行计划信息。
false
InstanceIdstring

OceanBase 集群 ID。

ob317v4uif****

返回参数

名称类型描述示例值
object

请求的返回结果

OutlineBindingobject

绑定信息。

BindPlanstring

绑定计划。

PHY_TABLE_SCAN | bmsql_order_line | 40 ******
OutlineIdlong

OutlineID。

-1
BindIndexstring

绑定索引。

PRIMARY
MaxConcurrentinteger

最大并发。

2
TableNamestring

表名称

RequestIdstring

请求 ID。

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C

示例

正常返回示例

JSON格式

{
  "OutlineBinding": {
    "BindPlan": "PHY_TABLE_SCAN | bmsql_order_line | 40 ******",
    "OutlineId": -1,
    "BindIndex": "PRIMARY",
    "MaxConcurrent": 2,
    "TableName": ""
  },
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C"
}

错误码

HTTP status code错误码错误信息描述
2014InternalErrorThe request processing has failed due to some unknown error.内部错误

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

变更历史

变更时间变更内容概要操作
2024-04-15OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:2014
2023-05-17OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:2014
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)