文档

ListProjects - 获取项目列表

获取项目列表

接口说明

项目相当于云 Flow 控制台的资源配置模块

调试

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

授权信息

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

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

请求参数

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

每页展示数据条数。

枚举值:
  • 20默认值
10
PageNumberinteger

页码(首页传 1)。

1
ProjectIdstring

项目 ID。

p-065z4tu9ak07h****
ProjectNamestring

项目名称。

notepad++***
SortTypestring

排序类型。

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

项目状态列表。

integer

项目状态。

枚举值:
  • 0未配置
  • 1可用
  • 2超期/时间用完
1

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

每页的查询结果数量。

10
PageNumberinteger

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

1
Codestring

状态码:

  • 200:成功。
  • 400:出错。
200
Messagestring

出错时的错误消息。

There is a missing parameter.
Successstring

请求成功与否,成功返回为 true,失败为 false。

true
Dataobject []

调用成功时,返回项目信息列表。

ProjectNamestring

项目名称。

notepad++***
ProjectIdstring

项目 ID。

p-065z4tu9ak07h****
ContentIdstring

项目关联的内容 ID。

c-06vcpamarryyq****
ContentNamestring

项目关联的内容名称。

notepad++***
ProjectStatestring

项目对象状态。

枚举值:
  • 0未配置
  • 1可用
  • 2超期/时间用完
0
SessionSpecstring

项目的统一会话规格。

枚举值:
  • appstreaming.vgpu.basic图形型-基础
  • appstreaming.vgpu.entry图形型-入门
  • appstreaming.vgpu.standard图形型-标准
  • appstreaming.general.basic通用型-基础
  • appstreaming.general.standard通用型-标准
  • appstreaming.vgpu.elementary图形型-初级
  • appstreaming.general.entry通用型-入门
appstreaming.general.basic
AvailableHoursinteger

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

3174301
AccessPageIdarray

访问页面 Id 列表。

long

访问页面 Id。

******
MaxHourslong

会话包时长最大值。

1000
MaxSessionslong

最大会话数量。

100
Descriptionstring

项目描述信息。

xxx
CreateTimestring

创建时间。

1701141509000
InUseSessionslong

使用中的会话数量

90
TotalCountinteger

查询结果的总数。

6

示例

正常返回示例

JSON格式

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "PageSize": 10,
  "PageNumber": 1,
  "Code": "200",
  "Message": "There is a missing parameter.",
  "Success": "true",
  "Data": [
    {
      "ProjectName": "notepad++***\n",
      "ProjectId": "p-065z4tu9ak07h****\n",
      "ContentId": "c-06vcpamarryyq****\n",
      "ContentName": "notepad++***",
      "ProjectState": "0",
      "SessionSpec": "appstreaming.general.basic",
      "AvailableHours": 3174301,
      "AccessPageId": [
        0
      ],
      "MaxHours": 1000,
      "MaxSessions": 100,
      "Description": "xxx",
      "CreateTime": "1701141509000",
      "InUseSessions": 90
    }
  ],
  "TotalCount": 6
}

错误码

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

  • 本页导读 (0)
文档反馈