{
  "schema_version": 2,
  "id": "operate/rs/references/cli-utilities/crdb-cli/task/cancel",
  "title": "crdb-cli task cancel",
  "url": "https://redis.io/docs/latest/operate/rs/references/cli-utilities/crdb-cli/task/cancel/",
  "summary": "Attempts to cancel a specified Active-Active database task.",
  "tags": [
    "docs",
    "operate",
    "rs"
  ],
  "last_updated": "2024-11-22T10:22:30-08:00",
  "page_type": "content",
  "content_hash": "426eec41804967a26bb30ad617fce5316a53cf99d65b1ab94c47fd6f8b48fa06",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "Cancels the Active-Active database task specified by the task ID.\n\n[code example]"
    },
    {
      "id": "parameters",
      "title": "Parameters",
      "role": "parameters",
      "text": "| Parameter           | Value  | Description                         |\n|---------------------|--------|-------------------------------------|\n| task-id \\<task_id\\>  | string | An Active-Active database task ID (required) |"
    },
    {
      "id": "returns",
      "title": "Returns",
      "role": "returns",
      "text": "Attempts to cancel an Active-Active database task.\n\nBe aware that tasks may complete before they can be cancelled."
    },
    {
      "id": "example",
      "title": "Example",
      "role": "example",
      "text": "[code example]"
    }
  ],
  "examples": [
    {
      "id": "overview-ex0",
      "language": "sh",
      "code": "crdb-cli task cancel --task-id <task_id>",
      "section_id": "overview"
    },
    {
      "id": "example-ex0",
      "language": "sh",
      "code": "$ crdb-cli task cancel --task-id 2901c2a3-2828-4717-80c0-6f27f1dd2d7c",
      "section_id": "example"
    }
  ]
}