Method: nodes.nodes.list
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://sasportal.googleapis.com/v1alpha1/{parent=nodes/*}/nodes
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The parent resource name, for example, "nodes/1".
|
Query parameters
| Parameters |
pageSize |
number
The maximum number of nodes to return in the response.
|
pageToken |
string
A pagination token returned from a previous call to nodes.list method that indicates where this listing should continue from.
|
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/userinfo.email
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-12-05 UTC.
[null,null,["Last updated 2023-12-05 UTC."],[[["\u003cp\u003eLists nodes, providing a paginated view of node resources within a specified parent.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/userinfo.email\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eUses a \u003ccode\u003eGET\u003c/code\u003e request to the \u003ccode\u003e/v1alpha1/{parent=nodes/*}/nodes\u003c/code\u003e endpoint with optional \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e query parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eparent\u003c/code\u003e path parameter specifies the parent resource name.\u003c/p\u003e\n"],["\u003cp\u003eReturns a \u003ccode\u003eListNodesResponse\u003c/code\u003e object containing the list of nodes and pagination information.\u003c/p\u003e\n"]]],["This document outlines how to list nodes via an HTTP GET request to `https://sasportal.googleapis.com/v1alpha1/{parent=nodes/*}/nodes`. The `parent` path parameter is required, representing the parent resource name. Optional query parameters include `pageSize` to limit results and `pageToken` for pagination. The request body must be empty. A successful response returns a `ListNodesResponse` instance. This operation requires the `https://www.googleapis.com/auth/userinfo.email` authorization scope.\n"],null,["# Method: nodes.nodes.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization Scopes](#body.aspect)\n\nLists [nodes](/spectrum-access-system/reference/rest/customers.nodes#Node).\n\n### HTTP request\n\n`GET https://sasportal.googleapis.com/v1alpha1/{parent=nodes/*}/nodes`\n\nThe URL uses [gRPC Transcoding](https://github.com/googleapis/googleapis/blob/master/google/api/http.proto) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------------------------|\n| `parent` | `string` Required. The parent resource name, for example, \"nodes/1\". |\n\n### Query parameters\n\n| Parameters ||\n|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `number` The maximum number of nodes to return in the response. |\n| `pageToken` | `string` A pagination token returned from a previous call to [nodes.list method](/spectrum-access-system/reference/rest/nodes.nodes/list#spectrum.sas.portal.v1alpha1.DeviceManager.ListNodes) that indicates where this listing should continue from. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [ListNodesResponse](/spectrum-access-system/reference/rest/ListNodesResponse).\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/userinfo.email`"]]