网络
虚拟私有云 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
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务
文档首页/ 弹性云服务器 ECS/ API参考/ 数据结构/ 数据结构(创建云服务器)
更新时间:2025-01-09 GMT+08:00
分享

数据结构(创建云服务器)

使用须知

自研的创建云服务器接口支持有v1和v1.1两个版本,其中v1只能创建按需的云服务器,v1.1可以创建按需和包年/包月虚拟机。

下面数据结构中的字段,当选择包年/包月计费模式时(包年包月的),请选择使用v1.1的创建云服务器接口。

publicip字段数据结构说明

该字段被如下接口使用
  • 创建云服务器 /v1/{project_id}/cloudservers
  • 创建云服务器 /v1.1/{project_id}/cloudservers
表1 publicip字段数据结构说明

参数

是否必选

参数类型

描述

id

String

为待创建云服务器分配已有弹性公网IP时,分配的弹性公网IP的ID,UUID格式。

约束:只能分配状态(status)为DOWN的弹性公网IP

eip

Object

配置云服务器自动分配弹性公网IP时,创建弹性公网IP的配置参数。

详情请参见表3

delete_on_termination

Boolean

弹性公网IP随实例释放策略。

  • true:弹性公网IP随实例释放。
  • false:弹性公网IP不随实例释放。

默认值:false。

说明:

该字段仅按需弹性公网IP支持。

输入publicip字段数据结构中的id和eip的值时,只能选择其中一个参数值输入。

security_groups字段数据结构说明

该字段被如下接口使用

  • 创建云服务器 /v1/{project_id}/cloudservers
  • 创建云服务器 /v1.1/{project_id}/cloudservers
表2 security_groups字段数据结构说明

参数

是否必选

参数类型

描述

id

String

待创建云服务器的安全组,会对创建云服务器中配置的网卡生效。需要指定已有安全组的ID,UUID格式;若不传id字段,底层会创建默认安全组。

eip字段数据结构说明

该字段被如下接口使用
  • 创建云服务器 /v1/{project_id}/cloudservers
  • 创建云服务器 /v1.1/{project_id}/cloudservers
表3 eip字段数据结构说明

参数

是否必选

参数类型

描述

iptype

String

弹性公网IP地址类型。

详情请参见“申请弹性公网IP”章节的“publicip”字段说明。

bandwidth

Object

弹性公网IP地址带宽参数。

详情请参见bandwidth字段数据结构说明

extendparam

Object

创建弹性公网IP的附加信息。

详情请参见表6

说明:

当创建云服务器的extendparam结构中chargingMode为prePaid时(即创建包年包月付费的云服务器),若需要创建按需计费的弹性IP,该字段必选,需要在该结构中增加chargingMode为postPaid(按需付费)。

bandwidth字段数据结构说明

该字段被如下接口使用
  • 创建云服务器 /v1/{project_id}/cloudservers
  • 创建云服务器 /v1.1/{project_id}/cloudservers
表4 bandwidth字段数据结构说明

参数

是否必选

参数类型

描述

size

Integer

功能说明:带宽大小

带宽(Mbit/s),取值范围为[1,2000]。

具体范围以各区域配置为准,请参见控制台对应页面显示。

调整带宽时的最小单位会根据带宽范围不同存在差异。
  • 小于等于300Mbit/s:默认最小单位为1Mbit/s。
  • 300Mbit/s~1000Mbit/s:默认最小单位为50Mbit/s。
  • 大于1000Mbit/s:默认最小单位为500Mbit/s。
说明:

如果share_type是PER,该参数必选项;如果share_type是WHOLE并且id有值,该参数会忽略。

sharetype

String

带宽的共享类型。

共享类型枚举:PER,表示独享。WHOLE,表示共享。

chargemode

String

带宽的计费类型。

  • 未传该字段,表示按带宽计费。
  • 字段值为空,表示按带宽计费。
  • 字段值为“traffic”,表示按流量计费。
  • 字段为其它值,会导致创建云服务器失败。
    说明:

    如果share_type是WHOLE并且id有值,该参数会忽略。

