Sign in
Actors/Actor runs

Abort run

[DEPRECATED] API endpoints related to run of the Actor were moved under new namespace actor-runs. Aborts an Actor run and returns an object that contains all the details about the run.

Only runs that are starting or running are aborted. For runs with status FINISHED, FAILED, ABORTING and TIMED-OUT this call does nothing.

post/v2/actors/{actorId}/runs/{runId}/abort

Path parameters

actorIdstring required
Example:compass~google-maps-extractor

Actor ID or the username of the Actor owner and the Actor name, separated by a tilde (~).

runIdstring required
Example:3KH8gEpp4d8uQSe8T

Actor run ID.

Query parameters

gracefullyboolean
Example:true

If true passed, the Actor run will abort gracefully. It will send aborting and persistState event into run and force-stop the run after 30 seconds. It is helpful in cases where you plan to resurrect the run later.

Response

Example response

{
  "data": {
    "id": "HG7ML7M8z78YcAPEB",
    "actId": "HDSasDasz78YcAPEB",
    "userId": "7sT5jcggjjA9fNcxF",
    "actorTaskId": "KJHSKHausidyaJKHs",
    "startedAt": "2019-11-30T07:34:24.202Z",
    "finishedAt": "2019-12-12T09:30:12.202Z",
    "statusMessage": "Actor is running",
    "pricingInfo": {
      "apifyMarginPercentage": 0.2
    },
    "stats": {
      "inputBodyLen": 240,
      "resurrectCount": 2,
      "memAvgBytes": 267874071.9,
      "memMaxBytes": 404713472,
      "cpuAvgUsage": 33.7532101107538,
      "cpuMaxUsage": 169.650735534941,
      "netRxBytes": 103508042,
      "netTxBytes": 4854600,
      "durationMillis": 248472,
      "runTimeSecs": 248.472,
      "computeUnits": 0.13804
    },
    "chargedEventCounts": {
      "actor-start": 1,
      "page-crawled": 150,
      "data-extracted": 75
    },
    "options": {
      "build": "latest",
      "timeoutSecs": 300,
      "memoryMbytes": 1024,
      "diskMbytes": 2048,
      "maxItems": 1000,
      "maxTotalChargeUsd": 5
    },
    "buildId": "7sT5jcggjjA9fNcxF",
    "generalAccess": "RESTRICTED",
    "defaultKeyValueStoreId": "eJNzqsbPiopwJcgGQ",
    "defaultDatasetId": "wmKPijuyDnPZAPRMk",
    "defaultRequestQueueId": "FL35cSF7jrxr3BY39",
    "storageIds": {
      "datasets": {
        "default": "wmKPijuyDnPZAPRMk"
      },
      "keyValueStores": {
        "default": "eJNzqsbPiopwJcgGQ"
      },
      "requestQueues": {
        "default": "FL35cSF7jrxr3BY39"
      }
    },
    "buildNumber": "0.0.36",
    "containerUrl": "https://g8kd8kbc5ge8.runs.apify.net",
    "isContainerServerReady": true,
    "gitBranchName": "master",
    "usage": {
      "ACTOR_COMPUTE_UNITS": 3,
      "DATASET_READS": 4,
      "DATASET_WRITES": 4,
      "KEY_VALUE_STORE_READS": 5,
      "KEY_VALUE_STORE_WRITES": 3,
      "KEY_VALUE_STORE_LISTS": 5,
      "REQUEST_QUEUE_READS": 2,
      "REQUEST_QUEUE_WRITES": 1,
      "DATA_TRANSFER_INTERNAL_GBYTES": 1,
      "DATA_TRANSFER_EXTERNAL_GBYTES": 3,
      "PROXY_RESIDENTIAL_TRANSFER_GBYTES": 34,
      "PROXY_SERPS": 3
    },
    "usageTotalUsd": 0.2654,
    "usageUsd": {
      "ACTOR_COMPUTE_UNITS": 0.0003,
      "DATASET_READS": 0.0001,
      "DATASET_WRITES": 0.0001,
      "KEY_VALUE_STORE_READS": 0.0001,
      "KEY_VALUE_STORE_WRITES": 0.00005,
      "KEY_VALUE_STORE_LISTS": 0.0001,
      "REQUEST_QUEUE_READS": 0.0001,
      "REQUEST_QUEUE_WRITES": 0.0001,
      "DATA_TRANSFER_INTERNAL_GBYTES": 0.001,
      "DATA_TRANSFER_EXTERNAL_GBYTES": 0.003,
      "PROXY_RESIDENTIAL_TRANSFER_GBYTES": 0.034,
      "PROXY_SERPS": 0.003
    },
    "metamorphs": [
      {
        "createdAt": "2019-11-30T07:39:24.202Z",
        "actorId": "nspoEjklmnsF2oosD",
        "buildId": "ME6oKecqy5kXDS4KQ",
        "inputKey": "INPUT-METAMORPH-1"
      }
    ],
    "platformUsageBillingModel": "USER"
  }
}

Changes

Changed in 3 of the 8 revisions of this API.121

  • 0a98d6a098a46See the full diff
    • ●

      added the new cannot-publish-actor-task enum value to the error/type response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new cannot-publish-actor-task enum value to the error/type response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new cannot-publish-actor-task enum value to the error/type response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new cannot-publish-actor-task enum value to the error/type response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new cannot-publish-actor-task enum value to the error/type response property for the response status 405

      response-property-enum-value-added

    • ●

      added the new cannot-publish-actor-task enum value to the error/type response property for the response status 429

      response-property-enum-value-added

  • 5ceb2cdfe6161See the full diff
    • ○

      api operation id act_run_abort_post removed and replaced with actors_run_abort_post

      api-operation-id-removed

  • b94a8abdfff16See the full diff
    • ●

      added the new cannot-monetize-without-payout-billing-info enum value to the error/type response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new cannot-monetize-without-payout-billing-info enum value to the error/type response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new cannot-monetize-without-payout-billing-info enum value to the error/type response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new cannot-monetize-without-payout-billing-info enum value to the error/type response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new cannot-monetize-without-payout-billing-info enum value to the error/type response property for the response status 405

      response-property-enum-value-added

    • ●

      added the new cannot-monetize-without-payout-billing-info enum value to the error/type response property for the response status 429

      response-property-enum-value-added

Of the 8 revisions, 1 has no diff computed.