菜单

查询虚拟机列表

下载

接口地址:/webapi/vm/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

虚拟机列表-分页

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
vmName	虚拟机名称	query	false	string
host	主机	query	false	string
vmGroupName	虚拟机组名称	query	false	string
hypervisorType	虚拟化平台类型	query	false	string
hypervisorIp	虚拟化平台地址	query	false	string
vmStatus	虚拟机状态	query	false	string
vmId	虚机ID	query	false	string
requestId	请求ID	query	false	string
page	当前页。默认1	query	false	string
pageSize	页数。默认-1	query	false	string
userGroupId	用户组ID	query	false	string
authType	授权类型	query	false	string
ignoreDataAuth	忽略数据权限	query	false	string

响应状态:

状态码	说明	schema
200	OK	ResponseResultIPageVmListVo

响应参数:

参数名称	参数说明	类型	schema
message	返回状态标记	string
statFlag	返回状态	integer(int32)	integer(int32)
dataInfo		IPageVmListVo	IPageVmListVo
records		array	VmListVo
planGroupName	计划组名称	string
vmId	虚拟机ID	integer(int64)
vmGroupName	虚拟机组名称	string
vmIp	虚拟机IP	string
hypervisorID	虚拟化平台ID	integer(int64)
vmStatus	虚拟机状态	integer(int32)
uuid	UUID	string
lastBackupSize	上次备份大小	integer(int64)
servicePlanName	服务计划名称	string
lastBackupJobId	上次备份作业id	integer(int64)
hypervisorName	虚拟化平台名称	string
host	主机	string
hypervisorIp	虚拟化平台IP	string
enableRecover	是否激活	integer(int32)
vmName	虚拟机名称	string
vmGroupId	虚拟机组ID	integer(int64)
planType	计划类型	integer(int32)
containerGroupId	副本组ID	integer(int64)
containerGroupName	副本组名称	string
hypervisorType	虚拟化平台类型	integer(int32)
lastBackupTime	上次备份时间	integer(int64)
vmSizeInGB	虚拟机大小	integer(int64)
servicePlanId	服务计划ID	integer(int64)
enableBackup	是否备份	integer(int32)
planGroupId	计划组ID	integer(int64)
total		integer(int64)
current		integer(int64)
pages		integer(int64)
size		integer(int64)
dataCount	返回数据条数	integer(int32)	integer(int32)

响应示例:

javascript 复制代码

{
	"message": "操作成功",
	"statFlag": 0,
	"dataInfo": {
		"records": [
			{
				"planGroupName": "",
				"vmId": 0,
				"vmGroupName": "",
				"vmIp": "",
				"hypervisorID": 0,
				"vmStatus": 0,
				"uuid": "",
				"lastBackupSize": 0,
				"servicePlanName": "",
				"lastBackupJobId": 0,
				"hypervisorName": "",
				"host": "",
				"hypervisorIp": "",
				"enableRecover": 0,
				"vmName": "",
				"vmGroupId": 0,
				"planType": 0,
				"containerGroupId": 0,
				"containerGroupName": "",
				"hypervisorType": 0,
				"lastBackupTime": 0,
				"vmSizeInGB": 0,
				"servicePlanId": 0,
				"enableBackup": 0,
				"planGroupId": 0
			}
		],
		"total": 0,
		"current": 0,
		"pages": 0,
		"size": 0
	},
	"dataCount": 10
}

上一个

根据作业号查询虚拟机列表

下一个

删除虚拟机组

最近修改: 2024-12-17