清理全部虚拟机元数据(CleanupAllVmInstanceMetadata)

清理一个或多个数据存储上保存的全部虚拟机元数据文件，仅管理员可调用。当 primaryStorageUuids 为空（未传或传空列表）时，将清理系统中所有 Enabled+Connected 且支持虚拟机元数据的数据存储；否则仅清理列表中指定的数据存储。

API请求

URLs

DELETE zstack/v1/vm-instances/metadata

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" -X DELETE http://localhost:8080/zstack/v1/vm-instances/metadata?primaryStorageUuids=01cc0bb1fafe3e6fb8971b72ad0f3b1a&primaryStorageUuids=ab71bdefa93c31d1afa724a41364e230

参数列表

名字	类型	位置	描述	起始版本
primaryStorageUuids (可选)	List	query	需要清理虚拟机元数据的数据存储UUID列表；为空时清理所有 Enabled+Connected 数据存储上的元数据	5.1.0
systemTags (可选)	List	query	系统标签	5.1.0
userTags (可选)	List	query	用户标签	5.1.0

API返回

返回示例

{
  "failedPrimaryStorageUuids": []
}

名字	类型	描述	起始版本
failedPrimaryStorageUuids	List	清理失败的数据存储UUID列表；具体失败原因汇总见 error 字段，逐条详情见 mn / agent 日志	5.1.0
success	boolean	操作是否成功；任一数据存储清理失败则为 false	5.1.0
error	ErrorCode	详情参考error	5.1.0

#error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	0.6
description	String	错误的概要描述	0.6
details	String	错误的详细信息	0.6
elaboration	String	保留字段，默认为null	0.6
opaque	LinkedHashMap	保留字段，默认为null	0.6
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	0.6

SDK示例

Java SDK

CleanupAllVmInstanceMetadataAction action = new CleanupAllVmInstanceMetadataAction();
action.primaryStorageUuids = asList("01cc0bb1fafe3e6fb8971b72ad0f3b1a","ab71bdefa93c31d1afa724a41364e230");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CleanupAllVmInstanceMetadataAction.Result res = action.call();

Python SDK

action = CleanupAllVmInstanceMetadataAction()
action.primaryStorageUuids = [01cc0bb1fafe3e6fb8971b72ad0f3b1a, ab71bdefa93c31d1afa724a41364e230]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

上一篇查询系统虚拟机(QueryApplianceVm)下一篇清理指定虚拟机在数据存储上的元数据文件(CleanupVmInstanceMetadata)