DescribeOutlineBinding - 查询 Outline 绑定信息 - 云数据库 OceanBase

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

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
oceanbase:DescribeOutlineBinding	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
TenantId	string	是	租户 ID。	t2mr3oae0****
TableName	string	是	租户名称。长度为 2~20 个字符，支持英文字母、数字和下划线，区分大小写，必须以字母或下划线开头，不可设置为 sys。	pay_online
DatabaseName	string	是	数据库名称。	testdb
SQLId	string	是	SQLID。	8D6E84**0B8FB1823D199E2CA1**
IsConcurrentLimit	boolean	否	当值为 True 时，查询 SQLID 在数据库中的限流信息。当值为 False 时，查询 SQLID 在数据库中绑定索引或是绑定执行计划信息。	false
InstanceId	string	否	OceanBase 集群 ID。	ob317v4uif****

返回参数

名称	类型	描述	示例值
	object	请求的返回结果
OutlineBinding	object	绑定信息。
BindPlan	string	绑定计划。	PHY_TABLE_SCAN \| bmsql_order_line \| 40 ******
OutlineId	long	OutlineID。	-1
BindIndex	string	绑定索引。	PRIMARY
MaxConcurrent	integer	最大并发。	2
TableName	string	表名称	cluster_info
RequestId	string	请求 ID。	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C

示例

正常返回示例

JSON格式

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

错误码

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

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

变更历史

变更时间	变更内容概要	操作
2024-04-15	OpenAPI 错误码发生变更	查看变更详情
2023-05-17	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情