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

Invoca una API ya creada en el servicio de datos.

Nota

Esta API se marcó como obsoleta. Se recomienda migrar a quickbi-public(2022-01-01) - QueryData para obtener funciones mejoradas y soporte continuo. Si bien la API obsoleta permanece accesible de forma temporal, no se entregarán nuevas actualizaciones ni correcciones de bugs.

Descripción de la operación

Requisitos previos

Cree la API del servicio de datos a través del servicio de datos de Quick BI. Para obtener más detalles, consulte Servicio de datos.

Restricciones de uso

La función de servicio de datos solo está disponible para clientes de la edición profesional.
El tiempo de espera para las llamadas a la API del servicio de datos es de 60 s, y el QPS para una sola API es de 10 veces por segundo.
Si los permisos a nivel de fila están habilitados en el conjunto de datos al que hace referencia la API del servicio de datos, la llamada a la API puede ser interceptada por la política de permisos a nivel de fila.

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

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 el servicio de datos. Para obtener más información, consulte Servicio de datos.	f4cc43bc3***
Conditions	string	No	Las condiciones de consulta para el servicio de datos, pasadas como pares clave-valor. Esta es una cadena de tipo mapa. Aquí, Key es el nombre del parámetro de solicitud y Value es el valor del parámetro de solicitud. Las claves y los valores deben aparecer en pares. Nota: Cuando el operador del parámetro de solicitud se establece en filtro de enumeración, el valor puede contener múltiples valores. En este caso, el formato del valor es una lista JSON. Por ejemplo: `area=["East China","North China","South China"]` Para las fechas, se proporcionan diferentes formatos según el tipo: Año: 2019 Trimestre: 2019Q1 Mes: 201901 (con cero a la izquierda) Semana: 2019-52 Día: 20190101 Hora: 14:00:00 (los minutos y segundos son 00) Minuto: 14:12:00 (los segundos son 00) Segundo: 14:34:34	{ "area": ["华东", "华北"], "shopping_date": "2019Q1", }
ReturnFields	string	No	Una lista de nombres de parámetros que se devolverán, como una cadena de tipo lista.	["area", "city", "price", "date"]

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
Success	boolean	Indica si la solicitud fue exitosa. Valores posibles: true: La solicitud fue exitosa false: La solicitud falló	true
RequestId	string	El ID de la solicitud.	78C1AA2D-9201-599E-A0BA-6FC462E57A95
Result	object	Devuelve el resultado de la consulta de la interfaz.
Headers	array<object>	Encabezados de columna.
	object
Aggregator	string	Operador de agregación. Solo está presente para campos de medida, como SUM, AVG y MAX.	SUM
Column	string	Nombre del campo, correspondiente al nombre del campo de la tabla física.	具体的物理字段名
DataType	string	El tipo de datos del campo. Los tipos comunes incluyen number, string, date, datetime, time y geographic.	string
Granularity	string	La granularidad del campo de dimensión. Este campo se devuelve solo cuando el campo solicitado es una dimensión de fecha o geográfica, con los siguientes valores posibles: Granularidad de fecha: yearRegion (año), monthRegion (mes), weekRegion (semana), dayRegion (día), hourRegion (hora), minRegion (minuto), secRegion (segundo) Granularidad geográfica: COUNTRY (nivel de país), PROVINCE (nivel de provincia), CITY (nivel de ciudad), XIAN (nivel de distrito/condado), REGION (región)	yearRegion
Label	string	Alias del campo, que sirve como clave en la fila de datos de mapa del parámetro values.	area
Type	string	Tipo de campo, utilizado para distinguir entre campos de dimensión y de medida.	StandardDimension
Sql	string	El SQL de la solicitud de consulta.	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 '%华东%' 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 consultados que se devuelven.
	object	Filas y columnas de los datos devueltos. Este parámetro es una estructura List, donde cada Map representa una fila de datos. La clave en el Map corresponde al campo Headers#Label.	[{"area":"华东","city":"三明市"},{"area":"华东","city":"上海市"}]

Ejemplos

Respuesta exitosa

JSON Formato

{
  "Success": true,
  "RequestId": "78C1AA2D-9201-599E-A0BA-6FC462E57A95",
  "Result": {
    "Headers": [
      {
        "Aggregator": "SUM",
        "Column": "具体的物理字段名",
        "DataType": "string",
        "Granularity": "yearRegion",
        "Label": "area",
        "Type": "StandardDimension"
      }
    ],
    "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 '%华东%' GROUP BY COMPANY_T_1_.`area`, COMPANY_T_1_.`city` HAVING SUM(COMPANY_T_1_.`order_amt`) > 1 LIMIT 0, 10",
    "Values": [
      [
        {
          "area": "华东",
          "city": "三明市"
        },
        {
          "area": "华东",
          "city": "上海市"
        }
      ]
    ]
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	API.No.Permission	You are not authorized to call the data service API operation.
400	API.Not.Exist	The data service API operation does not exist.
400	Cube.Not.Exist	The Cube does not exist.
400	Invalid.Parameter.Conditions	The specified Conditions is invalid. %s is not defined.
400	Invalid.Parameter.ReturnFields	The specified returnFields is invalid. %s is not defined.
400	Missing.Conditions	The specified Conditions is invalid. You must specify %s.
400	Missing.Dimension.Measure	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.
400	Datasource.Sql.ExecuteFailed	Failed to execute the SQL statement in the data source.

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.