- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- Try it!
Lists all endpoints.
HTTP request
GET https://servicedirectory.googleapis.com/v1beta1/{parent=projects/*/locations/*/namespaces/*/services/*}/endpoints
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The resource name of the service whose endpoints we'd like to list. Authorization requires the following IAM permission on the specified resource
|
Query parameters
Parameters | |
---|---|
pageSize |
Optional. The maximum number of items to return. |
pageToken |
Optional. The nextPageToken value returned from a previous List request, if any. |
filter |
Optional. The filter to list result by. General filter string syntax: Examples of valid filters: * "metadata.owner" returns Endpoints that have a label with the key "owner" this is the same as "metadata:owner". * "metadata.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-east/namespaces/my-namespace/services/my-service/endpoints/endpoint-c" returns Endpoints that have name that is alphabetically later than the string, so "endpoint-e" will be returned but "endpoint-a" will not be. * "metadata.owner!=sd AND metadata.foo=bar" returns Endpoints that have "owner" in label 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. |
orderBy |
Optional. The order to list result by. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
The response message for RegistrationService.ListEndpoints
.
JSON representation | |
---|---|
{
"endpoints": [
{
object ( |
Fields | |
---|---|
endpoints[] |
The list of endpoints. |
nextPageToken |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.