DescribeOutlineBinding - 查詢 Outline 綁定資訊 - ApsaraDB for OceanBase (Deprecated)

根據 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****
DynamicSql	boolean	否	是否模版 sql
FormatSqlId	string	否	format sqlId

返回參數

名稱	類型	描述	樣本值
	object	請求的返回結果
OutlineBinding	object	綁定資訊。
BindPlan	string	綁定計劃。	PHY_TABLE_SCAN \| bmsql_order_line \| 40 ******
OutlineId	integer	OutlineID。	-1
BindIndex	string	綁定索引。	PRIMARY
MaxConcurrent	integer	最大並發。	2
TableName	string	表名稱	cluster_info
SqlText	string	限流的文本
SqlTextConcurrentNum	integer	限流的數值
ByFormatSqlId	boolean	是否為模糊綁定
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",
    "SqlText": "",
    "SqlTextConcurrentNum": 0,
    "ByFormatSqlId": true
  },
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
2014	InternalError	The request processing has failed due to some unknown error.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。