全部產品
Search

搜尋本產品

    Quick BI：CreateTicket4Copilot - 產生智能小Q嵌入Ticket

    文件中心

    Quick BI：CreateTicket4Copilot - 產生智能小Q嵌入Ticket

    更新時間：Mar 09, 2026

    用於產生智能小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 的票據數量取值範圍：

    • 預設值為 1。

    • 建議值為 1。

    • 最大值為 99999。

    每次使用票據訪問後，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

    否

    使用者的帳號類型:

    • 1：阿里雲主帳號

    • 3：QuickBI 自建帳號。

    • 4：DingTalk

    • 5：阿里雲 RAM 帳號

    • 6：三方帳號（SAML、OAuth 等協議對對接的帳號）

    • 9：企業微信

    • 10：飛書

    重要 注意：accountName 不為空白，則 accountType 不可為空。

    1
    ExpireTime

    integer

    否

    到期時間。

    • 單位分鐘，最大 240（4 小時）。

    • 預設 240。

    200

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    D787E1A3-A93C-424A-B626-C2B05DF8D885
    Result

    string

    開通嵌入的智能小 Q 模組 ID。

    f5eeb52e-d9c2-4a8b-80e3-47ab55c2****
    Success

    boolean

    是否請求成功。取值範圍：

    • true：請求成功

    • false：請求失敗

    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. 票據數量不合法。

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。