v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13141948.7 KB
projects

Lists all endpoints.

get/v1/{+parent}/endpoints

Path parameters

parentstring required

Required. The resource name of the service whose endpoints you'd like to list.

Query parameters

filterstring

Optional. The filter to list results by. General filter string syntax: () * can be `name`, `address`, `port`, or `annotations.` for map field * can be <, >, <=, >=, !=, =, :. Of which : means HAS, and is roughly the same as = * must be the same data type as field * can be AND, OR, NOT Examples of valid filters: * annotations.owner returns endpoints that have a annotation with the key owner, this is the same as annotations:owner * annotations.protocol=gRPC returns endpoints that have key/value protocol=gRPC * address=192.108.1.105 returns endpoints that have this address * port>8080 returns endpoints that have port number larger than 8080 * name>projects/my-project/locations/us-east1/namespaces/my-namespace/services/my-service/endpoints/endpoint-c returns endpoints that have name that is alphabetically later than the string, so "endpoint-e" is returned but "endpoint-a" is not * annotations.owner!=sd AND annotations.foo=bar returns endpoints that have owner in annotation key but value is not sd AND have key/value foo=bar * doesnotexist.foo=bar returns an empty list. Note that endpoint doesn't have a field called "doesnotexist". Since the filter does not match any endpoints, it returns no results For more information about filtering, see API Filtering.

orderBystring

Optional. The order to list results by. General order_by string syntax: () (,) * allows values: `name`, `address`, `port` * ascending or descending order by ``. If this is left blank, asc is used Note that an empty order_by string results in default order, which is order by name in ascending order.

pageSizeinteger

Optional. The maximum number of items to return.

pageTokenstring

Optional. The next_page_token value returned from a previous List request, if any.

Response

Successful response