Skip to main content
API Explorer|API Explorer
Monitoring & Collection/Monitoring Cache
POSTMonitoringSince 1.0SynchronousAuth Required

PreviewDeleteWarmupRule

Preview the deletion impact for WarmupRule without mutating state. Returns blockers, cascade resources, orphan resources, finalizers, and available policies.

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • ruleIdStringRequired

    规则ID。

Body Fields

  • optionsObjectRequired

    Options for this resource

    • propagationPolicyString

      PropagationPolicy overrides the resource's default policy when non-empty. Accepted values: Restrict, Foreground, Background, Orphan, SoftDelete.

      Example: value

    • forceBoolean

      Force skips the Finalizer phase and advances directly to PhysicalDelete. Requires operator-level permission; returns PermissionDenied until the audit-integration rollout lands.

      Example: true

    • gracePeriodSecondsInteger

      GracePeriodSeconds defines the post-request delay before the engine begins the Checking phase. Default 0 (immediate).

      Example: 10

    • revokeRemoteCredentialsBoolean

      RevokeRemoteCredentials is a resource-scoped hint for resources that carry out-of-band credentials (e.g. Platform access keys). When true, the corresponding revoke finalizer is activated for this request. Ignored by resources that do not register such a finalizer.

      Example: true

Responses

200 OK

On success, this API returns the following response structure.

  • blockersList

    Resources that are blocking the deletion from proceeding

    Example: (nested array)

    • resourceTypeString

      Type of the blocking resource

      Example: VmNic

    • resourceUuidString

      UUID of the blocking resource

      Example: b2c3d4e5-f6a7-8901-bcde-f12345678901

    • resourceNameString

      Human-readable name of the blocking resource

      Example: nic-001

    • relationString

      Relationship between the blocker and the target resource

      Example: AttachedTo

    • suggestionString

      Recommended action to resolve the blocker

      Example: Detach the NIC before deleting the VM

    • hardBoolean

      Whether this blocker prevents deletion entirely (hard) or is a warning

      Example: true

  • cascadeResourcesList

    Resources that will be deleted in cascade along with the target

    Example: (nested array)

    • resourceTypeString

      Type of the related resource

      Example: Volume

    • resourceUuidString

      UUID of the related resource

      Example: c3d4e5f6-a7b8-9012-cdef-123456789012

    • resourceNameString

      Human-readable name of the related resource

      Example: vol-data-01

  • orphanResourcesList

    Resources that will become orphaned after the deletion

    Example: (nested array)

    • resourceTypeString

      Type of the related resource

      Example: Volume

    • resourceUuidString

      UUID of the related resource

      Example: c3d4e5f6-a7b8-9012-cdef-123456789012

    • resourceNameString

      Human-readable name of the related resource

      Example: vol-data-01

  • finalizersList

    Finalizer handlers that must complete before deletion is finished

    Example: (nested array)

    • nameString

      Unique name identifying this finalizer handler

      Example: cleanup-network

    • descriptionString

      Human-readable description of what this finalizer does

      Example: Releases network interfaces associated with the resource

    • statusString

      Current execution status of the finalizer

      Example: Succeeded

    • errorString

      Error message if the finalizer failed

      Example: timeout waiting for network release

  • availablePoliciesList

    Deletion propagation policies available for this resource type

    Example: item1,item2

  • softDeleteRecoverableBoolean

    Whether this resource supports recovery after soft deletion

    Example: true

Endpoint

POST/api/v1/monitoring/cache/warmup-rules/{ruleId}/previewDelete

/api/v1/monitoring/cache/warmup-rules/{ruleId}/previewDelete

Operation ID

PreviewDeleteWarmupRule

Permalink

Request Example

curl -X POST '{host}/api/v1/monitoring/cache/warmup-rules/{rule_id}/previewDelete' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"options":{"propagationPolicy":"value","force":true,"gracePeriodSeconds":10,"revokeRemoteCredentials":true}}'

Response Example

200
{"blockers": [{"resourceType": "VmNic", "resourceUuid": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "resourceName": "nic-001", "relation": "AttachedTo", "suggestion": "Detach the NIC before deleting the VM", "hard": true}], "cascadeResources": [{"resourceType": "Volume", "resourceUuid": "c3d4e5f6-a7b8-9012-cdef-123456789012", "resourceName": "vol-data-01"}], "orphanResources": [{"resourceType": "Volume", "resourceUuid": "c3d4e5f6-a7b8-9012-cdef-123456789012", "resourceName": "vol-data-01"}], "finalizers": [{"name": "cleanup-network", "description": "Releases network interfaces associated with the resource", "status": "Succeeded", "error": "timeout waiting for network release"}], "availablePolicies": ["value"], "softDeleteRecoverable": true}

Change History

This API has no change history records yet.

View all change history