id

String

带宽ID,创建WHOLE类型带宽的弹性IP时可以指定之前的共享带宽创建。

取值范围:WHOLE类型的带宽ID。

说明:

当创建WHOLE类型的带宽时,该字段必选。

ipv6_bandwidth字段数据结构说明

该字段被如下接口使用
  • 创建云服务器 /v1/{project_id}/cloudservers
  • 创建云服务器 /v1.1/{project_id}/cloudservers
表5 ipv6_bandwidth字段数据结构说明

参数

是否必选

参数类型

描述

id

String

IPv6带宽的ID。

创建弹性公网IP的extendparam字段数据结构说明

该字段被如下接口使用:

创建云服务器 /v1.1/{project_id}/cloudservers

表6 创建弹性公网IP的extendparam字段数据结构说明

名称

是否必选

参数类型

说明

chargingMode

String

公网IP的计费模式。

取值范围:

  • prePaid-预付费,即包年包月;
  • postPaid-后付费,即按需付费;
    说明:

    如果bandwidth对象中share_type是WHOLE且id有值,弹性公网IP只能创建为按需付费的,故该参数传参“prePaid”无效。

创建磁盘的extendparam字段数据结构说明

该字段被如下接口使用:

  • 创建云服务器 /v1/{project_id}/cloudservers
  • 创建云服务器 /v1.1/{project_id}/cloudservers
表7 创建磁盘的extendparam字段数据结构说明

参数

是否必选

参数类型

描述

resourceSpecCode

String

磁盘产品资源规格编码,如SATA,SAS和SSD。

说明:

废弃字段。

resourceType

String

磁盘产品资源类型。

说明:

废弃字段。

snapshotId

String

整机镜像中自带的原始数据盘(简称“原数据盘”)所对应的快照ID或原始数据盘ID。

使用场景

使用整机镜像创建云服务器,并且选择的整机镜像自带1个或者多个数据盘。

使用整机镜像创建云服务器时,系统会自动恢复整机镜像中自带的数据盘(包括数据盘类型和数据)。此时,您可以通过snapshotId,修改指定原数据盘恢复后的磁盘类型。

说明:
  • 建议对每块原数据盘都指定snapshotId。
  • 如需修改磁盘大小,修改后的磁盘大小需大于等于原数据盘大小。否则,会影响原数据盘的数据恢复。
  • 如需设置磁盘共享,需指定共享属性。
  • 如需设置磁盘加密,需在metadata字段指定相关加密属性。

实现原理

snapshotId是整机镜像自带原始数据盘的唯一标识,通过snapshotId可以获取原数据盘的磁盘信息,从而恢复数据盘数据。

通过管理控制台获取snapshotId

登录管理控制台,打开"云硬盘 > 快照"页面,根据原始数据盘的磁盘名称找到对应的快照ID或者原始数据盘的ID。

通过API查询snapshotId

已知整机镜像ID,参考镜像服务的“查询镜像详情”接口获取整机镜像ID关联的云备份或云服务器备份ID。
  • 如果使用的是云备份,请使用云备份ID查询备份信息,响应信息children字段中包含的resource_id或snapshot_id即为所需的snapshotId。详细操作请参考云备份服务“查询指定备份”接口。
  • 如果使用的是云服务器备份,请使用云服务器备份ID查询备份信息,响应信息volume_backups字段中包含的source_volume_id或snapshot_id即为所需的snapshotId。详细操作请参考云服务器备份“查询单个备份”接口。

创建云服务器的extendparam字段数据结构说明

该字段被如下接口使用:
  • 创建云服务器 /v1/{project_id}/cloudservers
  • 创建云服务器 /v1.1/{project_id}/cloudservers
表8 创建云服务器的extendparam字段数据结构说明(适用V1接口)

参数

是否必选

