文档

ListApplications - 获取应用列表

更新时间:

调用ListApplications接口获取应用列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
sae:ListApplications
  • 全部资源
    *

请求语法

GET /pop/v1/sam/app/listApplications

请求参数

名称类型必填描述示例值
CurrentPageinteger

当前页数。

1
PageSizeinteger

分页查询时获取的每页数量。取值范围[0,10000]。

20
AppNamestring

应用名称。

demo-app
NamespaceIdstring

命名空间 ID。

cn-beijing:demo
Tagsstring

标签键值对。取值说明如下:

  • key:标签键,长度范围[1,128]。
  • value:标签值,长度范围[1,128]。

区分大小写。如果指定多个标签,则会为指定资源同时创建并绑定多个标签。同一个资源上的同一个标签键只能对应一个标签值。如果您尝试添加已有标签键,则对应的标签值会更新为新值。

不能以aliyunacs:开头,不能包含http://或者https://

[{"key":"key","value":"value"}]
OrderBystring

对应用进行排序。取值说明如下:

  • runnings:按照当前实例数进行排序。
  • instances:按照目标实例数进行排序。
runnings
Reverseboolean

根据应用实例运行状态对其进行排序。如果状态相同,则按照实例 ID 排序。取值说明如下:

  • true:按升序排序。表示根据启动实例的步骤来排列,例如实例最终想要变更为运行状态,需先经过启动容器、拉取镜像、初始化实例等步骤。
  • false:按降序排序。

实例升序排列如下:

  1. Error:实例启动过程中出错。
  2. CrashLoopBackOff:容器无法启动,在启动过程中出错,重启后又出错。
  3. ErrImagePull:拉取实例中的容器镜像出错。
  4. ImagePullBackOff:无法获取容器镜像。
  5. Pending:实例等待调度中。
  6. Unknown:未知异常。
  7. Terminating:实例终止接入中。
  8. NotFound:无法找到实例。
  9. PodInitializing:实例初始化中。
  10. Init:0/1:实例初始化。
  11. Running:实例运行中。
true
FieldTypestring

设置筛选应用的维度。取值说明如下:

  • appName:应用名称。
  • appIds:应用 ID。
  • slbIps:SLB IP 地址。
  • instanceIps:实例 IP 地址。
appName
FieldValuestring

输入目标应用的应用名称、应用 ID、SLB IP 地址或实例 IP 地址。

demo-app
AppSourcestring

SAE 应用类型

  • micro_service
  • web
  • job
micro_service

返回参数

名称类型描述示例值
object

返回数据。

Messagestring

调用结果的附加信息。

success
RequestIdstring

请求 ID。

B4D805CA-926D-41B1-8E63-7AD0C1ED****
Dataobject

应用列表。

CurrentPageinteger

当前页数。

1
TotalSizeinteger

应用总个数。

2
PageSizeinteger

页面大小。

20
Applicationsarray<object>

应用列表。

object

应用列表信息。

AppNamestring

应用名称。

demo-app
NamespaceIdstring

命名空间 ID。

cn-beijing:demo
AppDeletingStatusboolean

是否正在删除应用。取值说明如下:

  • true:应用正在被删除。
  • false:应用没有被删除。
false
AppIdstring

应用 ID。

f7730764-d88f-4b9a-8d8e-cd8efbfe****
Tagsarray<object>

应用标签。

object

应用标签信息。

Keystring

标签键。

key
Valuestring

标签值。

value
RunningInstancesinteger

运行中的实例个数。

2
Instancesinteger

应用实例个数。

2
RegionIdstring

地域 ID。

cn-beijing
AppDescriptionstring

应用描述信息。

description
Cpuinteger

每个实例所需的 CPU,单位为毫核,不能为 0。目前仅支持以下固定规格:

  • 500
  • 1000
  • 2000
  • 4000
  • 8000
  • 16000
  • 32000
1000
Meminteger

每个实例所需的内存,单位为 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
ErrorCodestring

错误码。取值说明如下:

  • 请求成功:不返回 ErrorCode 字段。
  • 请求失败:返回 ErrorCode 字段。具体信息,请参见本文的错误码目录。
Codestring

接口状态或 POP 错误码。取值说明如下:

  • 2xx:成功。
  • 3xx:重定向。
  • 4xx:请求错误。
  • 5xx:服务器错误。
200
Successboolean

获取应用列表。取值说明如下:

  • true:获取成功。
  • false:获取失败。
true
CurrentPageinteger

当前页数。

1
TotalSizeinteger

应用总个数。

2
PageSizeinteger

页面大小。

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": "",
        "BaseAppId": "",
        "ProgrammingLanguage": "",
        "Children": [
          {
            "AppName": "",
            "NamespaceId": "",
            "AppDeletingStatus": true,
            "AppId": "",
            "ScaleRuleEnabled": true,
            "ScaleRuleType": "",
            "Tags": [
              {
                "Key": "",
                "Value": ""
              }
            ],
            "RunningInstances": 0,
            "Instances": 0,
            "RegionId": "",
            "AppDescription": "",
            "Cpu": 0,
            "Mem": 0,
            "MseEnabled": true,
            "BaseAppId": "",
            "ProgrammingLanguage": ""
          }
        ]
      }
    ]
  },
  "ErrorCode": "空",
  "Code": "200",
  "Success": true,
  "CurrentPage": 1,
  "TotalSize": 2,
  "PageSize": 20
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2024-05-24OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-05-21OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-01-22OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2021-07-21OpenAPI 错误码发生变更查看变更详情