Skip to main content
API Explorer|API Explorer
Compute Management/VM Related Interfaces
PUTVM Related InterfacesSince 5.0.0SynchronousAuth Required

Clean Up Metadata Files of Specified VM Instances on Primary Storage

Clean Up Metadata Files of Specified VM Instances on Primary Storage

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • cleanupvminstancemetadataObjectRequired

    cleanupvminstancemetadata request body object.

    • vmUuidsListRequired

      List of VM instance UUIDs whose metadata needs to be cleaned up

  • systemTagsList

    System tags

  • userTagsList

    User tags

Responses

200 OK

On success, this API returns the following response structure.

  • totalCleanedIntegerRequired

    Number of metadata files successfully cleaned up

  • totalFailedIntegerRequired

    Number of metadata files that failed to be cleaned up

  • failedVmUuidsListRequired

    List of VM instance UUIDs for which cleanup failed

  • successbooleanRequired

    Whether the operation succeeded

  • errorErrorCodeRequired

    For details, see error

    • codeStringRequired

      Error code, which is the globally unique identifier of the error, such as SYS.1000 or HOST.1001

    • descriptionStringRequired

      Summary description of the error

    • detailsStringRequired

      Detailed information about the error

    • elaborationStringRequired

      Reserved field. The default value is null.

    • opaqueLinkedHashMapRequired

      Reserved field. The default value is null.

    • causeErrorCodeRequired

      Root error that caused the current error. If there is no original error, this field is null.

Endpoint

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

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

Operation ID

CleanupVmInstanceMetadata

Permalink

Request Example

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>"]}'

Response Example

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

Change History

This API has no change history records yet.

View all change history