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

Obtiene la lista de configuraciones para activar la integración de XiaoQ.

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:QueryCopilotEmbedConfig

list

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Keyword	string	No	El nombre del módulo de configuración integrada; admite búsqueda difusa.	06-ELive

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud.	1FC71085-D5FD-08E0-813A-4D4BD1031BC5
Success	boolean	Indica si la solicitud se realizó correctamente. Valores posibles: true: La solicitud se realizó correctamente. false: La solicitud falló.	true
Result	array<object>	La lista de configuraciones integradas.
	array<object>	El objeto de configuración integrada.
AgentName	string	El apodo del robot.	小Q
CopilotId	string	El ID de integración.	9c079710-ddbe-48b3-b495-7c83c8d57cc4
CreateUser	string	El ID del creador.	qweqw12312423521
CreateUserName	string	El apodo del creador.	诸葛
DataRange	object	El rango de datos (temas de análisis y recursos de preguntas).
AllCube	boolean	Indica si todos los recursos de preguntas están seleccionados.	true/false
AllTheme	boolean	Indica si todos los temas de análisis están seleccionados.	true/false
LlmCubes	array	El conjunto de ID de recursos de preguntas.
	string	El ID del recurso de preguntas.	123124,1231241
Themes	array	El conjunto de ID de temas de análisis.
	string	El ID del tema de análisis.	123124,1231241
ModifyUser	string	El ID del modificador.	asda1231231dfs
ModuleName	string	El nombre del módulo.	小Q
ShowName	string	El nombre del módulo integrado.	0327

Ejemplos

Respuesta exitosa

JSON Formato

{
  "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"
    }
  ]
}

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.

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.