网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务
更新时间:2024-12-27 GMT+08:00
分享

创建服务器组

功能介绍

创建服务器组。

  • 服务器组是一组相同配置的服务器集合,服务器组内的服务器使用同一镜像创建,配置相同,运行相同的应用程序。用户在打开云应用时,会根据调度规则选取组内的一台可用服务器进行连接。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v1/{project_id}/app-server-groups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目唯一标识。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

服务器组名称,名称需满足如下规则:

  1. 由中文,英文大小写,数字,_-组成,不能有空格。

  2. 长度范围1~64个字符。

image_id

String

服务器组关联的镜像ID,用于创建对应组下的云服务器。

image_product_id

String

服务器组的镜像产品ID,当镜像为云市场镜像时,该字段必填。

image_type

String

镜像类型:

  • gold - 云市场镜像

  • public - 公共镜像

  • private - 私有镜像

  • shared - 共享镜像

  • other - 其他

os_type

String

系统类型,当前仅支持Windows。

  • Linux -

  • Windows -

  • Other -

description

String

服务器组描述。

route_policy

RoutePolicy object

路由策略。

product_id

String

产品ID。

说明:
  • 获取方式详见产品套餐管理ListProduct:"GET /v1/{project_id}/product"。

flavor_id

String

规格ID。

vpc_id

String

虚拟私有云ID。

subnet_id

String

网卡对应的子网ID。

system_disk_type

String

磁盘类型,获取可用磁盘类型详见接口磁盘管理ListVolumeType。

  • ESSD - 极速型SSD

  • SSD - 超高IO

  • GPSSD - 通用型SSD

  • SAS - 高IO

  • SATA - 普通IO

system_disk_size

Integer

磁盘容量,单位GB。

ou_name

String

默认组织名称。

cluster_id

String

云服务器系统盘对应的存储池的ID。

availability_zone

String

可用分区。

说明:
  • 将服务创建到指定的可用分区,如果不指定则使用系统随机的可用分区。

  • 获取方式详见可用区管理ListAvailabilityZone:"GET /v1/{project_id}/availability-zone"。

ip_virtual

IpVirtual object

虚拟IP功能选项。

is_vdi

Boolean

是否为vdi单会话模式。

app_type

String

服务器组应用类型:

  • SESSION_DESKTOP_APP - 会话桌面app

  • COMMON_APP - 普通app

extra_session_type

String

付费会话类型:

  • GPU - GPU规格会话。

  • CPU - 普通CPU规格会话。

extra_session_size

Integer

付费会话数,单位/个。

tags

Array of TmsTag objects

标签信息,最多包含20个key,不允许重复。

enterprise_project_id

String

企业项目ID,仅企业项目需配置(字段为空或者0表示使用默认default企业项目)。

primary_server_group_id

String

主服务器组id,绑定主服务器组,则创建的是备服务器。

server_group_status

Boolean

是否启用服务器组。

表4 RoutePolicy

参数

是否必选

参数类型

描述

max_session

Integer

单台服务器最大的链接会话数。

cpu_threshold

Integer

cpu使用率阈值,单位为%。

mem_threshold

Integer

内存使用率阈值,单位为%。

表5 IpVirtual

参数

是否必选

参数类型

描述

enable

Boolean

是否启用虚拟IP功能。

启用虚拟IP功能将占用额外的ip地址,注意合理规划网络ip数量。

约束:

  • 只支持windows镜像。

  • 只支持在创建服务器组时设置功能开关,不支持更新功能开关。

  • 只支持具备dhcp动态分配ip能力的网络。

表6 TmsTag

参数

是否必选

参数类型

描述

key

String

键。最大长度128个unicode字符。

  1. 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @。

  2. 两头不能有空白字符。

value

String

值。每个值最大长度255个unicode字符。

  1. 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @。

响应参数

状态码: 200

表7 响应Body参数

参数

参数类型

描述

id

String

服务器组的唯一标识。

name

String

服务器组名称。

description

String

