ListApplications - 获取应用列表 - Serverless 应用引擎

获取应用列表。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

sae:ListApplications

get

*全部资源

*

无

请求语法

GET /pop/v1/sam/app/listApplications HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
CurrentPage	integer	否	当前页数。	1
PageSize	integer	否	分页查询时获取的每页数量。取值范围[0,10000]。	20
AppName	string	否	应用名称。	demo-app
NamespaceId	string	否	命名空间 ID。	cn-beijing:demo
Tags	string	否	标签键值对。取值说明如下： key：标签键，长度范围[1,128]。 value：标签值，长度范围[1,128]。区分大小写。如果指定多个标签，则会为指定资源同时创建并绑定多个标签。同一个资源上的同一个标签键只能对应一个标签值。如果您尝试添加已有标签键，则对应的标签值会更新为新值。不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	[{"key":"key","value":"value"}]
OrderBy	string	否	对应用进行排序。取值说明如下： runnings：按照当前实例数进行排序。 instances：按照目标实例数进行排序。	runnings
Reverse	boolean	否	根据应用实例运行状态对其进行排序。如果状态相同，则按照实例 ID 排序。取值说明如下： true：按升序排序。表示根据启动实例的步骤来排列，例如实例最终想要变更为运行状态，需先经过启动容器、拉取镜像、初始化实例等步骤。 false：按降序排序。实例升序排列如下： Error：实例启动过程中出错。 CrashLoopBackOff：容器无法启动，在启动过程中出错，重启后又出错。 ErrImagePull：拉取实例中的容器镜像出错。 ImagePullBackOff：无法获取容器镜像。 Pending：实例等待调度中。 Unknown：未知异常。 Terminating：实例终止接入中。 NotFound：无法找到实例。 PodInitializing：实例初始化中。 Init:0/1：实例初始化。 Running：实例运行中。	true
FieldType	string	否	设置筛选应用的维度。取值说明如下： appName：应用名称。 appIds：应用 ID。 slbIps：SLB IP 地址。 instanceIps：实例 IP 地址。	appName
FieldValue	string	否	输入目标应用的应用名称、应用 ID、SLB IP 地址或实例 IP 地址。	demo-app
AppSource	string	否	SAE 应用类型。 micro_service。 web。 job。	micro_service
IsStateful	string	否
NewSaeVersion	string	否

返回参数

名称	类型	描述	示例值
	object	返回数据。
Message	string	调用结果的附加信息。	success
RequestId	string	请求 ID。	B4D805CA-926D-41B1-8E63-7AD0C1ED****
Data	object	应用列表。
CurrentPage	integer	当前页数。	1
TotalSize	integer	应用总个数。	2
PageSize	integer	页面大小。	20
Applications	array<object>	应用列表。
	array<object>	应用列表信息。
AppName	string	应用名称。	demo-app
NamespaceId	string	命名空间 ID。	cn-beijing:demo
AppDeletingStatus	boolean	是否正在删除应用。取值说明如下： true：应用正在被删除。 false：应用没有被删除。	false
AppId	string	应用 ID。	f7730764-d88f-4b9a-8d8e-cd8efbfe****
Tags	array<object>	应用标签。
	object	应用标签信息。
Key	string	标签键。	key
Value	string	标签值。	value
RunningInstances	integer	运行中的实例个数。	2
Instances	integer	应用实例个数。	2
RegionId	string	地域 ID。	cn-beijing
AppDescription	string	应用描述信息。	description
Cpu	integer	每个实例所需的 CPU，单位为毫核，不能为 0。目前仅支持以下固定规格： 500 1000 2000 4000 8000 16000 32000	1000
Mem	integer	每个实例所需的内存，单位为 MB，不能为 0。与 CPU 为一一对应关系，目前仅支持以下固定规格： 1024：对应 CPU 为 500 毫核和 1000 毫核。 2048：对应 CPU 为 500、1000 毫核和 2000 毫核。 4096：对应 CPU 为 1000、2000 毫核和 4000 毫核。 8192：对应 CPU 为 2000、4000 毫核和 8000 毫核。 12288：对应 CPU 为 12000 毫核。 16384：对应 CPU 为 4000、8000 毫核和 16000 毫核。 24576：对应 CPU 为 12000 毫核。 32768：对应 CPU 为 16000 毫核。 65536：对应 CPU 为 8000、16000 和 32000 毫核。 131072：对应 CPU 为 32000 毫核。	1024
MseEnabled	boolean	该应用是否已启用 MSE 微服务治理	true
MseNamespaceId	string	MSE 微服务治理命名空间 default：免费版 sae-pro：专业版 sae-ent：企业版	sae-ent
BaseAppId	string	Base 应用 ID，仅灰度应用存在此属性	xxx-xxx-xx-xxx
ProgrammingLanguage	string	应用的编程语言	java
Children	array<object>	该应用的灰度应用列表
	array<object>	详细信息。
AppName	string	应用名称。	app1
NamespaceId	string	命名空间 ID。	cn-beijing:demo
AppDeletingStatus	boolean	是否正在删除该应用。	false
AppId	string	应用 ID。	xxx-xxx-xxx-xxx
ScaleRuleEnabled	boolean	是否开启弹性伸缩策略。	false
ScaleRuleType	string	弹性规则的类型	timing
Tags	array<object>	应用标签。
	object	应用标签。
