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

Obtiene la lista de usuarios bajo el rol de espacio de trabajo especificado.

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

list

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RoleId	integer	Sí	El ID del rol de espacio de trabajo, que incluye roles predefinidos y roles personalizados: 25: Administrador de espacio de trabajo (rol predefinido) 26: Desarrollador (rol predefinido) 27: Analista (rol predefinido) 30: Visor (rol predefinido) Roles personalizados: El ID de rol correspondiente para los roles personalizados	25
WorkspaceId	string	No	El ID del espacio de trabajo. Este parámetro es opcional. Si no configura este parámetro, se devuelven los roles de todos los espacios de trabajo.	726bee5a-****-43e1-9a8e-b550f0120f35
PageNum	integer	No	El número de página actual para la paginación: Valor inicial: 1 Valor predeterminado: 1	1
PageSize	integer	No	El número de elementos por página para la paginación: Valor predeterminado: 10 Valor máximo: 1000	10
Keyword	string	No	La palabra clave para el apodo del usuario.	测试pop用户

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	Devuelve la lista de usuarios bajo el rol de espacio de trabajo especificado.
Data	array<object>	La lista de usuarios.
	object	Los detalles del usuario.
NickName	string	El apodo del miembro de la organización.	测试用户
UserId	string	El UserID del miembro de la organización en Quick BI.	b5d8fd9348cc4327****afb604
WorkspaceId	string	El ID del espacio de trabajo.	7350a155-0e94-4c6c-8620-57bbec38****
WorkspaceName	string	El nombre del espacio de trabajo.	测试空间
PageNum	integer	El número de página.	1
PageSize	integer	El número de elementos por página configurado en la solicitud.	10
TotalNum	integer	El número total de elementos.	1
TotalPages	integer	El número total de páginas.	1
Success	boolean	Indica si la solicitud se realizó correctamente. Valores posibles: true: La solicitud se realizó correctamente. false: La solicitud falló.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "NickName": "测试用户",
        "UserId": "b5d8fd9348cc4327****afb604\n",
        "WorkspaceId": "7350a155-0e94-4c6c-8620-57bbec38****",
        "WorkspaceName": "测试空间"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  },
  "Success": true
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	Invalid.Workspace	The workspace is not owned by the organization.
400	User.Role.NotExist	User role not exist: %s.

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.