服务器组描述。

image_id

String

服务器组关联的镜像ID,用于创建对应组下的云服务器。

os_type

String

系统类型,当前仅支持Windows。

  • Linux -

  • Windows -

  • Other -

product_id

String

产品id。

subnet_id

String

网卡对应的子网ID。

system_disk_type

String

磁盘类型,获取可用磁盘类型详见接口磁盘管理ListVolumeType。

  • ESSD - 极速型SSD

  • SSD - 超高IO

  • GPSSD - 通用型SSD

  • SAS - 高IO

  • SATA - 普通IO

system_disk_size

Integer

磁盘容量,单位GB。

is_vdi

Boolean

是否为vdi单会话模式。

extra_session_type

String

付费会话类型:

  • GPU - GPU规格会话。

  • CPU - 普通CPU规格会话。

extra_session_size

Integer

付费会话个数。

app_type

String

服务器组应用类型:

  • SESSION_DESKTOP_APP - 会话桌面app

  • COMMON_APP - 普通app

create_time

String

服务器组创建时间。

update_time

String

服务器组更新时间。

storage_mount_policy

String

用户访问APS的应用时,对应NAS存储目录在APS上的挂载策略。

  • USER - 仅挂载个人目录。

  • SHARE - 仅挂载共享目录。

  • ANY - 挂载目录不做限制(个人和共享NAS存储目录都会自动挂载)。

enterprise_project_id

String

企业项目ID(0表示默认企业项目Id)。

primary_server_group_ids

Array of strings

主服务器组id列表。

secondary_server_group_ids

Array of strings

备服务器组id列表。

server_group_status

Boolean

服务器是否处于启用状态,true表示处于启用状态 false表示处于禁用状态。

site_type

String

站点类型 - CENTER/IES。

site_id

String

站点id。

app_server_flavor_count

Integer

服务器配置总数量。

app_server_count

Integer

服务器总数量。

app_group_count

Integer

关联应用组的总数量。

image_name

String

镜像名称。

product_info

ProductInfo object

产品规格信息。

subnet_name

String

子网名称。

scaling_policy

ScalingPolicy object

弹性伸缩策略。

tags

Array of TmsTag objects

标签信息。

ou_name

String

默认组织名称。

表8 ProductInfo

参数

参数类型

描述

product_id

String

产品id。

flavor_id

String

规格ID。

type

String

产品类型:

  • BASE:表示产品基础套餐,套餐镜像中不包括除操作系统之外的其他商业软件,私有镜像场景只能使用此类套餐。

  • ADVANCED:表示产品高级套餐,套餐镜像中包括了一些商业软件。

architecture

String

产品架构,当前仅支持x86。

  • x86

  • arm

cpu

String

CPU。

cpu_desc

String

CPU描述。

memory

String

内存大小,单位兆:M。

is_gpu

Boolean

是否是GPU类型的规格。

system_disk_type

String

系统盘类型。

system_disk_size

String

系统盘大小。

gpu_desc

String

GPU描述。

descriptions

String

产品描述。

charge_mode

String

套餐标识。

  • 1:表示包周期。

  • 0:表示按需。

contain_data_disk

Boolean

套餐计费是否包含了数据盘。

resource_type

String

资源类型。

cloud_service_type

String

云服务类型。

volume_product_type

String

磁盘产品类型。

sessions

Integer

套餐默认支持的最大会话数。

status

String

产品套餐在销售模式下的状态,取值自ECS的cond:operation:status。

不配置时等同于normal在售状态。

  • normal - 正常商用

  • abandon - 下线(即不显示)

  • sellout - 售罄

  • obt - 公测

  • obt_sellout - 公测售罄

  • promotion - 推荐(等同normal,也是商用)

cond_operation_az

String

产品套餐在可用区的状态,配套status使用。

