CreateTicket - 產生報表嵌入ticket - Quick BI

產生報表嵌入需要使用的ticket。

介面說明

具體使用方法詳見報表嵌入資料許可權控制和傳參的安全增強方案。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

quickbi-public:CreateTicket

create

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
WorksId	string	是	開通嵌入的報表 ID，目前支援儀表板、試算表、資料大屏、自助取數、即席分析和資料填報。	a206f5f3-****-e9b17c835b03
CmptId	string	否	組件 ID。為以上儀表板中某個組件的 ID，其他作品類型不支援。擷取組件 ID 調用的介面請參見 QueryWorksBloodRelationship 。	0fc6a275c7f64f17b1****a306ce0f31
TicketNum	integer	否	Ticket 的票據數量，每次使用票據訪問後，Ticket 的票據數量減 1。預設值為 1。建議值為 1。最大值為 99999。	1
UserId	string	否	Quick BI 的 UserId，非您的阿里雲帳號 ID。您可以調用 QueryUserInfoByAccount 介面，擷取 UserId。UserId 範例為 fe67f61a35a94b7da1a34ba174a7****。說明 UserId 和 AccountName 只填一個即可，不填時預設綁定報表的 Owner，訪問報表時將以該使用者身份訪問。若您需要配置資料行級許可權，請參見行級許可權。	46e537466****92704c8
AccountName `deprecated`	string	否	使用者的帳號名稱。如果使用者是阿里雲主帳號 wangwu，格式為[主帳號]，例如 wangwu。如果使用者是 RAM 帳號 zhangsan@aliyun.cn，格式為[主帳號：子帳號]，例如wangwu:zhangsan****。說明 UserId 和 AccountName 只填一個即可，不填時預設綁定報表的 Owner，訪問報表時將以該使用者身份訪問。若您需要配置資料行級許可權，請參見行級許可權。	測試使用者
AccountType `deprecated`	integer	否	使用者的帳號類型。 1：阿里雲帳號 3：Quick BI 自建帳號 4：DingTalk 5：RAM 子帳號 9：企業微信 10：飛書說明若 AccountName 不為空白時，則 AccountType 也不可為空。	1
ExpireTime	integer	否	到期時間單位：分鐘預設：240	200
WatermarkParam	string	否	報表的浮水印參數。不得超過 50 個字元。當報表類型為大屏時，不支援浮水印傳參。	三方嵌入
GlobalParam	string	否	報表過濾條件的全域參數。 JsonArray 格式的字串。說明若您需要使用全域參數能力，請聯絡Quick BI 營運負責人。	[{"paramKey":"price","joinType":"and","conditionList":[{"operate":">","value":"0"}]}]

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	string	產生 ticket 的值。	ccd3428c-**-**-a608-26bae29dffee
Success	boolean	是否請求成功。取值範圍： true：請求成功 false：請求失敗	true

樣本

正常返回樣本

JSON格式

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

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
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.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。