Method: customers.deployments.list
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Requête HTTP
GET https://sasportal.googleapis.com/v1alpha1/{parent=customers/*}/deployments
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
| Paramètres |
parent |
string
Obligatoire. Nom de la ressource parente, par exemple "nodes/1" ou customer/1/nodes/2.
|
Paramètres de requête
| Paramètres |
pageSize |
integer
Nombre maximal de déploiements à renvoyer dans la réponse.
|
pageToken |
string
Jeton de pagination renvoyé par un appel précédent à deployments.list qui indique à partir de quel endroit cette liste doit continuer.
|
filter |
string
Expression du filtre. Le filtre doit être au format "DIRECT_CHILDREN" ou "direct_children". Le filtre n'est pas sensible à la casse. Si ce champ est vide, aucun déploiement n'est filtré.
|
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient une instance de ListDeploymentsResponse.
Champs d'application des autorisations
Requiert le champ d'application OAuth suivant :
https://www.googleapis.com/auth/sasportal
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[[["\u003cp\u003eLists available deployments, providing details about their configuration and status within the system.\u003c/p\u003e\n"],["\u003cp\u003eUsers can filter deployments, specify the maximum number of results returned, and utilize pagination for navigating larger datasets.\u003c/p\u003e\n"],["\u003cp\u003eThe API endpoint employs gRPC Transcoding and requires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/sasportal\u003c/code\u003e scope for access.\u003c/p\u003e\n"],["\u003cp\u003eBoth path and query parameters are used to define the request, allowing for flexible retrieval of deployment information.\u003c/p\u003e\n"]]],["This document details the process of listing deployments via an HTTP GET request to `https://sasportal.googleapis.com/v1alpha1/{parent=customers/*}/deployments`. The request requires a `parent` path parameter specifying the resource, and supports optional `pageSize`, `pageToken`, and `filter` query parameters for pagination and filtering. The request body must be empty. Successful responses return a `ListDeploymentsResponse`, and the operation necessitates the `https://www.googleapis.com/auth/sasportal` OAuth scope.\n"],null,["# Method: customers.deployments.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 [deployments](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments#Deployment).\n\n### HTTP request\n\n`GET https://sasportal.googleapis.com/v1alpha1/{parent=customers/*}/deployments`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The parent resource name, for example, \"nodes/1\", customer/1/nodes/2. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of deployments to return in the response. |\n| `pageToken` | `string` A pagination token returned from a previous call to [deployments.list](/spectrum-access-system/reference/rest/v1alpha1/nodes.deployments/list#spectrum.sas.portal.v1alpha1.DeviceManager.ListDeployments) that indicates where this listing should continue from. |\n| `filter` | `string` 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 deployments are filtered. |\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 [ListDeploymentsResponse](/spectrum-access-system/reference/rest/v1alpha1/ListDeploymentsResponse).\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/sasportal`"]]
