Skip to main content
GET
/
v1
/
projects
/
{project}
/
rollouts
/
{rollout}
/
stages
/
{stage}
/
tasks
/
{task}
/
taskRuns
/
{taskRun}
cURL
curl --request GET \
  --url https://api.example.com/v1/projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRuns/{taskRun}
{
  "name": "<string>",
  "creator": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "updateTime": "2023-11-07T05:31:56Z",
  "status": "STATUS_UNSPECIFIED",
  "detail": "<string>",
  "changelog": "<string>",
  "schemaVersion": "<string>",
  "startTime": "2023-11-07T05:31:56Z",
  "exportArchiveStatus": "EXPORT_ARCHIVE_STATUS_UNSPECIFIED",
  "priorBackupDetail": {
    "items": [
      {
        "sourceTable": {
          "database": "<string>",
          "schema": "<string>",
          "table": "<string>"
        },
        "targetTable": {
          "database": "<string>",
          "schema": "<string>",
          "table": "<string>"
        },
        "startPosition": {
          "line": 123,
          "column": 123
        },
        "endPosition": {
          "line": 123,
          "column": 123
        }
      }
    ]
  },
  "schedulerInfo": {
    "reportTime": "2023-11-07T05:31:56Z",
    "waitingCause": {
      "connectionLimit": true,
      "task": {
        "task": "<string>"
      },
      "parallelTasksLimit": true
    }
  },
  "sheet": "<string>",
  "runTime": "2023-11-07T05:31:56Z"
}

Path Parameters

​
project
string
required

The project id.

​
rollout
string
required

The rollout id.

​
stage
string
required

The stage id.

​
task
string
required

The task id.

​
taskRun
string
required

The taskRun id.

Response

OK

​
name
string

Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRuns/{taskRun}

​
creator
string

Format: users/[email protected]

​
createTime
string<date-time>
​
updateTime
string<date-time>
​
status
enum<string>

The current execution status of the task run.

Available options:
STATUS_UNSPECIFIED,
PENDING,
RUNNING,
DONE,
FAILED,
CANCELED
​
detail
string

Below are the results of a task run. Detailed information about the task run result.

​
changelog
string

The resource name of the changelog. Format: instances/{instance}/databases/{database}/changelogs/{changelog}

​
schemaVersion
string

The schema version after this task run completes.

​
startTime
string<date-time>

The time when the task run started execution.

​
exportArchiveStatus
enum<string>

The export archive status for data export tasks.

Available options:
EXPORT_ARCHIVE_STATUS_UNSPECIFIED,
READY,
EXPORTED
​
priorBackupDetail
object

The prior backup detail that will be used to rollback the task run.

​
schedulerInfo
object

Scheduling information about the task run.

​
sheet
string

Format: projects/{project}/sheets/{sheet}

​
runTime
string<date-time>

The task run should run after run_time. This can only be set when creating the task run calling BatchRunTasks.