Gunakan API AddWorkspaceUsers untuk menambahkan pengguna secara batch ke workspace - Quick BI - Alibaba Cloud - Quick BI

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

quickbi-public:AddWorkspaceUsers

create

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	ID ruang kerja.	95296e95-ca89-4c7d-8af9-dedf0ad0****
UserIds	string	Yes	ID pengguna. Ini adalah UserID untuk Quick BI, bukan UID Alibaba Cloud. Mendukung parameter batch, dengan ID pengguna dipisahkan oleh koma (,).	de4bc5f9429141cc8091cdd1c15b****
RoleId	integer	Yes	ID peran ruang kerja preset. Rentang nilai: 25: Administrator Ruang Kerja 26: Developer Ruang Kerja 27: Analis Ruang Kerja 30: Peninjau Ruang Kerja.	25

Elemen respons

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request was successful. Value range: true: The request was successful. There may be cases where some members are added successfully and others fail. For the reasons of failure, refer to the FailureDetail in the response. false: The request failed, and no data will be persisted.	true
RequestId	string	Request ID.	7AAB95D7-2E11-4FE2-94BC-858E4FC0C976
Result	object	Returns the result of the API execution.
Failure	integer	Number of users that failed to be added.	2
FailureDetail	object	Reasons for the failures.	{"2046274934845893" : "AE0150010001: This user already exists.", "1213444447906552" : "AE0150010001: This user already exists."}
Success	integer	Number of users that were added successfully.	1
Total	integer	Total number of users being added.	3

Contoh

Respons sukses

JSONformat

{
  "Success": true,
  "RequestId": "7AAB95D7-2E11-4FE2-94BC-858E4FC0C976",
  "Result": {
    "Failure": 2,
    "FailureDetail": {
      "2046274934845893": "AE0150010001: This user already exists.",
      "1213444447906552": "AE0150010001: This user already exists."
    },
    "Success": 1,
    "Total": 3
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.
400	User.RoleType.Valid	The role ID is invalid.
400	Viewer.CannotHave.CustomRole	Organization viewer cannot have custom roles.
400	UserAnalyst.NotSupport.ThisRole	This role has permissions that analysts cannot grant.
400	Workspace.Not.Exist	The group workspace does not exist.
400	ApiUser.Not.Exists	The specified user does not exist.
400	Viewer.AddInTo.Workspace	Organization members with viewer type are not allowed to add to workspace: %s.
400	User.AlreadyIn.Workspace	This user already exists.
400	User.AlreadyIn.Role	The user is already assigned this role.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.