文档目录

操作(Operations)

创建Bond网口(CreateBonding)

用户可以使用CreateBonding来创建Bond网口。 例如:
CreateBonding hostUuids=89f5104f987d45fcacbdc72563be604c bondingName=test slaveUuids=a9034f876d2d445d93085fd599d9e4c9 type=LinuxBonding mode=802.3ad

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
hostUuids 主机UUID列表 5.0.0
bondingName Bond名称 4.7.0
slaveUuids slave网卡Uuids列表 5.0.0
slaveNames slave网卡名称列表 5.0.0
type Bond类型
  • LinuxBonding
  • OvsBonding
4.7.0
mode 工作方式
  • 802.3ad
  • active-backup
4.7.0
xmitHashPolicy 哈希算法策略
  • layer2
  • layer2+3
  • layer3+4
4.7.0
description 资源的详细描述 4.7.0
resourceUuid 资源UUID 4.7.0
tagUuids 标签UUID列表 4.7.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.7.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.7.0

删除Bond网口(DeleteBonding)

用户可以使用DeleteBonding来删除Bond网口。 例如:
DeleteBonding uuid=1f85d0d55c7041e7b13111081af7f475

参数(Parameters)

名字 描述 Optional 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 4.7.0
deleteMode 删除模式 (Permissive/Enforcing,Permissive) 4.7.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.7.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.7.0

查询物理主机(QueryHost)

管理员可以使用QueryHost来查询主机。例如:
QueryHost managementIp=192.168.0.100
QueryHost vmInstance.vmNics.ip=10.21.100.2

原生域查询(Primitive Fields of Query)

请参见 物理机清单(Host Inventory)

