2023-06-07
▼ ▲ compute.regionDiskSettings.get
HTTP Method: GET
Description: Get Regional Disk Settings.
Scopes:
Parameter Order:
Flat Path: projects/{project}/regions/{region}/diskSettings
Path: projects/{project}/regions/{region}/diskSettings
Parameters:
region
Required: Yes
Type: string
Description: Name of the region for this request.
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
project
Description: Project ID for this request.
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])?))
Location: path
Type: string
▼ ▲ compute.regionDiskSettings.patch
Flat Path: projects/{project}/regions/{region}/diskSettings
HTTP Method: PATCH
Scopes:
Path: projects/{project}/regions/{region}/diskSettings
Description: Patch Regional Disk Settings
Parameters:
project
Description: Project ID for this request.
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
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
region
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
Required: Yes
Description: Name of the region for this request.
updateMask
Location: query
Type: string
Description: update_mask indicates fields to be updated as part of this request.
Format: google-fieldmask
Parameter Order:
▼ ▲ compute.regionZones.list
HTTP Method: GET
Parameter Order:
Scopes:
Path: projects/{project}/regions/{region}/zones
Parameters:
maxResults
Type: integer
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
Format: uint32
Location: query
Minimum: 0
filter
Type: string
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`.
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
Description: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Location: query
Type: boolean
project
Location: path
Type: string
Description: Project ID for this request.
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])?))
pageToken
Type: string
Location: query
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.
region
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required: Yes
Location: path
Description: Region for this request.
Type: string
Description: Retrieves the list of Zone resources under the specific region available to the specified project.
Flat Path: projects/{project}/regions/{region}/zones
▼ ▲ compute.diskSettings.get
Path: projects/{project}/zones/{zone}/diskSettings
Flat Path: projects/{project}/zones/{zone}/diskSettings
Description: Get Zonal Disk Settings.
Parameters:
zone
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type: string
Required: Yes
Description: Name of the zone for this request.
project
Location: path
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])?))
Description: Project ID for this request.
Type: string
Scopes:
Parameter Order:
HTTP Method: GET
▼ ▲ compute.diskSettings.patch
Description: Patch Zonal Disk Settings
Flat Path: projects/{project}/zones/{zone}/diskSettings
Parameter Order:
Parameters:
project
Type: string
Description: Project ID for this request.
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])?))
Location: path
requestId
Location: query
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
updateMask
Type: string
Format: google-fieldmask
Location: query
Description: update_mask indicates fields to be updated as part of this request.
zone
Type: string
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description: The name of the zone for this request.
Location: path
Path: projects/{project}/zones/{zone}/diskSettings
Scopes:
HTTP Method: PATCH
▼ ▲ compute.instances.patchPartnerMetadata
Path: projects/{project}/zones/{zone}/instances/{instance}/patchPartnerMetadata
Scopes:
HTTP Method: POST
Description: Patches partner metadata of the specified instance.
Parameter Order:
Flat Path: projects/{project}/zones/{zone}/instances/{instance}/patchPartnerMetadata
Parameters:
zone
Required: Yes
Location: path
Description: The name of the zone for this request.
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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])?))
Required: Yes
Location: path
Description: Project ID for this request.
Type: string
instance
Description: Name of the instance scoping this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
Type: string
Location: path
requestId
Location: query
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
▼ ▲ compute.instances.getPartnerMetadata
Scopes:
Path: projects/{project}/zones/{zone}/instances/{instance}/getPartnerMetadata
Parameter Order:
HTTP Method: GET
Flat Path: projects/{project}/zones/{zone}/instances/{instance}/getPartnerMetadata
Description: Gets partner metadata of the specified instance and namespaces.
Parameters:
zone
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
Required: Yes
Description: The name of the zone for this request.
Type: string
project
Description: Project ID for this request.
Type: string
Required: Yes
Location: path
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])?))
namespaces
Description: Comma separated partner metadata namespaces.
Location: query
Type: string
instance
Description: Name of the instance scoping this request.
Location: path
Required: Yes
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
▼ ▲ compute.storagePools.listDisks
Parameter Order:
Description: Lists the disks in a specified storage pool.
Scopes:
Path: projects/{project}/zones/{zone}/storagePools/{storagePool}/listDisks
HTTP Method: GET
Flat Path: projects/{project}/zones/{zone}/storagePools/{storagePool}/listDisks
Parameters:
filter
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`.
Type: string
storagePool
Description: Name of the storage pool to list disks of.
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
Type: string
returnPartialSuccess
Type: boolean
Description: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Location: query
zone
Required: Yes
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description: The name of the zone for this request.
Type: string
project
Type: string
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])?))
Required: Yes
Location: path
maxResults
Location: query
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`)
Minimum: 0
Format: uint32
Default: 500
Type: integer
pageToken
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
Type: string
orderBy
Location: query
Type: string
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.