说明:
  • 此参数是AZ级配置,优选取此参数的值,某个AZ没有在此参数中配置时默认使用status参数的取值。

  • 配置格式“az(xx)”。()内为某个AZ的flavor状态,()内必须要填有状态,不填为无效配置。

  • 例如:套餐在某个region的az0正常商用,az1售罄,az2公测,az3正常商用,其他az显示下线,可配置为:

    • “status”设置为:“abandon” 。

    • “cond_operation_az”设置为:“az0(normal), az1(sellout), az2(obt), az3(normal)”。

  • 说明:如果flavor在某个AZ下的状态与status配置状态不同,必须配置该参数。

sub_product_list

Array of strings

专属主机的子产品。

domain_ids

Array of strings

产品属于专有的domainId。

package_type

String

套餐类型:

  • general:表示产品通用套餐。

  • dedicated:表示产品专属主机套餐。

expire_time

String

产品套餐过期时间,产品将在改时间点后逐步下架。

support_gpu_type

String

产品套餐支持的GPU类型。

表9 ScalingPolicy

参数

参数类型

描述

enable

Boolean

是否启用策略,默认启用:

'true': 启用

'false': 禁用

max_scaling_amount

Integer

最大扩容数量。

single_expansion_count

Integer

单次扩容数量。

scaling_policy_by_session

ScalingPolicyBySession object

基于会话的弹性策略。

表10 ScalingPolicyBySession

参数

参数类型

描述

session_usage_threshold

Integer

分组的总会话使用率(达到改阈值后扩容)。

shrink_after_session_idle_minutes

Integer

给定时间内无会话连接的的实例进行释放。

表11 TmsTag

参数

参数类型

描述

key

String

键。最大长度128个unicode字符。

  1. 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @。

  2. 两头不能有空白字符。

value

String

值。每个值最大长度255个unicode字符。

  1. 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @。

状态码: 400

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 401

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 403

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 404

表15 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 405

表16 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 500

表17 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 503

表18 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

请求示例

POST /v1/a4da8115c9d8464ead3a38309130523f/app-server-groups

{
  "name" : "APIExplore测试应用服务器组",
  "image_id" : "",
  "os_type" : "Windows",
  "image_type" : "private",
  "image_product_id" : "00301-2019002-0--0",
  "description" : "",
  "route_policy" : {
    "max_session" : 1
  },
  "product_id" : "workspace.appstream.general.xlarge.2",
  "subnet_id" : "a5842cb4-5718-4b0a-8b27-3a3e9c74f977",
  "system_disk_type" : "SATA",
  "system_disk_size" : 60,
  "vpc_id" : "59785ba5-e5d5-4836-b9de-19f22ac15175",
  "ip_virtual" : {
    "enable" : false
  },
  "is_vdi" : false,
  "availability_zone" : "",
  "app_type" : "COMMON_APP",
  "extra_session_type" : "GPU",
  "extra_session_size" : 1,
  "primary_server_group_id" : "e5d5-4836-b9de-19f22ac15175",
  "server_group_status" : false
}

响应示例

状态码: 200

成功响应。

{
  "id" : "bc05da52-89df-45ba-8146-13fe3ce7c45a",
  "name" : "ApiExpirezSr5_20230606221433888186",
  "description" : "",
  "image_id" : "0fd6c925-6349-49d6-8788-48263b129854",
  "os_type" : "Windows",
  "product_id" : "workspace.appstream.general.xlarge.2",
  "subnet_id" : "a5842cb4-5718-4b0a-8b27-3a3e9c74f977",
  "system_disk_type" : "SATA",
  "system_disk_size" : 60,
  "is_vdi" : false,
  "create_time" : "2023-06-06T14:14:36.416Z",
  "update_time" : "2023-06-06T14:14:36.416Z",
  "ou_name" : "",
  "extra_session_type" : "GPU",
  "extra_session_size" : 1,
  "app_type" : "COMMON_APP"
}

状态码

状态码

描述

200

成功响应。

400

由于包含语法错误,当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

500

服务内部错误,具体返回错误码请参见错误码说明。

503

服务不可用。

错误码

请参见错误码

相关文档