用于生成智能小Q嵌入Ticket。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
CopilotId | string | 是 | 开通嵌入的智能小 Q 模块 ID。 | ccd3428c-dd23-460c-a608-26bae29dffee |
TicketNum | integer | 否 | ticket 的票据数量取值范围:
每次使用票据访问后,Ticket 的票据数量减 1。 | 1 |
UserId | string | 否 | Quick BI 的 UserId。
注意 注意:userId 和 accountName 只填一个即可,不填时默认绑定报表的 owner,访问报表时将以该用户身份访问。 | 9c-asdawf-casxcasd-asdasd |
AccountName | string | 否 | 用户的账号名称。 注意 注意:userId 和 accountName 只填一个即可,不填时默认绑定报表的 owner,访问报表时将以该用户身份访问。 | 测试用户 |
AccountType | integer | 否 | 用户的账号类型:
注意 注意:accountName 不为空,则 accountType 不能为空。 | 1 |
ExpireTime | integer | 否 | 过期时间。
| 200 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
"Result": "f5eeb52e-d9c2-4a8b-80e3-47ab55c2****",
"Success": true
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Internal.System.Error | An internal system error occurred. | 系统内部异常。 |
500 | Authorize3rdTicket.Num.HasNoLeft | There is no ticket number left, please generate new ticket. | 当前票据已消费完毕,请重新生成。 |
500 | Invalid.Param.Error | The parameter is invalid. | 无效参数。 |
500 | CopilotEmbed.Config.NotFind | Can not find copilot embed config with this copilot ID. | 找不到此嵌入配置 |
访问错误中心查看更多错误码。