文档

GetAppInstanceGroup - 查询指定交付组详细信息

更新时间:

查询指定交付组详细信息。

调试

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

授权信息

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

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

请求参数

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

交付组 ID。可调用接口 ListAppInstanceGroup 获取。

aig-9ciijz60n4xsv****
ProductTypestring

产品类型。

枚举值:
  • CloudApp无影云应用
CloudApp

返回参数

名称类型描述示例值
object

返回信息集合。

RequestIdstring

请求 ID。

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

AppInstanceGroupModels

Appsarray<object>

应用信息列表。

object

应用信息。

AppIdstring

应用 ID。

ca-i87mycyn419nu****
AppNamestring

应用名称。

办公应用
AppVersionstring

应用版本。

1.0.0
AppVersionNamestring

应用版本名称。

初始版本
AppIconstring

应用图标。

https://app-center-icon-****.png
AppCenterImageIdstring

应用镜像 ID。

img-8z4nztpaqvay4****
RegionIdstring

交付组所属的地域 ID。关于支持的地域详情,请参见使用限制

cn-hangzhou
ProductTypestring

产品类型。

CloudApp
AppInstanceTypestring

交付组规格类型。

__dynamic__
AppInstanceTypeNamestring

交付组规格类型名称

test001
AppInstanceGroupIdstring

交付组 ID。

aig-9ciijz60n4xsv****
Amountinteger

用户设置的包年包月资源的数量。最小值为 1。

1
MinAmountinteger

实例数最小值。最小值为 1。

1
MaxAmountinteger

实例数最大值。最小值为 1。

10
ReserveAmountRatiostring

预留实例百分比,即交付组中未使用的会话比例。取值范围为 0~99。

20
ReserveMinAmountinteger

最小预留实例数,即交付组中未使用会话的最小数量。最小值为 1。

1
ReserveMaxAmountinteger

最大预留实例数,即交付组中未使用会话的最大数量。最小值为 1。

5
ScalingStepinteger

扩容时每次创建会话的数量。最小值为 1。

10
ScalingUsageThresholdstring

会话使用率上限阈值(%)。当会话使用率超过该阈值时,将触发自动扩容。会话使用率的计算公式为会话使用率=当前使用中的会话数÷总会话数×100%。取值范围为 0~99。

85
ScalingDownAfterIdleMinutesinteger

无会话连接时长,单位为分钟。当资源内处于无会话连接状态达到此处设置的时长后,将触发自动缩容。最小值为 0。

5
ChargeTypestring

付费方式。

枚举值:
  • PostPaid按量付费
  • PrePaid包年包月
PrePaid
ChargeResourceModestring

售卖模式。

枚举值:
  • AppInstance按会话售卖
  • Node按资源售卖
Node
GmtCreatestring

创建时间。

2022-04-26T15:06:16.000+00:00
Statusstring

交付组状态。

枚举值:
  • PUBLISHED发布成功
  • FAILED发布失败
  • MAINTAIN_FAILED更新失败
  • EXPIRED已到期
  • MAINTAINING更新中
  • CEASED已欠费
  • EXPIRED_RECYCLING过期回收中
  • DEPLOYING发布中
PUBLISHED
NodePoolarray<object>

资源组信息。

object

资源组信息。

NodePoolIdstring

资源组 ID。

rg-g6922kced36hx****
NodeInstanceTypestring

购买资源的规格类型 ID。

appstreaming.vgpu.4c8g.2g
NodeAmountinteger

当前包年包月资源的总数量。

1
NodeUsedinteger

使用中的包年包月资源数量。

1
NodeCapacityinteger

并发会话数,即单个资源可同时连接的会话数。如果同时连接的会话数过多,可能导致应用的使用体验下降。取值范围因资源规格不同而不同。各资源规格对应的取值范围分别是:

  • appstreaming.general.4c8g:1~2;
  • appstreaming.general.8c16g:1~4;
  • appstreaming.vgpu.8c16g.4g:1~4;
  • appstreaming.vgpu.8c31g.16g:1~4;
  • appstreaming.vgpu.14c93g.12g:1~6;
2
ScalingNodeAmountinteger

弹性资源总数量。

8
ScalingNodeUsedinteger

使用中的弹性资源数量。

4
StrategyTypestring

弹性策略类型。

说明 NODE_SCALING_BY_USAGE(按用量伸缩策略)仅适用于PrePaid(包年包月)资源;NODE_SCALING_BY_SCHEDULE(定时伸缩策略)仅适用于PostPaid(按量付费)资源。
枚举值:
  • NODE_FIXED不使用弹性资源
  • NODE_SCALING_BY_SCHEDULE定时伸缩
  • NODE_SCALING_BY_USAGE按用量伸缩策略
NODE_FIXED
Amountinteger

创建交付组时购买资源的数量。

2
MaxScalingAmountinteger

扩容时最多创建资源的数量。

8
MaxIdleAppInstanceAmountinteger

空闲会话数上限。指定该值时,当会话使用率超过ScalingUsageThreshold且当前交付组空闲会话数小于MaxIdleAppInstanceAmount时,才会触发自动扩容,否则认为交付组空闲会话已足够使用,不自动扩容。该参数可用于灵活控制弹性扩容行为和降低使用成本。

3
ScalingStepinteger

扩容时每次创建资源的数量。取值范围:1~10。

2
ScalingUsageThresholdstring

会话使用率上限阈值(%)。当会话使用率超过该阈值时,将触发自动扩容。会话使用率的计算公式为会话使用率=当前会话数÷(资源总数×资源并发会话数)×100%

85
ScalingDownAfterIdleMinutesinteger

无会话连接时长,单位为分钟。当资源内处于无会话连接状态达到此处设置的时长后,将触发自动缩容。默认值:5。

