AI-generated Key Takeaways
-
Lists available nodes within the Spectrum Access System, allowing for filtering and pagination.
-
Requires authorization with the
https://www.googleapis.com/auth/sasportal
scope for access. -
Uses a GET request to the specified endpoint with path and optional query parameters.
-
Request body should be empty, and a successful response will contain a ListNodesResponse object.
-
Path parameter
parent
is required and specifies the parent resource name.
Lists nodes
.
HTTP request
GET https://sasportal.googleapis.com/v1alpha1/{parent=customers/*}/nodes
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The parent resource name, for example, "nodes/1". |
Query parameters
Parameters | |
---|---|
pageSize |
The maximum number of nodes to return in the response. |
pageToken |
A pagination token returned from a previous call to |
filter |
The filter expression. The filter should have the following format: "DIRECT_CHILDREN" or format: "direct_children". The filter is case insensitive. If empty, then no nodes are filtered. |
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of ListNodesResponse
.
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/sasportal