Query service groups by using ListGroups - Platform For AI - Alibaba Cloud - Platform For AI

Lists created service 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

eas:ListGroups

get

*All Resource

*

None

Request syntax

GET /api/v2/groups HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
PageSize	string	No	The number of service groups to display on each page in a paged query. Settings for paging default to 100.	20
PageNumber	string	No	The current page number of the service group list. Default value: 1.	1
Filter	string	No	The filter name. Fuzzy match is supported.	foo
WorkspaceId	string	No	The workspace ID.	123***
TrafficMode	string	No	The traffic allocation method used to filter service groups.	auto
Sort	string	No	The field by which to sort the results.	CreateTime
Order	string	No	The sort order of the results.	desc
Labels	object	No	The user-defined labels.
	string	No	按{"key":"value"}格式填写。Value 可为 null 或空字符，代表只按 Key 过滤，Value 可为任意值。	{"key1":"value1","key2":null}

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	40325405-579C-4D82****
Groups	array	The list of service groups.
	Group	The service group information.
PageSize	integer	The number of groups displayed per page.	20
PageNumber	integer	The current page number of the returned group list.	1
TotalCount	integer	The total number of service groups.	5

Examples

Success response

JSON format

{
  "RequestId": "40325405-579C-4D82****",
  "Groups": [
    {
      "Name": "foo",
      "ClusterId": "cn-shanghai",
      "CreateTime": "2020-05-19T14:19:42Z",
      "UpdateTime": "2021-01-29T11:13:20Z",
      "QueueService": "qservice",
      "InternetEndpoint": "http://1110*****.cn-hangzhou.pai-eas.aliyuncs.com/api/predict/test_group",
      "IntranetEndpoint": "http://1110*****.vpc.cn-hangzhou.pai-eas.aliyuncs.com/api/predict/test_group",
      "AccessToken": "MzJiMDI5MDliODc0MTlkYmI0ZDhlYmExYjczYTIyZTE3Zm********",
      "TrafficMode": "auto",
      "Network": {
        "VpcId": "",
        "VSwitchId": "",
        "SecurityGroupId": "",
        "GatewayId": ""
      },
      "ParentUid": "",
      "CallerUid": "",
      "Labels": [
        {
          "LabelKey": "",
          "LabelValue": ""
        }
      ]
    }
  ],
  "PageSize": 20,
  "PageNumber": 1,
  "TotalCount": 5
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.