文档

CreateProject - 创建项目

创建一个项目实例,项目实例作用如下 1. 云上环境、会话包和交付组配置的组合体,用户关联这几个实例 2. 作为访问页面的主要输入。

接口说明

  1. 项目相当于云 Flow 控制台的资源配置模块
  2. 当入参 ContentId 背后有多个版本的时候,当前 api 会
    注意 使用默认的那个版本
    同时进行绑定
  3. 只有 Content 的默认版本是可用状态,调用当前接口才可以成功

调试

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

授权信息

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

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

请求参数

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

内容唯一 id。

c-06vcpamarryyq****
Descriptionstring

项目描述。

xxx
FrameRateinteger

帧率(FPS)。

枚举值:
  • 3030
  • 6060
30
TerminalResolutionAdaptationboolean

是否开启分辨率自适应。

枚举值:
  • true默认值
  • falsefalse
true
SessionResolutionWidthinteger

会话分辨率宽度,单位为像素。若 TerminalResolutionAdaptation 为 true,此参数表示最大分辨率高度;若 TerminalResolutionAdaptation 为 false,此参数表示自定义分辨,设置后会话分辨率不跟随终端显示区域变化,始终为此处设置的值。

4096
SessionResolutionHeightinteger

分辨率的高度,单位为像素。若 TerminalResolutionAdaptation 为 true,此参数表示最大分辨率高度;若 TerminalResolutionAdaptation 为 false,此参数表示自定义分辨,设置后会话分辨率不跟随终端显示区域变化,始终为此处设置的值。

4096
StreamingModestring

协议类型。

枚举值:
  • webrtcwebrtc流
  • video视频流
  • mix混合流,默认值
mix
Clipboardinteger

剪切板状态。

枚举值:
  • 0关闭,默认值
  • 1双向允许
  • 2允许粘贴到云上
  • 3允许粘贴到本地
0
FileTransferinteger

文件操作状态。

枚举值:
  • 0不允许传输,默认值
  • 1只允许下载
  • 2只允许上传
  • 3允许上传下载
0
KeepAliveDurationinteger

会话断连保留时长,单位为分钟,有效值 1-300。

15
ProjectNamestring

项目名称。

notepad++xxxxx
CloudEnvIdstring

云环境的唯一 id。

c-xxxxxxx
SessionSpecstring

项目关联的会话规格

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

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

50158E8B-992E-1286-B174-XXXXXXXXXXXX
Datastring

项目 id。

p-xxxxxxxxxxx
Codestring

错误码。

200
Messagestring

出错时的错误消息。

There is a missing parameter.
PageNumberinteger

页码(首页传 1)。

1
PageSizeinteger

每页展示数据条数。

20
Successstring

是否调用成功。true:调用成功。false:调用失败。

true

示例

正常返回示例

JSON格式

{
  "RequestId": "50158E8B-992E-1286-B174-XXXXXXXXXXXX",
  "Data": "p-xxxxxxxxxxx",
  "Code": "200",
  "Message": "There is a missing parameter.",
  "PageNumber": 1,
  "PageSize": 20,
  "Success": "true"
}

错误码

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

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