All Products
Search
Document Center

Platform For AI:ListGroups

Last Updated:Nov 22, 2024

Queries created service groups.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
eas:ListGroupsget
*All Resources
*
    none
none

Request syntax

GET /api/v2/groups HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
PageSizestringNo

The number of entries per page. Default value: 100.

20
PageNumberstringNo

The page number. Default value: 1.

1
FilterstringNo

The name of the filter that is used to filter out unwanted service groups. Fuzzy match is supported.

foo
WorkspaceIdstringNo

The workspace ID.

123***

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

40325405-579C-4D82****
Groupsarray

The service groups.

Group

The information about the service group.

PageSizelong

The number of entries per page.

20
PageNumberlong

The page number.

1
TotalCountlong

The total number of entries returned.

5

Examples

Sample success responses

JSONformat

{
  "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********"
    }
  ],
  "PageSize": 20,
  "PageNumber": 1,
  "TotalCount": 5
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-09-01The request parameters of the API has changedView Change Details