参数类型

描述

chargingMode

Integer

计费模式:

  • 0:按需计费。(默认值是0)

regionID

String

云服务器所在区域ID。

请参考地区和终端节点获取。

support_auto_recovery

Boolean

是否配置云服务器自动恢复的功能。

  • “true”:配置该功能
  • “false”:不配置该功能
说明:

此参数为boolean类型,若传入非boolean类型字符,程序将按照“false”:不配置该功能的方式处理。

  • 当support_auto_recovery=false,flavor中不存在"cond:compute": autorecovery:不支持自动恢复功能。
  • 当support_auto_recovery=false,flavor中存在"cond:compute": autorecovery:仍支持自动恢复功能。

"cond:compute": autorecovery可通过查询规格详情和规格扩展信息列表查询。

enterprise_project_id

String

企业项目ID。

说明:

关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理服务用户指南》。

该字段不传(或传为字符串“0”),则将资源绑定给默认企业项目。

marketType

String

创建竞价实例时,需指定该参数的值为“spot”。

说明:

当chargingMode=0时且marketType=spot时此参数生效。

spotPrice

String

用户愿意为竞价实例每小时支付的最高价格。

说明:
  • 仅chargingMode=0且marketType=spot时,该参数设置后生效。
  • 当chargingMode=0且marketType=spot时,如果不传递spotPrice,默认使用按需购买的价格作为竞价。
  • spotPrice需要小于等于按需价格,并要大于等于云服务器市场价格。

diskPrior

String

是否支持先创建卷,再创建虚拟机。

  • “true”:配置该功能
  • “false”:不配置该功能

spot_duration_hours

Integer

购买的竞价实例时长。

说明:
  • 竞享实例必传且当interruption_policy=immediate时,该字段有效 。
  • spot_duration_hours大于0。最大值由预测系统给出可以从flavor的extra_specs的cond:spot_block:operation:longest_duration_hours字段中查询。

spot_duration_count

Integer

表示购买的“竞价实例时长”的个数。

说明:
  • 适用于竞享实例且当spot_duration_hours>0时,该字段有效。
  • spot_duration_hours小于6时,spot_duration_count值必须为1。
  • spot_duration_hours等于6时,spot_duration_count大于等于1。

    spot_duration_count的最大值由预测系统给出可以从flavor的extra_specs的cond:spot_block:operation:longest_duration_count字段中查询。

interruption_policy

String

竞价实例中断策略,当前支持immediate(立即释放)。

说明:

当实例为竞享模式时,必须设置为immediate

CB_CSBS_BACKUP

String

云备份策略和云备份存储库详情,取值包含备份策略ID和云备份存储库ID。

例如:在控制台查询备份策略ID为:fdcaa27d-5be4-4f61-afe3-09ff79162c04

云备份存储库ID为:332a9408-463f-436a-9e92-78dad95d1ac4

则CB_CSBS_BACKUP取值为:"{\"policy_id\":\"fdcaa27d-5be4-4f61-afe3-09ff79162c04\",\"vault_id\":\"332a9408-463f-436a-9e92-78dad95d1ac4\"}"

表9 创建云服务器的extendparam字段数据结构说明(适用V1.1接口)

名称

是否必选

参数类型

说明

chargingMode

String

计费模式。

功能说明:付费方式

取值范围:

  • prePaid-预付费,即包年包月;
  • postPaid-后付费,即按需付费;
  • 默认值是postPaid
    说明:

    当chargingMode为prePaid(即创建包年包月付费的云服务器),且使用SSH密钥方式登录云服务器时,metadata中的op_svc_userid字段为必选字段。

    metadata中的op_svc_userid字段的取值,请参见表11

regionID

String

云服务器所在区域ID。

请参考地区和终端节点获取。

periodType

String

订购周期类型。

取值范围:

  • month-月
  • year-年
    说明:

    chargingMode为prePaid时生效且为必选值。

periodNum

Integer

订购周期数。

