QueryTicketInfo接口用于获取免登嵌入报表的指定ticket的详情信息。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | QueryTicketInfo |
要执行的操作。取值:QueryTicketInfo。 |
Ticket | String | 是 | a27a9aec-****-****-bd40-1a21ea41d7c5 |
票据值。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | D787E1A3-A93C-424A-B626-C2B05DF8D885 |
请求ID。 |
Result | Object |
生成的票据详情。 |
|
AccessTicket | String | a27a9aec-****-****-bd40-1a21ea41d7c5 |
票据。 |
OrganizationId | String | 2fe4fbd8-****-****-b3e1-e92c7af083ea |
组织ID。 |
UserId | String | 974e50**********9033f46 |
Quick BI的用户ID。 |
UsedTicketNum | Integer | 47 |
已消费的票据数。 |
MaxTicketNum | Integer | 9999 |
最大支持的票据数。 |
RegisterTime | String | 2022-01-09 22:23:49 |
票据的注册时间。 |
InvalidTime | String | 2022-01-30 03:03:49 |
票据的失效时间。 |
WorksId | String | ccd3428c-****-****-a608-26bae29dffee |
报表ID。 |
CmptId | String | sfdgsds-****-****-a608-mghdgd |
报表内的组件ID。 |
GlobalParam | String | [{"paramKey":"price","joinType":"and","conditionList":[{"operate":">","value":"0"}]},{"paramKey":"product_type","joinType":"and","conditionList":[{"operate":"in","value":["办公用品","家具产品"]}]}]\n |
全局参数。 |
WatermarkParam | String | Ticket三方嵌入 |
水印参数。 |
Success | Boolean | true |
是否请求成功。取值范围:
|
示例
请求示例
http(s)://quickbi-public.aliyuncs.com/?Action=QueryTicketInfo
&Ticket=a27a9aec-****-****-bd40-1a21ea41d7c5
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<QueryTicketInfoResponse>
<RequestId>D787E1A3-A93C-424A-B626-C2B05DF8D885</RequestId>
<Result>
<AccessTicket>a27a9aec-****-****-bd40-1a21ea41d7c5</AccessTicket>
<OrganizationId>2fe4fbd8-****-****-b3e1-e92c7af083ea</OrganizationId>
<UserId>974e50**********9033f46</UserId>
<UsedTicketNum>47</UsedTicketNum>
<MaxTicketNum>9999</MaxTicketNum>
<RegisterTime>2022-01-09 22:23:49</RegisterTime>
<InvalidTime>2022-01-30 03:03:49</InvalidTime>
<WorksId>ccd3428c-****-****-a608-26bae29dffee</WorksId>
<CmptId>sfdgsds-****-****-a608-mghdgd</CmptId>
<GlobalParam>[{&quot;paramKey&quot;:&quot;price&quot;,&quot;joinType&quot;:&quot;and&quot;,&quot;conditionList&quot;:[{&quot;operate&quot;:&quot;&gt;&quot;,&quot;value&quot;:&quot;0&quot;}]},{&quot;paramKey&quot;:&quot;product_type&quot;,&quot;joinType&quot;:&quot;and&quot;,&quot;conditionList&quot;:[{&quot;operate&quot;:&quot;in&quot;,&quot;value&quot;:[&quot;办公用品&quot;,&quot;家具产品&quot;]}]}]\n</GlobalParam>
<WatermarkParam>Ticket三方嵌入</WatermarkParam>
</Result>
<Success>true</Success>
</QueryTicketInfoResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"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" : "[{"paramKey":"price","joinType":"and","conditionList":[{"operate":">","value":"0"}]},{"paramKey":"product_type","joinType":"and","conditionList":[{"operate":"in","value":["办公用品","家具产品"]}]}]\\n",
"WatermarkParam" : "Ticket三方嵌入"
},
"Success" : true
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | Internal.System.Error | An internal system error occurred. | 系统内部异常。 |
500 | Authorize3rdTicket.BindedWorks.Mismatch | The report bound by the ticket mismatches the actual report. | Ticket绑定的报表与访问页面报表不一致。 |
500 | Authorize3rdTicket.Expired | Ticket [%s] has expired. | 当前票据[%s]已过期。 |
500 | Authorize3rdTicket.HasNo.LoginToken | The request [%s] has no token. | 当前请求 [%s] 未找到token信息。 |
500 | Authorize3rdTicket.NotExist | Ticket %s does not exist. | 当前票据%s不存在。 |
500 | Authorize3rdTicket.Num.Exceed | The number of tickets %s is invalid. | 票据数量不合法。 |
500 | Authorize3rdTicket.Num.HasNoLeft | There is no ticket number left, please generate new ticket. | 当前票据已消费完毕,请重新生成。 |
500 | Invalid.Parameter.Error | The parameter is invalid:%s. | 无效参数%s。 |
访问错误中心查看更多错误码。