Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob
or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error
value with a google.rpc.Status.code
of 1, corresponding to code.CANCELLED
, and HyperparameterTuningJob.state
is set to CANCELLED
.
HTTP request
POST https://{service-endpoint}/v1/{name}:cancel
Where {service-endpoint}
is one of the supported service endpoints.
Path parameters
Parameters | |
---|---|
name |
Required. The name of the HyperparameterTuningJob to cancel. Format: |
Request body
The request body must be empty.
Response body
If successful, the response body is empty.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the name
resource:
aiplatform.hyperparameterTuningJobs.cancel
For more information, see the IAM documentation.