用于生成智能小Q嵌入Ticket。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
quickbi-public:CreateTicket4Copilot | create | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 | 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. | 票据数量不合法。 |
访问错误中心查看更多错误码。