全部產品
Search
文件中心

Quick BI:UpdateCubeBySql

更新時間:Jul 03, 2026

更新自訂 SQL 資料集。

調試

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

調試

授權資訊

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

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

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

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

quickbi-public:UpdateCubeBySql

update

*All Resource

*

請求文法

POST  HTTP/1.1

請求參數

名稱

類型

必填

描述

樣本值

CubeId

string

資料集 ID。

7c7223ae-****-3c744528014b

CustomSql

string

自訂 SQL 語句。

select * from sdsd

WorkspaceId

string

工作空間 ID。

95296e95-ca89-4c7d-8af9-dedf0ad0****

UserId

string

需要傳入一個有權限建立資料集的 Quick BI 的 UserId,非您的阿里雲帳號 ID。 您可以呼叫 QueryUserInfoByAccount 介面,取得 UserId。

95296e95-ca89-4c7d-8af9-dedf0ad0****

DsId

string

資料來源 ID。

7AAB95D-*****-****-*4FC0C976

Placeholders

string

佔位符參數,詳細內容請看下方補充說明。

[ { "name": "test", "style": "placeholder", "type": "string" } ]

佔位符 PlaceholderModel 結構

  • uniqueId -- string,非必傳,佔位符唯一 id,建立時候不用傳,傳了也不會用(更新時會用到此欄位)

  • name -- string,必傳,佔位符名,不能重複

  • style -- string,必傳,佔位符類型

    • 運算式佔位符:param

    • 值佔位符:placeholder

    • 條件佔位符:condition

  • type -- String,佔位符變數類型

    • 文字:string

    • 數值:number

    • 日期:見下方 format 描述

  • useInGlobal -- Boolean,非必傳,是否為全域生效,預設為 false

    • 是:true

    • 否:false

  • defaultValue -- List,非必傳,佔位符預設值,shipping_date_ph.get(0) 佔位符類型預設值個數只能為 0 或 2,其餘佔位符類型只能為 0 或 1

  • format -- String,非必填,日期類型格式(見下方 format)

  • originalType -- String,非必填,如果值佔位符為 shipping_date_ph.get(0) 的日期類型,將 originalType 設定為 dateRange,其餘情況均無需設定

  • conditionPlaceHolderFields -- List,非必填,條件佔位符欄位,僅條件佔位符需要設定

ConditionPlaceHolderFields 結構

  • uniqueId -- String,非必傳,條件佔位符欄位唯一 id,建立不需要傳,後台會預設產生

  • column -- String,必填,實體欄位名稱

運算式佔位符 style、type 對應關係

變數類型 ### 對應 type 類型。

  • 文字 string

  • 數字 number

  • 日期-年 yearRegion

  • 日期-年季 quarterRegion

  • 日期-年月 monthRegion

  • 日期-年週 weekRegion

  • 日期-年月日 dateRegion

  • 日期-年月日時分秒 ymdHmsRegion

值佔位符 style、type、format 對應關係(空白代表無需填寫)

變數類型 ### 對應 type 類型 ### format。

  • 文字 string (shipping_date_ph.get(0) 的日期類型不支援)

  • 數字 number (shipping_date_ph.get(0) 的日期類型不支援)

  • 日期-年 yearRegion

  • 日期-年季 quarterRegion

  • 日期-年月 monthRegion YYYY-MM 或 YYYYMM 或 YYYY/MM,3 種 format 選一種

  • 日期-年週 weekRegion

  • 日期-年月日 dateRegion YYYY-MM-DD 或 YYYYMMDD 或 YYYY/MM/DD,3 種 format 選一種

  • 日期-年月日時分秒 ymdHmsRegion YYYY-MM-DD HH:MI:SS 或 YYYYMMDD HH:MI:SS 或 YYYY/MM/DD HH:MI:SS 或 YYYYMMDDHHMISS,4 種 format 選一種

條件佔位符 style、type 對應關係

變數類型 ### 對應 type 類型。

  • 文字 string。

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

RequestId

string

請求 ID。

617277******************ABA47E31

Result

boolean

介面執行結果。取值範圍:

  • true:請求成功

  • false:請求失敗

true

Success

boolean

是否請求成功。取值範圍:

  • true:請求成功

  • false:請求失敗

true

樣本

正常返回樣本

JSON格式

{
  "RequestId": "617277******************ABA47E31",
  "Result": true,
  "Success": true
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 Internal.System.Error An internal system error occurred.
400 Invalid.User.Organization The user is not in your organization.
400 User.NotIn.Workspace The user is not a member of the group workspace.
400 Workspace.NotIn.Organization The workspace is not owned by the organization.
400 Datasource.NotFound.Error The specified data source does not exist: %s.
400 Invalid.Param.Error The parameter is invalid.
400 Cube.Not.Exist The Cube does not exist.
400 CubeSchema.Not.Exist The cube schema does not exist.
400 Cube.DuplicatedName.Error The dataset name already exists. Modify the name before saving.
400 Directory.NotExist.Error The directory does not exist.
400 Xengnie.TaskExecute.Error Fail to execute task %s.
400 Datasource.Sql.ExecuteFailed Failed to execute the SQL statement in the data source.
400 Placeholder.Date.Illegal The placeholder date format is illegal.
400 Placeholder.DefaultValue.Invalid Invalid placeholder default value.
400 Placeholder.Style.Illegal Illegal placeholder style.
400 Placeholder.Type.Illegal Illegal placeholder type.
400 Placeholder.UniqueId.Duplicate Sql placeholder uniqueId duplicate.
400 PlaceholderName.Duplicate.Error Sql placeholder name duplicate.
400 PlaceholderName.NotMatch.Error The parsing and input placeholder names do not match.
400 Placeholder.FieldNot.Empty Condition placeHolder field not empty.

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

變更歷史

更多資訊,參考變更詳情