QueryTicketInfo - 查询嵌入报表ticket详情

更新时间:
复制为 MD 格式

获取免登嵌入报表的指定ticket的详情信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

quickbi-public:QueryTicketInfo

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

Ticket

string

票据值。

a27a9aec-****-****-bd40-1a21ea41d7c5

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

D787E1A3-A93C-424A-B626-C2B05DF8D885

Result

object

生成的票据详情。

AccessTicket

string

票据。

a27a9aec-****-****-bd40-1a21ea41d7c5

CmptId

string

报表内的组件 ID。

sfdgsds-****-****-a608-mghdgd

GlobalParam

string

全局参数。

[{"paramKey":"price","joinType":"and","conditionList":[{"operate":">","value":"0"}]},{"paramKey":"product_type","joinType":"and","conditionList":[{"operate":"in","value":["]}]}]\n

InvalidTime

string

票据的失效时间。

2022-01-30 03:03:49

MaxTicketNum

integer

最大支持的票据数。

9999

OrganizationId

string

组织 ID。

2fe4fbd8-****-****-b3e1-e92c7af083ea

RegisterTime

string

票据的注册时间。

2022-01-09 22:23:49

UsedTicketNum

integer

已消费的票据数。

47

UserId

string

Quick BI 的用户 ID。

974e50**********9033f46

WatermarkParam

string

水印参数。

ticket

WorksId

string

报表 ID。

ccd3428c-****-****-a608-26bae29dffee

Success

boolean

是否请求成功。取值范围:

  • true:请求成功

  • false:请求失败

true

示例

正常返回示例

JSON格式

{
  "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
}

错误码

HTTP status code

错误码

错误信息

描述

400 Authorize3rdTicket.BindedWorks.Mismatch The report bound by the ticket mismatches the actual report. Ticket绑定的报表与访问页面报表不一致。
400 Authorize3rdTicket.Expired Ticket [%s] has expired. 当前票据[%s]已过期。
400 Authorize3rdTicket.HasNo.LoginToken The request [%s] has no token. 当前请求 [%s] 未找到token信息。
400 Authorize3rdTicket.NotExist Ticket %s does not exist. 当前票据%s不存在。
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. 您无权操作这些对象。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情