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.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| quickbi-public:CreateTicket | create | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|
| 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.
| 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****.
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 | string | No | The user's account name.
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 | integer | No | The type of the user's account.
If AccountName is not empty, then AccountType must also not be empty.
| 1 |
| ExpireTime | integer | No | Expiration time
| 200 |
| WatermarkParam | string | No | Watermark parameters for the report.
| test |
| GlobalParam | string | No | Global parameters for the report filter conditions.
If you need to use global parameter capabilities, please contact the Quick BI Operations Manager.
| [{"paramKey":"price","joinType":"and","conditionList":[{"operate":">","value":"0"}]}] |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
"Result": "ccd3428c-****-****-a608-26bae29dffee",
"Success": true
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|
| 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. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-10-24 | The Error code has changed | View Change Details |
| 2022-03-04 | The Error code has changed | View Change Details |
