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

Consulta la lista de miembros de la organización.

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

list

*Todos los recursos.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Keyword	string	No	La palabra clave para el nombre de usuario o el apodo del miembro de la organización.	test
PageNum	integer	No	El número de página de la lista de miembros de la organización. Valor mínimo: 1 Valor predeterminado: 1	1
PageSize	integer	No	El número de filas por página para 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 válidos: 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	El resultado paginado de la lista de usuarios. La información detallada de los miembros de la organización se almacena en el parámetro de respuesta Data.
Data	array<object>	La lista de usuarios devuelta por la solicitud.
	object	La lista de usuarios devuelta por la solicitud.
AccountId	string	El ID de la cuenta de Alibaba Cloud. Para los usuarios que no se agregan mediante la lectura de autoservicio de RAM, el ID de la cuenta de Alibaba Cloud solo se puede obtener después de iniciar sesión.	1355********
AccountName	string	El nombre de la cuenta de Alibaba Cloud.	test
AdminUser	boolean	Indica si el rol de administrador de la organización está vinculado. Valores válidos: true: Sí. false: No. Importante Este parámetro está obsoleto. Utilice el parámetro RoleIdList en su lugar.	true
AuthAdminUser	boolean	Indica si el rol de administrador de gestión de permisos está asignado. Valores válidos: true: Sí. false: No. Importante Este parámetro ha caducado y ya no se recomienda. Utilice el parámetro RoleIdList en su lugar.	true
JoinedDate	integer	La fecha en la que el miembro se unió a la organización. Este valor es una marca de tiempo UNIX en milisegundos.	1718691704000
LastLoginTime	integer	La hora del último inicio de sesión. Este valor es una marca de tiempo UNIX en milisegundos.	1718761320681
NickName	string	El apodo del miembro de la organización.	test
RoleIdList	array	La lista de ID de roles de la organización vinculados al usuario.
	integer	El ID del rol de la organización. Se admite un máximo de tres ID de rol, que incluyen, entre otros, los siguientes roles predefinidos: Administrador de la organización (rol predefinido): 111111111 Administrador de gestión de permisos (rol predefinido): 111111112 Usuario habitual (rol predefinido): 111111113	111111111
UserId	string	El ID de usuario en Quick BI.	fe67f61a35a94b7da1a34ba174a7****
UserType	integer	El tipo de usuario del miembro de la organización. Valores válidos: 1: desarrollador 2: visitante 3: analista	1
IsDeleted	boolean	El estado del usuario. Valores válidos: false: activado true: desactivado	false
CopilotModules	array	La cuota de módulos inteligentes del usuario. qreport: informe Q qExploreNum: edición Q explore smartQAskNum: consulta de datos Q smartQDevNum: constructor Q
	string	La cuota de módulos inteligentes.	qreport
PageNum	integer	El número de página.	1
PageSize	integer	El número de filas por página especificado 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": "1355********",
        "AccountName": "test",
        "AdminUser": true,
        "AuthAdminUser": true,
        "JoinedDate": 1718691704000,
        "LastLoginTime": 1718761320681,
        "NickName": "test",
        "RoleIdList": [
          111111111
        ],
        "UserId": "fe67f61a35a94b7da1a34ba174a7****",
        "UserType": 1,
        "IsDeleted": false,
        "CopilotModules": [
          "qreport"
        ]
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  }
}

Códigos de error

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.