接口地址:/webapi/vm/listGroup
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
接口描述:
查询虚拟机组列表
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| vmGroupName | 虚拟机组名称 | query | false | string | |
| hypervisorName | 平台名称 | query | false | string | |
| hypervisorType | 平台类型 | query | false | string | |
| hypervisorIp | 平台地址 | query | false | string | |
| vmGroupId | 虚机组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 | ResponseResultIPageVirtualMachineGroupVo |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| message | 返回状态标记 | string | |
| statFlag | 返回状态 | integer(int32) | integer(int32) |
| dataInfo | IPageVirtualMachineGroupVo | IPageVirtualMachineGroupVo | |
| records | array | virtualMachineGroupVo | |
| hypervisorIp | 虚拟化平台IP | string | |
| hypervisorId | 虚拟化平台ID | integer(int64) | |
| hypervisorName | 虚拟化平台名称 | string | |
| hypervisorType | 虚拟化平台类型ID | integer(int32) | |
| hypervisorTypeName | 虚拟化平台类型名称 | string | |
| vmGroupId | 虚拟机组ID | integer(int64) | |
| vmGroupName | 虚机组名称 | string | |
| backupContent | 虚拟机列表 | array | BackupContentItem |
| itemUUID | 客户端UUID | string | |
| uuid | 客户端UUID | string | |
| instanceUUID | 实例UUID | string | |
| itemName | 客户端名称 | string | |
| itemTypeId | 客户端类型 | integer(int32) | |
| operation | 操作 | integer(int32) | |
| projectId | 项目ID | string | |
| regionId | RegionId | string | |
| type | SmartX枚举类型,可用值:DATA_CENTER,CLUSTER,FOLDER,HOST,VM,VOLUME,IMAGE,USER,NETWORK,BUS_TYPE,STORAGE_POLICY_TYPE | string | |
| planType | 计划类型 | integer(int32) | |
| planGroupId | 计划组ID | integer(int64) | |
| planGroupName | 计划组名称 | string | |
| containerGroupId | 容器组ID | integer(int32) | |
| containerGroupName | 容器组名称 | string | |
| accessNodeIds | 访问节点ID列表 | array | integer |
| accessNodes | 访问节点信息列表 | array | NodeItem |
| nodeId | 节点ID | integer(int64) | |
| nodeName | 节点名称 | string | |
| description | 描述 | string | |
| lastBackupTime | 最后备份时间 | integer(int64) | |
| lastBackupSize | 最后备份大小 | integer(int64) | |
| lastBackupJobId | 最后备份作业ID | integer(int64) | |
| servicePlanId | 服务计划ID | integer(int64) | |
| streamCount | 流大小 | integer(int32) | |
| backupStatus | 备份标记 | integer(int32) | |
| desc | 描述 | string | |
| serviceplanName | 服务计划名称 | string | |
| total | integer(int64) | ||
| current | integer(int64) | ||
| pages | integer(int64) | ||
| size | integer(int64) | ||
| dataCount | 返回数据条数 | integer(int32) | integer(int32) |
响应示例:
{
"message": "操作成功",
"statFlag": 0,
"dataInfo": {
"records": [
{
"hypervisorIp": "",
"hypervisorId": 0,
"hypervisorName": "",
"hypervisorType": 0,
"hypervisorTypeName": "",
"vmGroupId": 0,
"vmGroupName": "",
"backupContent": [
{
"itemUUID": "",
"uuid": "",
"instanceUUID": "",
"itemName": "",
"itemTypeId": 0,
"operation": 0,
"projectId": "",
"regionId": "",
"type": ""
}
],
"planType": 0,
"planGroupId": 0,
"planGroupName": "",
"containerGroupId": 0,
"containerGroupName": "",
"accessNodeIds": [],
"accessNodes": [
{
"nodeId": 0,
"nodeName": "",
"description": ""
}
],
"lastBackupTime": 0,
"lastBackupSize": 0,
"lastBackupJobId": 0,
"servicePlanId": 0,
"streamCount": 0,
"backupStatus": 0,
"desc": "",
"serviceplanName": ""
}
],
"total": 0,
"current": 0,
"pages": 0,
"size": 0
},
"dataCount": 10
}