調用GetMetaTableDetailInfo介面擷取表的欄位與索引詳細資料-Data Management-阿里雲 - Data Management

調用GetMetaTableDetailInfo介面擷取表的欄位、索引等資訊。

介面說明

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:GetMetaTableDetailInfo

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Tid	integer	否	租戶 ID。說明取自系統右上方頭像處懸停展示的租戶 ID 資訊，詳情請參見查看租戶資訊。	123
TableGuid	string	是	表在 DMS 中的唯一識別碼 GUID（Globally Unique Identifier）。說明邏輯庫：可調用 ListLogicTables 介面擷取，需要將 ReturnGuid 參數設定為 true。物理庫：可調用 ListTables 介面擷取，需要將 ReturnGuid 參數設定為 true。	IDB_L_9032.db-test.yuyang_test
RealLoginUserUid	string	否	指定 API 呼叫者。	12345

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	E881CB2F-DE42-42E5-90EB-8B3173DCB9B9
DetailInfo	object	表詳情。
IndexList	array<object>	索引列表。
	object
IndexColumns	array	索引欄位列表。
	string	索引欄位。	id
IndexName	string	索引名。	PRIMARY
Unique	boolean	是否為唯一索引。取值： true：是唯一索引。 false：不是唯一索引。	false
IndexType	string	索引類型。例如：Primary、Unique、Normal。	Primary
IndexId	string	索引 ID。	123
ColumnList	array<object>	欄位列表。
	object
ColumnName	string	欄位名。	id
Description	string	欄位描述。	test
DataScale	integer	該欄位小數後的位元。	0
DataPrecision	integer	欄位精度。	0
ColumnType	string	欄位的資料類型。例如：Bigint 、Int、Varchar。	bigint(20) unsigned
AutoIncrement	boolean	當前欄位是否自增。取值： true：自增。 false：不自增。	true
Position	string	欄位在表中的順序。	1
Nullable	boolean	是否可空。取值： true：允許為空白。 false：不允許為空白。	false
ColumnId	string	欄位 ID。	191234849
DataLength	integer	欄位長度。	0
ErrorCode	string	錯誤碼。	UnknownError
ErrorMessage	string	錯誤資訊。	UnknownError
Success	boolean	請求是否成功。	true

樣本

正常返回樣本

JSON格式

{
  "RequestId": "E881CB2F-DE42-42E5-90EB-8B3173DCB9B9",
  "DetailInfo": {
    "IndexList": [
      {
        "IndexColumns": [
          "id"
        ],
        "IndexName": "PRIMARY",
        "Unique": false,
        "IndexType": "Primary",
        "IndexId": "123"
      }
    ],
    "ColumnList": [
      {
        "ColumnName": "id",
        "Description": "test",
        "DataScale": 0,
        "DataPrecision": 0,
        "ColumnType": "bigint(20) unsigned",
        "AutoIncrement": true,
        "Position": "1",
        "Nullable": false,
        "ColumnId": "191234849",
        "DataLength": 0
      }
    ]
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

錯誤碼

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

變更歷史

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