取值范围:

  • periodType=month(周期类型为月)时,取值为[1,2,3,4,5,6,7,8,9];
  • periodType=year(周期类型为年)时,取值为[1,2,3];
说明:
  • chargingMode为prePaid时生效且为必选值。
  • periodNum为正整数。
  • 根据华为云ECS产品定价规则,1年ECS(包年)价格=10个月ECS(包月)价格,因此购买包月时长超过9个月时,可直接购买包年ECS产品。

isAutoRenew

String

是否自动续订。

  • “true”:自动续订
  • “false”:不自动续订
    说明:

    chargingMode为prePaid时生效,不传该字段时默认为不自动续订。

isAutoPay

String

下单订购后,是否自动从客户的账户中支付,而不需要客户手动去进行支付。

  • “true”:是(自动支付)
  • “false”:否(需要客户手动支付)
说明:

chargingMode为prePaid时生效,不传该字段时默认为客户手动支付。

enterprise_project_id

String

企业项目ID。

说明:

关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理服务用户指南》。

该字段不传(或传为字符串“0”),则将资源绑定给默认企业项目。

support_auto_recovery

Boolean

是否配置虚拟机自动恢复的功能。

  • “true”:配置该功能
  • “false”:不配置该功能
说明:

此参数为boolean类型,若传入非boolean类型字符,程序将按照【“false”:不配置该功能】方式处理。

当marketType为spot时,不支持该功能。

marketType

String

创建竞价实例时,需指定该参数的值为“spot”。

说明:

当chargingMode=postPaid且marketType=spot时,此参数生效。

spotPrice

String

用户愿意为竞价云服务器每小时支付的最高价格。

说明:
  • 仅chargingMode=postPaid且marketType=spot时,该参数设置后生效。
  • 当chargingMode=postPaid且marketType=spot时,如果不传递spotPrice或者传递一个空字符串,默认使用按需购买的价格作为竞价。
  • spotPrice需要小于等于按需价格,并要大于等于云服务器市场价格。

diskPrior

String

是否支持先创建卷,再创建虚拟机。

  • “true”:配置该功能
  • “false”:不配置该功能

spot_duration_hours

Integer

购买的竞价实例时长。

说明:
  • 竞享实例必传且当interruption_policy=immediate时,该字段有效 。
  • spot_duration_hours大于0。最大值由预测系统给出可以从flavor的extra_specs的cond:spot_block:operation:longest_duration_hours字段中查询。

spot_duration_count

Integer

表示购买的“竞价实例时长”的个数。

说明:
  • 适用于竞享实例且当spot_duration_hours>0时,该字段有效。
  • spot_duration_hours小于6时,spot_duration_count值必须为1。
  • spot_duration_hours等于6时,spot_duration_count大于等于1。

    spot_duration_count的最大值由预测系统给出可以从flavor的extra_specs的cond:spot_block:operation:longest_duration_count字段中查询。

interruption_policy

String

竞价实例中断策略,当前支持immediate(立即释放)。

说明:

当实例为竞享模式时,必须设置为immediate

CB_CSBS_BACKUP

String

云备份策略和云备份存储库详情,取值包含备份策略ID和云备份存储库ID。

例如:在控制台查询备份策略ID为:fdcaa27d-5be4-4f61-afe3-09ff79162c04

云备份存储库ID为:332a9408-463f-436a-9e92-78dad95d1ac4

则CB_CSBS_BACKUP取值为:"{\"policy_id\":\"fdcaa27d-5be4-4f61-afe3-09ff79162c04\",\"vault_id\":\"332a9408-463f-436a-9e92-78dad95d1ac4\"}"

创建磁盘的metadata字段数据结构说明

该字段被如下接口使用:

  • 创建云服务器 /v1/{project_id}/cloudservers
  • 创建云服务器 /v1.1/{project_id}/cloudservers
  • 创建云服务器时,root_volume和data_volume都包含metadata字段。
