全部產品
Search
文件中心

Data Management:GetTableKnowledgeInfo

更新時間:Oct 26, 2026

獲取指定 guid 的中繼資料知識。

介面說明

僅開啟安全託管的資料庫執行個體可呼叫此 API。

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:GetTableKnowledgeInfo

get

*全部資源。

*

無 無

請求文法

POST  HTTP/1.1

請求參數

名稱

類型

必填

描述

樣本值

TableSchemaName

string

否

資料表結構描述名稱,僅當 SQL Server 需要傳遞為結構描述名稱。

dbo

DbId

integer

是

實體資料庫 ID,您可以呼叫 SearchDatabase 介面獲取該值。

325

TableName

string

是

資料表名稱。

table_name

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

RequestId

string

請求 ID。請求的唯一識別碼,用於定位日誌,排查問題。

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

Success

boolean

請求是否成功,傳回值如下:

  • true:請求成功

  • false:請求失敗

true

ErrorCode

string

錯誤碼。

UnknownError

ErrorMessage

string

錯誤資訊。

UnknownError

Table TableKnowledgeInfo

資料表的詳細資訊。

bill_orders

樣本

正常返回樣本

JSON格式

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "Success": true,
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Table": {
    "TableName": "orders",
    "Description": "訂單表",
    "AssetDescription": "查詢訂單時使用 order_id 定位訂單",
    "AssetModifiedGmt": "2026-10-22 10:30:00",
    "Summary": "儲存訂單業務資料",
    "ColumnList": [
      {
        "Description": "訂單編號",
        "ColumnType": "bigint",
        "AssetDescription": "用於唯一識別一筆訂單",
        "Position": 1,
        "AssetModifiedGmt": "2026-10-22 10:30:00",
        "ColumnName": "order_id",
        "Level": 5
      }
    ],
    "Level": 5
  }
}

錯誤碼

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

變更歷史

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