Method: customers.deployments.list
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
בקשת HTTP
GET https://sasportal.googleapis.com/v1alpha1/{parent=customers/*}/deployments
כתובת ה-URL משתמשת בתחביר של gRPC Transcoding.
פרמטרים של נתיב
פרמטרים |
parent |
string
חובה. שם משאב האב, לדוגמה, 'nodes/1', customer/1/nodes/2.
|
פרמטרים של שאילתה
פרמטרים |
pageSize |
integer
המספר המקסימלי של פריסות שיוחזרו בתשובה.
|
pageToken |
string
אסימון עימוד שהוחזר מקריאה קודמת ל-deployments.list ומציין מאיפה צריך להמשיך את הרישום הזה.
|
filter |
string
ביטוי הסינון. המסנן צריך להיות בפורמט 'DIRECT_CHILDREN' או בפורמט 'direct_children'. המסנן לא תלוי אותיות רישיות (case-sensitive). אם השדה ריק, לא מתבצע סינון של פריסות.
|
גוף הבקשה
גוף הבקשה צריך להיות ריק.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של ListDeploymentsResponse
.
היקפי הרשאות
נדרש היקף ההרשאות הבא של OAuth:
https://www.googleapis.com/auth/sasportal
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 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`"]]