CreateTicket - Quick BI - Alibaba Cloud Documentation Center

Generate a ticket for third-party embedding.

Operation description

For detailed usage, please refer to Report Embedding Data Permission Control and Parameter Passing Security Enhancement Solution.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

quickbi-public:CreateTicket

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
WorksId	string	Yes	The ID of the report to be embedded. Currently supports dashboards, spreadsheets, data screens, self-service data retrieval, ad-hoc analysis, and data entry.	a206f5f3-****-e9b17c835b03
CmptId	string	No	Component ID. This is the ID of a component within the above-mentioned dashboard; other types of works do not support this. Refer to QueryWorksBloodRelationship for the API to get the component ID.	0fc6a275c7f64f17b1****a306ce0f31
TicketNum	integer	No	The number of tickets. Each time a ticket is used, the number of tickets decreases by 1. Default value: 1 Recommended value: 1 Maximum value: 99999	1
UserId	string	No	Quick BI's UserId, which is not your Alibaba Cloud account ID. You can call the QueryUserInfoByAccount interface to obtain the UserId. An example of a UserId is fe67f61a35a94b7da1a34ba174a7**. Note** Only one of UserId and AccountName needs to be filled in. If neither is filled in, it will default to binding the report's Owner, and the report will be accessed with that user's identity. If you need to configure row-level permissions, please refer to Row-Level Permissions.	46e537466****92704c8
AccountName `deprecated`	string	No	The user's account name. If the user is an Alibaba Cloud primary account wangwu, the format is [Primary Account], for example, wangwu. If the user is a RAM account zhangsan@aliyun.cn, the format is [Primary Account: Sub-Account], for example, wangwu:zhangsan. Note** Only one of UserId and AccountName needs to be filled in. If neither is filled in, it will default to binding the report's Owner, and the report will be accessed with that user's identity. If you need to configure row-level permissions, please refer to Row-Level Permissions.	test
AccountType `deprecated`	integer	No	The type of the user's account. 1: Alibaba Cloud account 3: Quick BI self-built account 4: DingTalk 5: RAM sub-account 9: WeCom 10: Feishu Note If AccountName is not empty, then AccountType must also not be empty.	1
ExpireTime	integer	No	Expiration time Unit: minutes Default: 240	200
WatermarkParam	string	No	Watermark parameters for the report. Must not exceed 50 characters. When the report type is a large screen, watermark parameter passing is not supported.	ticket embed
GlobalParam	string	No	Global parameters for the report filter conditions. A string in JsonArray format. Note If you need to use global parameter capabilities, please contact the Quick BI Operations Manager.	[{"paramKey":"price","joinType":"and","conditionList":[{"operate":">","value":"0"}]}]

Response elements

Element	Type	Description	Example
	object
RequestId	string	Request ID.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	string	The generated ticket value.	ccd3428c-**-**-a608-26bae29dffee
Success	boolean	Indicates whether the request was successful. Value range: true: Request succeeded false: Request failed	true

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
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.	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.	This report is not enabled for 3rd party embedding.
400	Cube.Not.Exist	The Cube does not exist.	The Cube does not exist.
400	Datasource.NotFound.Error	The specified data source does not exist: %s.	The specified data source does not exist: %s.
400	Report.NotExist	The dashboard does not exist.	The dashboard does not exist.
400	Organization.Workspace.Inconformity	The workspace does not match the organization.	workspace inconformity with 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.	Screen embed does not support watermark parameters.
400	NoPermissionTo.Operate.Object	You are not authorized to operate the objects.	You are not authorized to do this.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.