嵌套和扩展域查询(Nested And Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
zone zone inventory 所在区域 0.6
cluster cluster inventory 父集群 0.6
vmInstance VM inventory 这个物理主机上运行的所有云主机 0.6

更新物理主机信息(UpdateHost)

管理员可以使用UpdateHost命令来更新物理主机的名称、描述和标签等参数。
UpdateHost  name=test uuid=5e0f90f7e44e471c96cf878f30301b42

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 物理主机的uuid 0.6
name 资源名字, 请参见 资源属性 0.6
description 资源描述description,请参见 资源属性 0.6
managementIp 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 HostVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 HostVO 0.6
timeout

更新物理主机启用状态(ChangeHostState)

管理员可以使用ChangeHostState命令来改变一个物理主机的可用状态。例如:
ChangeHostState stateEvent=maintain uuid=2893ce85c43d4a3a8d78f414da39966e

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 物理主机的uuid 0.6
stateEvent 可用状态触发事件。请参见 state
  • enable
  • disable
  • maintain
0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 HostVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 HostVO 0.6
timeout

重连物理主机(ReconnectHost)

管理员可以使用ReconnectHost来重新建立云平台管理节点和主机间的命令通道。 例如:
ReconnectHost uuid=2893ce85c43d4a3a8d78f414da39966e

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 物理主机的uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 HostVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 HostVO 0.6
timeout

删除物理主机(DeleteHost)

管理员可以使用DeleteHost来删除一个物理主机。 例如:
DeleteHost uuid=2893ce85c43d4a3a8d78f414da39966e

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 物理主机的uuid 0.6
deleteMode 请参见 删除资源(Delete Resources)
  • Permissive
  • Enforcing
0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 HostVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 HostVO 0.6
timeout

获取物理主机分配策略(GetHostAllocatorStrategies)

管理员可以使用GetHostAllocatorStrategies来获取物理主机分配策略。 返回示例:
{
    "hostAllocatorStrategies": [
        "DefaultHostAllocatorStrategy",
        "MinimumMemoryUsageHostAllocatorStrategy",
        "StoppedVmAwareLeastVmPreferredHostAllocatorStrategy",
        "LeastVmPreferredHostAllocatorStrategy",
        "MinimumCPUUsageHostAllocatorStrategy",
        "MaxInstancePerHostHostAllocatorStrategy"
    ]
}

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 HostVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 HostVO 0.6
timeout

获取物理机多路径拓扑(GetHostMultipathTopology)

管理员可以使用GetHostMultipathTopology来获取物理机多路径拓扑。例如:
GetHostMultipathTopology hostUuid=d08cf3ec60594b918d2dee583a0f00ad diskUuids=36001405b98903c943e344eaa7c4d23b5

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
hostUuid 物理机UUID 5.3.0
diskUuids 磁盘UUID 5.3.0
systemTags 系统标签,请参见创建系统标签(CreateSystemTag) 5.3.0
userTags 用户标签,请参见创建用户标签(CreateUserTag) 5.3.0

获取云主机虚拟化技术类型(GetHypervisorTypes)

管理员可以使用GetHypervisorTypes来获取云主机虚拟化技术类型。 返回示例:
{
    "hypervisorTypes": [
        "KVM",
        "ESX"
    ]
}

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 HostVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 HostVO 0.6
timeout

获取物理机交集网卡信息(GetCandidateNetworkInterfaces)

用户可以使用GetCandidateNetworkInterfaces来获取物理机交集网卡信息。 例如:
GetCandidateNetworkInterfaces hostUuids=89f5104f987d45fcacbdc72563be604c

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
hostUuids 物理机UUIDs 4.7.0
limit 4.7.0
start 4.7.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.7.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.7.0
slaveOnly 仅获取slave网卡 4.7.11

获取网口交集子接口信息(GetCandidateInterfaceVlanIds)

用户可以使用GetCandidateInterfaceVlanIds来获取网卡交集子接口信息。 例如:
GetCandidateInterfaceVlanIds interfaceUuids=d25e83af6ccf3d9ca8baa1702861a0c8

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
interfaceUuids 网口UUIDs 4.7.11
limit 4.7.11
start 4.7.11
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.7.11
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.7.11

在Bond网口配置IP(SetIpOnHostNetworkBonding)

用户可以使用SetIpOnHostNetworkBonding来在bond网口配置ip。 例如:
SetIpOnHostNetworkBonding bondingUuid=1f85d0d55c7041e7b13111081af7f475

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
bondingUuid bond网口UUID 4.7.0
ipAddress IP地址 4.7.0
netmask 子网掩码 4.7.0
isDefaultRoute 是否设置默认路由 4.7.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.7.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.7.0

在物理网口配置IP(SetIpOnHostNetworkInterface)

用户可以使用SetIpOnHostNetworkInterface来在物理网口配置ip。 例如:
SetIpOnHostNetworkInterface interfaceUuid=dc34c1afb2e54148ab33313751bf1e04

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
interfaceUuid 物理网口UUID 4.7.0
ipAddress IP地址 4.7.0
netmask 子网掩码 4.7.0
isDefaultRoute 是否设置默认路由 4.7.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.7.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.7.0

更新Bond网口(UpdateBonding)

用户可以使用UpdateBonding来更新Bond网口。 例如:
UpdateBonding uuid=1f85d0d55c7041e7b13111081af7f475

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 4.7.0
slaveUuids slave网卡Uuids列表 5.0.0
slaveNames slave网卡名称列表 5.0.0
type Bond类型
  • LinuxBonding
  • OvsBonding
4.7.0
mode 工作方式
  • 802.3ad
  • active-backup
4.7.0
xmitHashPolicy 哈希算法策略
  • layer2
  • layer2+3
  • layer3+4
4.7.0
description 资源的详细描述 4.7.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.7.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.7.0

绑定slave到Bond网口(AttachNicToBonding)

用户可以使用AttachNicToBonding来绑定slave到Bond网口。 例如:
AttachNicToBonding uuids=89f5104f987d45fcacbdc72563be604c slaveUuids=a9034f876d2d445d93085fd599d9e4c9

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 5.0.0
slaveUuids slave网卡Uuids列表 5.0.0
type Bond类型
  • LinuxBonding
  • OvsBonding
5.0.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 5.0.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 5.0.0

从Bond网口解绑slave(DetachNicFromBonding)

用户可以使用DetachNicFromBonding将salve从Bond网口解绑。 例如:
DetachNicFromBonding uuids=89f5104f987d45fcacbdc72563be604c slaveUuids=a9034f876d2d445d93085fd599d9e4c9

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 5.0.0
slaveUuids slave网卡Uuids列表 5.0.0
type Bond类型
  • LinuxBonding
  • OvsBonding
5.0.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 5.0.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 5.0.0

更新物理网口信息(UpdateHostNetworkInterface)

用户可以使用UpdateHostNetworkInterface来更新物理网口信息。 例如:
UpdateHostNetworkInterface interfaceUuid=dc34c1afb2e54148ab33313751bf1e04 description=test

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
interfaceUuid 物理网口UUID 4.7.0
description 资源的详细描述 4.7.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.7.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.7.0

更新KVM主机信息(UpdateKVMHost)

管理员可以使用UpdateKVMHost更新KVM主机信息。 返回示例:
UpdateKVMHost name=test uuid=5e0f90f7e44e471c96cf878f30301b42

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
username 用户名 0.6
password 密码 0.6
sshPort ssh端口号 0.6
uuid 物理主机uuid 0.6
name 资源名称 0.6
description 资源的详细描述 0.6
managementIp 管理节点IP 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 HostVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 HostVO 0.6
timeout

添加KVM主机(AddKVMHost)

管理员可以使用AddKVMHost添加KVM主机。 返回示例:
AddKVMHost username=root clusterUuid=2379a0d00ae242df91189f6d7d9e23e3 name=test
managementIp=10.0.225.39 password=password sshPort=22

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
username ssh用户名 0.6
password ssh密码 0.6
sshPort ssh端口号 0.6
name 资源名称 0.6
description 资源的详细描述 0.6
managementIp 管理节点IP 0.6
clusterUuid 集群uuid 0.6
resourceUuid 资源uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 HostVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 HostVO 0.6
timeout
Note:
  • ZStack Cloud创建KVM主机时支持关闭EPT功能,SystemTags增加关闭EPT功能选项。
    • 选项格式为:pageTableExtensionDisabled
    • 例如:pageTableExtensionDisabled

KVM运行Shell命令(KvmRunShell)

管理员可以使用KvmRunShell使KVM运行Shell命令。 返回示例:
KvmRunShell hostUuids=5e0f90f7e44e471c96cf878f30301b42 script=ls

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
hostUuids 目标机器uuid 0.6
script 脚本 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 HostVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 HostVO 0.6
timeout

通过文件导入方式添加物理机(AddKVMHostFromConfigFile)

用户可以使用AddKVMHostFromConfigFile通过文件导入方式添加物理机。 例如:
AddKVMHostFromConfigFile hostInfo=5ZCN56ewKihuYW1lKSznroDku4soZGVzY3JpcHRpb24pLOmbhue+pCooY2x1c3RlclV1aWQpLOeJqeeQhuacuklQKihtYW5hZ2VtZW50SXBzKSzmiavmj4/niannkIbmnLpJT01NVeiuvue9rihJT01NVSksU1NI56uv5Y+jKihzc2hQb3J0KSznlKjmiLflkI0qKHVzZXJuYW1lKSzlr4bnoIEqKHBhc3N3b3JkKQosLGFiZDIwMmJmYmM2MTQ1NDNhMjNiNDM3NGYzNGJlYzM1LDE3Mi4yMC4xOTguMjMyLCwscm9vdCxwYXNzd29yZAosLDkyN2NkNmRmZmZiYTQzMTI4Yzk1MDY0MTFhZjAyMmQzLDE3Mi4yMC4xOTcuMjQ3LCwscm9vdCxwYXNzd29yZAo=

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
hostInfo 经过base64编码的物理机信息 3.1.0
resourceUuid 3.1.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.1.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.1.0
timeout 3.1.0

添加物理机文件语法检查(CheckKVMHostConfigFile)

用户可以使用CheckKVMHostConfigFile添加物理机文件语法检查。 例如:
CheckKVMHostConfigFile hostInfo=5ZCN56ewKihuYW1lKSznroDku4soZGVzY3JpcHRpb24pLOmbhue+pCooY2x1c3RlclV1aWQpLOeJqeeQhuacuklQKihtYW5hZ2VtZW50SXBzKSzmiavmj4/niannkIbmnLpJT01NVeiuvue9rihJT01NVSksU1NI56uv5Y+jKihzc2hQb3J0KSznlKjmiLflkI0qKHVzZXJuYW1lKSzlr4bnoIEqKHBhc3N3b3JkKQosLGFiZDIwMmJmYmM2MTQ1NDNhMjNiNDM3NGYzNGJlYzM1LDE3Mi4yMC4xOTguMjMyLCwscm9vdCxwYXNzd29yZAosLDkyN2NkNmRmZmZiYTQzMTI4Yzk1MDY0MTFhZjAyMmQzLDE3Mi4yMC4xOTcuMjQ3LCwscm9vdCxwYXNzd29yZAo=

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
hostInfo 经过base64编码的物理机信息 3.1.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag)
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag)
timeout

