All Products
Search

This Product

    Platform For AI:DescribeGroupEndpoints

    Document Center

    Platform For AI:DescribeGroupEndpoints

    Last Updated:Jan 28, 2026

    Obtains a list of endpoints of 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:DescribeGroupEndpoints

    get

    *All Resource

    *

    		 None None

    Request syntax

    GET /api/v2/groups/{ClusterId}/{GroupName}/endpoints HTTP/1.1

    Path Parameters

    Parameter

    Type

    Required

    Description

    Example
    ClusterId

    string

    No

    The region ID.

    cn-hangzhou
    GroupName

    string

    Yes

    The service group name. For more information about how to obtain the service group name, see ListServices.

    xx_test_group

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    No parameters required.

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

    890772EF-3AD6-129A-8E15-8F349C944783
    Message

    string

    The response message.

    执行成功。
    AccessToken

    string

    The service token.

    Nzc5N2FhNTM4OTQ0YzBmYTIy****ZTUxN2NkYjg4MTJmMWQxZmY1****
    Endpoints

    array<object>

    The endpoints of the service group.

    object

    EndpointType

    string

    The service endpoint type. Valid values:

    • DefaultGateway: the shared gateway.

    • PrivateGateway: the dedicated gateway.

    • Nlb: Associate the service with the Network Load Balancer (NLB) instance.

    • Nacos: Associate the service with the Nacos instance.

    PrivateGateway
    BackendId

    string

    The backend access ID, which varies based on the value of the EndpointType parameter.

    • If you set EndpointType to DefaultGateway, the value of this parameter is default.

    • If you set EndpointType to PrivateGateway, the value of this parameter is the ID of the dedicated gateway.

    • If you set EndpointType to Nlb, the value of this parameter is the ID of the NLB instance.

    • If you set EndpointType to Nacos, the value of this parameter is the ID of the Nacos instance.

    gw-26340kjxjx8l3r****
    PathType

    string

    The path type. Valid values:

    • Group: the path of the service group.

    Group
    IntranetEndpoints

    array

    The full endpoint.

    string

    The full endpoint.

    http://gw-26340kjxjx8l3r****-vpc.cn-hangzhou.pai-eas.aliyuncs.com/api/predict/xx_test_group
    InternetEndpoints

    array

    The full endpoint.

    string

    The full endpoint.

    http://gw-26340kjxjx8l3r****.cn-hangzhou.pai-eas.aliyuncs.com/api/predict/xx_test_group
    Port

    integer

    The port number. This parameter takes effect only when you associate the service with an NLB or Nacos instance.

    8080

    Examples

    Success response

    JSON format

    {
  "RequestId": "890772EF-3AD6-129A-8E15-8F349C944783",
  "Message": "执行成功。",
  "AccessToken": "Nzc5N2FhNTM4OTQ0YzBmYTIy****ZTUxN2NkYjg4MTJmMWQxZmY1****",
  "Endpoints": [
    {
      "EndpointType": "PrivateGateway",
      "BackendId": "gw-26340kjxjx8l3r****",
      "PathType": "Group",
      "IntranetEndpoints": [
        "http://gw-26340kjxjx8l3r****-vpc.cn-hangzhou.pai-eas.aliyuncs.com/api/predict/xx_test_group"
      ],
      "InternetEndpoints": [
        "http://gw-26340kjxjx8l3r****.cn-hangzhou.pai-eas.aliyuncs.com/api/predict/xx_test_group"
      ],
      "Port": 8080
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.