Gunakan API QueryData melalui DataService Studio untuk Akses Aman - Quick BI - Alibaba Cloud - Quick BI

Memanggil API Studio Layanan Data untuk mengkueri data.

Deskripsi operasi

Prerequisites

Create an API in DataService Studio before calling this operation.

Limits

Requires Quick BI Professional Edition.
API call timeout: 60s. QPS limit per API: 10.
Row-level permissions on the referenced dataset also apply to API calls.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

quickbi-public:QueryData

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ApiId	string	Yes	ID API di Studio Layanan Data.	f4cc43bc3***
UserId	string	No	ID pengguna Quick BI. Dapatkan nilai ini dari QueryUserInfoByAccount. Catatan Menentukan identitas pengguna untuk Studio Layanan Data, digunakan bersama konfigurasi izin tingkat baris dan kolom. Penting Jika dihilangkan, kosong, atau null, nilai default adalah ID pengguna pemilik organisasi Quick BI. .	b5d8fd9348cc4327****afb604
Conditions	string	No	Kondisi filter sebagai string peta JSON. Setiap kunci adalah nama parameter permintaan, dan setiap nilai adalah nilai parameter. Catatan: Jika operator parameter permintaan diatur ke Enumeration Filter, nilai dapat berisi beberapa nilai. Dalam hal ini, nilai harus dalam format daftar JSON. Contoh: `area=["East China","North China","South China"]` Untuk tanggal, gunakan format berikut berdasarkan tipe tanggal: Tahun: 2019 Kuartal: 2019Q1 Bulan: 201901 (dengan nol di depan) Minggu: 2019-52 Hari: 20190101 Jam: 14:00:00 (menit dan detik adalah 00) Menit: 14:12:00 (detik adalah 00) Detik: 14:34:34.	{ "area": ["test", "test"], "shopping_date": "2019Q1", }
ReturnFields	string	No	Array JSON nama bidang yang akan dikembalikan.	["area", "city", "price", "date"]

Elemen respons

Element	Type	Description	Example
	object
Success	boolean	Whether the request succeeded. Valid values: true: The request was successful. false: The request failed.	true
RequestId	string	The request ID.	a4d1a221d-41za1-****
Result	object	The result of the API call. Valid values: true: The call was successful. false: The call failed.
Headers	array<object>	The column headers.
	object	Column headers.
Aggregator	string	The aggregate operator. This parameter is returned only for measure fields, such as SUM, AVG, and MAX. SUM: The sum. MAX: The maximum value. MIN: The minimum value. AVG: The average value. COUNT: The count. COUNTD: The count of unique values. STDDEV_POP: The population standard deviation. STDDEV_SAMP: The sample standard deviation. VAR_POP: The population variance. VAR_SAMP: The sample variance.	SUM
Column	string	The field name. It corresponds to the field name in the physical table.	test
DataType	string	The data type of the field. Common types include the following: number string date time datetime	string
Granularity	string	The granularity of the dimension field. This parameter is returned only when the requested field is a date dimension or a geographic dimension. Valid values: Date granularity: yearRegion (year), monthRegion (month), weekRegion (week), dayRegion (day), hourRegion (hour), minRegion (minute), secRegion (second) Geographic granularity: COUNTRY (country), PROVINCE (province), CITY (city), XIAN (county/district), REGION (region)	REGION
Label	string	The alias of the field. It is the key for the map data row in the values result parameter.	area
Type	string	The field type. It indicates whether the field is a dimension or a measure. Dimension Measure	Dimension
OriginalColumn	string	The original name of the corresponding field in the dataset.	area
Sql	string	The SQL statement for the query. Catatan The returned SQL includes both the filter conditions from this call and any row-level or column-level permission rules.	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>	The query results.
	object	The returned data rows. Each map represents one row, with keys corresponding to the `Headers#Label` field.	[{"area":"test","city":"test"},{"area":"test","city":"test"}]

Contoh

Respons sukses

JSONformat

{
  "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"
        }
      ]
    ]
  }
}

Kode kesalahan

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.
400	DataService.InputParam.Error	input parameter error: %s.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.