标记物理网口(非聚合口) 网络类型(SetServiceTypeOnHostNetworkInterface)

用户可以使用SetServiceTypeOnHostNetworkInterface在物理网口配置网络类型。 例如:
SetServiceTypeOnHostNetworkInterface interfaceUuids=2894f52c7d84366c85dd115b3bc193ca

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
interfaceUuids 物理网口UUID 4.7.11
vlanIds VLAN接口ID 4.7.11
serviceTypes 网络服务类型
  • ManagementNetwork
  • TenantNetwork
  • StorageNetwork
  • BackupNetwork
  • MigrationNetwork
4.7.11
systemTags 系统标签 4.7.11
userTags 用户标签 4.7.11

标记聚合网口网络类型(SetServiceTypeOnHostNetworkBonding)

用户可以使用SetServiceTypeOnHostNetworkBonding为聚合网口配置网络类型。 例如:
SetServiceTypeOnHostNetworkBonding interfaceUuids=e96881d20cde3a9ab337cdf0ab4e8b08

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
bondingUuids 聚合网口UUID 4.7.11
vlanIds VLAN子接口接口ID 4.7.11
serviceTypes 网络类型
  • ManagementNetwork
  • TenantNetwork
  • StorageNetwork
  • BackupNetwork
  • MigrationNetwork
4.7.11
systemTags 系统标签 4.7.11
userTags 用户标签 4.7.11

获取物理网口网络类型信息(GetInterfaceServiceTypeStatistic)

用户可以使用GetInterfaceServiceTypeStatistic获取物理网口网络类型统计信息。 例如:
GetInterfaceServiceTypeStatistic interfaceUuids=d8797841479d3951bcb698164b56bd9e

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
interfaceUuid 物理机网卡UUID 4.7.11
vlanId VLAN接口ID 4.7.11
interfaceType 网卡类型
  • All
  • Interface
  • Bonding
4.7.11
serviceType 统计网络类型
  • All
  • ManagementNetwork
  • TenantNetwork
  • StorageNetwork
  • MigrationNetwork
  • BackupNetwork
4.7.11
zoneUuid 区域UUID 4.7.11
clusterUuid 集群UUID 4.7.11
hostUuid 物理机UUID 4.7.11
sortBy 排序方式
  • InterfaceName
  • VlanId
  • HostIp
  • HostName
  • ClusterName
  • CreateDate
4.7.11
sortDirection 排序方向
  • asc
  • desc
4.7.11
start 统计结果起始位置 4.7.11
limit 统计结果数量 4.7.11
replyWithCount 同时返回统计结果总数 4.7.11
systemTags 系统标签 4.7.11
userTags 用户标签 4.7.11

获取物理机物理网络信息(GetHostNetworkFacts)

用户可以使用GetHostNetworkFacts获取物理机物理网络信息。 例如:
GetHostNetworkFacts hostUuid=e336fa8ef9283fe4a4d746957284379a

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
hostUuid 物理机UUID 3.5.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.5.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.5.0
timeout

查询物理机Bond信息(QueryHostNetworkBonding)

管理员可以使用QueryHostNetworkBonding查询物理机Bond信息。例如:
QueryHostNetworkBonding hostUuid=b86c9016b4f24953a9edefb53ca0678c

原生域查询(Primitive Fields of Query)

请参见物理机Bond信息清单(HostNetworkBonding Inventory)

嵌套和扩展域查询(Nested And Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
slaves slaves Inventory 物理机相关slaves信息 3.9.0

查询物理机网卡信息(QueryHostNetworkInterface)

管理员可以使用QueryHostNetworkInterface查询物理机网卡信息。例如:
QueryHostNetworkInterface hostUuid=b86c9016b4f24953a9edefb53ca0678c

原生域查询(Primitive Fields of Query)

请参见物理机网卡清单(HostNetworkInterface Inventory)

嵌套和扩展域查询(Nested And Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
bonding bonding Inventory 物理机网卡相关bond信息 3.9.0

查询HBA卡信息(QueryHBADevice)

管理员可以使用QueryHBADevice查询HBA卡信息。例如:
QueryFcHbaDevice hostUuid=2ce77ebddd7b48209ff048d57364aa8c

原生域查询(Primitive Fields of Query)

请参见HBA卡清单(HBA Device Inventory)

查询物理机的NUMA拓扑信息(GetHostNUMATopology)

用户可以使用GetVmEmulatorPinning获取VM Emulator Pin在那些物理机的cpu上。 例如:
GetHostNUMATopology uuid=a761ac08ca483af4a81d9ed3d9930ef4

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 物理机UUID 4.3.12
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.3.12
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.3.12
timeout 4.3.12

查询物理机系统类型(QueryHostOsCategory)

用户可以使用QueryHostOsCategory查询物理机的系统类型,例如:
QueryHostOsCategory uuid=306b48c6439548eb977bb27e9eb22b2e

原生域查询(Primitive Fields of Query)

请参见物理机操作系统类型清单(HostOsCategory Inventory)

查询资源的虚拟化软件信息(QueryKvmHypervisorInfo)

用户可以使用QueryKvmHypervisorInfo查询资源虚拟化软件信息,例如:
QueryKvmHypervisorInfo uuid=306b48c6439548eb977bb27e9eb22b2e

原生域查询(Primitive Fields of Query)

请参见资源虚拟化软件信息清单(KvmHypervisorInfo Inventory)

嵌套和扩展域查询(Nested And Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
resource 4.6.21

分配物理机计算资源(AllocateHostResource)

用户可以使用AllocateHostResource分配物理机计算资源。 例如:
AllocateHostResource uuid=5d4ab16fd5b24e879eddd7e8c582b182 strategy=continuous scene=normal vcpu=2

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 4.7.11
strategy 分配策略 continuous 4.7.11
scene 分配场景
  • normal
  • performance
4.7.11
vcpu 需要的vCPU数量 4.7.11
memSize 需要的内存大小 4.7.11
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.7.11
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.7.11

根据云主机需求获取物理机资源的分配信息(GetHostResourceAllocation)

用户可以使用GetHostResourceAllocation查询云主机的vNUMA拓扑信息。 例如:
GetHostResourceAllocation uuid=a761ac08ca483af4a81d9ed3d9930ef4 strategy=continuous scene=normal vcpu=4

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 物理机UUID 4.3.12
strategy 资源分配策略 4.3.12
scene 场景类型 4.3.12
vcpu 云主机需要分配的vCPU数量 4.3.12
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.3.12
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.3.12
timeout 4.3.12

获取物理机最新电源状态(GetHostPowerStatus)

用户可以使用GetHostPowerStatus获取物理机最新电源状态。 例如:
GetHostPowerStatus uuid=a761ac08ca483af4a81d9ed3d9930ef4

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 4.7.0
method 获取物理机电源状态方式
  • AUTO
  • AGENT
  • IPMI
4.7.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.7.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.7.0
timeout 4.7.0

获取物理机网页终端链接(GetHostWebSshUrl)

用户可以使用GetHostWebSshUrl获取物理机终端链接。 例如:
GetHostWebSshUrl uuid=a761ac08ca483af4a81d9ed3d9930ef4

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 4.7.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.7.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.7.0
https 4.7.11

物理机开机(PowerOnHost)

用户可以使用PowerOnHost将物理机开机。 例如:
PowerOnHost uuid=a761ac08ca483af4a81d9ed3d9930ef4

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 4.7.0
returnEarly 是否提前返回 4.7.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.7.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.7.0
timeout 4.7.0

重启物理机(PowerResetHost)

用户可以使用PowerResetHost重启物理机。 例如:
PowerResetHost uuid=a761ac08ca483af4a81d9ed3d9930ef4

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 4.7.0
method 重启方式
  • AUTO
  • AGENT
  • IPMI
4.7.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.7.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.7.0
timeout 4.7.0

关闭物理机(ShutdownHost)

用户可以使用ShutdownHost关闭物理机。 例如:
ShutdownHost uuid=a761ac08ca483af4a81d9ed3d9930ef4

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 4.7.0
returnEarly 是否提前返回 4.7.0
force 是否强制关机 4.7.0
method 关闭方式
  • AUTO
  • AGENT
  • IPMI
4.7.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.7.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.7.0
timeout 4.7.0

更新物理机IPMI信息(UpdateHostIpmi)

用户可以使用UpdateHostIpmi更新物理机IPMI信息。 例如:
UpdateHostIpmi uuid=a761ac08ca483af4a81d9ed3d9930ef4

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 4.7.0
ipmiAddress IPMI地址 4.7.0
ipmiUsername IPMI用户名 4.7.0
ipmiPassword IPMI密码 4.7.0
ipmiPort IPMI端口 4.7.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.7.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.7.0
timeout 4.7.0
CLI命令使用手册 | 5.4.12 | ZStack Cloud · ZCF | ZStack 资源中心