調用DescribeServiceEndpoints API擷取服務端點列表-人工智慧平台 PAI-阿里雲 - Platform For AI

擷取服務端點列表。

調試

您可以在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

請求參數

名稱

類型

必填

描述

樣本值

當前API無需請求參數

返回參數

名稱	類型	描述	樣本值
	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
    }
  ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。