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.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。