2023-07-07
▼ ▲ compute.interconnects.getMacsecConfig
Description: Returns the interconnectMacsecConfig for the specified Interconnect.
Scopes:
Path: projects/{project}/global/interconnects/{interconnect}/getMacsecConfig
Parameter Order:
Parameters:
interconnect
Location: path
Required: Yes
Type: string
Description: Name of the interconnect resource to query.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
project
Description: Project ID for this request.
Location: path
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])?))
Flat Path: projects/{project}/global/interconnects/{interconnect}/getMacsecConfig
HTTP Method: GET
▼ ▲ compute.instanceGroupManagerResizeRequests.get
Flat Path: projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}
Path: projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}
Description: Returns all of the details about the specified resize request.
Scopes:
Parameter Order:
HTTP Method: GET
Parameters:
instanceGroupManager
Location: path
Type: string
Required: Yes
Description: The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.
resizeRequest
Description: The name of the resize request. Name should conform to RFC1035 or be a resource ID.
Location: path
Type: string
Required: Yes
project
Location: path
Type: string
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])?))
zone
Description: Name of the href="/compute/docs/regions-zones/#available">zone scoping this request. Name should conform to RFC1035.
Type: string
Location: path
Required: Yes
▼ ▲ compute.instanceGroupManagerResizeRequests.insert
HTTP Method: POST
Description: Creates a new resize request that starts provisioning VMs immediately or queues VM creation.
Parameter Order:
Parameters:
instanceGroupManager
Required: Yes
Description: The name of the managed instance group to which the resize request will be added. Name should conform to RFC1035 or be a resource ID.
Type: string
Location: path
requestId
Type: string
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).
zone
Description: The name of the zone where the managed instance group is located and where the resize request will be created. Name should conform to RFC1035.
Type: string
Required: Yes
Location: path
project
Location: path
Type: string
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])?))
Flat Path: projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests
Path: projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests
Scopes:
▼ ▲ compute.instanceGroupManagerResizeRequests.list
Flat Path: projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests
Parameter Order:
Description: Retrieves a list of resize requests that are contained in the managed instance group.
Path: projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests
HTTP Method: GET
Parameters:
instanceGroupManager
Location: path
Type: string
Description: The name of the managed instance group. The name should conform to RFC1035.
Required: Yes
returnPartialSuccess
Description: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Type: boolean
Location: query
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
Description: Project ID for this request.
Location: path
Required: Yes
orderBy
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.
Type: string
Location: query
zone
Description: The name of the zone where the managed instance group is located. The name should conform to RFC1035.
Required: Yes
Location: path
Type: string
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
filter
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
Location: query
maxResults
Default: 500
Minimum: 0
Location: query
Format: uint32
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`)
Type: integer
Scopes:
▼ ▲ compute.instanceGroupManagerResizeRequests.delete
Parameter Order:
Description: Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously.
Flat Path: projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}
Path: projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}
HTTP Method: DELETE
Scopes:
Parameters:
zone
Location: path
Required: Yes
Type: string
Description: The name of the zone where the managed instance group is located. The name should conform to RFC1035.
instanceGroupManager
Required: Yes
Description: The name of the managed instance group. The name should conform to RFC1035 or be a resource ID.
Type: string
Location: path
resizeRequest
Location: path
Type: string
Description: The name of the resize request to delete. The name should conform to RFC1035 or be a resource ID.
Required: Yes
project
Type: string
Location: path
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])?))
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.regionNetworkEndpointGroups.attachNetworkEndpoints
HTTP Method: POST
Scopes:
Description: Attach a list of network endpoints to the specified network endpoint group.
Parameter Order:
Parameters:
networkEndpointGroup
Location: path
Description: The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.
Required: Yes
Type: string
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
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
region
Type: string
Description: The name of the region where you want to create the network endpoint group. It should comply with RFC1035.
Location: path
Required: Yes
Path: projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints
Flat Path: projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints
▼ ▲ compute.regionNetworkEndpointGroups.listNetworkEndpoints
HTTP Method: POST
Flat Path: projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints
Parameters:
pageToken
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.
Type: string
maxResults
Minimum: 0
Location: query
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`)
Format: uint32
Default: 500
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
filter
Location: query
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`.
networkEndpointGroup
Required: Yes
Type: string
Description: The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.
Location: path
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
region
Type: string
Description: The name of the region where the network endpoint group is located. It should comply with RFC1035.
Required: Yes
Location: path
orderBy
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.
Location: query
Description: Lists the network endpoints in the specified network endpoint group.
Scopes:
Path: projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints
Parameter Order:
▼ ▲ compute.regionNetworkEndpointGroups.detachNetworkEndpoints
HTTP Method: POST
Path: projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints
Parameter Order:
Flat Path: projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints
Description: Detach the network endpoint from the specified network endpoint group.
Parameters:
project
Description: Project ID for this request.
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])?))
Type: string
region
Required: Yes
Location: path
Description: The name of the region where the network endpoint group is located. It should comply with RFC1035.
Type: string
networkEndpointGroup
Description: The name of the network endpoint group you are detaching network endpoints from. It should comply with RFC1035.
Location: path
Type: string
Required: Yes
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). end_interface: MixerMutationRequestBuilder
Location: query
Type: string
Scopes: