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

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Sintaks permintaan

POST  HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
UserId	string	Yes	ID Pengguna.	3d7ebb8***********500078f4
WorkspaceId	string	Yes	ID Workspace.	3d7ebb8***********500078f4

Elemen respons

Element	Type	Description	Example
	object	Skema Respons
RequestId	string	ID Permintaan.	46e537a5**,3dadsu**
Result	array<object>	Hasil eksekusi API. Nilai yang mungkin: true: Permintaan berhasil false: Permintaan gagal
	object	Mengembalikan hasil eksekusi API.
DashboardName	string	Nama dashboard	612b
DashboardNl2sqlId	string	ID sumber daya pertanyaan dashboard	sasdas****sawdau
OwnerId	string	UserID pembuat dashboard	46e5374665ba4b679ee22e2a2927****
Authorities	array	Jika parameter ini memiliki nilai dan mencakup "READ", ini menandakan bahwa pengguna memiliki izin baca untuk sumber daya pertanyaan dashboard.
	string	Jika parameter ini memiliki nilai dan mencakup "READ", ini menandakan bahwa pengguna memiliki izin baca untuk sumber daya pertanyaan dashboard.	READ
Success	boolean	Menandakan apakah permintaan berhasil. Nilai yang mungkin: 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.	An internal system error occurred.
400	User.Not.In.Organization	The specified user is not in the organizational unit.	The specified user is not in the organizational unit.
400	Workspace.Not.Exist	The group workspace does not exist.	The group workspace does not exist.
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.	The workspace is not owned by the organization.
400	UserRoleConfig.NotContain.Function	The user %s does not have permission to operate.	The user %s does not have permission to operate.
400	User.NotIn.Workspace	The user is not a member of the group workspace.	The user is not a member of the group workspace.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.