Lists Executions in the MetadataStore.
HTTP request
GET https://{service-endpoint}/v1/{parent}/executions
Where {service-endpoint}
is one of the supported service endpoints.
Path parameters
Parameters | |
---|---|
parent |
Required. The MetadataStore whose Executions should be listed. Format: |
Query parameters
Parameters | |
---|---|
pageSize |
The maximum number of Executions to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. |
pageToken |
A page token, received from a previous When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with an INVALID_ARGUMENT error.) |
filter |
Filter specifying the boolean condition for the Executions to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters:
Each of the above supported filters can be combined together using logical operators ( For example: |
orderBy |
How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a |
Request body
The request body must be empty.
Response body
Response message for MetadataService.ListExecutions
.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"executions": [
{
object ( |
Fields | |
---|---|
executions[] |
The Executions retrieved from the MetadataStore. |
nextPageToken |
A token, which can be sent as |
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.executions.list
For more information, see the IAM documentation.