清理指定虚拟机在数据存储上的元数据文件(CleanupVmInstanceMetadata)

API请求

URLs

PUT zstack/v1/vm-instances/metadata/cleanup

Headers

Authorization: OAuth the-session-uuid

Body

{
  "cleanupVmInstanceMetadata": {
    "vmUuids": [
      "96783411c8c737c5a97e3c50ff774f7f",
      "61f1952f9841316d896011a0ef17f701"
    ]
  },
  "systemTags": [],
  "userTags": []
}

Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"cleanupVmInstanceMetadata":{"vmUuids":["96783411c8c737c5a97e3c50ff774f7f","61f1952f9841316d896011a0ef17f701"]}}' \
http://localhost:8080/zstack/v1/vm-instances/metadata/cleanup

参数列表

名字	类型	位置	描述	起始版本
vmUuids	List	body(包含在`cleanupVmInstanceMetadata`结构中)	需要清理元数据的虚拟机UUID列表	5.0.0
systemTags (可选)	List	body	系统标签	5.0.0
userTags (可选)	List	body	用户标签	5.0.0

API返回

返回示例

{
  "totalCleaned": 5,
  "totalFailed": 0,
  "failedVmUuids": []
}

名字	类型	描述	起始版本
totalCleaned	Integer	成功清理的元数据数量	5.0.0
totalFailed	Integer	清理失败的元数据数量	5.0.0
failedVmUuids	List	清理失败的虚拟机UUID列表	5.0.0
success	boolean	操作是否成功	5.0.0
error	ErrorCode	详情参考error	5.0.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

CleanupVmInstanceMetadataAction action = new CleanupVmInstanceMetadataAction();
action.vmUuids = asList("96783411c8c737c5a97e3c50ff774f7f","61f1952f9841316d896011a0ef17f701");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CleanupVmInstanceMetadataAction.Result res = action.call();

Python SDK

action = CleanupVmInstanceMetadataAction()
action.vmUuids = [96783411c8c737c5a97e3c50ff774f7f, 61f1952f9841316d896011a0ef17f701]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

上一篇清理全部虚拟机元数据(CleanupAllVmInstanceMetadata)下一篇更新虚拟机元数据(UpdateVmInstanceMetadata)