ModifyCopilotEmbedConfig_Quick BI_API文档

2022-01-01

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

quickbi-public:ModifyCopilotEmbedConfig	Update	全部资源 *	无	无

请求参数

字段名称	字段详情
CopilotIdstring	嵌入 id。示例值:ccd3428c-dd2xxxxxxxxxxxxdffee参考取值来源: QueryCopilotEmbedConfig CreateTicket4Copilot
DataRangestring	数据范围。展开详情示例值:Map<String,Object> data=new HashMap<>(); data.put("allTheme",true); //data.put("allCube",true); //data.put("themes",Lists.newArrayList("1111","22222")); //data.put("llmCubes",Lists.newArrayList("33333","44444")); request.setDataRange(JSON.toJSONString(data));枚举值:themesallThemellmCubesallCube
ModuleNamestring	模块名称。示例值:小Q
AgentNamestring	机器人昵称。示例值:小Q

返回参数

字段名称	字段详情
RequestIdstring	请求 id。示例值:4BAA4694-CC27-555F-B15A-688AA9289FEE
Successboolean	是否请求成功。取值范围：展开详情示例值:true
Resultboolean	返回接口执行结果。取值范围：展开详情示例值:true

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	UserRoleConfig.NotContain.Function	The user %s does not have permission to operate.	诊断
400	Copilot.Modulename.Error	ModuleName max length limit 20.	诊断
400	Copilot.AgentName.Error	AgentName max length limit 10.	诊断
400	Invalid.Parameter.Error	The parameter is invalid:%s.	诊断
400	CopilotEmbed.Config.NotFind	Can not find copilot embed config with this copilot ID.	诊断

变更历史

	变更时间	变更内容概要	操作
	2025-02-11	变更错误码400 删除错误码500
	2024-10-18	变更错误码400

相关示例