調用GetMetaTableColumn介面擷取表的欄位資訊。
介面說明
僅管控模式為安全協同的資料庫執行個體可調用此 API。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
dms:GetMetaTableColumn |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| Tid |
integer |
否 |
租戶 ID，可通過調用介面 GetUserActiveTenant 擷取該參數的值。 |
3*** |
| TableGuid |
string |
是 |
表在 DMS 中的唯一識別碼（Globally Unique Identifier，簡稱 GUID）。
|
IDB_40753****.qntest2.activity_setting |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
087DFBA1-378B-5D25-B13B-31F6409F**** |
| ErrorCode |
string |
錯誤碼。 |
MissingTableGuid |
| ColumnList |
array<object> |
欄位列表資訊。 |
|
|
object |
|||
| ColumnType |
string |
欄位的資料類型。 說明
欄位的資料類型傳回值不唯一，例如：bigint、int。 |
bigint(1) |
| AutoIncrement |
boolean |
欄位是否自增，傳回值說明如下：
|
false |
| ColumnId |
string |
欄位 ID。 |
63513**** |
| ColumnName |
string |
欄位名。 |
has_promotion |
| SecurityLevel |
string |
欄位的安全層級，傳回值說明如下：
說明
更多欄位的安全資訊，請參見欄位安全等級。 |
INNER |
| PrimaryKey |
string |
欄位是否為主鍵，傳回值說明如下：
|
true |
| Description |
string |
欄位描述。 |
是否有優惠活動 |
| DataPrecision |
integer |
欄位精度。 |
19 |
| DataScale |
integer |
欄位小數位元。 |
0 |
| Position |
integer |
欄位在表中的順序。 |
1 |
| Nullable |
boolean |
欄位是否允許為空白，傳回值說明如下：
|
false |
| DataLength |
integer |
欄位長度。 |
0 |
| ErrorMessage |
string |
錯誤資訊。 |
TableGuid is mandatory for this action. |
| Success |
boolean |
請求是否成功，傳回值如下：
|
true |
樣本
正常返回樣本
JSON格式
{
"RequestId": "087DFBA1-378B-5D25-B13B-31F6409F****",
"ErrorCode": "MissingTableGuid",
"ColumnList": [
{
"ColumnType": "bigint(1)",
"AutoIncrement": false,
"ColumnId": "63513****",
"ColumnName": "has_promotion",
"SecurityLevel": "INNER",
"PrimaryKey": "true",
"Description": "是否有優惠活動",
"DataPrecision": 19,
"DataScale": 0,
"Position": 1,
"Nullable": false,
"DataLength": 0
}
],
"ErrorMessage": "TableGuid is mandatory for this action.",
"Success": true
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。