生成AIPro超级框嵌入ticket。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| AiProId |
string |
是 |
AIPro 嵌入配置 ID;配置须存在、属于当前组织且 status=1 |
test |
| TicketNum |
integer |
否 |
票据可使用次数,默认 1,取值 1~99999 |
1 |
| QuickBIUserId |
string |
否 |
绑定访问用户的 QuickBI userId; 与 accountName+accountType 二选一 |
test |
| AccountName |
string |
否 |
绑定访问用户账号; userId 未传时配合 accountType 使用 |
test |
| AccountType |
integer |
否 |
用户的账号类型。
|
1 |
| ExpireTime |
integer |
否 |
有效期,单位分钟,默认 240,必须大于 0 |
22 |
| SystemUid |
string |
否 |
自定义系统标识,长度小于 150 |
test |
| CustomParam |
string |
否 |
自定义透传参数,非空时必须为合法 JSON 字符串 |
test |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID |
D787E1A**********DF8D885 |
| Result |
string |
ticket 票据 |
true |
| Success |
boolean |
请求是否成功
|
true |
示例
正常返回示例
JSON格式
{
"RequestId": "D787E1A**********DF8D885",
"Result": "true",
"Success": true
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | Internal.System.Error | An internal system error occurred. | 系统内部异常。 |
| 400 | UserRoleConfig.NotContain.Function | The user %s does not have permission to operate. | 此用户%s没有权限操作。 |
| 400 | Invalid.Parameter.Error | The parameter is invalid:%s. | 无效参数%s。 |
| 400 | AIPro.EmbedConfig.NotFindError | Can not find AI Pro embed config with this aiProId %s. | 未找到嵌入配置:%s。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。