調用ListAppServices API查詢微服務應用列表-Serverless 應用引擎-阿里雲 - Serverless App Engine

查詢微服務的服務列表。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

sae:ListAppServices

list

*全部資源

*

無

請求文法

GET /pop/v1/sam/service/listAppServices HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
AppId	string	否	應用 ID，vpcId、命名空間 ID、應用 ID 必須且只能填寫一項。	017f39b8-dfa4-4e16-a84b-1dcee4b1****
ServiceType	string	否	服務類型。取值說明如下： dubbo springCloud hsf k8sService	springCloud
RegistryType	string	否	註冊中心類型。取值： 0：SAE Nacos 1：自建註冊中心 2：MSE Nacos 9：SAE K8s Service	0
NacosInstanceId	string	否	MseNacos 執行個體 ID，當註冊中心為 MSE Nacos 時必填。	mse-cn-sco3r0u****
NacosNamespaceId	string	否	MseNacos 命名空間 ID，當註冊中心為 MSE Nacos 時必填。	mse-test
PageNumber	integer	否	列表頁碼。	1
PageSize	integer	否	頁面大小。	10
VpcId	string	否	VPC 唯一標識，vpcId、命名空間 ID、應用 ID 必須且只能填寫一項。	vpc-2ze0i263cnn311nvj****
NamespaceId	string	否	命名空間 ID，VpcId、命名空間 ID、應用 ID 必須且只能填寫一項。	cn-beijing:test

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	附加資訊。取值說明如下：請求正常，返回 success。請求異常，返回具體異常錯誤碼。	success
TraceId	string	調用鏈 ID，用於精確查詢調用資訊。	0a98a02315955564772843261e****
Data	array<object>	服務列表資訊。
	array<object>	服務資訊。
ServiceName	string	服務名稱。	frontend
ServiceGroup	string	服務分組。	DEFAULT_GROUP
ServiceVersion	string	服務版本。	1.0.0
InstanceCount	string	服務的執行個體數。	1
ServiceType	string	服務類型。取值說明如下： dubbo springCloud hsf k8sService	springCloud
ServiceProtocol	string	該服務使用的協議。	HTTP
ServicePorts	array	連接埠列表。
	integer	連接埠值。	8000
ServicePortAndProtocol	object	連接埠和協議 Map。
	string	連接埠和協議。	8000:TCP
RegistryType	string	註冊中心類型。取值： 0：SAE Nacos 1：自建註冊中心 2：MSE Nacos 9：SAE K8s Service	0
NamespaceId	string	應用所屬的命名空間 ID。	cn-beijing:test
NamespaceName	string	命名空間名稱。	Test namespace
AppId	string	應用 ID。	0099b7be-5f5b-4512-a7fc-56049ef1****
AppName	string	應用程式名稱。	demo-app
SecurityGroupId	string	安全性群組 ID。	sg-wz969ngg2e49q5i4****
ErrorCode	string	錯誤碼。取值說明如下：請求成功：不返回 ErrorCode 欄位。請求失敗：返回 ErrorCode 欄位。具體資訊，請參見本文的錯誤碼列表。
Code	string	介面狀態或 POP 錯誤碼。取值說明如下： 2xx：成功。 3xx：重新導向。 4xx：請求錯誤。 5xx：伺服器錯誤。	200
Success	boolean	是否成功。取值說明如下： true：成功。 false：失敗。	true

樣本

正常返回樣本

JSON格式

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": [
    {
      "ServiceName": "frontend",
      "ServiceGroup": "DEFAULT_GROUP",
      "ServiceVersion": "1.0.0",
      "InstanceCount": "1",
      "ServiceType": "springCloud",
      "ServiceProtocol": "HTTP",
      "ServicePorts": [
        8000
      ],
      "ServicePortAndProtocol": {
        "key": "8000:TCP"
      },
      "RegistryType": "0",
      "NamespaceId": "cn-beijing:test",
      "NamespaceName": "Test namespace",
      "AppId": "0099b7be-5f5b-4512-a7fc-56049ef1****",
      "AppName": "demo-app",
      "SecurityGroupId": "sg-wz969ngg2e49q5i4****"
    }
  ],
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	Micro.Service.NotFound	The micro service not found {%s}.	服務不存在
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.	不合法的參數{%s}。

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

變更歷史

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