用于生成智能小Q嵌入Ticket。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
quickbi-public:CreateTicket4Copilot |
create |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| CopilotId |
string |
是 |
开通嵌入的智能小 Q 模块 ID。 |
ccd3428c-dd23-460c-a608-26bae29dffee |
| TicketNum |
integer |
否 |
ticket 的票据数量取值范围：
每次使用票据访问后，Ticket 的票据数量减 1。 |
1 |
| UserId |
string |
否 |
Quick BI 的 UserId，非您的阿里云账号 ID。 您可以调用 QueryUserInfoByAccount 接口，获取 UserId。UserId 样例为 fe67f61a35a94b7da1a34ba174a7****。 重要 注意：userId 和 accountName 只填一个即可，不填时默认绑定报表的 owner，访问报表时将以该用户身份访问。 |
9c-asdawf-casxcasd-asdasd |
| AccountName |
string |
否 |
用户的账号名称。 重要 注意：userId 和 accountName 只填一个即可，不填时默认绑定报表的 owner，访问报表时将以该用户身份访问。 |
测试用户 |
| AccountType |
integer |
否 |
用户的账号类型:
重要 注意：accountName 不为空，则 accountType 不能为空。 |
1 |
| ExpireTime |
integer |
否 |
过期时间。
|
200 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
D787E1A3-A93C-424A-B626-C2B05DF8D885 |
| Result |
string |
开通嵌入的智能小 Q 模块 ID。 |
f5eeb52e-d9c2-4a8b-80e3-47ab55c2**** |
| Success |
boolean |
是否请求成功。取值范围：
|
true |
示例
正常返回示例
JSON格式
{
"RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
"Result": "f5eeb52e-d9c2-4a8b-80e3-47ab55c2****",
"Success": true
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | CopilotEmbed.Config.NotFind | Can not find copilot embed config with this copilot ID. | 找不到此嵌入配置 |
| 400 | Authorize3rdTicket.Num.HasNoLeft | There is no ticket number left, please generate new ticket. | 当前票据已消费完毕，请重新生成。 |
| 400 | Invalid.Param.Error | The parameter is invalid. | 无效参数。 |
| 400 | Authorize3rdTicket.Num.Exceed | The number of tickets %s is invalid. | 票据数量不合法。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。