Key	string	标签键。	key
Value	string	标签值。	value
RunningInstances	integer	运行中的实例个数。	2
Instances	integer	实例个数。	2
RegionId	string	地域 ID。	cn-beijing
AppDescription	string	应用描述信息。	测试应用
Cpu	integer	CPU 大小。	2000
Mem	integer	内存大小。	2048
MseEnabled	boolean	该应用是否已启用 MSE 微服务治理。	true
BaseAppId	string	基础应用 ID。	ee99cce6-1c8e-4bfa-96c3-3e2fa9******
ProgrammingLanguage	string	应用所用的语言。	java
AppType	string	应用部署的方式。	Image
NamespaceName	string	命名空间名称	demo
IsStateful	boolean
NewSaeVersion	string	应用版本： lite：轻量版 std：标准版 pro：专业版	pro
ResourceType	string
EnableIdle	string
ImageUrl	string	镜像地址。	registry.cn-hangzhou.aliyuncs.com/sae-serverless-demo/sae-demo:microservice-java-provider-v1.0
PackageUrl	string	部署包地址。	https://sae-oss-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/apps/K8S_APP_ID/1421801774382676/adf2624a-66fd-4a2b-8caa-6921da******/hello-sae.jar
AppType	string	应用部署的方式。	Image
NamespaceName	string	命名空间名称。	demo
IsStateful	boolean
NewSaeVersion	string	应用版本： lite：轻量版 std：标准版 pro：专业版	pro
EnableIdle	string	是否开启闲置。	false
DiskSize	integer	磁盘存储大小（单位 GB）。	20
VpcId	string
ResourceType	string
Labels	object
	string
ErrorCode	string	错误码。取值说明如下：请求成功：不返回 ErrorCode 字段。请求失败：返回 ErrorCode 字段。具体信息，请参见本文的错误码目录。	空
Code	string	接口状态或 POP 错误码。取值说明如下： 2xx：成功。 3xx：重定向。 4xx：请求错误。 5xx：服务器错误。	200
Success	boolean	获取应用列表。取值说明如下： true：获取成功。 false：获取失败。	true
CurrentPage	integer	当前页数。	1
TotalSize	integer	应用总个数。	2
PageSize	integer	页面大小。	20

示例

正常返回示例

JSON格式

{
  "Message": "success",
  "RequestId": "B4D805CA-926D-41B1-8E63-7AD0C1ED****",
  "Data": {
    "CurrentPage": 1,
    "TotalSize": 2,
    "PageSize": 20,
    "Applications": [
      {
        "AppName": "demo-app",
        "NamespaceId": "cn-beijing:demo",
        "AppDeletingStatus": false,
        "AppId": "f7730764-d88f-4b9a-8d8e-cd8efbfe****",
        "Tags": [
          {
            "Key": "key",
            "Value": "value"
          }
        ],
        "RunningInstances": 2,
        "Instances": 2,
        "RegionId": "cn-beijing",
        "AppDescription": "description",
        "Cpu": 1000,
        "Mem": 1024,
        "MseEnabled": true,
        "MseNamespaceId": "sae-ent",
        "BaseAppId": "xxx-xxx-xx-xxx",
        "ProgrammingLanguage": "java",
        "Children": [
          {
            "AppName": "app1",
            "NamespaceId": "cn-beijing:demo",
            "AppDeletingStatus": false,
            "AppId": "xxx-xxx-xxx-xxx",
            "ScaleRuleEnabled": false,
            "ScaleRuleType": "timing",
            "Tags": [
              {
                "Key": "key",
                "Value": "value"
              }
            ],
            "RunningInstances": 2,
            "Instances": 2,
            "RegionId": "cn-beijing",
            "AppDescription": "测试应用",
            "Cpu": 2000,
            "Mem": 2048,
            "MseEnabled": true,
            "BaseAppId": " ee99cce6-1c8e-4bfa-96c3-3e2fa9******",
            "ProgrammingLanguage": "java",
            "AppType": "Image",
            "NamespaceName": "demo",
            "IsStateful": true,
            "NewSaeVersion": "pro",
            "ResourceType": "",
            "EnableIdle": ""
          }
        ],
        "ImageUrl": "registry.cn-hangzhou.aliyuncs.com/sae-serverless-demo/sae-demo:microservice-java-provider-v1.0",
        "PackageUrl": "https://sae-oss-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/apps/K8S_APP_ID/1421801774382676/adf2624a-66fd-4a2b-8caa-6921da******/hello-sae.jar",
        "AppType": "Image",
        "NamespaceName": "demo",
        "IsStateful": true,
        "NewSaeVersion": "pro",
        "EnableIdle": "false",
        "DiskSize": 20,
        "VpcId": "",
        "ResourceType": "",
        "Labels": {
          "key": ""
        }
      }
    ]
  },
  "ErrorCode": "空",
  "Code": "200",
  "Success": true,
  "CurrentPage": 1,
  "TotalSize": 2,
  "PageSize": 20
}

错误码

HTTP status code	错误码	错误信息	描述
400	Illegal.argument	Illegal argument	参数异常

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

变更历史

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