Ringkasan API ListProjectRoles untuk Manajemen Role Workspace - DataWorks - Alibaba Cloud - DataWorks

Mengembalikan daftar role yang dipaginasi dalam sebuah workspace.

Deskripsi operasi

Fitur ini tersedia di DataWorks Basic Edition dan yang lebih tinggi.

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

list

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	ID workspace DataWorks. Anda dapat menemukan ID tersebut di halaman Workspace Management pada konsol DataWorks. Parameter ini menentukan workspace DataWorks yang ingin Anda tampilkan daftar role-nya.	21229
Codes	array	No	Array berisi kode role workspace.
	string	No	Kode dari sebuah role workspace. `role_project_admin`: Workspace Admin `role_project_dev`: Developer `role_project_dg_admin`: Data Governance Admin `role_project_guest`: Guest `role_project_security`: Security Admin `role_project_deploy`: Deployer `role_project_owner`: Workspace Owner `role_project_data_analyst`: Data Analyst `role_project_pe`: O&M `role_project_erd`: Model Designer	role_project_guest
Names	array	No	Array berisi nama role workspace.
	string	No	Nama dari sebuah role workspace.	Visitors
Type	string	No	Tipe role workspace. `UserCustom`: Custom Role `System`: System Role	System
PageNumber	integer	No	Nomor halaman yang akan dikembalikan.	1
PageSize	integer	No	Jumlah entri yang dikembalikan per halaman. Nilai default: 10. Nilai maksimum: 100.	10

Elemen respons

Element	Type	Description	Example
	object	Skema respons.
RequestId	string	ID permintaan. Gunakan ID ini untuk menemukan log dan memecahkan masalah.	61649187-0BCF-5E75-8D4B-64FDBEBBB447
PagingInfo	object	Informasi paginasi.
PageSize	string	Jumlah entri per halaman.	10
PageNumber	string	Nomor halaman yang dikembalikan.	1
TotalCount	string	Jumlah total entri yang cocok.	42
ProjectRoles	array<object>	Daftar role workspace.
	array<object>	Detail dari sebuah role workspace.
ProjectId	integer	The DataWorks workspace ID.	21229
Code	string	The code of the role in the DataWorks workspace.	role_project_guest
Name	string	The name of the role.	Visitors
Type	string	The type of the role in the DataWorks workspace.	System
ModulePermissions	array<object>
	object
ModuleId	integer		2
ModuleName	string		HoloStudio
PermissionType	string		Read

Contoh

Respons sukses

JSONformat

{
  "RequestId": "61649187-0BCF-5E75-8D4B-64FDBEBBB447",
  "PagingInfo": {
    "PageSize": "10",
    "PageNumber": "1",
    "TotalCount": "42",
    "ProjectRoles": [
      {
        "ProjectId": 21229,
        "Code": "role_project_guest\n",
        "Name": "Visitors",
        "Type": "System",
        "ModulePermissions": [
          {
            "ModuleId": 2,
            "ModuleName": "HoloStudio",
            "PermissionType": "Read"
          }
        ]
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.