QueryCopilotEmbedConfig - 获取开通小Q嵌入的配置列表

获取开通小Q嵌入的配置列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
quickbi-public:QueryCopilotEmbedConfiglist
*全部资源
*

请求参数

名称类型必填描述示例值
Keywordstring

嵌入配置模块名称,模糊搜索。

06-ELive

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 id。

1FC71085-D5FD-08E0-813A-4D4BD1031BC5
Successboolean

是否请求成功。取值范围:

  • true:请求成功
  • false:请求失败
true
Resultarray<object>

嵌入配置列表。

Resultobject

嵌入配置对象。

CopilotIdstring

嵌入 id。

9c079710-ddbe-48b3-b495-7c83c8d57cc4
ShowNamestring

嵌入模块名称。

0327
DataRangeobject

数据范围(分析主题和问数资源)。

AllThemeboolean

是否全选分析主题。

true/false
AllCubeboolean

是否全选问数资源。

true/false
Themesarray

分析主题的 id 集合。

Themesstring

分析主题 id。

123124,1231241
LlmCubesarray

问数资源 id 集合。

LlmCubesstring

问数资源 id。

123124,1231241
CreateUserstring

创建人 userid。

qweqw12312423521
CreateUserNamestring

创建人的昵称。

诸葛
ModifyUserstring

修改人 userId。

asda1231231dfs
ModuleNamestring

模块名称。

Q
AgentNamestring

机器人昵称。

Q

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400Internal.System.ErrorAn internal system error occurred.系统内部异常。
400UserRoleConfig.NotContain.FunctionThe user %s does not have permission to operate.此用户%s没有权限操作。

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