ListPersistentAppInstances - 查询持久会话应用实例列表

查询交付组内的持久会话应用实例列表。

调试

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

授权信息

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

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

请求参数

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

产品类型。

枚举值:
  • CloudApp云应用
  • CloudBrowser云浏览器
  • AndroidCloud云手机
CloudApp
AppInstanceGroupIdstring

交付组 ID。

aig-0bxls9m9arax6****
AppInstancePersistentIdsarray

持久会话 ID 列表。

string

持久会话 ID。

p-0cc7s3mw2fg4j****
PageSizeinteger

每页的查询结果数量,不可超过 100,默认值为 20

20
PageNumberinteger

需展示的查询结果页码,从 1 开始,默认为 1

1

返回参数

名称类型描述示例值
object

响应体。

RequestIdstring

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
TotalCountinteger

查询结果的总数。

15
PageSizeinteger

每页的查询结果数量。

20
PageNumberinteger

当前展示的查询结果页码。

1
PersistentAppInstanceModelsarray<object>

持久会话应用实例信息列表。

dataobject

持久会话应用实例信息。

AppInstancePersistentIdstring

持久会话 ID。

p-0cc7s3mw2fg4j****
AppInstancePersistentNamestring

持久会话应用实例名称。

test-persistent-name
AppInstancePersistentStatusstring

持久会话应用实例状态。

枚举值:
  • STARTING启动中
  • RUNNING运行中
  • STOPPED已停止
  • UNAVAILABLE不可用
  • DELETING删除中
  • PENDING创建中
  • STOPPING停止中
  • DELETED已删除
  • REBUILDING重置中
RUNNING
AppInstanceGroupIdstring

交付组 ID。

aig-0bxls9m9arax6****
AppInstanceIdstring

应用实例 ID。

ai-azn3kmwruh1vl****
AppInstanceStatusstring

应用实例状态。

枚举值:
  • INIT初始化
  • STARTING应用启动中
  • CLOSING应用停止中
  • CLOSED应用已关闭
  • RUNNING应用运行中
  • IDLE空闲
  • BOUND已绑定
  • UNAVAILABLE不可用
  • DELETED已删除
RUNNING
GmtCreatestring

创建时间。

2025-03-13T03:22:18.000+00:00
AuthorizedUsersarray

授权的用户名列表。

authorizedUsersstring

授权的用户名。

user-001

示例

正常返回示例

JSON格式

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "TotalCount": 15,
  "PageSize": 20,
  "PageNumber": 1,
  "PersistentAppInstanceModels": [
    {
      "AppInstancePersistentId": "p-0cc7s3mw2fg4j****",
      "AppInstancePersistentName": "test-persistent-name",
      "AppInstancePersistentStatus": "RUNNING",
      "AppInstanceGroupId": "aig-0bxls9m9arax6****",
      "AppInstanceId": "ai-azn3kmwruh1vl****",
      "AppInstanceStatus": "RUNNING",
      "GmtCreate": "2025-03-13T03:22:18.000+00:00",
      "AuthorizedUsers": [
        "user-001"
      ]
    }
  ]
}

错误码

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