AddWorkspaceUsers - Quick BI - Centro de documentación de Alibaba Cloud

Agrega miembros a un espacio de trabajo por lotes.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

quickbi-public:AddWorkspaceUsers

create

*Todos los recursos.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
WorkspaceId	string	Sí	El ID del espacio de trabajo.	95296e95-ca89-4c7d-8af9-dedf0ad0****
UserIds	string	Sí	Los ID de usuario. Estos son ID de usuario de Quick BI, no los UID de Alibaba Cloud. Puede especificar varios ID de usuario separados por comas (,).	de4bc5f9429141cc8091cdd1c15b****
RoleId	integer	Sí	El ID del rol preestablecido del espacio de trabajo. Valores válidos: 25: administrador de gestión de almacenamiento 26: desarrollador del espacio de trabajo 27: analista de análisis de almacenamiento 30: visor del espacio de trabajo Valores válidos: 25 : Administrador. 26 : Desarrollador. 27 : Analista. 30 : Visor.	25

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
Success	boolean	Indica si la solicitud es correcta. Valores válidos: true: la solicitud es correcta. Algunos miembros pueden agregarse correctamente, mientras que otros pueden fallar. Para conocer los motivos de los errores, consulte FailureDetail en la respuesta. false: la solicitud falló. No se persisten datos.	true
RequestId	string	El ID de la solicitud.	7AAB95D7-2E11-4FE2-94BC-858E4FC0C976
Result	object	El resultado de la ejecución de la operación.
Failure	integer	El número de usuarios que no se pudieron agregar.	2
FailureDetail	object	Los motivos de los errores.	{"2046274934845893" : "AE0150010001: Este usuario ya existe.", "1213444447906552" : "AE0150010001: Este usuario ya existe."}
Success	integer	El número de usuarios que se agregaron.	1
Total	integer	El número total de usuarios que se van a agregar.	3

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.	El espacio de trabajo no pertenece a la organización.
400	User.RoleType.Valid	The role ID is invalid.	El ID del rol no es válido.
400	Viewer.CannotHave.CustomRole	Organization viewer cannot have custom roles.	Los visitantes de la organización no pueden tener roles personalizados.
400	UserAnalyst.NotSupport.ThisRole	This role has permissions that analysts cannot grant.	El rol tiene permisos que un analista no puede otorgar.
400	Workspace.Not.Exist	The group workspace does not exist.	El espacio de trabajo de grupo no existe.
400	ApiUser.Not.Exists	The specified user does not exist.	El usuario no existe.
400	Viewer.AddInTo.Workspace	Organization members with viewer type are not allowed to add to workspace: %s.	No se pueden agregar usuarios de tipo invitado de la organización al espacio de trabajo: %s.
400	User.AlreadyIn.Workspace	This user already exists.	El usuario ya existe en el espacio de trabajo.
400	User.AlreadyIn.Role	The user is already assigned this role.	El usuario ya tiene el rol especificado.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.