QueryTicketInfo - Quick BI - Alibaba Cloud Documentation Center

Obtains the details of a specified ticket for a report that is not embedded in the report.

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:QueryTicketInfo

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Ticket	string	Yes	The value of the bill.	a27a9aec-**-**-bd40-1a21ea41d7c5

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	The details of the generated ticket.
AccessTicket	string	Notes.	a27a9aec-**-**-bd40-1a21ea41d7c5
CmptId	string	The ID of the component in the report.	sfdgsds-**-**-a608-mghdgd
GlobalParam	string	Global parameters.	[{"paramKey":"price","joinType":"and","conditionList":[{"operate":">","value":"0"}]},{"paramKey":"product_type","joinType":"and","conditionList":[{"operate":"in","value":["]}]}]\n
InvalidTime	string	Expiration time of the note.	2022-01-30 03:03:49
MaxTicketNum	integer	The maximum number of supported bills.	9999
OrganizationId	string	The ID of the organization.	2fe4fbd8-**-**-b3e1-e92c7af083ea
RegisterTime	string	The registration time of the ticket.	2022-01-09 22:23:49
UsedTicketNum	integer	The number of bills that have been consumed.	47
UserId	string	The user ID of the Quick BI.	974e50**********9033f46
WatermarkParam	string	Set the watermarking parameters.	ticket
WorksId	string	The ID of the operations report.	ccd3428c-**-**-a608-26bae29dffee
Success	boolean	Indicates whether the request is successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "AccessTicket": "a27a9aec-****-****-bd40-1a21ea41d7c5",
    "CmptId": "sfdgsds-****-****-a608-mghdgd",
    "GlobalParam": "[{"paramKey":"price","joinType":"and","conditionList":[{"operate":">","value":"0"}]},{"paramKey":"product_type","joinType":"and","conditionList":[{"operate":"in","value":["]}]}]\\n",
    "InvalidTime": "2022-01-30 03:03:49",
    "MaxTicketNum": 9999,
    "OrganizationId": "2fe4fbd8-****-****-b3e1-e92c7af083ea",
    "RegisterTime": "2022-01-09 22:23:49",
    "UsedTicketNum": 47,
    "UserId": "974e50**********9033f46",
    "WatermarkParam": "ticket",
    "WorksId": "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	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.