Gunakan QueryDatasetList untuk menanyakan dataset dalam ruang kerja - Quick BI - Alibaba Cloud - Quick BI

Mengueri dataset di workspace yang ditentukan. Hasilnya diurutkan dalam urutan menurun berdasarkan waktu pembuatan.

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

list

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	ID workspace.	95296e95-ca89-4c7d-8af9-dedf0ad0****
DirectoryId	string	No	ID folder. Jika Anda menentukan parameter ini, semua dataset dalam folder akan dikembalikan.	schemaad8aad00-9c55-4984-a767-b4e0ec60****
WithChildren	boolean	No	Menentukan apakah akan menyertakan dataset di subdirektori secara rekursif. Nilai yang valid: true: Mengembalikan semua dataset di folder yang ditentukan oleh DirectoryId dan subdirektorinya. false: Hanya mengembalikan dataset di folder yang ditentukan oleh DirectoryId.	true
Keyword	string	No	Kata kunci yang digunakan untuk mencari dataset berdasarkan nama.	test
PageNum	integer	No	Nomor halaman daftar dataset. Nilai awal: 1 Nilai default: 1	1
PageSize	integer	No	Jumlah entri yang akan dikembalikan di setiap halaman. Nilai default: 10 Nilai maksimum: 1000	10

Elemen respons

Element	Type	Description	Example
	object
Success	boolean	Menunjukkan apakah permintaan berhasil. Nilai yang valid: true: Permintaan berhasil. false: Permintaan gagal.	true
RequestId	string	ID permintaan.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	Hasil daftar dataset yang dipaginasi. Detail dataset dikembalikan dalam parameter Data.
Data	array<object>	Detail daftar dataset.
	array<object>
CreateTime	string	The time when the dataset was created.	2020-11-02 10:36:05
DataSource	object	The information about the data source to which the dataset belongs.
DsId	string	The data source ID.	261b252d-c3c3-498a-a0a7-5d1ec6cd****
DsName	string	The data source name.	test
DsType	string	The data source type.	mysql
DatasetId	string	The dataset ID.	5820f58c-c734-4d8a-baf1-7979af4f****
DatasetName	string	The dataset name.	company_sales_record_copy12
Description	string	The description of the dataset.	test
Directory	object	The information about the folder in which the dataset is located.
Id	string	The folder ID.	schemaad8aad00-9c55-4984-a767-b4e0ec60****
Name	string	The folder name.	test
PathId	string	The ID of the folder path.	schemaad8aad00-9c55-4984-a767-b4e0ec60****
PathName	string	The name of the folder path.	test
ModifyTime	string	The time when the dataset was last modified.	2020-11-02 10:36:05
OpenOfflineAcceleration	boolean	Indicates whether extraction-based acceleration is enabled. Valid values: true: Enabled false: Disabled	true
OwnerId	string	The user ID of the dataset owner in Quick BI.	136516262323****
OwnerName	string	The nickname of the dataset owner.	test
RowLevel	boolean	Indicates whether row-level permissions are enabled. Valid values: true: Enabled false: Disabled	true
WorkspaceId	string	The workspace ID.	95296e95-ca89-4c7d-8af9-dedf0ad06adf
WorkspaceName	string	The workspace name.	test
PageNum	integer	Nomor halaman.	1
PageSize	integer	Jumlah entri per halaman yang ditentukan dalam permintaan.	10
TotalNum	integer	Jumlah total entri.	1
TotalPages	integer	Jumlah total halaman.	1

Contoh

Respons sukses

JSONformat

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "CreateTime": "2020-11-02 10:36:05",
        "DataSource": {
          "DsId": "261b252d-c3c3-498a-a0a7-5d1ec6cd****",
          "DsName": "test",
          "DsType": "mysql"
        },
        "DatasetId": "5820f58c-c734-4d8a-baf1-7979af4f****",
        "DatasetName": "company_sales_record_copy12",
        "Description": "test",
        "Directory": {
          "Id": "schemaad8aad00-9c55-4984-a767-b4e0ec60****",
          "Name": "test",
          "PathId": "schemaad8aad00-9c55-4984-a767-b4e0ec60****",
          "PathName": "test"
        },
        "ModifyTime": "2020-11-02 10:36:05",
        "OpenOfflineAcceleration": true,
        "OwnerId": "136516262323****",
        "OwnerName": "test",
        "RowLevel": true,
        "WorkspaceId": "95296e95-ca89-4c7d-8af9-dedf0ad06adf",
        "WorkspaceName": "test"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.	The workspace is not owned by the organization.
400	CubeSchema.Not.Exist	The cube schema does not exist.	cube schema do not exists.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.