Query user group information by ID using ListByUserGroupId - Quick BI - Alibaba Cloud - Quick BI

Queries information about user groups in batch by user group ID.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

quickbi-public:ListByUserGroupId

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
UserGroupIds	string	Yes	The IDs of the user groups to query. Separate multiple IDs with commas (,).	34fe-*-6dcb,84q9-**-4a274

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
RequestId	string	The request ID.	D8749D65-E80A-433C-AF1B-CE9C180FF3B4
Result	object	The query results of the user groups.
FailedUserGroupIds	array	The list of user group IDs that failed to be queried.	[]
	string	The user group ID that failed to be queried.	[]
UserGroupModels	array<object>	The details of the queried user groups.
	object
CreateTime	string	The creation time in the format of YYYY-MM-DD HH:mm:ss.	2021-03-15 17:13:55
CreateUser	string	The UserID of the creator in Quick BI.	46e5*******ee22e2a292704c8
IdentifiedPath	string	The path of the user group.	2fe4fbd8-**-af083ea/34fd1-**-dcbc33f
ModifiedTime	string	The modification time in the format of YYYY-MM-DD HH:mm:ss.	2021-03-15 20:36:40
ModifyUser	string	The UserID of the modifier in Quick BI.	46e5*******ee22e2a292704c8
ParentUsergroupId	string	The ID of the parent user group.	2fe4fbd8-588f-489a-b3e1-e92c7af083ea
UsergroupDesc	string	The description of the user group.	Description information
UsergroupId	string	The user group ID.	34fd141d-****-4093-8c33-8e066dcbc33f
UsergroupName	string	The name of the user group.	Test user group

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "D8749D65-E80A-433C-AF1B-CE9C180FF3B4",
  "Result": {
    "FailedUserGroupIds": [
      "[]"
    ],
    "UserGroupModels": [
      {
        "CreateTime": "2021-03-15 17:13:55",
        "CreateUser": "46e5*******ee22e2a292704c8",
        "IdentifiedPath": "2fe4fbd8-****-af083ea/34fd1-****-dcbc33f",
        "ModifiedTime": "2021-03-15 20:36:40",
        "ModifyUser": "46e5*******ee22e2a292704c8",
        "ParentUsergroupId": "2fe4fbd8-588f-489a-b3e1-e92c7af083ea",
        "UsergroupDesc": "Description\n",
        "UsergroupId": "34fd141d-****-4093-8c33-8e066dcbc33f",
        "UsergroupName": "Test user group\n"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Usergroup.Not.Exist	The user group does not exist.	The user group does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.