Compute Engine API (compute:alpha)

▼ ▲ compute.nodeGroups.simulateMaintenanceEvent

HTTP Method : POST

Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/simulateMaintenanceEvent

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Parameters :

project

Required : Yes

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Type : string

Description : Project ID for this request.

Location : path

zone

Required : Yes

Location : path

Type : string

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Description : The name of the zone for this request.

requestId

Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

Location : query

Type : string

nodeGroup

Description : Name of the NodeGroup resource whose nodes will go under maintenance simulation.

Required : Yes

Type : string

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Location : path

Parameter Order :

• project
• zone
• nodeGroup

Description : Simulates maintenance event on specified nodes from the node group.

Flat Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/simulateMaintenanceEvent

▼ ▲ compute.regionNetworks.testIamPermissions

Flat Path : projects/{project}/regions/{region}/networks/{resource}/testIamPermissions

Path : projects/{project}/regions/{region}/networks/{resource}/testIamPermissions

HTTP Method : POST

Parameter Order :

• project
• region
• resource

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

Parameters :

resource

Required : Yes

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Description : Name or id of the resource for this request.

Location : path

Type : string

region

Type : string

Description : The name of the region for this request.

Required : Yes

Location : path

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

project

Required : Yes

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Type : string

Description : Project ID for this request.

Location : path

Description : Returns permissions that a caller has on the specified resource.

▼ ▲ compute.regionNetworks.getIamPolicy

Flat Path : projects/{project}/regions/{region}/networks/{resource}/getIamPolicy

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

HTTP Method : GET

Parameter Order :

• project
• region
• resource

Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters :

region

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Type : string

Required : Yes

Location : path

Description : The name of the region for this request.

optionsRequestedPolicyVersion

Type : integer

Description : Requested IAM Policy version.

Location : query

Format : int32

project

Required : Yes

Description : Project ID for this request.

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Type : string

Location : path

resource

Required : Yes

Description : Name or id of the resource for this request.

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Location : path

Type : string

Path : projects/{project}/regions/{region}/networks/{resource}/getIamPolicy

▼ ▲ compute.regionNetworks.delete

HTTP Method : DELETE

Parameter Order :

• project
• region
• network

Description : Deletes the specified network.

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Path : projects/{project}/regions/{region}/networks/{network}

Parameters :

region

Required : Yes

Type : string

Location : path

Description : Name of the region scoping this request.

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

requestId

Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

Type : string

Location : query

project

Required : Yes

Type : string

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Location : path

Description : Project ID for this request.

network

Location : path

Type : string

Required : Yes

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Description : Name of the network to delete.

Flat Path : projects/{project}/regions/{region}/networks/{network}

▼ ▲ compute.regionNetworks.list

Description : Retrieves the list of networks available to the specified project in the given region.

Path : projects/{project}/regions/{region}/networks

HTTP Method : GET

Parameter Order :

• project
• region

Flat Path : projects/{project}/regions/{region}/networks

Parameters :

project

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Type : string

Location : path

Description : Project ID for this request.

Required : Yes

region

Description : Name of the region scoping this request.

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Location : path

Required : Yes

Type : string

filter

Type : string

Location : query

Description : 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 `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`.

maxResults

Description : The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

Default : 500

Minimum : 0

Type : integer

Format : uint32

Location : query

pageToken

Type : string

Description : Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

Location : query

orderBy

Type : string

Location : query

Description : 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 `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

returnPartialSuccess

Type : boolean

Location : query

Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

▼ ▲ compute.regionNetworks.setIamPolicy

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Flat Path : projects/{project}/regions/{region}/networks/{resource}/setIamPolicy

Path : projects/{project}/regions/{region}/networks/{resource}/setIamPolicy

Parameters :

resource

Location : path

Description : Name or id of the resource for this request.

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Type : string

Required : Yes

region

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Description : The name of the region for this request.

Required : Yes

Location : path

Type : string

project

Required : Yes

Type : string

Location : path

Description : Project ID for this request.

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Description : Sets the access control policy on the specified resource. Replaces any existing policy.

HTTP Method : POST

Parameter Order :

• project
• region
• resource

▼ ▲ compute.regionNetworks.get

Parameters :

project

Location : path

Type : string

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Description : Project ID for this request.

Required : Yes

region

Required : Yes

Location : path

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Description : Name of the region scoping this request.

Type : string

network

Location : path

Type : string

Required : Yes

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Description : Name of the network to return.

Description : Returns the specified network.

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

HTTP Method : GET

Parameter Order :

• project
• region
• network

Path : projects/{project}/regions/{region}/networks/{network}

Flat Path : projects/{project}/regions/{region}/networks/{network}

▼ ▲ compute.regionNetworks.insert

Path : projects/{project}/regions/{region}/networks

Parameters :

project

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Type : string

Location : path

Required : Yes

Description : Project ID for this request.

requestId

Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

Type : string

Location : query

region

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Required : Yes

Type : string

Description : Name of the region scoping this request.

Location : path

Flat Path : projects/{project}/regions/{region}/networks

HTTP Method : POST

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Description : Creates a network in the specified project and region using the data included in the request.

Parameter Order :

• project
• region