Gunakan ListFolders untuk kueri folder - DataWorks - Alibaba Cloud -

Mengkueri folder.

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

dataworks:*

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ProjectId	integer	No	ID ruang kerja DataWorks. Masuk ke Konsol DataWorks dan buka halaman Workspace Management untuk mendapatkan ID ruang kerja. Anda harus menetapkan parameter ini atau ProjectIdentifier untuk menentukan ruang kerja DataWorks pada pemanggilan API ini.	10000
ProjectIdentifier	string	No	Nama ruang kerja DataWorks. Masuk ke Konsol DataWorks dan buka halaman Workspace Management untuk mendapatkan nama ruang kerja. Anda harus menetapkan parameter ini atau ProjectId untuk menentukan ruang kerja DataWorks pada pemanggilan API ini.	dw_project
ParentFolderPath	string	Yes	Jalur folder induk.	Business_process/my_first_business_process/MaxCompute
PageNumber	integer	Yes	Nomor halaman. Parameter ini digunakan untuk paginasi.	1
PageSize	integer	Yes	Jumlah entri per halaman. Nilai default: 10. Nilai maksimum: 100.	10

Elemen respons

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
ErrorMessage	string	The error message.	The connection does not exist.
RequestId	string	The ID of the request. Use this ID to troubleshoot issues.	0000-ABCD-****
ErrorCode	string	The error code.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indicates whether the operation is successful.	true
Data	object	A list of folders that meet the specified criteria.
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries on the returned page.	10
TotalCount	integer	The total number of entries that meet the filter criteria.	13
Folders	array<object>	A list of folders.
	object
FolderPath	string		Business_process/my_first_business_process/MaxCompute/ods_layer
FolderId	string		2735c2****

Contoh

Respons sukses

JSONformat

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 13,
    "Folders": [
      {
        "FolderPath": "Business_process/my_first_business_process/MaxCompute/ods_layer",
        "FolderId": "2735c2****"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.