Method: projects.locations.orders.list

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

string

Required. The project and location to list orders in. Format: projects/{project}/locations/{location}

To list orders across all locations, substitute - (the hyphen or dash character) for the location and check the unreachable field in the response message.

Query parameters

Parameters
pageSize

integer

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken

string

Optional. A token identifying a page of results the server should return.
filter

string

Optional. Filtering condition. See AIP-160.
orderBy

string

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 (Order)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Fields
orders[]

object (Order)

The list of orders.
nextPageToken

string

A token identifying a page of results the server should return.
unreachable[]

string

Locations that could not be reached. Only used for queries to the wildcard location -. If non-empty, it indicates that the results are incomplete.

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.