DsgUserGroupQueryUserList - DataWorks - Centro de documentación de Alibaba Cloud

Consulta una lista de usuarios o roles del inquilino actual.

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

dataworks:DsgUserGroupQueryUserList

list

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro

Tipo

Obligatorio

Descripción

Ejemplo

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	OpenApiResultModel<List<UserGroupQueryUserListVO>>
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true: correcta false: fallida	true
ErrorCode	string	El código de error.	1029030003
ErrorMessage	string	El mensaje de error.	param error
HttpStatusCode	integer	El código de estado HTTP.	400
Data	array<object>	El resultado devuelto.
	object	La información del usuario devuelta.
AccountName	string	El nombre del usuario.	user1
YunAccount	string	El nombre de la cuenta de Alibaba Cloud o del rol de RAM. El valor devuelto de este parámetro se debe utilizar si el grupo de usuarios se crea con una cuenta de Alibaba Cloud o un rol de RAM.	user:user1
AccountType	integer	El tipo de usuario. Valores válidos: 1 a 5: cuenta de Alibaba Cloud 6: rol de RAM	2
BaseId	string	El ID de usuario o de rol.	234
ParentAccountId	string	El ID del usuario principal. Este parámetro se aplica a los usuarios de RAM.	123
RequestId	string	El ID de la solicitud.	102400001

Ejemplos

Respuesta exitosa

JSON Formato

{
  "Success": true,
  "ErrorCode": "1029030003",
  "ErrorMessage": "param error",
  "HttpStatusCode": 400,
  "Data": [
    {
      "AccountName": "user1",
      "YunAccount": "user:user1",
      "AccountType": 2,
      "BaseId": "234",
      "ParentAccountId": "123"
    }
  ],
  "RequestId": "102400001"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	USERGROUP.ACCOUNTLISTSIZE.ERROR	The number of account exceeds the limit.
400	USERGROUP.ID.ERROR	The user group ID does not match the tenant or does not exist.
400	USERGROUP.LISTSIZE.ERROR	The number of user groups exceeds the limit.
400	USERGROUP.PAGESIZE.ERROR	Page size is too large, maximum of 100.
400	USERACCOUNT.OWNER.ERROR	User list or owner user does not exist.
400	PARAMS.ERROR	param error.
500	UNKNOWN.ERROR	unknown error.
403	PERMISSION.DENIED.ERROR	Permission denied

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.