QueryTicketInfo - Quick BI - Alibaba Cloud Documentation Center

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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 Resources is 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
quickbi-public:QueryTicketInfo	get	All Resources ``	none	none

Request parameters

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

Response parameters

Parameter	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
OrganizationId	string	The ID of the organization.	2fe4fbd8-**-**-b3e1-e92c7af083ea
UserId	string	The user ID of the Quick BI.	974e50**********9033f46
UsedTicketNum	integer	The number of bills that have been consumed.	47
MaxTicketNum	integer	The maximum number of supported bills.	9999
RegisterTime	string	The registration time of the ticket.	2022-01-09 22:23:49
InvalidTime	string	Expiration time of the note.	2022-01-30 03:03:49
WorksId	string	The ID of the operations report.	ccd3428c-**-**-a608-26bae29dffee
CmptId	string	The ID of the component in the report.	sfdgsds-**-**-a608-mghdgd
GlobalParam	string	Global parameters.	\[&{quot;paramKey\":\"price\",\"joinType\"and\",\"conditionList\":\[{\" operation\"\"\"\"\"\"\"value ;& quot;\"\"\"\"\"\"\"\"\&quot product_type\",\"joinType\":\"and ";,& quot;conditionList\", the conditions must be:\[{\"operate" ;:& quot;in\",\"value\", the conditions must be:\[\" office supplies\",\" furniture products\"]}]}]\n
WatermarkParam	string	Set the watermarking parameters.	Tripartite embedding of Ticket
Success	boolean	Indicates whether the request is successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "AccessTicket": "a27a9aec-****-****-bd40-1a21ea41d7c5",
    "OrganizationId": "2fe4fbd8-****-****-b3e1-e92c7af083ea",
    "UserId": "974e50**********9033f46",
    "UsedTicketNum": 47,
    "MaxTicketNum": 9999,
    "RegisterTime": "2022-01-09 22:23:49",
    "InvalidTime": "2022-01-30 03:03:49",
    "WorksId": "ccd3428c-****-****-a608-26bae29dffee",
    "CmptId": "sfdgsds-****-****-a608-mghdgd",
    "GlobalParam": "\\[&{quot;paramKey\\&quot;:\\&quot;price\\&quot;,\\&quot;joinType\\&quot;and\\&quot;,\\&quot;conditionList\\&quot;:\\[{\\&quot; operation\\&quot;\\&quot;\\&quot;\\&quot;\\&quot;\\&quot;\\&quot;value ;& quot;\\&quot;\\&quot;\\&quot;\\&quot;\\&quot;\\&quot;\\&quot;\\&quot;\\&quot product_type\\&quot;,\\&quot;joinType\\&quot;:\\&quot;and \";,& quot;conditionList\\&quot;, the conditions must be:\\[{\\&quot;operate\" ;:& quot;in\\&quot;,\\&quot;value\\&quot;, the conditions must be:\\[\\&quot; office supplies\\&quot;,\\&quot; furniture products\\&quot;]}]}]\\n\n",
    "WatermarkParam": "Tripartite embedding of Ticket\n"
  },
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	Internal.System.Error	An internal system error occurred.	An internal system error occurred.
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	Invalid.Parameter.Error	The parameter is invalid:%s.	invalid parameter: ${0}.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history