表10 创建磁盘的metadata字段数据结构说明

参数

是否必选

参数类型

描述

__system__encrypted

String

metadata中的表示加密功能的字段,0代表不加密,1代表加密。

该字段不存在时,云硬盘默认为不加密。

__system__cmkid

String

用户主密钥ID,是metadata中的表示加密功能的字段,与__system__encrypted配合使用。

说明:

请参考查询密钥列表,通过HTTPS请求获取密钥ID。

创建云服务器的metadata字段数据结构说明

该字段被如下接口使用:

  • 创建云服务器 /v1/{project_id}/cloudservers
  • 创建云服务器 /v1.1/{project_id}/cloudservers
表11 metadata预留字段数据结构说明

参数

是否必选

参数类型

描述

op_svc_userid

String

用户ID。

您可以在我的凭证下,通过“API凭证”页面的“IAM用户ID”,获取该参数的值。更多内容,请参见API凭证

说明:

该参数取值为当前登录账号的“IAM用户ID”,如果您当前使用IAM用户登录,则需要获取对应IAM用户的“IAM用户ID”。

agency_name

String

委托的名称。

委托是由租户管理员在统一身份认证服务(Identity and Access Management,IAM)上创建的,可以为弹性云服务器提供访问云服务的临时凭证。

说明:

委托获取、更新请参考如下步骤:

  1. 使用IAM服务提供的查询委托列表接口,获取有效可用的委托名称。
  2. 使用更新云服务器元数据接口,更新metadata中agency_name字段为新的委托名称。

__support_agent_list

String

云服务器是否支持主机安全服务、主机监控。

  • "ces":主机监控
  • "hss":主机安全服务基础版
  • "hss,hss-ent":主机安全服务企业版

取值样例:

__support_agent_list:“hss,ces”

可以通过查询镜像详情判断创建云服务器使用的镜像是否支持主机安全服务或主机监控。

os:scheduler_hints字段数据结构说明

该字段被如下接口使用:
  • 创建云服务器 /v1/{project_id}/cloudservers
  • 创建云服务器 /v1.1/{project_id}/cloudservers
  • 创建云服务器(原生) /v2.1/{project_id}/servers
表12 os:scheduler_hints字段数据结构说明(请求参数)

参数

是否必选

参数类型

描述

group

String

云服务器组ID,UUID格式。

云服务器组的ID可以从控制台或者参考查询云服务器组列表获取。

说明:

请确保云服务器组使用的是反亲和性anti-affinity策略,不推荐使用其他策略。

在指定的专属主机上创建的弹性云服务器不支持选择反亲和性anti-affinity策略。

tenancy

String

在指定的专属主机或者共享主机上创建弹性云服务器

参数值为shared或者dedicated。

dedicated_host_id

String

专属主机的ID。

说明:

专属主机的ID仅在tenancy为dedicated时生效。

表13 os:scheduler_hints字段数据结构说明(响应参数)

参数

参数类型

描述

group

Array of strings

云服务器组ID,UUID格式。

云服务器组的ID可以从控制台或者参考查询云服务器组列表获取。

tenancy

Array of strings

在指定的专属主机或者共享主机上创建弹性云服务器

参数值为shared或者dedicated。

dedicated_host_id

Array of strings

专属主机的ID。

说明:

专属主机的ID仅在tenancy为dedicated时生效。

server_tags字段数据结构说明

该字段被如下接口使用:
  • 创建云服务器 /v1/{project_id}/cloudservers
  • 创建云服务器 /v1.1/{project_id}/cloudservers
表14 server_tags字段数据结构说明

参数

是否必选

参数类型

描述

key

String

键。

最大长度36个unicode字符。key不能为空。不能包含非打印字符ASCII(0-31),"=", "*",“<”,“>”,“\”,“,”,“|”,“/”。

同一资源的key值不能重复。

value

String

值。

每个值最大长度43个unicode字符,可以为空字符串。 不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”。

相关文档