Treasure Data API (3)
https://api.treasuredata.com/v3/
https://api.treasuredata.co.jp/v3/
https://api.ap02.treasuredata.com/v3/
https://api.eu01.treasuredata.com/v3/
https://api.treasuredata.com/v3/job/list
https://api.treasuredata.co.jp/v3/job/list
https://api.ap02.treasuredata.com/v3/job/list
https://api.eu01.treasuredata.com/v3/job/list
- cURL
- Java
- Go
- Ruby
- Python
- Node.js
curl -i -X GET \
https://api.treasuredata.com/v3/job/list \
-H 'Authorization: TD1 <YOUR_TOKEN_HERE>'
OK
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
unique identifier of job
unique identifier of job
the number of records in the result. Will be null
until job has finished, and may not be set for all query types
unique identifier of job
unique identifier of job
size in bytes of the job's result, in msgpack.gz
format
automatically retry this many times on failure
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
current status of the job
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
{ "jobs": [ { … } ], "count": 0, "from": 0, "to": 0 }
https://api.treasuredata.com/v3/job/show/{job_id}
https://api.treasuredata.co.jp/v3/job/show/{job_id}
https://api.ap02.treasuredata.com/v3/job/show/{job_id}
https://api.eu01.treasuredata.com/v3/job/show/{job_id}
- cURL
- Java
- Go
- Ruby
- Python
- Node.js
curl -i -X GET \
https://api.treasuredata.com/v3/job/show/19 \
-H 'Authorization: TD1 <YOUR_TOKEN_HERE>'
OK
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
unique identifier of job
unique identifier of job
the number of records in the result. Will be null
until job has finished, and may not be set for all query types
unique identifier of job
unique identifier of job
size in bytes of the job's result, in msgpack.gz
format
automatically retry this many times on failure
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
current status of the job
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
{ "cpu_time": 0, "created_at": "2020-12-31 11:22:33 UTC", "database": "string", "duration": 10, "end_at": "2020-12-31 11:22:33 UTC", "hive_result_schema": "string", "job_id": "19", "linked_result_export_job_id": 19, "num_records": 100, "organization": "string", "priority": 0, "query": "string", "result": "string", "result_export_target_job_id": 19, "result_size": 1048576, "retry_limit": 3, "start_at": "2020-12-31 11:22:33 UTC", "status": "success", "type": "presto", "updated_at": "2020-12-31 11:22:33 UTC", "url": "string", "user_name": "Treasure Data", "debug": { "cmdout": "string", "stderr": "string" } }
https://api.treasuredata.com/v3/job/status/{job_id}
https://api.treasuredata.co.jp/v3/job/status/{job_id}
https://api.ap02.treasuredata.com/v3/job/status/{job_id}
https://api.eu01.treasuredata.com/v3/job/status/{job_id}
- cURL
- Java
- Go
- Ruby
- Python
- Node.js
curl -i -X GET \
https://api.treasuredata.com/v3/job/status/19 \
-H 'Authorization: TD1 <YOUR_TOKEN_HERE>'
OK
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
the number of records in the result. Will be null
until job has finished, and may not be set for all query types
size in bytes of the job's result, in msgpack.gz
format
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
current status of the job
{ "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" }
https://api.treasuredata.com/v3/job/status_by_domain_key/{domain_key}
https://api.treasuredata.co.jp/v3/job/status_by_domain_key/{domain_key}
https://api.ap02.treasuredata.com/v3/job/status_by_domain_key/{domain_key}
https://api.eu01.treasuredata.com/v3/job/status_by_domain_key/{domain_key}
- cURL
- Java
- Go
- Ruby
- Python
- Node.js
curl -i -X GET \
https://api.treasuredata.com/v3/job/status_by_domain_key/domain_key_123 \
-H 'Authorization: TD1 <YOUR_TOKEN_HERE>'
OK
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
the number of records in the result. Will be null
until job has finished, and may not be set for all query types
size in bytes of the job's result, in msgpack.gz
format
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
current status of the job
{ "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" }
https://api.treasuredata.com/v3/job/statistics/{job_id}
https://api.treasuredata.co.jp/v3/job/statistics/{job_id}
https://api.ap02.treasuredata.com/v3/job/statistics/{job_id}
https://api.eu01.treasuredata.com/v3/job/statistics/{job_id}
- cURL
- Java
- Go
- Ruby
- Python
- Node.js
curl -i -X GET \
https://api.treasuredata.com/v3/job/statistics/19 \
-H 'Authorization: TD1 <YOUR_TOKEN_HERE>'
{ "records_inserted": "28345" }
https://api.treasuredata.com/v3/job/issue/{job_type}/{database_name}
https://api.treasuredata.co.jp/v3/job/issue/{job_type}/{database_name}
https://api.ap02.treasuredata.com/v3/job/issue/{job_type}/{database_name}
https://api.eu01.treasuredata.com/v3/job/issue/{job_type}/{database_name}
- cURL
- Java
- Go
- Ruby
- Python
- Node.js
curl -i -X POST \
https://api.treasuredata.com/v3/job/issue/presto/Alpha \
-H 'Authorization: TD1 <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"query": "SELECT COUNT(1) FROM www_access",
"priority": 0,
"result": "string",
"retry_limit": 0,
"pool_name": "string"
}'
{ "job": "19", "job_id": "19", "database": "Alpha" }
https://api.treasuredata.com/v3/job/kill/{job_id}
https://api.treasuredata.co.jp/v3/job/kill/{job_id}
https://api.ap02.treasuredata.com/v3/job/kill/{job_id}
https://api.eu01.treasuredata.com/v3/job/kill/{job_id}
- cURL
- Java
- Go
- Ruby
- Python
- Node.js
curl -i -X POST \
https://api.treasuredata.com/v3/job/kill/19 \
-H 'Authorization: TD1 <YOUR_TOKEN_HERE>'
Datetime in ISO 8601 format (2020-12-31T11:22:33-05:00
or 2020-12-31T11:22:33Z
for UTC)
https://api.treasuredata.com/v3/job/result_export/{job_id}
https://api.treasuredata.co.jp/v3/job/result_export/{job_id}
https://api.ap02.treasuredata.com/v3/job/result_export/{job_id}
https://api.eu01.treasuredata.com/v3/job/result_export/{job_id}
- cURL
- Java
- Go
- Ruby
- Python
- Node.js
curl -i -X POST \
https://api.treasuredata.com/v3/job/result_export/19 \
-H 'Authorization: TD1 <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d domain_key=domain_key_123 \
-d pool_name=pool_1 \
-d priority=0 \
-d 'query=SELECT * FROM my_table;' \
-d retry_limit=3 \
-d scheduled_time=2020-12-31T11:22:33Z \
-d target_job_id=19 \
-d result_connection_id=17 \
-d result=string \
-d database=Alpha \
-d table=Bravo
OK
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
unique identifier of job
unique identifier of job
the number of records in the result. Will be null
until job has finished, and may not be set for all query types
unique identifier of job
unique identifier of job
size in bytes of the job's result, in msgpack.gz
format
automatically retry this many times on failure
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
current status of the job
Datetime in custom format (2020-12-31 11:22:33 -0500
or 2020-12-31 11:22:33 UTC
for UTC)
{ "cpu_time": 0, "created_at": "2020-12-31 11:22:33 UTC", "database": "string", "duration": 10, "end_at": "2020-12-31 11:22:33 UTC", "hive_result_schema": "string", "job_id": "19", "linked_result_export_job_id": 19, "num_records": 100, "organization": "string", "priority": 0, "query": "string", "result": "string", "result_export_target_job_id": 19, "result_size": 1048576, "retry_limit": 3, "start_at": "2020-12-31 11:22:33 UTC", "status": "success", "type": "presto", "updated_at": "2020-12-31 11:22:33 UTC", "url": "string", "user_name": "Treasure Data", "debug": { "cmdout": "string", "stderr": "string" } }
https://api.treasuredata.com/v3/export/run/{database_name}/{table_name}
https://api.treasuredata.co.jp/v3/export/run/{database_name}/{table_name}
https://api.ap02.treasuredata.com/v3/export/run/{database_name}/{table_name}
https://api.eu01.treasuredata.com/v3/export/run/{database_name}/{table_name}
- cURL
- Java
- Go
- Ruby
- Python
- Node.js
curl -i -X POST \
https://api.treasuredata.com/v3/export/run/Alpha/Bravo \
-H 'Authorization: TD1 <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d access_key_id=a_key \
-d assume_role=string \
-d bucket=test_bucket \
-d domain_key=domain_key_123 \
-d encryption=string \
-d file_format=json.gz \
-d file_prefix=string \
-d from=1356998400 \
-d pool_name=pool_1 \
-d secret_access_key=secret_abc \
-d storage_type=s3 \
-d to=1356998400
{ "job": "19", "job_id": "19", "database": "Alpha" }
https://api.treasuredata.com/v3/job/result/{job_id}
https://api.treasuredata.co.jp/v3/job/result/{job_id}
https://api.ap02.treasuredata.com/v3/job/result/{job_id}
https://api.eu01.treasuredata.com/v3/job/result/{job_id}
- cURL
- Java
- Go
- Ruby
- Python
- Node.js
curl -i -X GET \
'https://api.treasuredata.com/v3/job/result/19?header=true&nullify_special=true' \
-H 'Authorization: TD1 <YOUR_TOKEN_HERE>'
https://api.treasuredata.com/v3/table/partialdelete/{database_name}/{table_name}
https://api.treasuredata.co.jp/v3/table/partialdelete/{database_name}/{table_name}
https://api.ap02.treasuredata.com/v3/table/partialdelete/{database_name}/{table_name}
https://api.eu01.treasuredata.com/v3/table/partialdelete/{database_name}/{table_name}
- cURL
- Java
- Go
- Ruby
- Python
- Node.js
curl -i -X POST \
https://api.treasuredata.com/v3/table/partialdelete/Alpha/Bravo \
-H 'Authorization: TD1 <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d domain_key=domain_key_123 \
-d from=1356998400 \
-d pool_name=pool_1 \
-d to=1356998400
{ "job_id": 19, "database": "Alpha", "table": "Bravo", "from": 1356998400, "to": 1356998400 }