使用ListAppServices API查询微服务列表-Serverless 应用引擎-阿里云-Serverless 应用引擎(SAE)-阿里云帮助中心

查询微服务的服务列表。

调试

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

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

变更历史

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