Lists the Trials associated with a Study.
HTTP request
GET https://{service-endpoint}/v1/{parent}/trials
Where {service-endpoint}
is one of the supported service endpoints.
Path parameters
Parameters | |
---|---|
parent |
Required. The resource name of the Study to list the Trial from. Format: |
Query parameters
Parameters | |
---|---|
pageToken |
Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages. |
pageSize |
Optional. The number of Trials to retrieve per "page" of results. If unspecified, the service will pick an appropriate default. |
Request body
The request body must be empty.
Response body
Response message for VizierService.ListTrials
.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"trials": [
{
object ( |
Fields | |
---|---|
trials[] |
The Trials associated with the Study. |
nextPageToken |
Pass this token as the |
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 parent
resource:
aiplatform.trials.list
For more information, see the IAM documentation.