Skip to content

Get job status by domain_key

Request

Checks the status of a job using the domain key.

Security
ApiKeyAuth
Path
domain_keystring(DomainKey)required
Example:domain_key_123
curl -i -X GET \
  https://api.treasuredata.com/v3/job/status_by_domain_key/domain_key_123 \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
job_idstring(JobIdAsString)required

unique identifier of job

Example:"19"
cpu_timeinteger or null(cpu_time)required
created_atstring(created_at)\d{4}-\d{2}-\d{2}\s\d{2}:\d{2}:\d{2}\s(([+-]\...required

Datetime in custom format (2020-12-31 11:22:33 -0500 or 2020-12-31 11:22:33 UTC for UTC)

Example:"2020-12-31 11:22:33 UTC"
end_atDateTimeAsString (string) or EmptyString (string)(end_at)required
One of:

Datetime in custom format (2020-12-31 11:22:33 -0500 or 2020-12-31 11:22:33 UTC for UTC)

string(DateTimeAsString)
durationinteger or null(duration)required

Duration

Example:10
num_recordsinteger or null(num_records)required

the number of records in the result. Will be null until job has finished, and may not be set for all query types

Example:100
result_sizeinteger or null(result_size)required

size in bytes of the job's result, in msgpack.gz format

Example:1048576
start_atDateTimeAsString (string) or EmptyString (string)(start_at)required
One of:

Datetime in custom format (2020-12-31 11:22:33 -0500 or 2020-12-31 11:22:33 UTC for UTC)

string(DateTimeAsString)
statusstring(status)required

current status of the job

Enum:"queued""running""killed""success""error"
Example:"success"
updated_atstring(updated_at)\d{4}-\d{2}-\d{2}\s\d{2}:\d{2}:\d{2}\s(([+-]\...required

Datetime in custom format (2020-12-31 11:22:33 -0500 or 2020-12-31 11:22:33 UTC for UTC)

Example:"2020-12-31 11:22:33 UTC"
Response
{ "job_id": "19", "cpu_time": 0, "created_at": "2020-12-31 11:22:33 UTC", "end_at": "2020-12-31 11:22:33 UTC", "duration": 10, "num_records": 100, "result_size": 1048576, "start_at": "2020-12-31 11:22:33 UTC", "status": "success", "updated_at": "2020-12-31 11:22:33 UTC" }