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

Calls an API created in Data Service.

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

Before you begin

You have created an API in the Data Service of Quick BI. For more information, see Data Service.

Limits

The Data Service feature is available only to Professional Edition users.
When you invoke a Data Service API, the timeout period is 60 seconds, and the queries per second (QPS) limit for a single API is 10.
If row-level permissions are enabled for the dataset referenced by a Data Service API, the request may be blocked by the row-level access policy when you invoke the API.

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 ID of the API in Data Service. For more information, see Data Service.	f4cc43bc3***
Conditions	string	No	The query conditions for Data Service, passed in key-value pairs. The value is a string of the map type. The key is the name of the request parameter, and the value is the value of the request parameter. Keys and values must appear in pairs. Note: When the operator of a request parameter is set to enumeration filter, the value can contain multiple values. In this case, the value must be a JSON-formatted list. Example: `area=["East China","North China","South China"]` For dates, different input formats are provided based on the type: Year: 2019 Quarter: 2019Q1 Month: 201901 (including the 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": ["East China", "North China"], "shopping_date": "2019Q1", }
ReturnFields	string	No	The list of return parameter names. The value is a string of the list type.	["area", "city", "price", "date"]

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.	true
RequestId	string	The ID of the request.	78C1AA2D-9201-599E-A0BA-6FC462E57A95
Result	object	The query result returned by the API.
Headers	array<object>	The column headers.
	object
Aggregator	string	The aggregation operator. This field is available only for measure fields, such as SUM, AVG, and MAX.	SUM
Column	string	The field name, which corresponds to the physical table field name.	Specific physical field name
DataType	string	The data type of the field. Common values include number, string, date, datetime, time, and geographic.	string
Granularity	string	The granularity of the dimension field. This field is returned only when the requested field is a date dimension or geographic dimension field. Valid values: Date granularity: yearRegion (year), monthRegion (month), weekRegion (week), dayRegion (day), hourRegion (hour), minRegion (minute), and secRegion (second). Geographic granularity: COUNTRY (country level), PROVINCE (province level), CITY (city level), XIAN (district/county level), and REGION (region level).	yearRegion
Label	string	The alias of the field, which is the key of the map data row in the Values result parameter.	area
Type	string	The field type, which is used to distinguish whether the field is a dimension or a measure.	StandardDimension
Sql	string	The SQL statement of the query request.	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 '%East China%' 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 returned query results.
	object	The rows and columns of the returned data. This parameter is of the List structure, where each map represents a row of data. The keys in the map correspond to the Label field in Headers.	[{"area":"East China","city":"Sanming"},{"area":"East China","city":"Shanghai"}]

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "78C1AA2D-9201-599E-A0BA-6FC462E57A95",
  "Result": {
    "Headers": [
      {
        "Aggregator": "SUM",
        "Column": "The alias of the field. The key of the map data row in the result parameter values.",
        "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_   LIMIT 0, 10",
    "Values": [
      [
        {
          "area": "west",
          "city": "asd"
        },
        {
          "area": "wesd",
          "city": "sdfa"
        }
      ]
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
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.	Failed to execute SQL on the data source.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.