DescribeGroupEndpoints - 获取群组端点列表

更新时间:2025-03-24 08:28:07

获取群组端点列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

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

请求参数

名称类型必填描述示例值
名称类型必填描述示例值
ClusterIdstring

区域 ID。

cn-hangzhou
GroupNamestring

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

xx_test_group

返回参数

名称类型描述示例值
名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

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

返回结果说明。

执行成功。
Endpointsobject

群组端点列表。

EndpointTypestring

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

  • DefaultGateway:共享网关。
  • PrivateGateway:专属网关。
  • Nlb:挂载 NLB。
  • Nacos:挂载 Nacos。
PrivateGateway
BackendIdstring

后端接入 ID,取决于 EndpointType:

  • DefaultGateway:为 default。
  • PrivateGateway:为专属网关 ID。
  • Nlb:为 NLB 实例 ID。
  • Nacos:为 Nacos 实例 ID。
gw-26340kjxjx8l3r****
PathTypestring

地址类型,可能值为:

  • Group:服务群组地址。
  • Service:服务地址。
Group
IntranetEndpointsarray

内网地址列表。

IntranetEndpointsstring

完整的访问地址。

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

公网地址列表。

InternetEndpointsstring

完整的访问地址。

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

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

9090
AccessTokenstring

服务 Token。

Nzc5N2FhNTM4OTQ0YzBmYTIy****ZTUxN2NkYjg4MTJmMWQxZmY1****

示例

正常返回示例

JSON格式

{
  "RequestId": "890772EF-3AD6-129A-8E15-8F349C944783",
  "Message": "执行成功。",
  "Endpoints": {
    "EndpointType": "PrivateGateway",
    "BackendId": "gw-26340kjxjx8l3r****",
    "PathType": "Group",
    "IntranetEndpoints": [
      "http://gw-26340kjxjx8l3r****.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": 9090
  },
  "AccessToken": "Nzc5N2FhNTM4OTQ0YzBmYTIy****ZTUxN2NkYjg4MTJmMWQxZmY1****"
}

错误码

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

  • 本页导读 (1)
  • 调试
  • 授权信息
  • 请求语法
  • 请求参数
  • 返回参数
  • 示例
  • 错误码