通过 UpdateCubeBySql 更新自定义 SQL 数据集 - 智能商业分析 Quick BI -Alibaba Cloud - 智能商业分析 Quick BI

更新自定义sql数据集。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

quickbi-public:UpdateCubeBySql

update

*全部资源

*

无

请求语法

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.	数据源不存在：%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.	任务执行失败 %s。
400	Datasource.Sql.ExecuteFailed	Failed to execute the SQL statement in the data source.	数据源执行SQL失败。
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.	Sql占位符uniqueId重复。
400	PlaceholderName.Duplicate.Error	Sql placeholder name duplicate.	Sql占位符名称重复。
400	PlaceholderName.NotMatch.Error	The parsing and input placeholder names do not match.	解析和输入占位符名称不匹配。
400	Placeholder.FieldNot.Empty	Condition placeHolder field not empty.	条件占位符字段不能为空

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。