5
RecurrenceSchedulesarray<object>

策略执行周期列表。

object

策略执行周期。

RecurrenceTypestring

策略执行周期的类型。必须同时指定RecurrenceTypeRecurrenceValues

Weekly
RecurrenceValuesarray

策略执行周期的数值列表。

integer

策略执行周期的数值。

1
TimerPeriodsarray<object>

策略执行周期的时间段列表。

object

策略执行周期的时间段。

Amountinteger

目标资源数量。

5
EndTimestring

结束时间。格式为 HH:mm

11:00
StartTimestring

开始时间。格式为 HH:mm

09:30
StrategyDisableDatestring

策略失效日期。格式为:yyyy-MM-dd。

2022-09-08
StrategyEnableDatestring

策略生效日期。格式为:yyyy-MM-dd。

2022-08-01
WarmUpboolean

是否开启资源预热策略。

false
NodeTypeNamestring

资源规格名称。

无影-通用型_4核8G
SpecIdstring

与交付组 ID 唯一对应的 ID。

spec-8o18t8uc31qib0****
SessionTimeoutstring

会话断连保留时长,单位为分钟。终端用户会话断开连接后,会话将保留此处设置的时长,然后再注销。如果始终保留,则填写-1。取值范围:-1 和 3~300。默认值为15

15
AppInstanceGroupNamestring

交付组名称。

办公应用
ExpiredTimestring

交付组到期时间。

2022-04-27T16:00:00.000+00:00
OtaInfoobject

OTA 升级任务信息。

OtaVersionstring

当前 OTA 版本。

0.0.1-D-20220615.11****
NewOtaVersionstring

新的 OTA 版本。为空表示没有新版本。

0.0.1-D-20220630.11****
TaskIdstring

OTA 升级任务 ID。

ota-e49929gv8acz5****
OsTypestring

系统类型。

Windows
AppCenterImageNamestring

应用镜像名称。

OfficeApps
ResourceStatusstring

资源状态。

AVAILABLE
AppPolicyIdstring

应用策略 ID。

pg-g3k5wa2ms2****
SkipUserAuthCheckboolean

是否跳过用户授权校验。

枚举值:
  • true不校验
  • false校验 [默认值]
false

示例

正常返回示例

JSON格式

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "AppInstanceGroupModels": {
    "Apps": [
      {
        "AppId": "ca-i87mycyn419nu****",
        "AppName": "办公应用",
        "AppVersion": "1.0.0",
        "AppVersionName": "初始版本",
        "AppIcon": "https://app-center-icon-****.png"
      }
    ],
    "AppCenterImageId": "img-8z4nztpaqvay4****",
    "RegionId": "cn-hangzhou",
    "ProductType": "CloudApp",
    "AppInstanceType": "__dynamic__",
    "AppInstanceTypeName": "test001",
    "AppInstanceGroupId": "aig-9ciijz60n4xsv****",
    "Amount": 1,
    "MinAmount": 1,
    "MaxAmount": 10,
    "ReserveAmountRatio": "20",
    "ReserveMinAmount": 1,
    "ReserveMaxAmount": 5,
    "ScalingStep": 10,
    "ScalingUsageThreshold": "85",
    "ScalingDownAfterIdleMinutes": 5,
    "ChargeType": "PrePaid",
    "ChargeResourceMode": "Node",
    "GmtCreate": "2022-04-26T15:06:16.000+00:00",
    "Status": "PUBLISHED",
    "NodePool": [
      {
        "NodePoolId": "rg-g6922kced36hx****",
        "NodeInstanceType": "appstreaming.vgpu.4c8g.2g",
        "NodeAmount": 1,
        "NodeUsed": 1,
        "NodeCapacity": 2,
        "ScalingNodeAmount": 8,
        "ScalingNodeUsed": 4,
        "StrategyType": "NODE_FIXED",
        "Amount": 2,
        "MaxScalingAmount": 8,
        "MaxIdleAppInstanceAmount": 3,
        "ScalingStep": 2,
        "ScalingUsageThreshold": "85",
        "ScalingDownAfterIdleMinutes": 5,
        "RecurrenceSchedules": [
          {
            "RecurrenceType": "Weekly",
            "RecurrenceValues": [
              1
            ],
            "TimerPeriods": [
              {
                "Amount": 5,
                "EndTime": "11:00",
                "StartTime": "09:30"
              }
            ]
          }
        ],
        "StrategyDisableDate": "2022-09-08",
        "StrategyEnableDate": "2022-08-01",
        "WarmUp": false,
        "NodeTypeName": "无影-通用型_4核8G"
      }
    ],
    "SpecId": "spec-8o18t8uc31qib0****",
    "SessionTimeout": "15",
    "AppInstanceGroupName": "办公应用",
    "ExpiredTime": "2022-04-27T16:00:00.000+00:00",
    "OtaInfo": {
      "OtaVersion": "0.0.1-D-20220615.11****",
      "NewOtaVersion": "0.0.1-D-20220630.11****",
      "TaskId": "ota-e49929gv8acz5****"
    },
    "OsType": "Windows",
    "AppCenterImageName": "OfficeApps",
    "ResourceStatus": "AVAILABLE",
    "AppPolicyId": "pg-g3k5wa2ms2****",
    "SkipUserAuthCheck": false
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-09-12OpenAPI 返回结构发生变更查看变更详情
2023-12-28OpenAPI 返回结构发生变更查看变更详情
2023-05-12OpenAPI 返回结构发生变更查看变更详情
2023-04-28OpenAPI 返回结构发生变更查看变更详情
2023-03-24OpenAPI 返回结构发生变更查看变更详情