Tasks
get/cloud/v1/tasks/{task_id}

Request

  • Base URL
    https://api.gcore.com
  • URL
    https://api.gcore.com/cloud/v1/tasks/{task_id}
  • Auth
    HTTP apikey

Path parameters

task_idstring required

Task ID

Response

OK

acknowledged_atstring nullable

If task was acknowledged, this field stores acknowledge timestamp

acknowledged_byinteger nullable

If task was acknowledged, this field stores user_id of the person

client_idinteger nullable

The client ID

created_onstring nullable required

Created timestamp

dataunknown
detailed_state'CLUSTER_CLEAN_UP' | 'CLUSTER_REBUILD' | 'CLUSTER_RESIZE' | 'CLUSTER_RESUME' | 'CLUSTER_SERVER_REBUILD' | 'CLUSTER_SUSPEND' | 'ERROR' | 'FINISHED' | 'IPU_SERVERS' | 'NETWORK' | 'POPLAR_SERVERS' | 'POST_DEPLOY_SETUP' | 'VIPU_CONTROLLER'
errorstring nullable

The error value

finished_onstring nullable

Finished timestamp

idstring required

The task ID

job_idstring nullable

Job ID

lifecycle_policy_idinteger nullable

Lifecycle policy ID

project_idinteger nullable

The project ID

region_idinteger nullable

The region ID

request_idstring nullable

The request ID

schedule_idstring nullable

Schedule ID

state'ERROR' | 'FINISHED' | 'NEW' | 'RUNNING' required
task_typestring required

The task type

updated_onstring nullable

Last updated timestamp

user_client_idinteger nullable

Client, specified in user's JWT

user_idinteger required

The user ID that initiated the task

Example response

{
  "acknowledged_by": 123,
  "client_id": 123,
  "created_on": "2019-06-25T08:42:42Z",
  "data": {
    "block_device_config": [
      {
        "boot_index": 0,
        "image_id": "f01fd9a0-9548-48ba-82dc-a8c8b2d6f2f1",
        "name": "volume for vm1",
        "size": 1,
        "source": "image",
        "type_name": "standard"
      }
    ],
    "flavor_name": "g1s-shared-1-0.5",
    "keypair_name": null,
    "name": "cirroz1",
    "network_config": null,
    "reservation_id": "01d4925e-f5db-414a-9808-74e08aa4a741",
    "security_groups": null
  },
  "id": "26986bc0-748a-4448-b836-0a2aa465eb06",
  "project_id": 123,
  "region_id": 123,
  "task_type": "create_vm",
  "user_client_id": 123,
  "user_id": 123
}

Changes

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      removed subschema #1 subschema #2 from the response property anyOf list for the response status