- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Request the job status.
To request the status of a job, we recommend using projects.locations.jobs.getMetrics
with a regional endpoint. Using projects.jobs.getMetrics
is not recommended, as you can only request the status of jobs that are running in us-central1
.
HTTP request
GET https://dataflow.googleapis.com/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
projectId |
A project id. |
location |
The regional endpoint that contains the job specified by jobId. |
jobId |
The job to get metrics for. |
Query parameters
Parameters | |
---|---|
startTime |
Return only metric data that has changed since this time. Default is to return all information about all metrics for the job. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of JobMetrics
.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.