Ringkasan API ListProjectRoles untuk Manajemen Role Workspace - DataWorks

Deskripsi operasi

Operasi API ini tersedia untuk semua edisi DataWorks.

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

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	ID ruang kerja DataWorks. Anda dapat login ke DataWorks console dan membuka halaman Workspace untuk mengetahui ID tersebut. Anda harus mengonfigurasi parameter ini untuk menentukan ruang kerja DataWorks tempat operasi API ini diterapkan.	21229
Codes	array	No	Kode role di ruang kerja DataWorks.
	string	No	Kode role di ruang kerja DataWorks. Nilai yang valid: role_project_admin: administrator ruang kerja role_project_dev: developer role_project_dg_admin: administrator tata kelola data role_project_guest: pengunjung role_project_security: administrator keamanan role_project_deploy: deployer role_project_owner: pemilik ruang kerja role_project_data_analyst: analis data role_project_pe: insinyur O&M role_project_erd: desainer model	role_project_guest
Names	array	No	Nama role di ruang kerja DataWorks.
	string	No	Nama role di ruang kerja DataWorks.	Visitors
Type	string	No	Tipe role. Nilai yang valid: UserCustom: role yang ditentukan pengguna System: role sistem	System
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.	61649187-0BCF-5E75-8D4B-64FDBEBBB447
PagingInfo	object	Informasi paginasi.
PageSize	string	Jumlah entri per halaman.	10
PageNumber	string	Nomor halaman.	1
TotalCount	string	Total jumlah entri yang dikembalikan.	42
ProjectRoles	array<object>	Role di ruang kerja DataWorks.
	object	Role di ruang kerja DataWorks.
ProjectId	integer	ID ruang kerja DataWorks.	21229
Code	string	Kode role di ruang kerja DataWorks.	role_project_guest
Name	string	Nama role.	Visitors
Type	string	Tipe role di ruang kerja DataWorks.	System

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"
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.