DescribeGroupEndpoints - 获取群组端点列表

更新时间:
复制为 MD 格式

获取群组端点列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

eas:DescribeGroupEndpoints

get

*全部资源

*

请求语法

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

路径参数

名称

类型

必填

描述

示例值

ClusterId

string

区域 ID。

cn-hangzhou

GroupName

string

群组名称。如何获取群组名称,请参见 ListServices

xx_test_group

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称

类型

描述

示例值

object

返回结果。

RequestId

string

请求 ID。

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

Message

string

返回结果说明。

执行成功。

AccessToken

string

服务 Token。

Nzc5N2FhNTM4OTQ0YzBmYTIy****ZTUxN2NkYjg4MTJmMWQxZmY1****

Endpoints

array<object>

群组端点列表。

object

EndpointType

string

服务端点接入方式,可能值为:

  • DefaultGateway:共享网关。

  • PrivateGateway:专属网关。

  • Nlb:挂载 NLB。

  • Nacos:挂载 Nacos。

PrivateGateway

BackendId

string

后端接入 ID,取决于 EndpointType:

  • DefaultGateway:为 default。

  • PrivateGateway:为专属网关 ID。

  • Nlb:为 NLB 实例 ID。

  • Nacos:为 Nacos 实例 ID。

gw-26340kjxjx8l3r****

PathType

string

地址类型,可能值为:

  • Group:服务群组地址。

Group

IntranetEndpoints

array

完整的访问地址。

string

完整的访问地址。

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

InternetEndpoints

array

完整的访问地址。

string

完整的访问地址。

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

Port

integer

端口。仅挂载 NlB 和 Nacos 时,Port 才有值。

8080

示例

正常返回示例

JSON格式

{
  "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
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情