生成报表嵌入需要使用的ticket。
接口说明
具体使用方法详见报表嵌入数据权限控制和传参的安全增强方案。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| WorksId | string | 是 | 开通嵌入的报表 ID。 目前仅支持仪表板，电子表格，自助取数和大屏。 | a206f5f3-****-e9b17c835b03 |
| CmptId | string | 否 | 组件 ID。为以上仪表板中某个组件的 ID，其他作品类型不支持。 获取组件 ID 调用的接口请参见 QueryWorksBloodRelationship 。 | 0fc6a275c7f64f17b1****a306ce0f31 |
| TicketNum | integer | 否 | Ticket 的票据数量，每次使用票据访问后，Ticket 的票据数量减 1。
| 1 |
| UserId | string | 否 | Quick BI 的 UserId，非您的阿里云账号 ID。 您可以调用 QueryUserInfoByAccount 接口，获取 UserId。UserId 样例为 fe67f61a35a94b7da1a34ba174a7****。 说明
UserId 和 AccountName 只填一个即可，不填时默认绑定报表的 Owner，访问报表时将以该用户身份访问。若您需要配置数据行级权限，请参见行级权限。
| 46e537466****92704c8 |
| AccountName | string | 否 | 用户的账号名称。
说明
UserId 和 AccountName 只填一个即可，不填时默认绑定报表的 Owner，访问报表时将以该用户身份访问。若您需要配置数据行级权限，请参见行级权限。
| 测试用户 |
| AccountType | integer | 否 | 用户的账号类型。
说明
若 AccountName 不为空时，则 AccountType 也不能为空。
| 1 |
| ExpireTime | integer | 否 | 过期时间
| 200 |
| WatermarkParam | string | 否 | 报表的水印参数。
| 三方嵌入 |
| GlobalParam | string | 否 | [{"paramKey":"price","joinType":"and","conditionList":[{"operate":">","value":"0"}]}] |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
"Result": "ccd3428c-****-****-a608-26bae29dffee",
"Success": true
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Internal.System.Error | An internal system error occurred. | 系统内部异常。 |
| 400 | Authorize3rdTicket.BindedWorks.Mismatch | The report bound by the ticket mismatches the actual report. | Ticket绑定的报表与访问页面报表不一致。 |
| 400 | Authorize3rdTicket.Expired | Ticket [%s] has expired. | 当前票据[%s]已过期。 |
| 400 | Authorize3rdTicket.HasNo.LoginToken | The request [%s] has no token. | 当前请求 [%s] 未找到token信息。 |
| 400 | Authorize3rdTicket.NotExist | Ticket %s does not exist. | 当前票据%s不存在。 |
| 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. | 作品不存在，可能已经被删除。作品ID:%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. | 数据源不存在：%s。 |
| 400 | Report.NotExist | The dashboard does not exist. | 当前仪表板不存在。 |
| 400 | Organization.Workspace.Inconformity | The workspace does not match the organization. | 工作空间与组织不一致。 |
| 400 | ApiUser.Not.Exists | The specified user does not exist. | 用户不存在。 |
| 400 | Parameter.Length.Exceed | Parameter length exceeds maximum limit: [%s]. | 参数长度超过限制：%s。 |
| 400 | Invalid.User.Organization | The user is not in your organization. | 该用户不在您的组织中。 |
| 400 | GlobalParam.Restricted.Use | The global parameter function is restricted in your version. | 当前版本不可用全局参数 |
| 400 | Authorize3rdTicket.Unsupport.ScreenWatermark | Screen embed does not support watermark parameters. | 大屏嵌入不支持水印参数。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-10-24 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2022-03-04 | OpenAPI 错误码发生变更 | 查看变更详情 |