Retrieves the list of region resources available to the specified
project. To decrease latency for this method, you can optionally omit
any unneeded information from the response by using a field mask. This
practice is especially recommended for unused quota information (the
items.quotas
field). To exclude one or more fields, set your request's
fields
query parameter to only include the fields you need. For
example, to only include the id
and selfLink
fields, add the query
parameter ?fields=id,selfLink
to your request.
Arguments
Parameters | |
---|---|
project |
Required. Project ID for this request.
|
filter |
A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either
|
maxResults |
The maximum number of results per page that should be returned. If the number of available results is larger than
|
orderBy |
Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using
|
pageToken |
Specifies a page token to use. Set
|
returnPartialSuccess |
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
|
Raised exceptions
Exceptions | |
---|---|
ConnectionError |
In case of a network problem (such as DNS failure or refused connection). |
HttpError |
If the response status is >= 400 (excluding 429 and 503). |
TimeoutError |
If a long-running operation takes longer to finish than the specified timeout limit. |
TypeError |
If an operation or function receives an argument of the wrong type. |
ValueError |
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout. |
Response
If successful, the response contains an instance of RegionList
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- list: call: googleapis.compute.v1.regions.list args: project: ... filter: ... maxResults: ... orderBy: ... pageToken: ... returnPartialSuccess: ... result: listResult
JSON
[ { "list": { "call": "googleapis.compute.v1.regions.list", "args": { "project": "...", "filter": "...", "maxResults": "...", "orderBy": "...", "pageToken": "...", "returnPartialSuccess": "..." }, "result": "listResult" } } ]