使用SearchTable API搜尋表詳情-Data Management-阿里雲

搜尋表詳情列表。

介面說明

僅管控模式為安全協同的資料庫執行個體可調用此 API。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:SearchTable

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Tid	integer	否	租戶 ID。說明取自系統右上方頭像處懸停展示的租戶 ID 資訊，詳情請參見查看租戶資訊。	1
SearchKey	string	否	搜尋表名稱的關鍵字。	test
PageNumber	integer	否	第幾頁。	1
PageSize	integer	否	每頁記錄數。	10
EnvType	string	否	資料庫的環境類型，更多資訊，請參見執行個體環境說明。	PRODUCT
SearchRange	string	否	許可權範圍，取值和說明： HAS_PERMSSION：有許可權的 OWNER：我 Owner 的 MY_FOCUS：我關注的 UNKNOWN：不限	OWNER
SearchTarget	string	否	搜尋表類型，取值如下： TABLE：表，包含物理表和邏輯表 SINGLE_TABLE：物理表 LOGIC_TABLE：邏輯表	LOGIC_TABLE
DbType	string	否	資料庫類型，取值為： MySQL SQLServer PostgreSQL Oracle DRDS OceanBase Mongo Redis	MySQL
ReturnGuid	boolean	否	是否返回表 GUID。	false

返回參數

名稱	類型	描述	樣本值
	object
SearchTableList	object
SearchTable	array<object>	搜尋表詳情列表。
	array<object>
TableId	string	表 ID。	1
Description	string	描述資訊。	test
DatabaseId	string	所屬的庫 ID。	1
Encoding	string	表編碼。	utf8
DBSearchName	string	表所對應的庫搜尋名。	test
EnvType	string	環境類型。	test
DbType	string	資料庫類型，取值為： MySQL SQLServer PostgreSQL Oracle DRDS OceanBase Mongo Redis	mysql
TableName	string	表名。	test_table
TableGuid	string	表 GUID。	IDB_L_9032.db-test.yuyang_test
TableSchemaName	string	表所對應庫名。	test@xxx.xxx.xxx.xxx:3306
DbName	string	庫名。	test
OwnerNameList	object
OwnerNames	array	表 Owner 暱稱列表。
	string	表 Owner 暱稱。	user
Logic	boolean	是否為邏輯表，取值： true：是 false：否	false
OwnerIdList	object
OwnerIds	array	表 Owner ID 列表。
	string	表 Owner ID。	1
Engine	string	表引擎。	innodb
TotalCount	integer	滿足搜尋條件的記錄總數。	1
RequestId	string	請求 ID。	1489257F-1B5D-4B5B-89EF-923C12CEEBD1
ErrorCode	string	錯誤碼。	UnknownError
ErrorMessage	string	錯誤資訊。	UnknownError
Success	boolean	請求是否成功。	true

樣本

正常返回樣本

JSON格式

{
  "SearchTableList": {
    "SearchTable": [
      {
        "TableId": "1",
        "Description": "test",
        "DatabaseId": "1",
        "Encoding": "utf8",
        "DBSearchName": "test",
        "EnvType": "test",
        "DbType": "mysql",
        "TableName": "test_table",
        "TableGuid": "IDB_L_9032.db-test.yuyang_test",
        "TableSchemaName": "test@xxx.xxx.xxx.xxx:3306",
        "DbName": "test",
        "OwnerNameList": {
          "OwnerNames": [
            "user"
          ]
        },
        "Logic": false,
        "OwnerIdList": {
          "OwnerIds": [
            "1"
          ]
        },
        "Engine": "innodb"
      }
    ]
  },
  "TotalCount": 1,
  "RequestId": "1489257F-1B5D-4B5B-89EF-923C12CEEBD1",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

錯誤碼

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

變更歷史

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