全部產品
Search

搜尋本產品

    Data Management：ListTableColumns - 擷取表欄位資訊

    文件中心

    Data Management：ListTableColumns - 擷取表欄位資訊

    更新時間：Mar 21, 2026

    擷取表欄位資訊。

    調試

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

    調試

    授權資訊

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

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dms:ListTableColumns

    get

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Tid

    integer

    否

    租戶 ID，可通過調用介面 GetUserActiveTenant 或 ListUserTenants 擷取該參數的值。

    3***
    DbId

    integer

    是

    物理庫 ID：可通過調用介面 ListDatabases 或 SearchDatabase 擷取該參數的值。

    123
    TableName

    string

    是

    表名。

    說明

    您可以通過調用介面 ListTables 擷取該參數的值。

    100g_customer
    TableSchemaName

    string

    否

    表模式名，僅當 SQLServer 需要傳遞為架構名。

    dbo

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
    ErrorCode

    string

    錯誤碼，請求異常時返回。

    UnknownError
    ColumnList

    object

    Column

    array<object>

    欄位列表資訊。

    object

    ColumnId

    string

    欄位 id。

    12345
    ColumnType

    string

    欄位類型。

    varchar
    Description

    string

    欄位描述。

    column desc
    AutoIncrement

    boolean

    當前欄位是否自增。傳回值如下：

    • true：自增。

    • false：不自增。

    false
    FunctionType

    string

    欄位遮掩演算法類型，傳回值如下：

    • null：無遮掩

    • DEFAULT：全遮掩

    • FIX_POS：固定位置遮掩

    • FIX_CHAR：固定字元替換

    NULL
    DataPrecision

    integer

    欄位的有效數字位元。

    0
    DefaultValue

    string

    欄位預設值。

    aaa
    ColumnName

    string

    欄位名。

    c1
    SecurityLevel

    string

    安全層級，傳回值如下：

    • INNER：內部（非敏感）

    • SENSITIVE：敏感

    • CONFIDENTIAL：機密

    INNER
    DataScale

    integer

    欄位的小數位元。

    0
    DataLength

    integer

    欄位長度。

    32
    Sensitive

    boolean

    是否敏感欄位，傳回值如下：

    • true：敏感欄位

    • false：非敏感欄位

    false
    Nullable

    boolean

    欄位是否可空，傳回值如下：

    • true：可空

    • false：不可空

    true
    ErrorMessage

    string

    調用失敗時，返回的錯誤資訊。

    UnknownError
    Success

    boolean

    請求是否成功，傳回值如下：

    • true：請求成功

    • false：請求失敗

    true

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ColumnList": {
    "Column": [
      {
        "ColumnId": "12345",
        "ColumnType": "varchar",
        "Description": "column desc",
        "AutoIncrement": false,
        "FunctionType": "NULL",
        "DataPrecision": 0,
        "DefaultValue": "aaa",
        "ColumnName": "c1",
        "SecurityLevel": "INNER",
        "DataScale": 0,
        "DataLength": 32,
        "Sensitive": false,
        "Nullable": true
      }
    ]
  },
  "ErrorMessage": "UnknownError",
  "Success": true
}

    錯誤碼

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

    變更歷史

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