跳转到主要内容
API Explorer|API Explorer
计算管理/虚拟机相关接口
PUTVM Related Interfaces起始版本 5.0.0同步需要认证

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

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

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • cleanupvminstancemetadataObject必填

    cleanupvminstancemetadata 请求体结构

    • vmUuidsList必填

      需要清理元数据的云主机UUID列表

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • totalCleanedInteger必填

    成功清理的元数据数量

  • totalFailedInteger必填

    清理失败的元数据数量

  • failedVmUuidsList必填

    清理失败的云主机UUID列表

  • successboolean必填

    操作是否成功

  • errorErrorCode必填

    详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

请求地址

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

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

操作 ID

CleanupVmInstanceMetadata

永久链接

请求示例

curl -X PUT 'http://{host}/zstack/v1/vm-instances/metadata/cleanup' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"cleanupvminstancemetadata":{"vmUuids":["<vmUuids>"]},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

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

变更历史

此 API 暂无变更历史记录。

查看全部变更历史