生成報表嵌入需要使用的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 錯誤碼發生變更 | 查看變更詳情 |