調用ListColumns介面查詢資料地圖資料表欄位列表-巨量資料開發治理平台 DataWorks-阿里雲

介面說明

需要購買 DataWorks 基礎版及以上版本才能使用。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:ListColumns

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
TableId	string	是	資料表 ID，可參考 ListTables 介面返回結果，以及中繼資料實體相關概念說明。	maxcompute-table:::project_name:[schema_name]:table_name
Name	string	否	名稱，模糊比對。	test_table
Comment	string	否	注釋，模糊比對。	test comment
SortBy	string	否	排序欄位，預設為 Position，枚舉值，當前支援 Name 名稱 Position 位置	Position
Order	string	否	排序方向，預設為 Asc，枚舉值，當前支援 Asc 升序 Desc 降序	Asc
PageNumber	integer	否	分頁頁碼，預設為 1。	1
PageSize	integer	否	分頁大小，預設為 10，最大為 100。	10

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求 ID。	D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx
Success	boolean	請求是否成功。	true
PagingInfo	object	分頁結果。
TotalCount	integer	總記錄數。	1
PageNumber	integer	分頁頁碼。	1
PageSize	integer	分頁大小。	10
Columns	array	欄位列表。
	Column	欄位資訊。

樣本

正常返回樣本

JSON格式

{
  "RequestId": "D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 10,
    "Columns": [
      {
        "Id": "maxcompute-column:123456::test_project:default:test_tbl:col1",
        "Name": "col1",
        "Comment": "欄位1",
        "TableId": "maxcompute-table:123456::test_project:default:test_tbl",
        "Position": 1,
        "Type": "bigint",
        "PrimaryKey": false,
        "PartitionKey": false,
        "ForeignKey": false,
        "BusinessMetadata": {
          "Description": "欄位1的業務描述"
        }
      }
    ]
  }
}

錯誤碼

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

變更歷史

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