Method: projects.locations.endpoints.list

Lists Endpoints in a Location.

HTTP request

GET https://{service-endpoint}/v1/{parent}/endpoints

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

Parameters
parent

string

Required. The resource name of the Location from which to list the Endpoints. Format: projects/{project}/locations/{location}

Query parameters

Parameters
filter

string

Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.

  • endpoint supports = and !=. endpoint represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name.
  • displayName supports = and, !=
  • labels supports general map functions that is:
    • labels.key=value - key:value equality
    • `labels.key:* or labels:key - key existence
    • A key including a space must be quoted. labels."a key".

Some examples: * endpoint=1 * displayName="myDisplayName" * labels.myKey="myValue"

pageSize

integer

Optional. The standard list page size.

pageToken

string

Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call.

readMask

string (FieldMask format)

Optional. Mask specifying which fields to read.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

orderBy

string

A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * displayName * createTime * updateTime

Example: displayName, createTime desc.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for EndpointService.ListEndpoints.

JSON representation
{
  "endpoints": [
    {
      object (Endpoint)
    }
  ],
  "nextPageToken": string
}
Fields
endpoints[]

object (Endpoint)

List of Endpoints in the requested page.

nextPageToken

string

A token to retrieve the next page of results. Pass to ListEndpointsRequest.page_token to obtain that page.

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.endpoints.list

For more information, see the IAM documentation.