使用QueryCopilotEmbedConfig擷取小Q嵌入的配置列表-智能商務分析 Quick BI-阿里雲

擷取開通小Q嵌入的配置列表。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

quickbi-public:QueryCopilotEmbedConfig

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Keyword	string	否	嵌入配置模組名稱，模糊搜尋。	06-ELive

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 id。	1FC71085-D5FD-08E0-813A-4D4BD1031BC5
Success	boolean	是否請求成功。取值範圍： true：請求成功 false：請求失敗	true
Result	array<object>	嵌入配置列表。
	array<object>	嵌入設定物件。
AgentName	string	機器人暱稱。	小Q
CopilotId	string	嵌入 id。	9c079710-ddbe-48b3-b495-7c83c8d57cc4
CreateUser	string	建立人 userid。	qweqw12312423521
CreateUserName	string	建立人的暱稱。	諸葛
DataRange	object	資料範圍（分析主題和問數資源）。
AllCube	boolean	是否全選問數資源。	true/false
AllTheme	boolean	是否全選分析主題。	true/false
LlmCubes	array	問數資源 id 集合。
	string	問數資源 id。	123124,1231241
Themes	array	分析主題的 id 集合。
	string	分析主題 id。	123124,1231241
ModifyUser	string	修改人 userId。	asda1231231dfs
ModuleName	string	模組名稱。	小Q
ShowName	string	嵌入模組名稱。	0327

樣本

正常返回樣本

JSON格式

{
  "RequestId": "1FC71085-D5FD-08E0-813A-4D4BD1031BC5",
  "Success": true,
  "Result": [
    {
      "AgentName": "小Q",
      "CopilotId": "9c079710-ddbe-48b3-b495-7c83c8d57cc4",
      "CreateUser": "qweqw12312423521",
      "CreateUserName": "諸葛",
      "DataRange": {
        "AllCube": true,
        "AllTheme": true,
        "LlmCubes": [
          "123124,1231241"
        ],
        "Themes": [
          "123124,1231241"
        ]
      },
      "ModifyUser": "asda1231231dfs",
      "ModuleName": "小Q",
      "ShowName": "0327"
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	UserRoleConfig.NotContain.Function	The user %s does not have permission to operate.

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

變更歷史

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