Manage whitelist masking data melalui API - DataWorks - Alibaba Cloud - DataWorks

Menambahkan atau memodifikasi daftar putih penyamaran data.

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

list

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
WhiteLists	array<object>	Yes	Sekumpulan daftar putih.
	object	No
RuleId	integer	Yes	ID aturan penyamaran data. Anda dapat memanggil operasi DsgDesensPlanQueryList untuk mengkueri ID aturan penyamaran data.	123
Id	integer	No	ID daftar putih penyamaran data. Jika Anda tidak mengonfigurasi parameter ini, operasi saat ini adalah menambahkan daftar putih penyamaran data. Jika Anda mengonfigurasi parameter ini, operasi saat ini adalah memodifikasi daftar putih penyamaran data. Anda dapat memanggil operasi DsgWhiteListQueryList untuk mengkueri ID daftar putih.	123
StartTime	string	Yes	Awal rentang waktu untuk dikueri.	2024-04-10 00:00:00
EndTime	string	No	Akhir rentang waktu untuk dikueri. Jika Anda memasukkan null, daftar putih berlaku secara permanen.	null
UserGroupIds	array	Yes	Sekumpulan ID grup pengguna.
	integer	No	ID grup pengguna. Anda dapat memanggil operasi DsgUserGroupQueryList untuk mengkueri ID grup pengguna.	123

Elemen respons

Element	Type	Description	Example
	object	Hasil yang dikembalikan.
Success	boolean	Menunjukkan apakah permintaan berhasil. Nilai yang valid: true false	true
ErrorCode	string	Kode kesalahan.	1029030003
ErrorMessage	string	Pesan kesalahan.	param error
HttpStatusCode	integer	Kode status HTTP.	400
Data	boolean	Hasil operasi. Nilai yang valid: true: Operasi berhasil. false: Operasi gagal.	true
RequestId	string	ID permintaan. Anda dapat menemukan log dan memecahkan masalah berdasarkan ID.	102400001

Contoh

Respons sukses

JSONformat

{
  "Success": true,
  "ErrorCode": "1029030003",
  "ErrorMessage": "param error",
  "HttpStatusCode": 400,
  "Data": true,
  "RequestId": "102400001"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	WHITELIST.DESENSID.ERROR	The desensitization rule ID does not match or does not exist with the tenant.	The scenario ID does not exist or does not belong to the tenant.
400	WHITELIST.ENDTIME.ERROR	end time cannot be earlier than start time.	The end time cannot be earlier than the start time.
400	WHITELIST.ID.ERROR	The whitelist ID does not match or does not exist with the tenant.	The whitelist ID does not exist or does not belong to the tenant.
400	WHITELIST.MCPROJECT.ERROR	The projectName on the bottom layer desensitization whitelist of MC cannot be empty.	ProjectName cannot be empty when creating MC desensitization whitelist
400	WHITELIST.PAGESIZE.ERROR	Page size is too large, maximum of 100.	Page size exceeded, cannot exceed 100
400	WHITELIST.SIZE.ERROR	The number of white list exceeds the limit.	Whitelist quantity exceeded
400	WHITELIST.STARTTIME.ERROR	start time cannot be earlier than today.	Start time cannot be earlier than today
400	WHITELIST.TIMEFORMAT.ERROR	The time format is incorrect, please use yyyy MM dd HH: mm: ss format.	The time parameter is formatted incorrectly. You need to use yyyy MM dd HH: mm: ss.
400	WHITELIST.USERGROUP.ERROR	The user group ID does not match or does not exist with the tenant.	The user group ID does not exist or does not belong to the tenant.
400	WHITELIST.USERGROUPEMPTY.ERROR	User group ID cannot be empty.	User group ID cannot be empty
400	WHITELIST.USERGROUPLISTSIZE.ERROR	The number of user group exceeds the limit.	The number of user groups exceeds the limit.
400	PARAMS.ERROR	param error.
500	UNKNOWN.ERROR	unknown error.	Unknown error.
403	PERMISSION.DENIED.ERROR	Permission denied	Insufficient permissions.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.