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

Llama a una API de DataService Studio para consultar datos.

Descripción de la operación

Requisitos previos

Cree una API en DataService Studio antes de llamar a esta operación.

Límites

Requiere Quick BI Professional Edition.
Tiempo de espera de llamada a la API: 60 s. Límite de QPS por API: 10.
Los permisos a nivel de fila en el conjunto de datos referenciado también se aplican a las llamadas a la API.

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

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ApiId	string	Sí	El ID de la API en DataService Studio.	f4cc43bc3***
UserId	string	No	El ID de usuario de Quick BI. Obtenga este valor de QueryUserInfoByAccount. Nota Especifica la identidad del usuario para DataService Studio, utilizada con las configuraciones de permisos a nivel de fila y columna. Importante Si se omite, está vacío o es nulo, el valor predeterminado es el ID de usuario del propietario de la organización de Quick BI.	b5d8fd9348cc4327****afb604
Conditions	string	No	Condiciones de filtro como una cadena de mapa JSON. Cada clave es un nombre de parámetro de solicitud y cada valor es el valor del parámetro. Nota: Si el operador de un parámetro de solicitud se establece en Filtro de enumeración, el valor puede contener múltiples valores. En este caso, el valor debe tener el formato de una lista JSON. Por ejemplo: `area=["East China","North China","South China"]` Para fechas, utilice los siguientes formatos según el tipo de fecha: Año: 2019 Trimestre: 2019Q1 Mes: 201901 (con cero a la izquierda) Semana: 2019-52 Día: 20190101 Hora: 14:00:00 (minutos y segundos son 00) Minuto: 14:12:00 (segundos son 00) Segundo: 14:34:34	{ "area": ["test", "test"], "shopping_date": "2019Q1", }
ReturnFields	string	No	Una matriz JSON de nombres de campos que se devolverán.	["area", "city", "price", "date"]

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true: La solicitud se realizó correctamente. false: La solicitud falló.	true
RequestId	string	El ID de la solicitud.	a4d1a221d-41za1-****
Result	object	El resultado de la llamada a la API. Valores válidos: true: La llamada se realizó correctamente. false: La llamada falló.
Headers	array<object>	Los encabezados de columna.
	object	Encabezados de columna.
Aggregator	string	El operador de agregación. Se devuelve solo para campos de medida. SUM: La suma. MAX: El valor máximo. MIN: El valor mínimo. AVG: El valor promedio. COUNT: El recuento. COUNTD: El recuento de valores únicos. STDDEV_POP: La desviación estándar poblacional. STDDEV_SAMP: La desviación estándar muestral. VAR_POP: La varianza poblacional. VAR_SAMP: La varianza muestral.	SUM
Column	string	El nombre del campo de la tabla física.	test
DataType	string	El tipo de datos del campo. Tipos comunes: number string date time datetime	string
Granularity	string	La granularidad de la dimensión. Se devuelve solo para dimensiones de fecha o geográficas. Valores válidos: Granularidad de fecha: yearRegion (año), monthRegion (mes), weekRegion (semana), dayRegion (día), hourRegion (hora), minRegion (minuto), secRegion (segundo) Granularidad geográfica: COUNTRY (país), PROVINCE (provincia), CITY (ciudad), XIAN (condado/distrito), REGION (región)	REGION
Label	string	El alias del campo. Se utiliza como clave en cada entrada del mapa Values.	area
Type	string	Indica si el campo es una dimensión o una medida. Dimension Measure	Dimension
OriginalColumn	string	El nombre original del campo en el conjunto de datos.	area
Sql	string	La sentencia SQL para la consulta. Nota La sentencia SQL devuelta incluye tanto las condiciones de filtro de esta llamada como cualquier regla de permisos a nivel de fila o columna.	SELECT COMPANY_T_1_.`area` AS D_AREA_2_, COMPANY_T_1_.`city` AS D_CITY_3_, SUM(COMPANY_T_1_.`profit_amt`) AS D_PROFIT_4_ FROM `quickbi_test`.`company_sales_record_copy` AS COMPANY_T_1_ WHERE COMPANY_T_1_.`area` LIKE '%test%' GROUP BY COMPANY_T_1_.`area`, COMPANY_T_1_.`city` HAVING SUM(COMPANY_T_1_.`order_amt`) > 1 LIMIT 0, 10
Values	array<object>	Los resultados de la consulta.
	object	Las filas de datos devueltas. Cada mapa representa una fila, con claves correspondientes al campo `Headers#Label`.	[{"area":"test","city":"test"},{"area":"test","city":"test"}]

Ejemplos

Respuesta exitosa

JSON Formato

{
  "Success": true,
  "RequestId": "a4d1a221d-41za1-****",
  "Result": {
    "Headers": [
      {
        "Aggregator": "SUM",
        "Column": "test",
        "DataType": "string",
        "Granularity": "REGION",
        "Label": "area",
        "Type": "Dimension",
        "OriginalColumn": "area"
      }
    ],
    "Sql": "SELECT COMPANY_T_1_.`area` AS D_AREA_2_, COMPANY_T_1_.`city` AS D_CITY_3_, SUM(COMPANY_T_1_.`profit_amt`) AS D_PROFIT_4_ FROM `quickbi_test`.`company_sales_record_copy` AS COMPANY_T_1_ WHERE COMPANY_T_1_.`area` LIKE '%test%' GROUP BY COMPANY_T_1_.`area`, COMPANY_T_1_.`city` HAVING SUM(COMPANY_T_1_.`order_amt`) > 1 LIMIT 0, 10",
    "Values": [
      [
        {
          "area": "test",
          "city": "test"
        },
        {
          "area": "test",
          "city": "test"
        }
      ]
    ]
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	API.No.Permission	You are not authorized to call the data service API operation.	You are not authorized to call the data service API operation.
400	API.Not.Exist	The data service API operation does not exist.	The data service API operation does not exist.
400	Cube.Not.Exist	The Cube does not exist.	The Cube does not exist.
400	Invalid.Parameter.Conditions	The specified Conditions is invalid. %s is not defined.	The specified Conditions is invalid. %s is not defined.
400	Invalid.Parameter.ReturnFields	The specified returnFields is invalid. %s is not defined.	The specified returnFields is invalid. %s is not defined.
400	Missing.Conditions	The specified Conditions is invalid. You must specify %s.	The specified Conditions is invalid. You must specify %s.
400	Missing.Dimension.Measure	The dimension or measure %s does not exist in Cube.	The dimension or measure %s does not exist in Cube.
400	Rowlevel.Permission.Forbbiden	The request is denied by row level permission. The dataset is %s, %s %s.	Request forbidden by row level permission, dataset is %s, %s %s.
400	Datasource.Sql.ExecuteFailed	Failed to execute the SQL statement in the data source.
400	DataService.InputParam.Error	input parameter error: %s.	The parameters entered were incorrect: %s.

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.