DescribeServiceEndpoints - 获取服务端点列表_人工智能平台 PAI(PAI)-阿里云帮助中心

获取服务端点列表。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

eas:DescribeServiceEndpoints

get

*全部资源

*

无

请求语法

GET /api/v2/services/{ClusterId}/{ServiceName}/endpoints HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
ClusterId	string	否	区域 ID。	cn-hangzhou
ServiceName	string	是	服务名称。如何获取服务名称，请参见 ListServices 。	service_name

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	739998B5-FB39-12A3-8323-0FA340317298
Message	string	返回结果说明。	执行成功。
AccessToken	string	服务 Token。	Nzc5N2FhN**TQ0YzBmYTIyN2MxZTUxN2NkYjg4MTJmMWQxZmY1**
Endpoints	array<object>	服务端点列表。
	object
EndpointType	string	服务端点接入方式，可能值为： DefaultGateway：共享网关。 PrivateGateway：专属网关。 Nlb：挂载 NLB。 Nacos：挂载 Nacos。	Nlb
BackendId	string	后端接入 ID，取决于 EndpointType： DefaultGateway：为 default。 PrivateGateway：为专属网关 ID。 Nlb：为 NLB 实例 ID。 Nacos：为 Nacos 实例 ID。	nlb-5q4sp7u6oorkha****
PathType	string	地址类型，可能值为： Group：服务群组地址。 Service：服务地址。	Service
IntranetEndpoints	array	内网地址列表。
	string	完整的访问地址。	nlb-5q4sp7u6oor****jvv.cn-hangzhou.nlb.aliyuncs.com
InternetEndpoints	array	公网地址列表。
	string	完整的访问地址。	null
Port	integer	端口。仅挂载 NlB 和 Nacos 时，Port 才有值。	9090

示例

正常返回示例

JSON格式

{
  "RequestId": "739998B5-FB39-12A3-8323-0FA340317298",
  "Message": "执行成功。",
  "AccessToken": "Nzc5N2FhN****TQ0YzBmYTIyN2MxZTUxN2NkYjg4MTJmMWQxZmY1****",
  "Endpoints": [
    {
      "EndpointType": "Nlb",
      "BackendId": "nlb-5q4sp7u6oorkha****",
      "PathType": "Service",
      "IntranetEndpoints": [
        "nlb-5q4sp7u6oor****jvv.cn-hangzhou.nlb.aliyuncs.com"
      ],
      "InternetEndpoints": [
        "null"
      ],
      "Port": 9090
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。