ListGroups - DataHub - Alibaba Cloud Documentation Center

Retrieves a list of consumer groups.

Operation description

Queries the list of consumer groups.

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

dhs:ListGroups

list

*Group

acs:dhs:{#regionId}:{#accountId}:projects/{#projectName}/groups/*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The project name.	test_project
Skip	integer	No	The number of records to skip in a paged query.	1
MaxResults	integer	No	The maximum number of records to return in a paged query.	5
NextToken	string	No	The pagination token. If NextToken is empty, paged query starts from the beginning. Otherwise, paged query starts from where the previous query ended based on the token.	9892074a2a89600ae4b0d5a34fb99a3f
Keyword	string	No	The keyword used to filter results in a paged query.	dh
Pure	boolean	No	Specifies whether to return only primary key information.	false

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	A20A7093-8FE0-058C-BE0C-3C8057D5F1A1
Success	boolean	Indicates whether the request was successful.	True
TotalCount	integer	The total number of records in the query result.	50
MaxResults	integer	The maximum number of records returned in this query.	5
NextToken	string	The token for the next query. If NextToken is empty, no more results are available. If NextToken has a value, it indicates the token to use for the next query.	9892074a2a89600ae4b0d5a34fb99a3f
List	array<object>	The list of consumer groups.
	object	The list of consumer groups.
ProjectName	string	The project name.	test_project
GroupName	string	The consumer group name.	test_group
Comment	string	The description of the consumer group.	test_comment
TopicList	array	The list of topics bound to the consumer group.
	string	The topic name.	["topic1","topic2"]
Creator	string	The creator of the consumer group.	276887103073464052
CreateTime	integer	The time when the consumer group was created.	1708171905000
UpdateTime	integer	The time when the consumer group was last updated.	1708171905000

Examples

Success response

JSON format

{
  "RequestId": "A20A7093-8FE0-058C-BE0C-3C8057D5F1A1",
  "Success": true,
  "TotalCount": 50,
  "MaxResults": 5,
  "NextToken": "9892074a2a89600ae4b0d5a34fb99a3f",
  "List": [
    {
      "ProjectName": "test_project",
      "GroupName": "test_group",
      "Comment": "test_comment",
      "TopicList": [
        "[\"topic1\",\"topic2\"]"
      ],
      "Creator": "276887103073464052",
      "CreateTime": 1708171905000,
      "UpdateTime": 1708171905000
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	Error:%s.	The parameter entered is illegal
400	MissingParameter	Error:%s.	Missing required parameters
500	InternalServerError	Error:%s.	Server error, server unavailable or unexpected error occurred
403	NoPermission	Error:%s.	You are not authorized to perform this operation.
403	OperationDenied	Error:%s.	Operation denied
404	ResourceNotFound	Error:%s.	Resource does not exist

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.