华为云用户手册

  • 修改策略配置 使用管理员帐号登录云应用的管理控制台。 在左侧导航栏中单击“策略组”,进入策略组列表页面。 单击“策略配置”,进入通用策略配置页面。 根据需要设置启用或禁用对应策略项。策略项内容如表1所示。 表1 策略管理 策略类型 策略参数 策略说明 文件重定向 固定驱动器 只读,对驱动器和存储设备中的文件只可以预览。 读写,对驱动器存储设备中的文件可编辑修改。 在云应用环境下实现对驱动器的支持,用户可以在虚拟机中通过文件重定向方式使用驱动器。 可移除驱动器 光盘驱动器 网络驱动器 剪切板重定向 开启双向 启用后最终用户可以在云应用中复制数据并在本地桌面中粘贴,同时也可以在本地桌面中复制数据后在云应用中粘贴。 服务端到客户端 启用后最终用户只支持在云应用中复制数据并在本地桌面中粘贴。 客户端到服务端 启用后,只支持在本地桌面中复制数据并在云应用中粘贴。 说明: 文件拷贝操作只支持使用Windows客户端到服务端,且需要开启文件重定向及对应驱动器。 打印机设备重定向 服务端到客户端 用户可以使用TC上连接的打印机设备 会话配置 无键鼠事件自动断开 自动断开:客户端中无键鼠操作超过设置的等待时间后,将自动断开与服务器的连接,关闭应用。 已禁用:关闭自动断开功能禁用。 等待时间(分钟) 无键鼠事件自动断开的等待时间设置。配置范围:3~86400 自动注销 开启无键鼠事件自动断开功能后,可配置在断开多久后自动注销会话。 会话断连保留时长(分钟) 无键鼠事件自动断开功能开启后,自动断开连接后,等待设置的会话保留时长后,自动注销会话。配置范围:1~86400。 单击“高级策略”,根据场景需求编辑高级策略项。 单击“保存”。
  • 操作步骤 使用管理员帐号登录云应用的管理控制台。 在左侧导航栏中单击“应用组”,进入应用组列表页面。 单击应用组名称,进入应用列表页面。 单击“添加应用”,进入添加应用列表页面。 选择“应用来源”为“自定义添加”,相关配置参数如所示。 表1 应用配置参数 参数 说明 取值样例 应用名称 应用名称由中文、英文大小写、数字、_-组成,长度范围1~64个字符。 - 应用沙箱模式运行 沙箱适用场景: 不支持在多个远程会话里同时打开的软件,可以通过沙箱实现多开 沙箱使用限制: 沙箱中的数据在沙箱内,删除沙箱,所有的东西都会被清理掉。 如果文件太大,不能拷贝到沙箱中编辑,只能是只读模式。 说明: 请先确认并关联服务器组实例已安装应用沙箱软件;否则应用将无法启动。 勾选 沙箱应用路径 沙箱应用文件的安装位置, 如Sandboxie软件: C:\Program Files\Sandboxie\Start.exe\Start.exe - 版本号 添加的沙盒应用版本号,可根据实际情况填写。 - 发布者 添加沙盒应用的发布者。 - 工作目录 沙箱应用文件的安装目录,如Sandboxie软件:C:\Program Files\Sandboxie 工作目录涉及到读取配置文件、依赖库搜索路径等. - 命令行参数 格式:指令+空格+"在沙箱模式下启动的应用路径"。 例如:/box:DefaultBox "C:\Program Files\Internet Explorer\iexplore.exe" 说明: 在沙箱模式下启动的应用路径必须用双引号“”。 - 描述 根据实际情况填写需要的信息。 - 单击“确定”。 单击“授权用户”,进入用户列表页面。 单击“添加用户”,进入添加用户列表页面。 选择需要使用应用的用户/用户组,单击“确定”。 用户将收到云应用授权服务通知邮件。
  • 操作步骤 使用管理员帐号登录云应用的管理控制台。 在“总览”页面,单击“定时任务”。 进入“定时任务”页面。 单击页面右上角“创建任务”。 弹出“创建定时任务”界面。 配置定时任务信息。 任务类型:选择“开机”。 定时任务名称:用户自定义。 执行周期:支持以下有几种周期,根据用户需求自行选择。 时区:用户可设置对应的时区。 指定时间:可精确到某年某月某日某时某分某秒。 按天:可设置具体时间、间隔天数、过期时间。 按周:可设置具体日期、时间、过期时间。 按月:可设置具体月份、具体日期、时间、过期时间。 不存在的日期会自动跳过,比如:2月30号。 如果存在夏令时,具体时间请查看即将执行时间。 点击“下一步:选择对象”。 跳转至“可选对象”界面。 在“可选对象”的搜索框中搜索云应用服务器名称并勾选。 单击“立即创建”。
  • 操作步骤 使用管理员帐号登录云应用的管理控制台。 在“总览”页面,单击“定时任务”。 进入“定时任务”页面。 单击页面右上角“创建任务”。 弹出“创建任务”界面。 配置定时任务信息。 任务类型:选择“关机”。 您设置好定时关机任务后,当到达定时时间点时,当前云应用服务器有用户连接,为保证用户体验,系统不会执行关机,将自动顺延到下一个定时时间点。 强制执行关机任务:如果勾选后,系统到达定时时间点后,将会强制执行关机。 定时任务名称:用户自定义。 执行周期:支持以下几种周期,根据用户需求自行选择。 时区:用户可设置对应的时区。 指定时间:可精确到某年某月某日某时某分某秒。 按天:可设置具体时间、间隔天数、过期时间。 按周:可设置具体日期、时间、过期时间。 按月:可设置具体月份、具体日期、时间、过期时间。 不存在的日期会自动跳过,比如:2月30号。 如果存在夏令时,具体时间请查看即将执行时间。 点击“下一步:选择对象”。 跳转至“可选对象”界面。 在“可选对象”的搜索框中搜索云应用服务器名称并勾选。 单击“立即创建”。
  • 操作步骤 使用管理员帐号登录云应用的管理控制台。 在左侧导航栏中单击“用户管理”,进入用户列表页面。 根据需要,可执行如表1所示操作。 表1 用户管理操作列表 操作名称 操作步骤 场景说明 用户管理 点击用户将跳转至桌面的“用户管理”页面,详情请参考 云桌面 《管理员用户指南》的“用户管理”章节。 当管理员需要了解用户时,可在云桌面上查看。 用户组管理 点击用户组将跳转至桌面的“用户组管理”页面,详情请参考云桌面《管理员用户指南》的“用户组管理”章节。 当管理员需要了解用户组时,可在云桌面上查看 查看授权应用组 在用户/用户组所在行,单击“查看授权应用组”,即可进入查看授权应用组列表页面,查看用户/用户组已授权使用的应用组,单击应用组名称,可查看用户具体可用的应用列表。 当管理员需要了解用户/用户组的可用应用列表时,可查看授权应用组。
  • 前提条件 管理员已具有云应用服务的操作权限。 自主注册的华为云帐号默认拥有华为云所有服务的操作权限,如果您使用的是此类帐号,无需再进行确认。 华为云帐号下新建的 IAM 帐号,需要加入“admin”内置用户组,或者拥有云应用服务操作权限的用户组,才可使用云应用。可进入“ 统一身份认证 服务”中查看是否属于“admin”内置用户组。若非“admin”内置用户组,请参见云应用服务授权赋予IAM帐号使用云应用服务的权限。 已参考如何部署AD服务器?、如何部署RD Licensing服务器?准备AD服务器以及RD Licensing服务器,且已配置License完成服务器激活。 仅对接了AD场景需要配置。 为保证RD Licensing服务器能持续可用,需要参考如何配置RDS服务授权及安全策略?完成RD Licensing服务器的RDS服务授权及安全策略配置。 已参考如何配置云应用和Windows AD网络互通配置云应用网络与Windows AD网络互通,并准备以下数据: 域名 域管理员帐号 域管理员密码 主域控制器名称 主域控制器IP地址 主DNS服务器IP地址 备域控制器名称(可选) 备域控制器IP地址(可选) 备DNS服务器IP地址(可选) 仅对接了AD场景需要配置。
  • 使用场景 云应用主要用在如下场景: 简单办公场景 办公场景的特征是计算机主要用来进行日常办公及固定的行业软件使用。针对这种场景,若采用普通虚拟桌面或PC解决方案,用户只使用了虚拟桌面或PC机很少的能力,但仍然需购买PC,增加了成本。使用云应用可以大幅减少用户的硬件投资及操作系统投资。 简单办公场景的典型远程应用场景如下: 任务型工作:用户通过Intranet或Internet使用公司集中部署的OA、Notes、其他业务系统等,无需在终端上安装相关软件。 双网隔离:在内外网隔离环境下,但用户又有访问外部网络的需求时,可将浏览器通过云应用平台发布出来,所有访问外部网络的操作都在云应用上完成,而用户个人机器并没有访问外部网络的权限,保证了用户数据的安全性。 父主题: 简介
  • 创建IAM用户使用云应用 创建用户组并授权 在IAM控制台创建用户组,并授予该用户组如表1中所示的“Workspace Administrator”、“IMS Administrator”和“E CS FullAccess”权限,并选择授权范围。 创建用户并加入用户组 在IAM控制台创建用户,并将其加入1中创建的用户组。 用户登录并验证权限 新创建的用户登录控制台,验证云应用的管理员权限。 进入云应用的管理控制台。 选择“同意授权”,进入云应用服务主界面。 云应用提供了弹性扩容特性,需要获取用户授权,用于创建委托帐号,便于用户在启用弹性扩容特性后,系统能自动进行扩缩容。 开通服务后,单击“服务器组”,进入服务器组列表页面,单击右上角“创建服务器组”,若没有提示权限不足,表示赋予的权限已生效。
  • 云应用服务管理员权限 默认情况下,新建的IAM用户没有任何权限,您需要将其加入用户组,并给用户组授予云应用管理员权限,才能使得用户组中的用户获得对应权限,这一过程称为授权。授权后,IAM用户可以在对应拥有权限的项目中对应用资源进行操作。 如表1所示,包括了云应用(云桌面)的所有系统权限以及依赖服务所需的操作权限。其中“依赖关系”表示对应服务的系统权限对其它角色的依赖。由于华为云各服务之间存在业务交互关系,云应用(云桌面)的角色依赖其他服务的角色实现功能。因此给用户组授予云应用的权限时,需选择如表1所示权限,且请勿取消已默认选择的其他依赖权限,否则云应用的权限将无法生效。 表1 云应用(云桌面)系统权限 系统权限 描述 依赖关系 Workspace Administrator 云应用(云桌面)服务的管理员权限,即拥有云应用(云桌面)服务下的所有执行权限。 依赖Tenant Guest、Server Administrator、VPC Administrator角色。 Tenant Guest:全部云服务只读权限(除IAM权限)。 Server Administrator:服务器管理员。 VPC Administrator:网络管理员。 IMS Administrator 镜像服务 的所有执行权限。 该角色有依赖,需要勾选依赖的角色:Tenant Administrator。
  • 举例说明 例如您希望a、b两组员工之间的权限隔离,即a组员工使用区域一项目云应用资源、b组员工使用区域二项目云应用资源。 您可以创建A、B两个用户组并授权,即将用户组A赋予区域一项目中云应用的管理员权限,将用户组B赋予区域二中云应用的管理员权限。 再创建两个IAM用户user1、user2,并将IAM用户user1加入用户组A,将IAM用户user2加入用户组B。此时IAM用户user1即拥有区域一项目云应用管理员权限,IAM用户user2拥有区域二项目云应用管理员权限。 a组员工的管理员可以使用IAM用户user1的帐号登录华为云,进入区域一项目的云应用控制台页面,为a组员工发布应用,并对区域一项目中的云应用进行管理。b组员工的管理员可以使用IAM用户user2的帐号登录华为云,进入区域二项目的云应用控制台页面,为b组员工发布应用,并对区域二项目中的云应用进行管理。操作流程如图1所示。IAM用户创建请参见创建IAM用户。 图1 操作示意图
  • 操作步骤 使用管理员帐号登录云应用的管理控制台。 在左侧导航栏中单击“服务器组”,进入服务器组列表页面。 单击“创建服务器组”,进入服务器组配置页面。 参考表1配置参数。 表1 服务器组参数说明 参数 说明 取值样例 服务器组名称 自定义服务器组名称。 命名规则: 名称长度范围为1~64个字符。 名称中可包含大写字母、小写字母、数字、中划线(-)、下划线(_)。 Server_Gp-Win2016 区域 根据规划选择应用待部署区域。 不同区域的应用之间内网互不相通,且需分区域管理应用,推荐将应用创建在同一区域。 华南-广州 项目 根据规划选择应用待部署项目。 cn-north-5(默认) 会话模式 单会话模式 多会话模式 说明: 不对接场景AD仅支持单会话模式。 对接AD场景支持单会话模式和多会话模式。 - 应用组类型 应用:应用是单个应用程序,用户可以访问应用程序而无需安装。 桌面:桌面应用组是一种完整的虚拟桌面,用户访问的是远程桌面。 应用 关联应用组 根据需求选择是否勾选自动创建应用组。 勾选自动创建应用组。 计费方式 根据服务器使用场景选择“包年/包月”或者“按需计费”。 按需计费 可用分区 可用区是在同一区域下,电力、网络隔离的物理区域。可用区之间内网互通,不同可用区之间物理隔离,一个可用区发生故障后不会影响同一区域下的其他可用区。 随机分配 操作系统 选择待创建服务器的操作系统类型,目前仅支持Windows操作系统。 Windows CPU架构 目前仅支持X86计算。 X86计算 套餐类型 根据应用类型选择办公类型及规格。 通用办公型为普通规格,适用于通用的办公应用。 图形优化型为GPU规格,适用于高效图形制作类应用。 通用办公型 - 镜像 选择待创建的服务器使用的镜像类型及具体的镜像版本。 公共镜像是云应用提供的标准操作系统镜像,所有用户可见,包括操作系统及预装的应用。公共镜像具有高度稳定性,皆为正版授权。支持Windows Server 2016/2019数据中心版中英文镜像。 私有镜像是基于标准操作系统镜像文件创建的个人镜像,可自定义预装应用,仅用户自己可见。请选择制作应用发布镜像中已生成的镜像。 私有镜像 - 系统盘 选择磁盘类型并设置磁盘大小。 磁盘类型性能说明可参考云硬盘产品介绍。 高IO磁盘:是指由SAS存储提供资源的磁盘类型。 超高IO磁盘:是指由SSD存储提供资源的磁盘类型。 磁盘大小范围:10GB~1020GB 高IO磁盘 1020GB 网络 选择虚拟网络。如果需要在多个业务子网中可用应用,可选择多个子网,或者在网络配置下方单击“单击此处创建子网”,创建子网。 虚拟私有云(VPC)为云应用构建隔离的、用户自主配置和管理的虚拟网络环境,方便管理、配置内部网络。您的云应用将被创建在所选择的虚拟私有云子网内,以便访问企业内网的资源和应用。 - 增购会话数 单台服务器增购会话数,范围根据服务器套餐大小选择。 说明: 服务器组创建完成后,会话数不支持变更。 - 会话调度策略 会话连接数:服务器会话连接数量,范围根据服务器套餐大小选择。 CPU使用率:服务器CPU的使用率,范围为1~100。 内存使用率:服务器内存使用率,范围为1~100。 说明: 若服务器任意一个指标超出阈值,将不会再接受会话,策略会调度服务器组可用的服务器建立会话。 - OU名称 在Windows AD服务器上创建了OU时,可选择对应使用的OU。 说明: 仅对接AD场景需要配置。 - 协议组件 HDP协议服务端接入组件:安装在云应用服务器实例中,与云办公客户端进行通信接入的代理组件 说明: 勾选后,如果您镜像里的组件版本过低,我们会在发放过程进行同步升级组件,预计会增加整体机器的发放时长。 勾选 IP虚拟化 :关闭IP虚拟化开关。 :开启IP虚拟化开关。 说明: 启用IP虚拟化,将给每个会话分配不同的IP。服务器预分配的虚拟IP个数与最大会话数一致。 最大会话数=默认会话数+增购会话数。 仅多会话模式支持配置。 扩缩容策略 :关闭扩缩容策略开关。 :启用扩缩容策略开关。 启用扩缩容策略开关,配置扩容策略。 扩容策略:会话使用率超过x%时,自动创建按需付费的弹性资源。 说明: 会话使用率 = 实例会话数子和/(实例最大会话数*可用实例书) 每次创建x台(取值范围:1~10),最多创建x台(取值范围:1~100) 缩容策略:无会话连接的弹性资源最多保留x分钟。(取值范围:5~120分钟) 配置购买数量。 计费方式为“包年/包月”时,可根据实际需要配置购买时长。 单击“下一步:确认配置”,进入配置确认页面。 计费方式为“包年/包月”时,可以选择是否自动续费。 最大会话数:选择套餐的默认会话数量加上增购会话数。 确认配置无误,单击“立即购买”。 计费方式为“按需计费”,资源创建成功后,可在“服务器组”列表页面查看已购买的服务器组及其服务器。 计费方式为“包年/包月”,则进入订单支付页面,完成支付后,可在“服务器组”列表页面查看已购买的服务器组及其服务器。
  • 操作步骤 使用管理员帐号登录云应用的管理控制台。 在左侧导航栏中单击“策略组”,进入策略组列表页面。 在页面右上角单击“创建策略组”,进入创建策略组基础信息配置页面。 设置“策略名称”和“描述”信息。 “策略名称”必须由半角数字、字母和下划线组成,输入长度不可超过55个字符。 描述字数最多支持255个。 根据实际需求,选择“创建模式”。 全新创建:使用空的默认模板创建。 从模板创建:使用现有的策略模板创建,配置项默认与该策略模板相同。 管理员可以选择已存在的策略模板或者通过新增自定义模板创建新的模板。 系统已提供四种不同场景的策略模板。帮助您快速完成云应用策略配置。 安全场景:安全场景下,通过华为云桌面协议禁止云应用中的数据流出到个人存储设备,确保数据资产只保留在企业的数据中心。 游戏场景:针对游戏场景,优化鼠标的跟随性和画面显示,在带宽有限的场景下,优先保证流畅度,提升游戏体验。 制图场景:针对制图场景,调整显示帧率,提升画面的显示质量;调整鼠标跟随模式,降低光标与图片之间的间隔,减少用户的视觉差异。 视频编辑 场景:针对视频编辑场景,通过视频加速,优化视频播放质量,鼠标紧密跟随用户操作,提升用户操作体验。 导入已有策略:如果已经创建过策略,可在已有的策略中选择策略导入,配置项默认与选择的该策略相同。 单击“下一步:策略配置”。 进入通用策略配置页面。 在“通用策略配置”页面中,根据用户的实际场景需求,设置计算机各方面的应用策略。 通用策略精简自高级策略,可以满足常用办公需求。已默认开启满足常用办公需求的策略参数项。 表示该项策略已启用。 表示该项策略已禁用。 通用策略配置的策略内容如表1 策略管理所示。 表1 策略管理 策略类型 策略参数 策略说明 文件重定向 固定驱动器 只读,对驱动器和存储设备中的文件只可以预览。 读写,对驱动器存储设备中的文件可编辑修改。 在云应用环境下实现对驱动器的支持,用户可以在虚拟机中通过文件重定向方式使用驱动器。 可移除驱动器 光盘驱动器 网络驱动器 剪切板重定向 开启双向 启用后最终用户可以在云应用中复制数据并在本地桌面中粘贴,同时也可以在本地桌面中复制数据后在云应用中粘贴。 服务端到客户端 启用后最终用户只支持在云应用中复制数据并在本地桌面中粘贴。 客户端到服务端 启用后,只支持在本地桌面中复制数据并在云应用中粘贴。 说明: 文件拷贝操作只支持使用Windows客户端到服务端,且需要开启文件重定向及对应驱动器。 打印机设备重定向 服务端到客户端 用户可以使用TC上连接的打印机设备 会话配置 无键鼠事件自动断开 自动断开:客户端中无键鼠操作超过设置的等待时间后,将自动断开与服务器的连接,关闭应用。 已禁用:关闭自动断开功能禁用。 等待时间(分钟) 无键鼠事件自动断开的等待时间设置。配置范围:3~86400 自动注销 开启无键鼠事件自动断开功能后,可配置在断开多久后自动注销会话。 会话断连保留时长(分钟) 无键鼠事件自动断开功能开启后,自动断开连接后,等待设置的会话保留时长后,自动注销会话。配置范围:1~86400。 配置高级策略。 通用策略配置可以满足常用办公需求,如有特殊场景需求,可进行“高级策略”配置。 在通用策略配置页面,单击“高级策略”。 进入“高级策略”配置页面。 图1 高级策略配置入口 根据场景需求,配置高级策略。如图2 高级策略配置所示,高级策略配置参数请参考配置高级策略参数。 图2 高级策略配置 单击“下一步:应用对象”。 按实际情况选择“对象类型”,选择对象,如图3所示。 所有对象 用户 用户组 应用组 图3 选择应用对象 单击“下一步:完成”。 创建策略成功,策略会在用户下一次登录云应用客户端后生效。
  • 操作步骤 使用管理员帐号登录云应用的管理控制台。 在左侧导航栏中单击“应用组”,进入应用组列表页面。 单击应用名称,进入应用列表页面。 单击“添加应用”,进入添加应用列表页面。 选择“应用来源”为“私有镜像”,并在应用列表中选择需要发布的应用。 同一应用组中不能添加名称相同的应用。 单击“确定”。 单击“授权用户”,进入用户列表页面。 单击“添加用户”,进入添加用户列表页面。 选择需要使用应用的用户/用户组,单击“确定”。 用户将收到云应用授权服务通知邮件。 AD用户组的用户,暂不支持发送通知消息。
  • 操作步骤 使用管理员帐号登录云应用的管理控制台。 在左侧导航栏中单击“服务器组”,进入服务器组列表页面。 单击需要修改挂载策略的服务器组名称,进入服务器组详情页面 单击“挂载策略”右侧“”,弹出“修改挂载策略”窗口。 根据需求,配置挂载目录设置。 个人目录:选择服务器组挂载策略为个人目录时,服务器只挂载个人文件夹。 共享目录:选择服务器组挂载策略为共享目录时,服务器只挂载共享文件夹。 所有目录:服务器组挂载策略为所有目录时,服务器同时挂载个人文件夹和共享文件夹。 单击“确定”。
  • 响应示例 状态码: 200 get template successfully { "name" : "AI Drawing Stable-Diffusion", "description" : "AI Drawing", "runtime" : "http", "category" : "AI", "params" : "", "image" : "iVBORw0KGgxxxxxx", "deploy_count" : 0, "version" : 20231103, "template_guide" : "Stable Diffusion AI Drawing...", "create_time" : 1699328406899, "update_time" : 1699328406899, "resources" : [ { "resource_name" : "Object Storage Service (OBS)", "icon" : "iVBORw0KGgoAAAANSUhEUgAAAGAAAABgCAYAAADixxxx", "href" : "/console/?region=%s&locale=zh-cn#/obs/manage/%s/object/list" } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 name String 模板名称 description String 模板描述 runtime String 模板执行运行时 category String 模板使用场景 params String 模板参数 image String 模板镜像文件(base64编码) deploy_count Long 模板部署次数 version Long 模板版本 template_guide String 模板指南 create_time Long 模板创建时间 update_time Long 模板更新时间 resources Array of AppTemplateResourceDetail objects 模板资源 表4 AppTemplateResourceDetail 参数 参数类型 描述 resource_name String 资源名称 icon String 图标文件(base64编码) href String 超链接地址 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 响应参数 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 响应示例 状态码: 200 Ok { "func_urn" : "urn:fss:xxxxxxxxx:7aad83af3e8d42e99ac194xxxxxxxxxx:function:default:test:latest", "max_async_event_age_in_seconds" : 60, "max_async_retry_attempts" : 1, "destination_config" : { "on_success" : { "destination" : "FunctionGraph", "param" : "{\"func_urn\":\"urn:fss:{region}:5691ba790e2b46ceb38316xxxxxxxxxx:function:default:testPython:latest\"}" }, "on_failure" : { "destination" : "FunctionGraph", "param" : "{\"func_urn\":\"urn:fss:{region}:5691ba790e2b46ceb38316xxxxxxxxxx:function:default:testPython:latest\"}" } }, "created_time" : "2021-03-04T14:50:02+08:00", "last_modified" : "2021-03-04 14:50:02" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 func_urn String 函数URN。 最小长度:1 最大长度:269 max_async_event_age_in_seconds Integer 消息最大存活时长,取值范围[1,86400]。单位:秒。 max_async_retry_attempts Integer 异步调用失败后的最大重试次数,默认值为3。取值范围[0,8]。 destination_config FuncAsyncDestinationConfig object 异步调用目标。 created_time String 异步调用配置的创建时间。 last_modified String 异步调用配置的最后更改时间。 enable_async_status_log Boolean 开启异步调用状态持久化 表4 FuncAsyncDestinationConfig 参数 参数类型 描述 on_success FuncDestinationConfig object 当函数执行成功时,函数计算将调用该配置对应的目标。 on_failure FuncDestinationConfig object 当函数执行失败(系统错误或函数内部错误)时,函数计算将调用该配置对应的目标。 表5 FuncDestinationConfig 参数 参数类型 描述 destination String 目标类型。 OBS:通知到OBS服务。 SMN :通知到SMN服务。 DIS:通知到DIS服务。 FunctionGraph: 通知到函数服务。 枚举值: OBS SMN DIS FunctionGraph param String 通知目标服务对应参数,json字符串。 OBS:包含bucket桶,对象目录前缀prefix,对象默认expires过期时间[0~365]天,0默认不过期。 SMN:包含smn 主题topic_urn。 DIS:包含DIS 通道名stream_name。 FunctionGraph:包含func_urn,函数urn 状态码: 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 响应示例 状态码: 200 list templates successfully { "templates" : [ { "id" : "5351xxxx-xxxx-xxxx-xxxx-xxxxxxfa2d27", "name" : "AI Drawing Stable-Diffusion", "runtime" : "http", "category" : "AI", "description" : "AI Drawing", "image" : "iVBORw0KGgxxxxxx" } ], "next_marker" : 11, "count" : 11 }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 templates Array of ListAppTemplatesResult objects 函数应用程序模板列表 next_marker Long 下次读取位置 count Long 应用程序模板总数 表5 ListAppTemplatesResult 参数 参数类型 描述 id String 模板id name String 模板名称 runtime String 模板执行运行时 category String 模板使用场景 description String 模板描述 image String 模板镜像文件(base64编码) 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • URI GET /v2/{project_id}/fgs/application/templates 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目 ID,获取方式请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 marker 否 String 本次查询起始位置,默认值0 缺省值:0 最小长度:0 最大长度:64 maxitems 否 String 本次查询最大返回的数据条数,最大值500,默认值100 缺省值:0 最小长度:0 最大长度:64 runtime 否 String 模板执行运行时 缺省值:all category 否 String 模板类别 缺省值:all
  • 响应参数 状态码: 202 表4 响应Header参数 参数 参数类型 描述 Content-Type String application/json 表5 响应Body参数 参数 参数类型 描述 instance_id String 预留实例id 状态码: 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 请求示例 创建函数应用程序。 POST /v2/{project_id}/fgs/applications { "name" : "appTest", "template_id" : "xxx", "params" : { }, "description" : "应用程序测试", "enterprise_project_id" : "0", "agency_name" : "" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 application_id String 应用id 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 响应示例 状态码: 200 list applications successfully { "applications" : [ { "id" : "a2685d64-9bf6-481d-8845-0482271f99cc", "name" : "testApplication", "status" : "repoFail", "last_modified_time" : 1699320954910, "description" : "test function application" } ], "next_marker" : 1, "count" : 1 }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 applications Array of ListFunctionApplicationResult objects 函数应用列表 next_marker Long 下次读取位置 count Long 应用程序总数 表4 ListFunctionApplicationResult 参数 参数类型 描述 id String 应用id name String 应用名称 status String 应用状态 last_modified_time Long 最后修改时间 description String 应用描述 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 响应示例 状态码: 200 get application successfully { "name" : "testApplication", "last_modified_time" : 1699356705515, "stack_resources" : null, "status" : "repoFail", "stack_name" : "", "repo_name" : "", "description" : "test for function application.", "repo" : { }, "project_id" : "c53626012ba84727b938ca8bf03108ef" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 name String 应用名称 last_modified_time Long 最后修改时间 stack_resources StackResource object 资源栈 status String 应用状态 stack_name String 资源栈名称 stack_id String 资源栈id repo_name String 存储库名称 description String 应用描述 repo RepoInfo object 存储库信息 pipeline_id String 管道id project_id String 项目id apig_url String 调用URL 表4 StackResource 参数 参数类型 描述 physical_resource_id String 物理资源id physical_resource_name String 物理资源名称 logical_resource_name String 逻辑资源名称 logical_resource_type String 逻辑资源类型 resource_status String 资源状态 status_message String 状态信息 href String 超链接地址 display_name String 云服务名称 表5 RepoInfo 参数 参数类型 描述 https_url String http地址 web_url String 存储库链接 repo_status String 存储库状态 error_msg String 报错信息 project_id String 项目id 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 结构化模板日志详情 NGINX日志示例 表1 结构化模板示例 模板名称 示例日志 NGINX 192.168.1.101 - [27/Aug/2018:14:20:29 +0800] "GET http://www.example.com / HTTP/1.0" 200 8796 6775 "-" "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/34.0.1847.131 Safari/537.36" "-" "0.185" "0.010" 12.129.120.121:8090 200 794 结构化字段及字段说明 表2 结构化字段 字段 示例 描述 类型 body_bytes_sent 6775 发送给客户端的文件主体内容的大小 long bytes_sent 8796 响应大小 long host www.example.com 请求域名 string http_referer - 来源页面链接 string http_user_agent Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/34.0.1847.131 Safari/537.36 客户端浏览器信息 string http_x_forwarded_for - 客户端的真实ip string remote_addr 192.168.1.101 客户端地址 string remote_user - 远程客户端用户名称 string request_length 794 请求长度 long request_method GET 请求方法 string request_time 0.185 请求时间 float request_uri / 请求url string scheme http http或https string server_protocol HTTP/1.0 请求协议 string status 200 响应状态码 long time_local 27/Aug/2018:14:20:29 日期 string upstream_addr 12.129.120.121:8090 后端服务器地址 string upstream_response_time 0.010 后端服务器响应时间 float upstream_status 200 后端服务器响应状态 long
共100000条