创建一个项目实例,项目实例作用如下 1. 云上环境、会话包和交付组配置的组合体,用户关联这几个实例 2. 作为访问页面的主要输入。
接口说明
- 项目相当于云 Flow 控制台的资源配置模块
- 当入参 ContentId 背后有多个版本的时候,当前 api 会同时进行绑定注意 使用默认的那个版本
- 只有 Content 的默认版本是可用状态,调用当前接口才可以成功
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
appstreaming:CreateProject | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ContentId | string | 否 | 内容唯一 id。 | c-06vcpamarryyq**** |
Description | string | 否 | 项目描述。 | xxx |
FrameRate | integer | 否 | 帧率(FPS)。 枚举值:
| 30 |
TerminalResolutionAdaptation | boolean | 否 | 是否开启分辨率自适应。 枚举值:
| true |
SessionResolutionWidth | integer | 否 | 会话分辨率宽度,单位为像素。若 TerminalResolutionAdaptation 为 true,此参数表示最大分辨率高度;若 TerminalResolutionAdaptation 为 false,此参数表示自定义分辨,设置后会话分辨率不跟随终端显示区域变化,始终为此处设置的值。 | 4096 |
SessionResolutionHeight | integer | 否 | 分辨率的高度,单位为像素。若 TerminalResolutionAdaptation 为 true,此参数表示最大分辨率高度;若 TerminalResolutionAdaptation 为 false,此参数表示自定义分辨,设置后会话分辨率不跟随终端显示区域变化,始终为此处设置的值。 | 4096 |
StreamingMode | string | 否 | 协议类型。 枚举值:
| mix |
Clipboard | integer | 否 | 剪切板状态。 枚举值:
| 0 |
FileTransfer | integer | 否 | 文件操作状态。 枚举值:
| 0 |
KeepAliveDuration | integer | 否 | 会话断连保留时长,单位为分钟,有效值 1-300。 | 15 |
ProjectName | string | 否 | 项目名称。 | notepad++xxxxx |
CloudEnvId | string | 否 | 云环境的唯一 id。 | c-xxxxxxx |
SessionSpec | string | 否 | 项目关联的会话规格 枚举值:
| appstreaming.general.entry |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "50158E8B-992E-1286-B174-XXXXXXXXXXXX",
"Data": "p-xxxxxxxxxxx",
"Code": "200",
"Message": "There is a missing parameter.",
"PageNumber": 1,
"PageSize": 20,
"Success": "true"
}
错误码
访问错误中心查看更多错误码。