ModifyCopilotEmbedConfig - Quick BI - Centro de documentación de Alibaba Cloud

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

quickbi-public:ModifyCopilotEmbedConfig

update

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
CopilotId	string	Sí	El ID de incrustación.	ccd3428c-dd2xxxxxxxxxxxxdffee
DataRange	string	No	El rango de datos. Importante El tipo de parámetro es jsonString, y solo puede estar activo un selector entre temas de análisis y recursos de consulta. Cuando el selector de selección total es true, tiene prioridad. Se recomienda pasar solo un parámetro, con otras notas Valores válidos: themes : themes allTheme : allTheme llmCubes : llmCubes allCube : allCube	Si el cliente desea autorizar todos los temas de análisis, entonces {allTheme: true} Si el cliente desea autorizar todos los recursos de consulta, entonces {allCube: true} Si el cliente desea autorizar algunos recursos de consulta, entonces {llmCubes: [12314,12345]} Si el cliente desea autorizar algunos temas de análisis, entonces {themes: [12314,12345]}
ModuleName	string	No	El nombre del módulo.	小Q
AgentName	string	No	El apodo del agente.	小Q

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud.	4BAA4694-CC27-555F-B15A-688AA9289FEE
Success	boolean	Indica si la solicitud se realizó correctamente. Valores posibles: true: La solicitud se realizó correctamente. false: La solicitud falló.	true
Result	boolean	Devuelve el resultado de la ejecución de la API. Valores posibles: true: La ejecución se realizó correctamente. false: La ejecución falló.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "4BAA4694-CC27-555F-B15A-688AA9289FEE",
  "Success": true,
  "Result": true
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	UserRoleConfig.NotContain.Function	The user %s does not have permission to operate.	The user %s does not have permission to operate.
400	Copilot.Modulename.Error	ModuleName max length limit 20.	The maximum length of a module name is 20.
400	Copilot.AgentName.Error	AgentName max length limit 10.	The maximum length of the robot name is limited to 10.
400	Invalid.Parameter.Error	The parameter is invalid:%s.	invalid parameter: ${0}.
400	CopilotEmbed.Config.NotFind	Can not find copilot embed config with this copilot ID.	Cannot find this embedded configuration

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.