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

Busca información del grupo de usuarios mediante una palabra clave del nombre del grupo de usuarios.

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

list

*Todos los recursos.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Keyword	string	Sí	La palabra clave del nombre del grupo de usuarios.	Grupo de usuarios de prueba

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.	D7980306-1F08-5A88-9FE7-ECB8B9C4C0F5
Result	array<object>	La información del grupo de usuarios.
	object
CreateTime	string	La hora en la que se creó el grupo de usuarios, en formato YYYY-MM-DD HH:mm:ss.	2021-03-15 17:13:55
CreateUser	string	El creador del grupo de usuarios secundario. Corresponde al UserID en Quick BI, no al UID de la cuenta de Alibaba Cloud.	46e5374665ba4b679ee22e2a2927****
IdentifiedPath	string	La jerarquía de carpetas del grupo de usuarios.	2fe4fbd8-588f-489a-b3e1-e92c7af0**/34fd141d-4598-4093-8c33-8e066dcb**
ModifiedTime	string	La hora en la que se modificó por última vez el grupo de usuarios, en formato YYYY-MM-DD HH:mm:ss.	2021-03-15 20:36:40
ModifyUser	string	El usuario que modificó por última vez el grupo de usuarios. Corresponde al UserID en Quick BI, no al UID de la cuenta de Alibaba Cloud.	46e5374665ba4b679ee22e2a2927****
ParentUsergroupId	string	El ID del grupo de usuarios principal.	2fe4fbd8-588f-489a-b3e1-e92c7af0****
UsergroupDesc	string	La descripción del grupo de usuarios.	Descripción de prueba
UsergroupId	string	El ID del grupo de usuarios.	34fd141d-4598-4093-8c33-8e066dcb****
UsergroupName	string	El nombre del grupo de usuarios.	Grupo de usuarios de prueba 01

Ejemplos

Respuesta exitosa

JSON Formato

{
  "Success": true,
  "RequestId": "D7980306-1F08-5A88-9FE7-ECB8B9C4C0F5",
  "Result": [
    {
      "CreateTime": "2021-03-15 17:13:55",
      "CreateUser": "46e5374665ba4b679ee22e2a2927****",
      "IdentifiedPath": "2fe4fbd8-588f-489a-b3e1-e92c7af0****/34fd141d-4598-4093-8c33-8e066dcb****",
      "ModifiedTime": "2021-03-15 20:36:40",
      "ModifyUser": "46e5374665ba4b679ee22e2a2927****",
      "ParentUsergroupId": "2fe4fbd8-588f-489a-b3e1-e92c7af0****",
      "UsergroupDesc": "测试描述",
      "UsergroupId": "34fd141d-4598-4093-8c33-8e066dcb****",
      "UsergroupName": "测试用户组01"
    }
  ]
}

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.