文档

ListSessionPackages - 获取项目的会话包列表

更新时间:

获取项目的会话包列表。

调试

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

授权信息

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

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

请求参数

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

云 Flow 项目 ID。

p-xxxxxxxxxxxx
SessionPackageNamestring

会话包名称。

测试会话包
SortTypestring

自定义排序类型。

枚举值:
  • ASC升序
  • DESC降序
ASC
SessionPackageIdstring

会话包的唯一 ID。

tp-xxxxxxxx
PageSizeinteger

每页展示数据(默认 20 条)。

100
PageNumberinteger

页码(首页传 1), 为空就获取所有数据。

1
StateListarray

会话包状态列表。

integer

会话包状态。

枚举值:
  • 1预定
  • 2未支付
  • 3支付成功
  • 4生产成功
  • 5生产失败
  • 6重建
  • 7取消
  • 8包年包月资源到期关停
  • 9包年包月资源超期释放关停
4

返回参数

名称类型描述示例值
object

返回对象。

RequestIdstring

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5Fxxxxxxxx
PageSizeinteger

每页展示数据。

100
PageNumberinteger

页码。

1
TotalCountlong

当前用户项目总数。

1
Dataobject []

用户会话包数据集。

ProjectIdstring

云 Flow 项目 ID。

p-xxxxxxxxxxxx
ProjectNamestring

云 flow 项目名称

wuying-project-npp-test
SessionPackageIdstring

会话包 ID。

tp-xxxxxxxxx
SessionPackageTypeIdstring

会话包类型 ID。

枚举值:
  • 01000小时,100人并发
  • 15000小时,500人并发
  • 25000小时,500人并发
  • 31小时,10人并发
  • 43小时,20人并发
0
SessionPackageNamestring

会话包名称。

测试会话包
ChargeTypestring

付费方式。

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

会话包对应的会话规格。

appstreaming.general.entry
MaxHourslong

会话包时长最大值。

1000
AvailableHourslong

可用会话时长,剩余可用小时数。

500
MaxSessionslong

最大连接数。

100
SessionUsageRatelong

使用中的会话数量。

60
UserIdentificationlong

租户 ID。

156xxxxxxxxxx
Regionstring

会话包所属的地域 ID。

枚举值:
  • cn-shanghai华东2(上海)
  • cn-hangzhou华东1(杭州)
cn-hangzhou
DeleteStatusinteger

数据库删除标记。

枚举值:
  • 0未删除
  • 1已删除
0
GmtCreatestring

会话包创建时间。

1701170196000
GmtModifiedTimestring

会话包修改时间。

1701170203000
InstanceObjectobject

实例对象。

ExpiredTimestring

到期时间。

2024-05-28T16:00:00Z
InstanceIdstring

会话包 ID。

tp-xxxxxxxxxxx
InstanceTypestring

会话包类型。

appstreaming.general.entry
ResourceIdstring

会话包项目 ID。

p-xxxxxxxxxx
ResourceTypestring

会话包付费类型。

AppSessionPackage
StartTimestring

会话包开始时间。

2023-11-28T04:14:07Z
TotalTimelong

会话包时长。单位:秒。

3600000
UsedTimelong

会话包已使用时间。单位:秒。

1021
Stateinteger

会话包状态。

枚举值:
  • 1预定
  • 2未支付
  • 3已支付
  • 4成功创建
  • 5创建失败
  • 6重建
  • 7取消
  • 8包年包月资源到期关停
  • 9包年包月资源超期释放关停
4

示例

正常返回示例

JSON格式

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5Fxxxxxxxx\n",
  "PageSize": 100,
  "PageNumber": 1,
  "TotalCount": 1,
  "Data": [
    {
      "ProjectId": "p-xxxxxxxxxxxx",
      "ProjectName": "wuying-project-npp-test",
      "SessionPackageId": "tp-xxxxxxxxx",
      "SessionPackageTypeId": "0",
      "SessionPackageName": "测试会话包",
      "ChargeType": "PostPaid",
      "SessionSpec": "appstreaming.general.entry",
      "MaxHours": 1000,
      "AvailableHours": 500,
      "MaxSessions": 100,
      "SessionUsageRate": 60,
      "UserIdentification": 0,
      "Region": "cn-hangzhou",
      "DeleteStatus": 0,
      "GmtCreate": "1701170196000",
      "GmtModifiedTime": "1701170203000",
      "InstanceObject": {
        "ExpiredTime": "2024-05-28T16:00:00Z",
        "InstanceId": "tp-xxxxxxxxxxx",
        "InstanceType": "appstreaming.general.entry\n",
        "ResourceId": "p-xxxxxxxxxx",
        "ResourceType": "AppSessionPackage",
        "StartTime": "2023-11-28T04:14:07Z",
        "TotalTime": 3600000,
        "UsedTime": 1021
      },
      "State": 4
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)
文档反馈