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

Consulta datos mediante la función de Preguntas y respuestas inteligentes.

Descripción de la operación

Nota: Cuando un usuario está autorizado para llamar a esta API, puede consultar datos como un usuario especificado al pasar el parámetro userId.

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

get

*Todos los recursos.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
UserId	string	No	El ID de usuario. Importante Si no se especifica este parámetro, los datos se consultan como el propietario de la organización de forma predeterminada.	7c7223ae-****-3c744528014b
UserQuestion	string	Sí	El texto de la pregunta.	test
CubeId	string	No	El ID del conjunto de datos. Vaya a Workbench > Conjuntos de datos, abra el conjunto de datos deseado y busque el cubeId en la URL. En escenarios de múltiples tablas, deje este parámetro vacío.	7c7223ae-****-3c744528014b
MultipleCubeIds	string	No	La lista de múltiples ID de conjuntos de datos. El modelo selecciona una o más tablas de la lista según la pregunta para generar una respuesta. Este parámetro es obligatorio en escenarios de múltiples tablas y no es necesario en escenarios de tabla única.	7c7**-3c744528014b,a876asd*yhashd2

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud.	D787E1A3-A************2B05DF8D885
Result	object	El resultado devuelto.
ChartType	string	El tipo de gráfico sugerido.	NEW_TABLE
MetaType	array<object>	La lista de tipos de tupla de columna.
	object	El objeto de metadatos.
Key	string	El nombre de la tupla de columna.	Polar***STPS
Value	string	El tipo de tupla de columna.	string
Type	string	El tipo de fila o columna de metadatos. Dimension: dimensión Measure: medida	Dimension
Values	array<object>	La matriz de listas de valores de datos.
	object	El objeto de lista de valores de datos.
Row	array	Los valores de datos para cada fila.
	string	El valor de datos para cada campo.	199
LogicSql	string	El SQL lógico de visualización.	select * ****
ConclusionText	string	La información de resumen.	test
DataList	array	La lista de datos devuelta solo en escenarios de múltiples pasos. Cada elemento corresponde a un conjunto de datos de gráfico.
	string	Los datos del gráfico.	test
Success	boolean	Indica si la solicitud fue exitosa.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "D787E1A3-A************2B05DF8D885",
  "Result": {
    "ChartType": "NEW_TABLE",
    "MetaType": [
      {
        "Key": "Polar***STPS",
        "Value": "string",
        "Type": "Dimension"
      }
    ],
    "Values": [
      {
        "Row": [
          "199"
        ]
      }
    ],
    "LogicSql": "select * ****",
    "ConclusionText": "test",
    "DataList": [
      "test"
    ]
  },
  "Success": true
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	Internal.System.Error	An internal system error occurred.	Ocurrió un error interno del sistema.
400	Query.Auth.Error	Query is not permitted.	No tiene permiso de consulta.
400	Instance.Expired	Your instance has expired.	Su instancia adquirida ha caducado.
400	Instance.Not.Exist	The specified instance does not exist.	No se encontró ninguna instancia adquirida para su cuenta.
400	Invalid.Organization	The specified organizational unit does not exist.	La organización no existe.
400	User.Not.In.Organization	The specified user is not in the organizational unit.	El usuario no pertenece a la organización.
400	Invalid.Parameter	An error occurred while verifying parameters.	La validación del parámetro falló.
400	Invalid.Parameter.Error	The parameter is invalid:%s.	Parámetro no válido: %s.
400	Invalid.Param.Error	The parameter is invalid.	Parámetro no válido.
400	Invalid.User.Admin	You are not an administrator of this organization.	No tiene el permiso. No es administrador de la organización.
400	System.Param.Empty	You must specify the %s parameter.
400	Access.Forbidden	Your instance version or access key is not allowed to call the API operation, only professional version supports calling.	La edición de su instancia o su AccessKey no está autorizada para invocar esta API. Solo la edición Professional admite esta llamada a la API.
400	UserInfo.Error	The personal information is invalid.	La información personal no es válida.
400	ApiUser.Not.Exists	The specified user does not exist.	El usuario no existe.
400	User.Not.WorkspaceAdmin	Only administrators of the group workspace can perform this operation.	No tiene los permisos necesarios. No es administrador de este espacio de trabajo.
400	Application.Object.NotExist	The object you are operating does not exist or has been deleted.	El componente de operación no existe o ha sido eliminado.
400	Not.ApiCall.AuthUser	You are not an administrator or API call auth user of this organization.	El usuario no es administrador de la organización ni un usuario autorizado por API.
400	UserRoleConfig.NotContain.Function	The user %s does not have permission to operate.	El usuario %s no tiene permiso para realizar esta operación.
400	RobotNl2sql.Moudle.NotPurchase	Please purchase Nl2sql module first.	Adquiera primero el módulo de chat de IA.
400	LlmCopilotQuestion.NotRelatedData.Error	The question you raised is not related to data queries, or the relevant field information could not be found in the dataset. Please try again.	La pregunta que formuló no está relacionada con consultas de datos, o no se encontró la información de campo relevante en el conjunto de datos. Inténtelo de nuevo.
500	Invalid.User.Organization	The user is not in your organization.

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.