使用UpdateTable API更新資料表資訊-資料湖構建-阿里雲

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dlf:UpdateTable

*全部資源

*

無

請求文法

PUT /api/metastore/catalogs/databases/tables HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
Body	object	否	HTTP 要求體，均採用 JSON 格式。
CatalogId	string	否	資料目錄 ID。	1344371
DatabaseName	string	否	資料庫名稱。	database_test
SkipArchive	boolean	否	預設情況下，更新資料表會建立一個新的歸檔版本，但如果 skipArchive 設定 true 則不會建立版本。	false
TableInput	TableInput	否	更新後資料表詳細資料。
TableName	string	否	資料表名稱。	test_table_20201223
IsAsync	boolean	否	是否同步更新。	true
AllowPartitionKeyChange	boolean	否	是否允許更新 partition key。	false

IsAsync：

true：表示非同步呼叫，不等待背景工作返回，介面即返回結果，返回結果中帶上 taskid，這樣用戶端可以通過 taskid 查詢任務的狀態。
false：表示同步調用，介面等待背景工作完成時，介面才返回結果。那麼為 false 的風險就是如果背景工作需要做很長，介面會逾時

返回參數

名稱	類型	描述	樣本值
	object	返回結果體。
Code	string	狀態代碼描述。	OK
Message	string	返回資訊。	.
RequestId	string	請求 ID。	B7F4B621-E41E-4C84-B97F-42B5380A32BB
Success	boolean	是否調用成功。取值如下： true：成功。 false：失敗。	true
TaskId	string	非同步任務 ID。	aa689782deb97265701f57324fc4ae42

Code 錯誤碼說明：

InvalidOperation：對應的資料庫、表不存在。
InternalError：其他類型錯誤，請參考 Message 提示。
taskid：因為 updatetable 也會更新 table 的所有 partitions 資訊，如果是非同步提交，那麼就會返回一個 taskid，用來跟蹤非同步任務的執行狀態。如果同步提交，那麼該值無意義。

樣本

正常返回樣本

JSON格式

{
  "Code": "OK",
  "Message": ".",
  "RequestId": "B7F4B621-E41E-4C84-B97F-42B5380A32BB",
  "Success": true,
  "TaskId": "aa689782deb97265701f57324fc4ae42"
}

錯誤碼

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

變更歷史

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