entity-cancel

dpsctl import entity-cancel Usage Guide

Cancel an in-flight entity import operation by request ID. The request ID is returned by dpsctl import entity.

Use this command when an entity generation request is still pending or running and you want the server to stop processing it.

Usage

dpsctl import entity-cancel --request-id <id>

Flags

Includes global dpsctl options.

   --request-id value                   Request ID returned by 'import entity' command (required)
   --help, -h                           show help

Examples

Cancel an Entity Import Request

$ dpsctl import entity-cancel --request-id abc123-def456-ghi789
{
  "status": {
    "ok": true
  }
}

After cancellation, use dpsctl import entity-delete if you also want to remove the stored request record and any stored results.

Cancel vs Delete

  • entity-cancel stops an entity generation request that is pending or running.
  • entity-cancel does not remove the request record or stored results.
  • entity-delete removes a stored request and any stored results.

Notes

  • The --request-id flag is required.
  • The request ID must be the value returned by dpsctl import entity.
  • The server validates whether the request can be cancelled and returns an error if it cannot.