Buat Dataset Quick BI dari Custom SQL melalui API CreateCubeBySql - Quick BI - Alibaba Cloud - Quick BI

Membuat set data berdasarkan pernyataan SQL kustom.

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

create

*All Resource

*

None

Sintaks permintaan

POST  HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
CustomSql	string	Yes	Pernyataan SQL kustom.	select * from qqq
Caption	string	Yes	Nama set data kustom.	test
DsId	string	Yes	ID sumber data.	7AAB95D-***-*-4FC0C976
WorkspaceId	string	Yes	ID ruang kerja.	95296e95-ca89-4c7d-8af9-dedf0ad0****
UserId	string	Yes	UserId pengguna Quick BI yang memiliki izin untuk membuat set data. Ini bukan ID akun Alibaba Cloud Anda. Anda dapat memanggil operasi QueryUserInfoByAccount untuk mendapatkan UserId.	asdaf-asda*****asd
Placeholders	string	No	Parameter placeholder. Untuk informasi lebih lanjut, lihat deskripsi tambahan di bawah.	[ { "name": "test", "style": "placeholder", "type": "string" } ]

Struktur PlaceholderModel placeholder

uniqueId -- string, opsional. ID unik placeholder. Anda tidak perlu menentukan parameter ini saat membuat set data. Meskipun ditentukan, parameter ini tidak digunakan. (Bidang ini digunakan saat pembaruan.)
name -- string, wajib. Nama placeholder. Harus unik.
style -- string, wajib. Tipe placeholder.
- Placeholder ekspresi: param
- Placeholder nilai: placeholder
- Placeholder kondisi: condition
type -- String. Tipe variabel placeholder.
- Teks: string
- Numerik: number
- Tanggal: lihat deskripsi format di bawah
useInGlobal -- Boolean, opsional. Apakah akan membuat placeholder berlaku secara global. Nilai default: false.
- Ya: true
- Tidak: false
defaultValue -- List, opsional. Nilai default placeholder. Tipe placeholder shipping_date_ph.get(0) hanya mendukung 0 atau 2 nilai default. Tipe placeholder lain hanya mendukung 0 atau 1 nilai default.
format -- String, opsional. Format tipe tanggal. (Lihat deskripsi format di bawah.)
originalType -- String, opsional. Jika placeholder nilai adalah tipe tanggal shipping_date_ph.get(0), tetapkan originalType ke dateRange. Parameter ini tidak perlu ditetapkan dalam kasus lain.
conditionPlaceHolderFields -- List, opsional. Bidang placeholder kondisi. Konfigurasikan parameter ini hanya untuk placeholder kondisi.

Struktur ConditionPlaceHolderFields

uniqueId -- String, opsional. ID unik bidang placeholder kondisi. Anda tidak perlu menentukan parameter ini saat membuat set data. Sistem menghasilkan nilai secara otomatis.
column -- String, wajib. Nama bidang fisik.

Pemetaan antara style dan type untuk placeholder ekspresi

Tipe variabel ### Nilai type yang sesuai.

Teks string
Numerik number
Tanggal-Tahun yearRegion
Tanggal-Tahun-Kuartal quarterRegion
Tanggal-Tahun-Bulan monthRegion
Tanggal-Tahun-Minggu weekRegion
Tanggal-Tahun-Bulan-Hari dateRegion
Tanggal-Tahun-Bulan-Hari-Jam-Menit-Detik ymdHmsRegion

Pemetaan antara style, type, dan format untuk placeholder nilai (kosong berarti tidak wajib)

Tipe variabel ### Nilai type yang sesuai ### format.

Teks string (tidak didukung untuk tipe tanggal shipping_date_ph.get(0))
Numerik number (tidak didukung untuk tipe tanggal shipping_date_ph.get(0))
Tanggal-Tahun yearRegion
Tanggal-Tahun-Kuartal quarterRegion
Tanggal-Tahun-Bulan monthRegion Pilih salah satu dari tiga format berikut: YYYY-MM, YYYYMM, atau YYYY/MM
Tanggal-Tahun-Minggu weekRegion
Tanggal-Tahun-Bulan-Hari dateRegion Pilih salah satu dari tiga format berikut: YYYY-MM-DD, YYYYMMDD, atau YYYY/MM/DD
Tanggal-Tahun-Bulan-Hari-Jam-Menit-Detik ymdHmsRegion Pilih salah satu dari empat format berikut: YYYY-MM-DD HH:MI:SS, YYYYMMDD HH:MI:SS, YYYY/MM/DD HH:MI:SS, atau YYYYMMDDHHMISS

Pemetaan antara style dan type untuk placeholder kondisi

Tipe variabel ### Nilai type yang sesuai.

Teks string.

Elemen respons

Element	Type	Description	Example
	object	Skema Respons.
RequestId	string	ID permintaan.	05739b************02522b9
Result	string	Hasil eksekusi operasi. Nilai valid: true: Permintaan berhasil. false: Permintaan gagal.	true
Success	boolean	Apakah permintaan berhasil. Nilai valid: true: Permintaan berhasil. false: Permintaan gagal.	true

Contoh

Respons sukses

JSONformat

{
  "RequestId": "05739b************02522b9",
  "Result": "true",
  "Success": true
}

Kode kesalahan

HTTP status code	Error code	Error message
400	Internal.System.Error	An internal system error occurred.
400	Invalid.User.Organization	The user is not in your organization.
400	User.NotIn.Workspace	The user is not in this workspace.
400	Invalid.Workspace	The workspace is not owned by the organization.
400	Datasource.NotFound.Error	The specified data source does not exist: %s.
400	DatasourceId.IsNull.Error	You must select a data source before selecting the table.
400	Name.RegularExpression.Error	Name format validation failed.
400	NameExceeded.MaxLength.Error	The name cannot exceed %s characters in length.
400	Cube.DuplicatedName.Error	The dataset name already exists. Modify the name before saving.
400	Directory.NotExist.Error	The directory does not exist.
400	Xengnie.TaskExecute.Error	Fail to execute task %s.
400	Datasource.Sql.ExecuteFailed	Failed to execute the SQL statement in the data source.
400	Placeholder.Date.Illegal	The placeholder date format is illegal.
400	Placeholder.DefaultValue.Invalid	Invalid placeholder default value.
400	Placeholder.FieldNot.Empty	Condition placeHolder field not empty.
400	Placeholder.Style.Illegal	Illegal placeholder style.
400	Placeholder.Type.Illegal	Illegal placeholder type.
400	Placeholder.UniqueId.Duplicate	Sql placeholder uniqueId duplicate.
400	PlaceholderName.Duplicate.Error	Sql placeholder name duplicate.
400	PlaceholderName.NotMatch.Error	The parsing and input placeholder names do not match.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.