Referensi API QueryDashboardNl2sql-Quick BI-Alibaba Cloud - Quick BI

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

none

*Semua Sumber daya.

*

None

Sintaks permintaan

POST  HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
UserId	string	Yes	ID pengguna.	3d7ebb8***********500078f4
WorkspaceId	string	Yes	ID ruang kerja.	3d7ebb8***********500078f4

Elemen respons

Element	Type	Description	Example
	object	Skema Respons.
RequestId	string	ID permintaan.	46e537a5**,3dadsu**
Result	array<object>	Hasil eksekusi operasi API. Nilai valid: true: Permintaan berhasil. false: Permintaan gagal.
	object	Hasil eksekusi operasi API yang dikembalikan.
DashboardName	string	Nama dasbor.	612b
DashboardNl2sqlId	string	ID sumber daya NL2SQL dasbor.	sasdas****sawdau
OwnerId	string	ID pengguna pembuat dasbor.	46e5374665ba4b679ee22e2a2927****
Authorities	array	Izin pada sumber daya NL2SQL dasbor. Jika parameter ini memiliki nilai dan berisi READ, hal ini menunjukkan bahwa pengguna memiliki izin NL2SQL pada sumber daya NL2SQL dasbor.
	string	Izin pada sumber daya NL2SQL dasbor. Jika parameter ini memiliki nilai dan berisi READ, hal ini menunjukkan bahwa pengguna memiliki izin NL2SQL pada sumber daya NL2SQL dasbor.	READ
Success	boolean	Apakah permintaan berhasil. Nilai valid: true: Permintaan berhasil. false: Permintaan gagal.	true

Contoh

Respons sukses

JSONformat

{
  "RequestId": "46e537a5****,3dadsu****",
  "Result": [
    {
      "DashboardName": "612b",
      "DashboardNl2sqlId": "sasdas****sawdau",
      "OwnerId": "46e5374665ba4b679ee22e2a2927****",
      "Authorities": [
        "READ"
      ]
    }
  ],
  "Success": true
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	Internal.System.Error	An internal system error occurred.	Terjadi kesalahan sistem internal.
400	User.Not.In.Organization	The specified user is not in the organizational unit.	Pengguna tidak berada di organisasi.
400	Workspace.Not.Exist	The group workspace does not exist.	Ruang kerja kelompok tidak ada.
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.	Ruang kerja tidak berada di organisasi.
400	UserRoleConfig.NotContain.Function	The user %s does not have permission to operate.	Pengguna %s tidak memiliki izin untuk melakukan operasi.
400	User.NotIn.Workspace	The user is not a member of the group workspace.	Pengguna tidak berada di ruang kerja kelompok.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.