云服务器内容精选

  • 数据结构(查询云服务器详情) 表1 address参数 参数 参数类型 描述 version String IP地址版本。 “4”:代表IPv4。 “6”:代表IPv6。 addr String IP地址。 primary Boolean 是否是主网卡。 true:主网卡。 false:辅助网卡。 OS-EXT-IPS:type String IP地址类型。 fixed:代表私有IP地址。 floating:代表浮动IP地址。 OS-EXT-IPS-MAC:mac_addr String MAC地址。 OS-EXT-IPS:port_id String IP地址对应的端口ID。 表2 flavor参数 参数 参数类型 描述 id String 云服务器规格ID。 name String 云服务器规格名称。 disk String 该云服务器规格对应要求系统盘大小,0为不限制。 此字段在本系统中无效。 vcpus String 该云服务器规格对应的CPU核数。 ram String 该云服务器规格对应的内存大小,单位为MB。 gpus Array of objects 该云服务器规格对应的GPU卡信息。 详细内容,请参见表8。 asic_accelerators Array of objects 该云服务器规格对应的ASIC加速卡信息。 详细内容,请参见表9。 表3 security_groups参数 参数 参数类型 描述 name String 安全组名称或者UUID。 id String 安全组ID。 表4 os-extended-volumes:volumes_attached 参数 参数 参数类型 描述 id String 磁盘ID,格式为UUID。 delete_on_termination String 删除云服务器时是否一并删除该磁盘。 true:是 false:否 微版本2.3及以上版本支持。 bootIndex String 云硬盘启动顺序。 0为系统盘。 非0为数据盘。 device String 云硬盘挂载盘符,即磁盘挂载点。 表5 metadata参数 参数 参数类型 描述 charging_mode String 云服务器的计费类型。 “0”:按需计费(即postPaid-后付费方式)。 “1”:按包年包月计费(即prePaid-预付费方式)。 "2":竞价实例计费 metering.order_id String 按“包年/包月”计费的云服务器对应的订单ID。 metering.product_id String 按“包年/包月”计费的云服务器对应的产品ID。 vpc_id String 云服务器所属的虚拟私有云ID。 EcmResStatus String 云服务器的冻结状态。 normal:云服务器正常状态(未被冻结)。 freeze:云服务器被冻结。 说明: 当云服务器被冻结或者解冻后,系统默认添加该字段,且该字段必选。 metering.image_id String 云服务器操作系统对应的镜像ID。 metering.imagetype String 镜像类型,目前支持: 公共镜像(gold) 私有镜像(private) 共享镜像(shared) metering.resourcespeccode String 云服务器对应的资源规格。 metering.resourcetype String 云服务器对应的资源类型。 取值为“1”,代表资源类型为云服务器。 cascaded.instance_extrainfo String 系统内部虚拟机扩展信息。 image_name String 云服务器操作系统对应的镜像名称。 agency_name String 委托的名称。 委托是由租户管理员在 统一身份认证 服务(Identity and Access Management, IAM )上创建的,可以为弹性云服务器提供访问云服务器的临时凭证。 os_bit String 操作系统位数,一般取值为“32”或者“64”。 os_type String 操作系统类型,取值为:Linux、Windows。 __support_agent_list String 云服务器是否支持主机安全服务、主机监控。 “hss”:主机安全服务 “ces”:主机监控 lockCheckEndpoint String 回调URL,用于检查云服务器的加锁是否有效。 如果有效,则云服务器保持锁定状态。 如果无效,解除锁定状态,删除失效的锁。 lockSource String 云服务器来自哪个服务。 订单加锁(ORDER) lockSourceId String 云服务器的加锁来自哪个ID。 lockSource为“ORDER”时,lockSourceId为订单ID。 lockScene String 云服务器的加锁类型。 按需转包年/包月(TO_PERIOD_LOCK) virtual_env_type String IOS镜像创建虚拟机,"virtual_env_type": "IsoImage" 属性; 非IOS镜像创建虚拟机,在19.5.0版本以后创建的虚拟机将不会添加virtual_env_type 属性,而在此之前的版本创建的虚拟机可能会返回"virtual_env_type": "FusionCompute"属性 。 说明: virtual_env_type属性不允许用户增加、删除和修改。 表6 sys_tags参数 参数 参数类型 描述 key String 系统标签的Key值 value String 系统标签的value值 表7 image参数 参数 参数类型 描述 id String 镜像id 您可以根据镜像ID查询更多镜像信息,详细内容,请参见查询镜像列表。 表8 gpus参数 参数 参数类型 描述 name String GPU卡名称。 count Integer GPU卡数量。 memory_mb Integer GPU卡显存大小,单位为MB。 表9 asic_accelerators参数 参数 参数类型 描述 name String ASIC加速卡名称。 count Integer ASIC加速卡数量。 memory_mb Integer ASIC加速卡内存大小,单位为MB。 父主题: 数据结构
  • 创建磁盘的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。 agency_name 否 String 委托的名称。 委托是由租户管理员在统一身份认证服务(Identity and Access Management,IAM)上创建的,可以为弹性云服务器提供访问云服务的临时凭证。 说明: 委托获取、更新请参考如下步骤: 使用IAM服务提供的查询委托列表接口,获取有效可用的委托名称。 使用更新云服务器元数据接口,更新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策略,不推荐使用其他策略。 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时生效。
  • 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类型的带宽时,该字段必选。
  • 创建弹性公网IP的extendparam字段数据结构说明 该字段被如下接口使用: 创建云服务器 /v1.1/{project_id}/cloudservers 表6 创建弹性公网IP的extendparam字段数据结构说明 名称 是否必选 参数类型 说明 chargingMode 否 String 公网IP的计费模式。 取值范围: prePaid-预付费,即包年包月; postPaid-后付费,即按需付费; 说明: 如果bandwidth对象中share_type是WHOLE且id有值,弹性公网IP只能创建为按需付费的,故该参数传参“prePaid”无效。
  • 数据结构导航 publicip字段数据结构说明 security_groups字段数据结构说明 eip字段数据结构说明 bandwidth字段数据结构说明 ipv6_bandwidth字段数据结构说明 创建弹性公网IP的extendparam字段数据结构说明 创建磁盘的extendparam字段数据结构说明 创建云服务器的extendparam字段数据结构说明 创建磁盘的metadata字段数据结构说明 创建云服务器的metadata字段数据结构说明 os:scheduler_hints字段数据结构说明 server_tags字段数据结构说明
  • 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字段,底层会创建默认安全组。
  • 数值类型 数值类型的范围查询,[]包含两端点值,{}不包含两端点值。 rowkey:[1 TO *] 大于等于1 rowkey:[* TO 1] 小于等于1 rowkey:[1 TO 10] 1到10 Request Body示例: { "image_base64":"/9j/4AAQSkZJRgABAQAAAQABAAD...", "filter" : "number:[1 TO *]" } 单值。 rowkey:1 值为1 Request Body示例: { "image_base64":"/9j/4AAQSkZJRgABAQAAAQABAAD...", "filter" : "number:10" } 多条件,使用()区分优先级。 rowkey:[1 TO *] && externalImageID:1 (rowkey:[1 TO *] && externalImageID:1) || timestamp:1000 rowkey:[1 TO *] && (externalImageID:1 || timestamp:1000) Request Body示例: { "image_base64":"/9j/4AAQSkZJRgABAQAAAQABAAD...", "filter" : "number:[1 TO 20] && external_image_id:test" } 非,需要在非语句前后加括号。 externalImageID:1 && (!rowkey:2) Request Body示例: { "image_base64":"/9j/4AAQSkZJRgABAQAAAQABAAD...", "filter" : "external_image_id:test && (!number:10)" }
  • 字符串类型 单值 title:quick Request Body示例: { "image_base64":"/9j/4AAQSkZJRgABAQAAAQABAAD...", "filter" : "id:zhangsan" } 多条件 title:quick && color:brown Request Body示例: { "image_base64":"/9j/4AAQSkZJRgABAQAAAQABAAD...", "filter" : "id:zhangsan && number:30" } 非,使用括号分隔 (!color:brown) Request Body示例: { "image_base64":"/9j/4AAQSkZJRgABAQAAAQABAAD...", "filter" : "(!id:zhangsan)" }
  • os_extra_specs(flavor)字段数据结构说明 该字段被如下接口使用: 查询规格详情和规格扩展信息列表 /v1/{project_id}/cloudservers/flavors 查询云服务器规格扩展字段详情 /v1/{project_id}/flavors/{flavor_id}/os-extra_specs 表1 os_extra_specs数据结构说明(仅列举常用参数) 参数 参数类型 描述 ecs:performancetype String 云服务器规格的分类: normal:通用计算型 entry:通用入门型 cpuv1:计算I型 cpuv2:计算II型 computingv3:通用计算增强型 kunpeng_computing:鲲鹏通用计算增强型 kunpeng_highmem:鲲鹏内存优化型 kunpeng_highio:鲲鹏超高I/O型 highmem:内存优化型 saphana:超大内存型 diskintensive:磁盘增强型 highio:超高I/O型 ultracpu:超高性能计算型 gpu:GPU加速型 fpga:FPGA加速型 ascend:AI加速型 说明: 早期注册的规格该字段为hws:performancetype。 XEN实例不支持该参数。 hw:numa_nodes String 主机的物理cpu数量。(该字段是否返回根据云服务器规格而定) resource_type String 资源类型。resource_type是为了区分云服务器的物理主机类型。 hpet_support String 云服务器高精度时钟是否开启,开启为true,否则为false。(该字段是否返回根据云服务器规格而定) instance_vnic:type String 网卡类型,值固定为“enhanced”,表示使用增强型网络的资源创建云服务器。 instance_vnic:instance_bandwidth String 最大带宽,单位Mbps,最大值为10000。 instance_vnic:max_count String 最大网卡个数,最大为4。 quota:local_disk String 值格式为{type}:{count}:{size}:{safeFormat},其中: type指磁盘类型,当前只支持hdd。 count指本地磁盘数量,目前支持: d1类型:3/6/12/24 d2类型:2/4/8/12/16/24 d3类型:2/4/8/12/16/24/28。 size指单个磁盘容量,单位GB,目前只支持1675(实际磁盘大小为1800,格式化后可用大小为1675)。 safeFormat指云服务器本地磁盘是否安全格式化,目前仅支持: d1类型:FALSE d2/d3类型:True。 说明: 磁盘增强型特有字段。 quota:nvme_ssd String 值格式为{type}:{spec}:{num}:{size}:{safeFormat}:{挂载协议},其中: type指主机上配备的nvme ssd的单卡容量大小,当前只支持1.6T/3.2T。 spec指nvme ssd的规格,包括large/small。large表示大规格,small表示小规格。 目前仅支持i3和ir3类型:large。 num指磁盘划分的分区个数。 size指guest使用的盘的容量大小,单位为GB。在spec值为large的情况下,此项即为host单卡大小。在spec值为small的情况下,此为1/4规格或者1/2规格。 safeFormat指云服务器本地磁盘是否安全格式化。 目前仅支持i3和ir3类型:True。 挂载协议 目前仅支持ir3类型:blk。 说明: 超高I/O型特有字段。 extra_spec:io:persistent_grant String 是否支持持久化,值为true。 代表云服务器访问存储的方式为持久化授权。 说明: 密集存储D1型特有字段。 ecs:generation String 弹性云服务器类型的代数。 示例:s3中的3表示通用型III代,详细的规格类型和代系请参考《弹性云服务器用户指南》的“实例规格清单”。 ecs:virtualization_env_types String 虚拟化类型。 如果值为“FusionCompute”,表示弹性云服务器使用基于XEN的虚拟化技术。 如果值为“CloudCompute”,表示弹性云服务器使用基于KVM的虚拟化技术。 说明: 可选字段。 pci_passthrough:enable_gpu String 显卡是否直通。 值为“true”,表示GPU直通。 pci_passthrough:gpu_specs String G1型和G2型云服务器应用的技术,包括GPU虚拟化和GPU直通。 如果该规格的云服务器使用GPU虚拟化技术,且GPU卡的型号为M60-1Q,参数值为“m60_1q:virt:1”。 如果该规格的云服务器使用GPU直通技术,且GPU卡的型号为M60,参数值为“m60:direct_graphics:1”。 pci_passthrough:alias String PCI直通设备信息,格式为PCI设备名称:数量。多个设备信息以逗号隔开。 例如nvidia-a30:1,表示携带一张A30的GPU。 cond:operation:status String 此参数是Region级配置,某个AZ没有在cond:operation:az参数中配置时默认使用此参数的取值。不配置或无此参数时等同于“normal”。取值范围: normal:正常商用 abandon:下线(即不显示) sellout:售罄 obt:公测 obt_sellout:公测售罄 promotion:推荐(等同normal,也是商用) cond:operation:az String 此参数是AZ级配置,某个AZ没有在此参数中配置时默认使用cond:operation:status参数的取值。此参数的配置格式“az(xx)”。()内为某个AZ的flavor状态,()内必须要填有状态,不填为无效配置。状态的取值范围与cond:operation:status参数相同。 例如:flavor在某个region的az0正常商用,az1售罄,az2公测,az3正常商用,其他az显示下线,可配置为: “cond:operation:status”设置为“abandon” “cond:operation:az”设置为“az0(normal), az1(sellout), az2(obt), az3(normal)” 说明: 如果flavor在某个AZ下的状态与cond:operation:status配置状态不同,必须配置该参数。 quota:max_rate String 最大带宽 单位Mbps,显示为Gbps时除以1000 quota:min_rate String 基准带宽 单位Mbps,显示为Gbps时除以1000 quota:max_pps String 内网最大收发包能力 单位个,显示为xx万时除以10000 cond:operation:charge:stop String 关机是否收费 关机是否计费,默认免费: charge free cond:operation:charge String 计费类型 计费场景,不配置时都支持 period,包年/包月 demand,按需 cond:spot:operation:az String spot售卖信息请使用 查询规格销售策略 接口查询。 Flavor在竞价销售模式下显示的AZ。 cond:operation:roles String 允许的角色 匹配的用户标签(roles的op_gatexxx标签)。不设置时所有用户可见 cond:spot:operation:status String spot售卖信息请使用 查询规格销售策略 接口查询。 Flavor在竞价销售模式下的状态 不配置时等同abandon normal,正常商用 abandon,下线 sellout,售罄 obt,公测,未申请时提示申请(暂不支持) private,私有,只给特定用户显示(暂不支持) test,试用/免费(暂不支持) promotion,推荐 cond:network String 网络约束 支持网络特性,不配置时以控制台默认配置为准。 cond:storage String 存储约束 支持磁盘特性,不配置时以控制台默认配置为准。 scsi,支持scsi localdisk,支持本地盘 ib,支持ib cond:storage:type String 支持的磁盘类型,不配置时以控制台默认配置为准。 SATA:普通IO云硬盘(已售罄) SAS:高IO云硬盘 GPSSD:通用型SSD云硬盘 SSD:超高IO云硬盘 ESSD:极速IO云硬盘 GPSSD2:通用型SSD V2云硬盘 ESSD2:极速型SSD V2云硬盘 cond:compute:live_resizable String 计算约束 true,支持在线扩容。 false或不存在该字段,不支持在线扩容。 cond:compute String 计算约束 autorecovery,自动恢复特性。 不存在该字段,不支持自动恢复。 ecs:instance_architecture String 该规格对应的CPU架构,且仅鲲鹏实例架构规格返回该字段。 取值为arm64表示CPU架构为鲲鹏计算。 info:gpu:name String GPU显卡数量和名称。 info:cpu:name String CPU名称。 quota:gpu String GPU显卡名称。 quota:vif_max_num String 云服务器最多支持绑定的弹性网卡个数。 quota:sub_network_interface_max_num String 云服务器最多支持绑定的辅助弹性网卡个数。 network_interface:traffic_mirroring_supported String 该规格是否支持流量镜像。 security:enclave_supported String 该规格是否支持QingTian Enclave。 info:gpus String 该规格的GPU卡信息。 name:GPU名称 memory_mb:GPU显存大小 count:GPU显卡数量 alias_prefix:GPU显卡内部别名 info:asic_accelerators String 该规格的加速器信息。 name:加速器名称 memory_mb:加速器显存大小 count:加速器显卡数量 alias_prefix:加速器显卡内部别名
  • 字段说明 表1 字段说明 属性 是否必选 参数类型 描述 subnetId 是 HuaweiCloud.VPC.Subnet.Id 待创建云服务器的网卡信息。 取值说明:需要指定云服务器所属虚拟私有云下已创建的子网(subnet)的ID,或通过连线VPC.Subnet来自动生成 取值约束:满足UUID规则,最大64位 使用建议:1. 将该字段通过get_input函数传入,通过在AOS界面创建堆栈填写输入参数时可自动选择 2. 通过连线到subnet对象以get_reference方式获取一个新建的subnet的ID 参考E CS 服务资料https://support.huaweicloud.com/api-ecs/zh-cn_topic_0020212668.html allowedAddressPairs 否 ECS.AddressPair 地址Paris 取值说明:根据实际情况选择 使用建议:无 ipAddress 否 ip 待创建云服务器网卡的IP地址 取值说明:IP地址,不填或空字符串为自动分配 取值约束:IPv4格式,不填或空字符串,默认在网络(network)对应的子网(subnet)中自动分配一个未使用的IP作网卡的IP地址。如果指定IP地址,该IP地址必须在网络(network)对应的子网的网段内,且未被使用。 使用建议:参考ECS服务资料:https://support.huaweicloud.com/api-ecs/zh-cn_topic_0020212668.html ipCheck 否 boolean 是否进行ip check 取值说明:根据实际情况选择 使用建议:无 portSecurityEnabled 否 boolean 是否打开PortSecurity 取值说明:根据实际情况选择 使用建议:无
  • JSON样例 "driver-config-values": { "configs": [ { "inputs": [ { "name": "throttlingConfig.numExtractors", "value": "1" }, { "name": "throttlingConfig.numLoaders", "value": "1" }, { "name": "throttlingConfig.recordDirtyData", "value": "false" } ], "name": "throttlingConfig" }, { "inputs": [], "name": "jarConfig" }, { "inputs": [ { "name": "schedulerConfig.isSchedulerJob", "value": "false" }, { "name": "schedulerConfig.disposableType", "value": "NONE" } ], "name": "schedulerConfig" }, { "inputs": [], "name": "transformConfig" }, { "inputs": [ { "name": "retryJobConfig.retryJobType", "value": "NONE" } ], "name": "retryJobConfig" } ] }