更新虚拟机元数据(UpdateVmInstanceMetadata)

立即触发指定虚拟机的元数据更新

API请求

URLs

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

Headers

Authorization: OAuth the-session-uuid

Body

{
  "updateVmInstanceMetadata": {
    "vmUuids": [
      "9880f2cf55223a069f43c01ac1c05c33"
    ]
  },
  "systemTags": [],
  "userTags": []
}

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" -X PUT -d '{"updateVmInstanceMetadata":{"vmUuids":["9880f2cf55223a069f43c01ac1c05c33"]}}' http://localhost:8080/zstack/v1/vm-instances/metadata/actions

参数列表

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

API返回

该API成功时返回一个空的JSON结构{}，出错时返回的JSON结构包含一个error字段，例如：

{
	"error": {
		"code": "SYS.1001",
		"description": "A message or a operation timeout",
		"details": "Create VM on KVM timeout after 300s"
	}
}

SDK示例

Java SDK

UpdateVmInstanceMetadataAction action = new UpdateVmInstanceMetadataAction();
action.vmUuids = asList("9880f2cf55223a069f43c01ac1c05c33");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateVmInstanceMetadataAction.Result res = action.call();

Python SDK

action = UpdateVmInstanceMetadataAction()
action.vmUuids = [9880f2cf55223a069f43c01ac1c05c33]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

上一篇清理指定虚拟机在数据存储上的元数据文件(CleanupVmInstanceMetadata)下一篇从元数据注册虚拟机(RegisterVmInstanceFromMetadata)