CreateTicket_Quick BI_API文档

2022-01-01

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

具体使用方法详见报表嵌入数据权限控制和传参的安全增强方案。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

quickbi-public:CreateTicket	Create	全部资源 *	无	无

请求参数

字段名称	字段详情
WorksIdstring	开通嵌入的报表 ID，目前支持仪表板、电子表格、数据大屏、自助取数、即席分析和数据填报。示例值:a206f5f3-****-e9b17c835b03参考取值来源: GetWorksEmbedList
CmptIdstring	组件 ID。为以上仪表板中某个组件的 ID，其他作品类型不支持。展开详情示例值:0fc6a275c7f64f17b1****a306ce0f31
TicketNuminteger<int32>	Ticket 的票据数量，每次使用票据访问后，Ticket 的票据数量减 1。展开详情示例值:1
UserIdstring	Quick BI 的 UserId，非您的阿里云账号 ID。展开详情示例值:46e537466****92704c8参考取值来源: AddUser QueryUserList
deprecatedAccountNamestring	用户的账号名称。展开详情示例值:测试用户参考取值来源: QueryUserInfoByAccount
deprecatedAccountTypeinteger<int32>	用户的账号类型。展开详情示例值:1
ExpireTimeinteger<int32>	过期时间展开详情示例值:200
WatermarkParamstring	报表的水印参数。展开详情示例值:三方嵌入
GlobalParamstring	报表过滤条件的全局参数。展开详情示例值:[{"paramKey":"price","joinType":"and","conditionList":[{"operate":">","value":"0"}]}]

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:D787E1A3-A93C-424A-B626-C2B05DF8D885
Resultstring	生成 ticket 的值。示例值:ccd3428c-**-**-a608-26bae29dffee
Successboolean	是否请求成功。取值范围：展开详情示例值:true

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	Authorize3rdTicket.BindedWorks.Mismatch	The report bound by the ticket mismatches the actual report.	诊断
400	Authorize3rdTicket.Expired	Ticket [%s] has expired.	诊断
400	Authorize3rdTicket.HasNo.LoginToken	The request [%s] has no token.	诊断
400	Authorize3rdTicket.NotExist	Ticket %s does not exist.	诊断
400	Authorize3rdTicket.Num.Exceed	The number of tickets %s is invalid.	诊断
400	Authorize3rdTicket.Num.HasNoLeft	There is no ticket number left, please generate new ticket.	诊断
400	Report.NotExist.Error	This work does not exist. It may have been deleted. Work ID is %s.	诊断
400	Authorize3Rd.Report.Unauthorized	The report is not enabled for third party embedding.	诊断
400	Cube.Not.Exist	The Cube does not exist.	诊断
400	Datasource.NotFound.Error	The specified data source does not exist: %s.	诊断
400	Report.NotExist	The dashboard does not exist.	诊断
400	Organization.Workspace.Inconformity	The workspace does not match the organization.	诊断
400	Parameter.Length.Exceed	Parameter length exceeds maximum limit: [%s].	诊断
400	GlobalParam.Restricted.Use	The global parameter function is restricted in your version.	诊断
400	Authorize3rdTicket.Unsupport.ScreenWatermark	Screen embed does not support watermark parameters.	诊断

变更历史

	变更时间	变更内容概要	操作
	2024-10-18	变更错误码400
	2023-10-24	变更错误码400
	2022-03-04	变更错误码400

相关示例