- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Lists orders in a given project and location.
HTTP request
GET https://gdchardwaremanagement.googleapis.com/v1alpha/{parent=projects/*/locations/*}/orders
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The project and location to list orders in. Format: |
Query parameters
Parameters | |
---|---|
pageSize |
Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
pageToken |
Optional. A token identifying a page of results the server should return. |
filter |
Optional. Filtering condition. See AIP-160. |
orderBy |
Optional. Hint for how to order the results. |
Request body
The request body must be empty.
Response body
A list of orders.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"orders": [
{
object ( |
Fields | |
---|---|
orders[] |
The list of orders. |
nextPageToken |
A token identifying a page of results the server should return. |
unreachable[] |
Locations that could not be reached. |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the parent
resource:
gdchardwaremanagement.orders.list
For more information, see the IAM documentation.