Invoke a data service API - Quick BI:QueryDataService - Alibaba Cloud - Quick BI

Invokes a data service API created in Quick BI.

Note

This API has been deprecated. We recommend migrating to quickbi-public(2022-01-01) - QueryData for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

Operation description

Prerequisites

Create a data service API in Quick BI. For more information, see Data Service.

Usage Restrictions

The data service feature is available only to Professional edition users.
The timeout for data service API calls is 60s, and the QPS limit for a single API is 10 requests per second.
If row-level permissions are enabled on the dataset that the data service API references, the API call may be blocked by the row-level permission policy.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

quickbi-public:QueryDataService

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ApiId	string	Yes	The API ID in the data service. For more information, see Data Service.	f4cc43bc3***
Conditions	string	No	Query conditions for the data service, specified as key-value pairs in a map-type string. The key is the request parameter name and the value is the request parameter value. Keys and values must appear in pairs. Note: When the operator of the request parameter is set to enumeration filter, the value can contain multiple values, formatted as a JSON list. For example: `area=["East China","North China","South China"]` Date values use different formats depending on the granularity: Year: 2019 Quarter: 2019Q1 Month: 201901 (with leading zero) Week: 2019-52 Day: 20190101 Hour: 14:00:00 (minutes and seconds are 00) Minute: 14:12:00 (seconds are 00) Second: 14:34:34	{ "area": ["华东", "华北"], "shopping_date": "2019Q1", }
ReturnFields	string	No	A list of parameter names to return, specified as a List-type string.	["area", "city", "price", "date"]

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request was successful. Possible values: true: The request was successful false: The request failed	true
RequestId	string	The request ID.	78C1AA2D-9201-599E-A0BA-6FC462E57A95
Result	object	The query result.
Headers	array<object>	Column headers.
	object
Aggregator	string	Aggregation operator. Only present for measure fields, such as SUM, AVG, and MAX.	SUM
Column	string	The field name, which corresponds to the physical table field name.	具体的物理字段名
DataType	string	The data type of the field, such as number, string, date, datetime, time, or geographic.	string
Granularity	string	The granularity of the dimension field. Returned only when the requested field is a date or geographic dimension. Possible values: Date granularity: yearRegion (year), monthRegion (month), weekRegion (week), dayRegion (day), hourRegion (hour), minRegion (minute), secRegion (second) Geographic granularity: COUNTRY (country level), PROVINCE (province level), CITY (city level), XIAN (district/county level), REGION (region)	yearRegion
Label	string	The field alias, used as the key in each map data row of the Values parameter.	area
Type	string	The field type, which distinguishes dimension fields from measure fields.	StandardDimension
Sql	string	The SQL statement of the query.	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>	The query results.
	object	Rows and columns of the returned data. This parameter uses a List<Map> structure where each Map represents a row of data. The key in each Map corresponds to the Headers#Label field.	[{"area":"华东","city":"三明市"},{"area":"华东","city":"上海市"}]

Examples

Success response

JSON format

{
  "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": "上海市"
        }
      ]
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.