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

Consulta la lista de miembros de un 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:QueryWorkspaceUserList

list

*All Resource

*

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****
Keyword	string	No	La palabra clave para el nombre de usuario del miembro del espacio de trabajo.	分析
PageNum	integer	No	El número de página actual de la lista de miembros del espacio de trabajo: Valor inicial: 1 Valor predeterminado: 1	1
PageSize	integer	No	El número de filas por página en una consulta paginada: Valor predeterminado: 10 Valor máximo: 1000	10

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
Success	boolean	Indica si la solicitud se realizó correctamente. Valores posibles: true: La solicitud se realizó correctamente. false: La solicitud falló.	true
RequestId	string	El ID de la solicitud.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	Devuelve el resultado paginado de la lista de miembros, con información detallada sobre los miembros almacenada en el parámetro Data de la respuesta.
Data	array<object>	Información sobre los miembros del espacio de trabajo.
	array<object>
AccountId	string	El ID de la cuenta de Alibaba Cloud.	16020915****8429
AccountName	string	El nombre de la cuenta de Alibaba Cloud.	pop****@aliyunid.test
NickName	string	El apodo.	我就是那个分析师大神
Role	object	La información del rol predefinido del miembro del espacio de trabajo.
RoleCode	string	El código correspondiente al rol predefinido.	role_workspace_admin
RoleId	integer	El ID del rol predefinido. Valores posibles: 25: Administrador del espacio de trabajo 26: Desarrollador del espacio de trabajo 27: Analista del espacio de trabajo 30: Visor del espacio de trabajo	25
RoleName	string	El nombre del rol predefinido.	管理员
UserId	string	El ID de usuario de Quick BI.	de4bc5f9429141cc8091cdd1c15b****
PageNum	integer	El número de página.	1
PageSize	integer	El número de filas por página establecido en la solicitud.	10
TotalNum	integer	El número total de filas.	1
TotalPages	integer	El número total de páginas.	1

Ejemplos

Respuesta exitosa

JSON Formato

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "AccountId": "16020915****8429",
        "AccountName": "pop****@aliyunid.test",
        "NickName": "我就是那个分析师大神",
        "Role": {
          "RoleCode": "role_workspace_admin",
          "RoleId": 25,
          "RoleName": "管理员"
        },
        "UserId": "de4bc5f9429141cc8091cdd1c15b****"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  }
}

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.
400	Workspace.Not.Exist	The group workspace does not exist.

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.