Daftar ruang kerja DataWorks melalui API ListProjects - DataWorks - Alibaba Cloud - DataWorks

Mengkueri daftar ruang kerja DataWorks dari tenant tempat akun Anda berada.

Deskripsi operasi

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

list

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Ids	array	No	ID ruang kerja DataWorks.
	integer	No	ID ruang kerja DataWorks. Anda dapat masuk ke konsol DataWorks dan buka halaman Ruang Kerja untuk mengkueri ID.	123456
Names	array	No	Nama ruang kerja DataWorks.
	string	No	Nama ruang kerja DataWorks. Anda dapat masuk ke konsol DataWorks dan buka halaman Ruang Kerja untuk mengkueri nama.	sora_finance
AliyunResourceGroupId	string	No	ID grup sumber daya Alibaba Cloud tempat ruang kerja berada. Anda dapat masuk ke konsol Resource Management dan buka halaman Grup Sumber Daya untuk mengkueri ID. Parameter ini digunakan untuk mengkueri informasi tentang ruang kerja yang termasuk dalam grup sumber daya tertentu.	rg-acfmzbn7pti3zff
Status	string	No	Status ruang kerja. Nilai yang valid: Available Initializing InitFailed Forbidden Deleting DeleteFailed Frozen Updating UpdateFailed	Available
DevEnvironmentEnabled	boolean	No	Menentukan apakah lingkungan pengembangan diaktifkan. Nilai yang valid: true: Lingkungan pengembangan diaktifkan. Dalam hal ini, lingkungan pengembangan terisolasi dari lingkungan produksi dalam suatu ruang kerja. false: Lingkungan pengembangan dinonaktifkan. Dalam hal ini, hanya lingkungan produksi yang digunakan dalam suatu ruang kerja.	true
DevRoleDisabled	boolean	No	Menentukan apakah peran Develop dinonaktifkan. Nilai yang valid: false (default) true	false
PaiTaskEnabled	boolean	No	Menentukan apakah penjadwalan task Platform for AI (PAI) diaktifkan. Nilai yang valid: true: Penjadwalan task PAI diaktifkan. Dalam hal ini, Anda dapat membuat node PAI di ruang kerja DataWorks dan mengonfigurasi properti penjadwalan untuk node tersebut guna mengimplementasikan penjadwalan periodik task PAI. false: Penjadwalan task PAI dinonaktifkan.	true
AliyunResourceTags	array<object>	No	Tag.
	object	No	Tag. Anda dapat masuk ke konsol Resource Management dan buka halaman Tag untuk mengkueri kunci tag dan nilai tag.
Key	string	No	Kunci tag.	batch
Value	string	No	Nilai tag.	blue
PageNumber	integer	No	Nomor halaman.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai default: 10. Nilai maksimum: 100.	10

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
RequestId	string	ID permintaan.	6D24AD9A-652F-59E2-AC1F-05029300F8A4
PagingInfo	object	Informasi pagination.
PageSize	integer	Jumlah entri per halaman.	1
PageNumber	integer	Nomor halaman.	10
TotalCount	integer	Total jumlah entri yang dikembalikan.	100
Projects	array<object>	Ruang kerja.
	array<object>	Ruang kerja.
Id	integer	The workspace ID.	123456
Name	string	The name of the workspace.	sora_finance
DisplayName	string	The display name of the workspace.	Sora financial analysis
Description	string	The description of the workspace.	Financial analysis group project data development
Owner	string	The ID of the Alibaba Cloud account to which the workspace belongs.	123532153125
AliyunResourceGroupId	string	The ID of the Alibaba Cloud resource group to which the workspace belongs.	rg-acfmzbn7pti3zfa
Status	string	The status of the workspace. Valid values: Available Initializing InitFailed Forbidden Deleting DeleteFailed Frozen Updating UpdateFailed	Available
PaiTaskEnabled	boolean	Indicates whether scheduling of PAI tasks is enabled. Valid values: true: Scheduling of PAI tasks is enabled. In this case, you can create a PAI node in a DataWorks workspace and configure scheduling properties for the node to implement periodic scheduling of PAI tasks. false: Scheduling of PAI tasks is disabled.	true
DevEnvironmentEnabled	boolean	Indicates whether the development environment is enabled. Valid values: true: The development environment is enabled. In this case, the development environment is isolated from the production environment in the workspace. false: The development environment is disabled. In this case, only the production environment is used in the workspace.	true
DevRoleDisabled	boolean	Indicates whether the Develop role is disabled. Valid values: false (default) true	false
AliyunResourceTags	array<object>	The tags.
	object	The tag.
Key	string	The tag key.	batch
Value	string	The tag value.	blue

Contoh

Respons sukses

JSONformat

{
  "RequestId": "6D24AD9A-652F-59E2-AC1F-05029300F8A4",
  "PagingInfo": {
    "PageSize": 1,
    "PageNumber": 10,
    "TotalCount": 100,
    "Projects": [
      {
        "Id": 123456,
        "Name": "sora_finance",
        "DisplayName": "Sora financial analysis\n",
        "Description": "Financial analysis group project data development",
        "Owner": "123532153125",
        "AliyunResourceGroupId": "rg-acfmzbn7pti3zfa",
        "Status": "Available",
        "PaiTaskEnabled": true,
        "DevEnvironmentEnabled": true,
        "DevRoleDisabled": false,
        "AliyunResourceTags": [
          {
            "Key": "batch",
            "Value": "blue"
          }
        ]
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.