AI 助理
备案控制台
文档
输入文档关键字查找
首页 Serverless 应用引擎 Serverless应用引擎（新版） 开发参考 API参考指南 API目录 微服务应用 应用信息查询 DescribeApplicationInstances - 获取应用实例列表

DescribeApplicationInstances - 获取应用实例列表

更新时间：
产品详情
我的收藏

调用DescribeApplicationInstances接口获取应用实例列表。

调试

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

授权信息

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

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

请求语法

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

请求参数

名称类型必填描述示例值
AppIdstring是

应用 ID。

d700e680-aa4d-4ec1-afc2-6566b5ff****
GroupIdstring是

应用分组 ID。需要调用 DescribeApplicationGroups 接口获取。

b2a8a925-477a-4ed7-b825-d5e22500****
CurrentPageinteger否

当前页码。

1
PageSizeinteger否

分页查询时设置的每页行数。默认为 10，取值范围(0,1000000000)。

10
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

返回参数

名称类型描述示例值
object

返回数据。

RequestIdstring

请求 ID。

91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Messagestring

调用结果的附加信息。

success
TraceIdstring

调用链 ID，用于精确查询调用信息。

0a98a02315955564772843261e****
Dataobject

应用实例信息。

CurrentPageinteger

当前页码。

1
TotalSizeinteger

实例总数。

10
PageSizeinteger

分页查询时设置的每页数量。

10
Instancesarray<object>

应用实例列表。

Instanceobject

应用实例列表。

CreateTimeStamplong

实例开始创建的时间戳。单位：毫秒。

1558442609000
VSwitchIdstring

实例所在可用区。

vsw-***
InstanceContainerStatusstring

实例运行状态。取值说明如下：

  • Error：实例启动过程中出错。
  • CrashLoopBackOff：容器无法启动，在启动过程中出错，重启后又出错。
  • ErrImagePull：拉取实例中的容器镜像出错。
  • ImagePullBackOff：无法获取容器镜像。
  • Pending：实例等待调度中。
  • Unknown：未知异常。
  • Terminating：终止实例接入中。
  • NotFound：无法找到实例。
  • PodInitializing：实例初始化中。
  • Init:0/1：实例初始化。
  • Running：实例运行中。
Running
InstanceHealthStatusstring

健康检查配置信息。取值说明如下：

  • WithoutHealthCheckConfig：Liveness 与 Readiness 健康检查未配置。
  • WithoutLivenessConfig：Liveness 健康检查未配置。
  • WithoutReadinessConfig：Readiness 健康检查未配置。
  • NotCheckedYet：实例正在或等待进行健康检查。
  • LivenessUnhealthy：Liveness 健康检查失败，实例不健康。
  • ReadinessUnhealthy：Readiness 健康检查失败，实例不健康。
  • Unhealthy：Liveness 与 Readiness 健康检查失败，实例不健康。
  • Healthy：健康检查通过，实例健康。
WithoutHealthCheckConfig
InstanceContainerRestartslong

实例重启次数。

0
GroupIdstring

实例所属分组 ID。

b2a8a925-477a-4ed7-b825-d5e22500****
InstanceContainerIpstring

实例内网 IP。

192.168.X.X
InstanceIdstring

实例 ID。

b2a8a925-477a-4ed7-b825-d5e22500****
ImageUrlstring

镜像仓库地址。

说明 如果您是通过 JAR 包或 WAR 包部署，那么由 SAE 平台所生成的镜像不对外开放下载。
registry-vpc.cn-beijing.aliyuncs.com/sae-demo-image/cartservice:1.0
PackageVersionstring

版本信息。

1609939496200
Eipstring

弹性公网 IP。

8.129.XX.XXX
FinishTimeStamplong

实例创建完成的时间戳。单位：毫秒。

1642757283000
DebugStatusboolean

实例是否在调试中。取值说明如下：

  • True：是。
  • False：否。
False
ErrorCodestring

错误码。取值说明如下：

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

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

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

获取应用实例列表是否成功。取值说明如下：

  • true：获取成功。
  • false：获取失败。
true

示例

正常返回示例

JSON格式

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "CurrentPage": 1,
    "TotalSize": 10,
    "PageSize": 10,
    "Instances": [
      {
        "CreateTimeStamp": 1558442609000,
        "VSwitchId": "vsw-***",
        "InstanceContainerStatus": "Running",
        "InstanceHealthStatus": "WithoutHealthCheckConfig",
        "InstanceContainerRestarts": 0,
        "GroupId": "b2a8a925-477a-4ed7-b825-d5e22500****",
        "InstanceContainerIp": "192.168.X.X",
        "InstanceId": "b2a8a925-477a-4ed7-b825-d5e22500****",
        "ImageUrl": "registry-vpc.cn-beijing.aliyuncs.com/sae-demo-image/cartservice:1.0",
        "PackageVersion": "1609939496200",
        "Eip": "8.129.XX.XXX",
        "FinishTimeStamp": 1642757283000,
        "DebugStatus": true,
        "SidecarContainersStatus": [
          {
            "ContainerId": "",
            "ContainerStatus": "",
            "ImageUrl": ""
          }
        ],
        "MainContainerStatus": "",
        "UnhealthyMessage": ""
      }
    ]
  },
  "ErrorCode": "空",
  "Code": "200",
  "Success": true
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-12-20OpenAPI 返回结构发生变更查看变更详情
上一篇：DescribeEdasContainers - 获取应用微服务容器组件列表下一篇：DescribeApplicationImage - 描述应用镜像信息
文档推荐