CreateTicket接口用于生成报表嵌入需要使用的ticket。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 CreateTicket

要执行的操作。取值：CreateTicket。

WorksId String 是 a206f5f3-****-e9b17c835b03

是否是管理员。取值范围：

  • true：是
  • false：否
CmptId String 否 0fc6a275c7f64f17b1****a306ce0f31

组件ID，为以上报表中某个组件的ID。
TicketNum Integer 否 1

ticket的票据数量。

  • 默认为1，每次使用票据访问后-1。
  • 建议为1。
UserId String 否 46e537466****92704c8

Quick BI的用户ID。

  • 注意：userId和accountName只填一个即可，不填时默认绑定报表的owner。
AccountName String 否 测试用户

用户的账号名称。

  • 注意：userId和accountName只填一个即可，不填时默认绑定报表的owner。
AccountType Integer 否 1

用户的账号类型。

  • 1：阿里云主账号 5：RAM账号
  • 3：QuickBI 自建账号。
  • 6：三方账号（SAML、OAuth等协议对对接的账号）
  • 4：钉钉
  • 9：企业微信
  • 10：飞书
ExpireTime Integer 否 200

过期时间。

  • 单位分钟，最大240（4小时）。
  • 默认240。
WatermarkParam String 否 三方嵌入

报表的水印参数。

  • 不得超过50个字符。
GlobalParam String 否 [{"paramKey":"price","joinType":"and","conditionList":[{"operate":">","value":"0"}]}]

报表过滤条件的全局参数。

  • JSON格式的字符串。

1、userId和accountName只填一个即可，不填时默认绑定报表的owner。accountName不为空时，则accountType不能为空。

2、若水印参数和全局参数中带上了中文符号，必须进行URLEncoder.encode(GLOBAL_PARAM, "UTF-8")后进行传参。

返回数据

名称 类型 示例值 描述
RequestId String D787E1A3-A93C-424A-B626-C2B05DF8D885

请求ID。
Result String ccd3428c-****-****-a608-26bae29dffee

生成的票据。
Success Boolean true

是否请求成功。取值范围：

  • true：请求成功
  • false：请求失败

示例

请求示例

http(s)://quickbi-public.aliyuncs.com/?Action=CreateTicket
&WorksId=a206f5f3-****-e9b17c835b03
&CmptId=0fc6a275c7f64f17b1****a306ce0f31
&TicketNum=1
&UserId=46e537466****92704c8
&AccountName=测试用户
&AccountType=1
&ExpireTime=200
&WatermarkParam=三方嵌入
&GlobalParam=[{"paramKey":"price","joinType":"and","conditionList":[{"operate":">","value":"0"}]}]
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateTicketResponse>
    <RequestId>D787E1A3-A93C-424A-B626-C2B05DF8D885</RequestId>
    <Result>ccd3428c-****-****-a608-26bae29dffee</Result>
    <Success>true</Success>
</CreateTicketResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result" : "ccd3428c-****-****-a608-26bae29dffee",
  "Success" : true
}

错误码

HttpCode 错误码 错误信息 描述
500 Internal.System.Error An internal system error occurred. 系统内部异常。
500 Authorize3rdTicket.BindedWorks.Mismatch The report bound by the ticket mismatches the actual report. Ticket绑定的报表与访问页面报表不一致。
500 Authorize3rdTicket.Expired Ticket [%s] has expired. 当前票据[%s]已过期。
500 Authorize3rdTicket.HasNo.LoginToken The request [%s] has no token. 当前请求 [%s] 未找到token信息。
500 Authorize3rdTicket.NotExist Ticket %s does not exist. 当前票据%s不存在。
500 Authorize3rdTicket.Num.Exceed The number of tickets %s is invalid. 票据数量不合法。
500 Authorize3rdTicket.Num.HasNoLeft There is no ticket number left, please generate new ticket. 当前票据已消费完毕，请重新生成。
500 Invalid.Parameter.Error The parameter is invalid:%s. 无效参数%s。
500 Report.NotExist.Error This work does not exist. It may have been deleted. Work ID is %s. 作品不存在，可能已经被删除。作品ID:%s。
500 Authorize3Rd.Report.Unauthorized The report is not enabled for third party embedding. 报表未开通三方嵌入，请开通后重试。
500 Cube.Not.Exist The Cube does not exist. 数据集不存在。
500 Datasource.NotFound.Error The specified data source does not exist: %s. 数据源不存在：%s。
500 Report.NotExist The dashboard does not exist. 当前仪表板不存在。
500 Organization.Workspace.Inconformity The workspace does not match the organization. 工作空间与组织不一致。
500 ApiUser.Not.Exists The specified user does not exist. 用户不存在。
500 Parameter.Length.Exceed Parameter length exceeds maximum limit: [%s]. 参数长度超过限制：%s。

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