Update Network Interface
|
|||||
|
|
Updates an instance's network interface. This method follows PATCH semantics
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data across Google Cloud Platform services
- View and manage your Google Compute Engine resources
Input
This building block consumes 22 input parameters
Name | Format | Description |
---|---|---|
project Required |
STRING |
Project ID for this request |
zone Required |
STRING |
The name of the zone for this request |
instance Required |
STRING |
The instance name for this request |
networkInterface Required |
STRING |
The name of the network interface to update |
requestId |
STRING |
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) |
accessConfigs[] |
OBJECT |
An access configuration attached to an instance's network interface. Only one access config per instance is supported |
accessConfigs[].kind |
STRING |
[Output Only] Type of the resource. Always compute#accessConfig for access configs |
accessConfigs[].name |
STRING |
The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access |
accessConfigs[].natIP |
STRING |
An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance |
accessConfigs[].networkTier |
ENUMERATION |
This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP |
accessConfigs[].publicPtrDomainName |
STRING |
The DNS domain name for the public PTR record. You can set this field only if the |
accessConfigs[].setPublicPtr |
BOOLEAN |
Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name |
accessConfigs[].type |
ENUMERATION |
The type of configuration. The default and only option is ONE_TO_ONE_NAT |
aliasIpRanges[] |
OBJECT |
An alias IP range attached to an instance's network interface |
aliasIpRanges[].ipCidrRange |
STRING |
The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24) |
aliasIpRanges[].subnetworkRangeName |
STRING |
The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used |
fingerprint |
BINARY |
Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface, otherwise the request will fail with error 412 conditionNotMet |
kind |
STRING |
[Output Only] Type of the resource. Always compute#networkInterface for network interfaces |
name |
STRING |
[Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc |
network |
STRING |
URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
|
networkIP |
STRING |
An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system |
subnetwork |
STRING |
The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
|
= Parameter name
= Format
project STRING Required Project ID for this request |
zone STRING Required The name of the zone for this request |
instance STRING Required The instance name for this request |
networkInterface STRING Required The name of the network interface to update |
requestId STRING 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) |
accessConfigs[] OBJECT An access configuration attached to an instance's network interface. Only one access config per instance is supported |
accessConfigs[].kind STRING [Output Only] Type of the resource. Always compute#accessConfig for access configs |
accessConfigs[].name STRING The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access |
accessConfigs[].natIP STRING An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance |
accessConfigs[].networkTier ENUMERATION This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP |
accessConfigs[].publicPtrDomainName STRING The DNS domain name for the public PTR record. You can set this field only if the |
accessConfigs[].setPublicPtr BOOLEAN Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name |
accessConfigs[].type ENUMERATION The type of configuration. The default and only option is ONE_TO_ONE_NAT |
aliasIpRanges[] OBJECT An alias IP range attached to an instance's network interface |
aliasIpRanges[].ipCidrRange STRING The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24) |
aliasIpRanges[].subnetworkRangeName STRING The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used |
fingerprint BINARY Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface, otherwise the request will fail with error 412 conditionNotMet |
kind STRING [Output Only] Type of the resource. Always compute#networkInterface for network interfaces |
name STRING [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc |
network STRING URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
|
networkIP STRING An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system |
subnetwork STRING The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
|
Output
This building block provides 32 output parameters
Name | Format | Description |
---|---|---|
clientOperationId |
STRING |
[Output Only] The value of |
creationTimestamp |
STRING |
[Deprecated] This field is deprecated |
description |
STRING |
[Output Only] A textual description of the operation, which is set when the operation is created |
endTime |
STRING |
[Output Only] The time that this operation was completed. This value is in RFC3339 text format |
error |
OBJECT |
[Output Only] If errors are generated during processing of the operation, this field will be populated |
error.errors[] |
OBJECT |
|
error.errors[].code |
STRING |
[Output Only] The error type identifier for this error |
error.errors[].location |
STRING |
[Output Only] Indicates the field in the request that caused the error. This property is optional |
error.errors[].message |
STRING |
[Output Only] An optional, human-readable error message |
httpErrorMessage |
STRING |
[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND |
httpErrorStatusCode |
INTEGER |
[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found |
id |
INTEGER |
[Output Only] The unique identifier for the resource. This identifier is defined by the server |
insertTime |
STRING |
[Output Only] The time that this operation was requested. This value is in RFC3339 text format |
kind |
STRING |
[Output Only] Type of the resource. Always compute#operation for Operation resources |
name |
STRING |
[Output Only] Name of the resource |
operationType |
STRING |
[Output Only] The type of operation, such as insert, update, or delete, and so on |
progress |
INTEGER |
[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses |
region |
STRING |
[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations |
selfLink |
STRING |
[Output Only] Server-defined URL for the resource |
startTime |
STRING |
[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format |
status |
ENUMERATION |
[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE |
statusMessage |
STRING |
[Output Only] An optional textual description of the current status of the operation |
targetId |
INTEGER |
[Output Only] The unique target ID, which identifies a specific incarnation of the target resource |
targetLink |
STRING |
[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from |
user |
STRING |
[Output Only] User who requested the operation, for example: [email protected] |
warnings[] |
OBJECT |
|
warnings[].code |
ENUMERATION |
[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response |
warnings[].data[] |
OBJECT |
|
warnings[].data[].key |
STRING |
[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding) |
warnings[].data[].value |
STRING |
[Output Only] A warning data value corresponding to the key |
warnings[].message |
STRING |
[Output Only] A human-readable description of the warning code |
zone |
STRING |
[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations |
= Parameter name
= Format
clientOperationId STRING [Output Only] The value of |
creationTimestamp STRING [Deprecated] This field is deprecated |
description STRING [Output Only] A textual description of the operation, which is set when the operation is created |
endTime STRING [Output Only] The time that this operation was completed. This value is in RFC3339 text format |
error OBJECT [Output Only] If errors are generated during processing of the operation, this field will be populated |
error.errors[] OBJECT |
error.errors[].code STRING [Output Only] The error type identifier for this error |
error.errors[].location STRING [Output Only] Indicates the field in the request that caused the error. This property is optional |
error.errors[].message STRING [Output Only] An optional, human-readable error message |
httpErrorMessage STRING [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND |
httpErrorStatusCode INTEGER [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found |
id INTEGER [Output Only] The unique identifier for the resource. This identifier is defined by the server |
insertTime STRING [Output Only] The time that this operation was requested. This value is in RFC3339 text format |
kind STRING [Output Only] Type of the resource. Always compute#operation for Operation resources |
name STRING [Output Only] Name of the resource |
operationType STRING [Output Only] The type of operation, such as insert, update, or delete, and so on |
progress INTEGER [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses |
region STRING [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations |
selfLink STRING [Output Only] Server-defined URL for the resource |
startTime STRING [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format |
status ENUMERATION [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE |
statusMessage STRING [Output Only] An optional textual description of the current status of the operation |
targetId INTEGER [Output Only] The unique target ID, which identifies a specific incarnation of the target resource |
targetLink STRING [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from |
user STRING [Output Only] User who requested the operation, for example: [email protected] |
warnings[] OBJECT |
warnings[].code ENUMERATION [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response |
warnings[].data[] OBJECT |
warnings[].data[].key STRING [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding) |
warnings[].data[].value STRING [Output Only] A warning data value corresponding to the key |
warnings[].message STRING [Output Only] A human-readable description of the warning code |
zone STRING [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations |