Console
    Contact Us Start free

    Method: subnetworks.patch

    Patches the specified subnetwork with the data included in the request. Only certain fields can be updated with a patch request as indicated in the field descriptions. You must specify the current fingerprint of the subnetwork resource being patched.

    HTTP request

    PATCH https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/subnetworks/{subnetwork}

    The URL uses gRPC Transcoding syntax.

    Path parameters

    Parameters
    project

    string

    Project ID for this request.
    region

    string

    Name of the region scoping this request.
    subnetwork

    string

    Name of the Subnetwork resource to patch.

    Query parameters

    Parameters
    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 ).
    drainTimeoutSeconds

    integer

    The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true: - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = BACKUP - the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped.

    Request body

    The request body contains data with the following structure:

    JSON representation 
     { 
 "kind" 
 : 
 string 
 , 
 "id" 
 : 
 string 
 , 
 "creationTimestamp" 
 : 
 string 
 , 
 "name" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "network" 
 : 
 string 
 , 
 "ipCidrRange" 
 : 
 string 
 , 
 "reservedInternalRange" 
 : 
 string 
 , 
 "gatewayAddress" 
 : 
 string 
 , 
 "region" 
 : 
 string 
 , 
 "selfLink" 
 : 
 string 
 , 
 "privateIpGoogleAccess" 
 : 
 boolean 
 , 
 "secondaryIpRanges" 
 : 
 [ 
 { 
 "rangeName" 
 : 
 string 
 , 
 "ipCidrRange" 
 : 
 string 
 , 
 "reservedInternalRange" 
 : 
 string 
 } 
 ] 
 , 
 "fingerprint" 
 : 
 string 
 , 
 "allowSubnetCidrRoutesOverlap" 
 : 
 boolean 
 , 
 "enableFlowLogs" 
 : 
 boolean 
 , 
 "privateIpv6GoogleAccess" 
 : 
 enum 
 , 
 "ipv6CidrRange" 
 : 
 string 
 , 
 "externalIpv6Prefix" 
 : 
 string 
 , 
 "internalIpv6Prefix" 
 : 
 string 
 , 
 "purpose" 
 : 
 enum 
 , 
 "role" 
 : 
 enum 
 , 
 "state" 
 : 
 enum 
 , 
 "logConfig" 
 : 
 { 
 "enable" 
 : 
 boolean 
 , 
 "aggregationInterval" 
 : 
 enum 
 , 
 "flowSampling" 
 : 
 number 
 , 
 "metadata" 
 : 
 enum 
 , 
 "metadataFields" 
 : 
 [ 
 string 
 ] 
 , 
 "filterExpr" 
 : 
 string 
 } 
 , 
 "stackType" 
 : 
 enum 
 , 
 "ipv6AccessType" 
 : 
 enum 
 , 
 "ipCollection" 
 : 
 string 
 , 
 "ipv6GceEndpoint" 
 : 
 enum 
 , 
 "params" 
 : 
 { 
 "resourceManagerTags" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 } 
 , 
 "utilizationDetails" 
 : 
 { 
 "ipv4Utilizations" 
 : 
 [ 
 { 
 "rangeName" 
 : 
 string 
 , 
 "totalAllocatedIp" 
 : 
 string 
 , 
 "totalFreeIp" 
 : 
 string 
 } 
 ] 
 , 
 "externalIpv6InstanceUtilization" 
 : 
 { 
 "totalAllocatedIp" 
 : 
 { 
 "high" 
 : 
 string 
 , 
 "low" 
 : 
 string 
 } 
 , 
 "totalFreeIp" 
 : 
 { 
 "high" 
 : 
 string 
 , 
 "low" 
 : 
 string 
 } 
 } 
 , 
 "externalIpv6LbUtilization" 
 : 
 { 
 "totalAllocatedIp" 
 : 
 { 
 "high" 
 : 
 string 
 , 
 "low" 
 : 
 string 
 } 
 , 
 "totalFreeIp" 
 : 
 { 
 "high" 
 : 
 string 
 , 
 "low" 
 : 
 string 
 } 
 } 
 , 
 "internalIpv6Utilization" 
 : 
 { 
 "totalAllocatedIp" 
 : 
 { 
 "high" 
 : 
 string 
 , 
 "low" 
 : 
 string 
 } 
 , 
 "totalFreeIp" 
 : 
 { 
 "high" 
 : 
 string 
 , 
 "low" 
 : 
 string 
 } 
 } 
 } 
 , 
 "systemReservedInternalIpv6Ranges" 
 : 
 [ 
 string 
 ] 
 , 
 "systemReservedExternalIpv6Ranges" 
 : 
 [ 
 string 
 ] 
 , 
 "resolveSubnetMask" 
 : 
 enum 
 }
    Fields
    kind

    string

    [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.

    id

    string ( uint64 format)

    [Output Only] The unique identifier for the resource. This identifier is defined by the server.

    creationTimestamp

    string

    [Output Only] Creation timestamp in RFC3339 text format.

    name

    string

    The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035 . Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

    description

    string

    An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time.

    network

    string

    The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time.

    ipCidrRange

    string

    The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10 . Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange .

    reservedInternalRange

    string

    The URL of the reserved internal range.

    gatewayAddress

    string

    [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.

    region

    string

    URL of the region where the Subnetwork resides. This field can be set only at resource creation time.

    privateIpGoogleAccess

    boolean

    Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess .

    secondaryIpRanges[]

    object

    An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a patch request.

    secondaryIpRanges[].rangeName

    string

    The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035 . The name must be unique within the subnetwork.

    secondaryIpRanges[].ipCidrRange

    string

    The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network. Only IPv4 is supported. The range can be any range listed in the Valid ranges list.

    secondaryIpRanges[].reservedInternalRange

    string

    The URL of the reserved internal range.

    fingerprint

    string ( bytes format)

    Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a Subnetwork . An up-to-date fingerprint must be provided in order to update the Subnetwork , otherwise the request will fail with error 412 conditionNotMet .

    To see the latest fingerprint, make a get() request to retrieve a Subnetwork.

    A base64-encoded string.

    allowSubnetCidrRoutesOverlap

    boolean

    Whether this subnetwork's ranges can conflict with existing static routes. Setting this to true allows this subnetwork's primary and secondary ranges to overlap with (and contain) static routes that have already been configured on the corresponding network.

    For example if a static route has range 10.1.0.0/16, a subnet range 10.0.0.0/8 could only be created if allowConflictingRoutes=true.

    Overlapping is only allowed on subnetwork operations; routes whose ranges conflict with this subnetwork's ranges won't be allowed unless route.allow_conflicting_subnetworks is set to true.

    Typically packets destined to IPs within the subnetwork (which may contain private/sensitive data) are prevented from leaving the virtual network. Setting this field to true will disable this feature.

    The default value is false and applies to all existing subnetworks and automatically created subnetworks.

    This field cannot be set to true at resource creation time.

    enableFlowLogs

    boolean

    Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled. This field isn't supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY .

    privateIpv6GoogleAccess

    enum

    This field is for internal use.

    This field can be both set at resource creation time and updated using patch .

    ipv6CidrRange

    string

    [Output Only] This field is for internal use.

    externalIpv6Prefix

    string

    The external IPv6 address range that is owned by this subnetwork.

    internalIpv6Prefix

    string

    The internal IPv6 address range that is owned by this subnetwork.

    purpose

    enum

    role

    enum

    The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY . The value can be set to ACTIVE or BACKUP . An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request.

    state

    enum

    [Output Only] The state of the subnetwork, which can be one of the following values: READY : Subnetwork is created and ready to use DRAINING : only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of READY

    logConfig

    object

    This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging.

    logConfig.enable

    boolean

    Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled. Flow logging isn't supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY .

    logConfig.aggregationInterval

    enum

    Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection.

    logConfig.flowSampling

    number

    Can only be specified if VPC flow logging for this subnetwork is enabled. The value of the field must be in [0, 1]. Set the sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default is 0.5 unless otherwise specified by the org policy, which means half of all collected logs are reported.

    logConfig.metadata

    enum

    Can only be specified if VPC flow logs for this subnetwork is enabled. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default is EXCLUDE_ALL_METADATA .

    logConfig.metadataFields[]

    string

    Can only be specified if VPC flow logs for this subnetwork is enabled and "metadata" was set to CUSTOM_METADATA.

    logConfig.filterExpr

    string

    Can only be specified if VPC flow logs for this subnetwork is enabled. The filter expression is used to define which VPC flow logs should be exported to Cloud Logging.

    stackType

    enum

    The stack type for the subnet. If set to IPV4_ONLY , new VMs in the subnet are assigned IPv4 addresses only. If set to IPV4_IPV6 , new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used.

    This field can be both set at resource creation time and updated using patch .

    ipv6AccessType

    enum

    The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack.

    ipCollection

    string

    Reference to the source of IP, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must be a sub-PDP in EXTERNAL_IPV6_SUBNETWORK_CREATION mode.

    Use one of the following formats to specify a sub-PDP when creating a dual stack subnetwork with external access using BYOIP:

    • Full resource URL, as in https://www.googleapis.com/compute/v1/projects/ projectId /regions/ region /publicDelegatedPrefixes/ sub-pdp-name
    • Partial URL, as in
      • projects/ projectId /regions/ region /publicDelegatedPrefixes/ sub-pdp-name
      • regions/ region /publicDelegatedPrefixes/ sub-pdp-name

    Authorization requires the following IAM permission on the specified resource ipCollection :

    • compute.publicDelegatedPrefixes.use
    ipv6GceEndpoint

    enum

    [Output Only] Possible endpoints of this subnetwork. It can be one of the following:

    • VM_ONLY : The subnetwork can be used for creating instances and IPv6 addresses with VM endpoint type. Such a subnetwork gets external IPv6 ranges from a public delegated prefix and cannot be used to create NetLb.
    • VM_AND_FR : The subnetwork can be used for creating both VM instances and Forwarding Rules. It can also be used to reserve IPv6 addresses with both VM and FR endpoint types. Such a subnetwork gets its IPv6 range from Google IP Pool directly.
    params

    object

    Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.

    params.resourceManagerTags

    map (key: string, value: string)

    Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags . The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : } or Namespaced format { : }. For example the following are valid inputs: * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} * {"123/environment" : "production", "345/abc" : "xyz"} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {"123/environment" : "tagValues/444"} is invalid.

    utilizationDetails

    object

    Output only. [Output Only] The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range.

    utilizationDetails.ipv4Utilizations[]

    object

    Utilizations of all IPV4 IP ranges. For primary ranges, the range name will be empty.

    utilizationDetails.ipv4Utilizations[].rangeName

    string

    Will be set for secondary range. Empty for primary IPv4 range.

    utilizationDetails.ipv4Utilizations[].totalAllocatedIp

    string ( int64 format)

    utilizationDetails.ipv4Utilizations[].totalFreeIp

    string ( int64 format)

    utilizationDetails.externalIpv6InstanceUtilization

    object

    Utilizations of external IPV6 IP range.

    utilizationDetails.externalIpv6InstanceUtilization.totalAllocatedIp

    object

    utilizationDetails.externalIpv6InstanceUtilization.totalAllocatedIp.high

    string ( uint64 format)

    utilizationDetails.externalIpv6InstanceUtilization.totalAllocatedIp.low

    string ( uint64 format)

    utilizationDetails.externalIpv6InstanceUtilization.totalFreeIp

    object

    utilizationDetails.externalIpv6InstanceUtilization.totalFreeIp.high

    string ( uint64 format)

    utilizationDetails.externalIpv6InstanceUtilization.totalFreeIp.low

    string ( uint64 format)

    utilizationDetails.externalIpv6LbUtilization

    object

    Utilizations of external IPV6 IP range for NetLB.

    utilizationDetails.externalIpv6LbUtilization.totalAllocatedIp

    object

    utilizationDetails.externalIpv6LbUtilization.totalAllocatedIp.high

    string ( uint64 format)

    utilizationDetails.externalIpv6LbUtilization.totalAllocatedIp.low

    string ( uint64 format)

    utilizationDetails.externalIpv6LbUtilization.totalFreeIp

    object

    utilizationDetails.externalIpv6LbUtilization.totalFreeIp.high

    string ( uint64 format)

    utilizationDetails.externalIpv6LbUtilization.totalFreeIp.low

    string ( uint64 format)

    utilizationDetails.internalIpv6Utilization

    object

    Utilizations of internal IPV6 IP range.

    utilizationDetails.internalIpv6Utilization.totalAllocatedIp

    object

    utilizationDetails.internalIpv6Utilization.totalAllocatedIp.high

    string ( uint64 format)

    utilizationDetails.internalIpv6Utilization.totalAllocatedIp.low

    string ( uint64 format)

    utilizationDetails.internalIpv6Utilization.totalFreeIp

    object

    utilizationDetails.internalIpv6Utilization.totalFreeIp.high

    string ( uint64 format)

    utilizationDetails.internalIpv6Utilization.totalFreeIp.low

    string ( uint64 format)

    systemReservedInternalIpv6Ranges[]

    string

    Output only. [Output Only] The array of internal IPv6 network ranges reserved from the subnetwork's internal IPv6 range for system use.

    systemReservedExternalIpv6Ranges[]

    string

    Output only. [Output Only] The array of external IPv6 network ranges reserved from the subnetwork's external IPv6 range for system use.

    resolveSubnetMask

    enum

    Configures subnet mask resolution for this subnetwork.

    Response body

    Represents an Operation resource.

    Google Compute Engine has three Operation resources:

    You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses .

    Operations can be global, regional or zonal.

    • For global operations, use the globalOperations resource.
    • For regional operations, use the regionOperations resource.
    • For zonal operations, use the zoneOperations resource.

    For more information, read Global, Regional, and Zonal Resources .

    Note that completed Operation resources have a limited retention period.

    If successful, the response body contains data with the following structure:

    JSON representation 
     { 
 "kind" 
 : 
 string 
 , 
 "id" 
 : 
 string 
 , 
 "creationTimestamp" 
 : 
 string 
 , 
 "name" 
 : 
 string 
 , 
 "zone" 
 : 
 string 
 , 
 "clientOperationId" 
 : 
 string 
 , 
 "operationType" 
 : 
 string 
 , 
 "targetLink" 
 : 
 string 
 , 
 "targetId" 
 : 
 string 
 , 
 "status" 
 : 
 enum 
 , 
 "statusMessage" 
 : 
 string 
 , 
 "user" 
 : 
 string 
 , 
 "progress" 
 : 
 integer 
 , 
 "insertTime" 
 : 
 string 
 , 
 "startTime" 
 : 
 string 
 , 
 "endTime" 
 : 
 string 
 , 
 "error" 
 : 
 { 
 "errors" 
 : 
 [ 
 { 
 "code" 
 : 
 string 
 , 
 "location" 
 : 
 string 
 , 
 "message" 
 : 
 string 
 , 
 "errorDetails" 
 : 
 [ 
 { 
 "errorInfo" 
 : 
 { 
 "reason" 
 : 
 string 
 , 
 "domain" 
 : 
 string 
 , 
 "metadatas" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 } 
 , 
 "quotaInfo" 
 : 
 { 
 "metricName" 
 : 
 string 
 , 
 "limitName" 
 : 
 string 
 , 
 "dimensions" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "limit" 
 : 
 number 
 , 
 "futureLimit" 
 : 
 number 
 , 
 "rolloutStatus" 
 : 
 enum 
 } 
 , 
 "help" 
 : 
 { 
 "links" 
 : 
 [ 
 { 
 "description" 
 : 
 string 
 , 
 "url" 
 : 
 string 
 } 
 ] 
 } 
 , 
 "localizedMessage" 
 : 
 { 
 "locale" 
 : 
 string 
 , 
 "message" 
 : 
 string 
 } 
 } 
 ] 
 } 
 ] 
 } 
 , 
 "warnings" 
 : 
 [ 
 { 
 "code" 
 : 
 enum 
 , 
 "message" 
 : 
 string 
 , 
 "data" 
 : 
 [ 
 { 
 "key" 
 : 
 string 
 , 
 "value" 
 : 
 string 
 } 
 ] 
 } 
 ] 
 , 
 "httpErrorStatusCode" 
 : 
 integer 
 , 
 "httpErrorMessage" 
 : 
 string 
 , 
 "selfLink" 
 : 
 string 
 , 
 "region" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "operationGroupId" 
 : 
 string 
 , 
 // Union field metadata 
can be only one of the following: 
 "setCommonInstanceMetadataOperationMetadata" 
 : 
 { 
 "clientOperationId" 
 : 
 string 
 , 
 "perLocationOperations" 
 : 
 { 
 string 
 : 
 { 
 "state" 
 : 
 enum 
 , 
 "error" 
 : 
 { 
 "code" 
 : 
 integer 
 , 
 "message" 
 : 
 string 
 , 
 "details" 
 : 
 [ 
 { 
 "@type" 
 : 
 string 
 , 
 field1 
 : 
 ... 
 , 
 ... 
 } 
 ] 
 } 
 } 
 , 
 ... 
 } 
 } 
 , 
 "instancesBulkInsertOperationMetadata" 
 : 
 { 
 "perLocationStatus" 
 : 
 { 
 string 
 : 
 { 
 "status" 
 : 
 enum 
 , 
 "targetVmCount" 
 : 
 integer 
 , 
 "createdVmCount" 
 : 
 integer 
 , 
 "failedToCreateVmCount" 
 : 
 integer 
 , 
 "deletedVmCount" 
 : 
 integer 
 } 
 , 
 ... 
 } 
 } 
 // End of list of possible types for union field metadata 
. 
 }
    Fields
    kind

    string

    [Output Only] Type of the resource. Always compute#operation for Operation resources.

    id

    string ( uint64 format)

    [Output Only] The unique identifier for the operation. This identifier is defined by the server.

    creationTimestamp

    string

    [Deprecated] This field is deprecated.

    name

    string

    [Output Only] Name of the operation.

    zone

    string

    [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

    clientOperationId

    string

    [Output Only] The value of requestId if you provided it in the request. Not present otherwise.

    operationType

    string

    [Output Only] The type of operation, such as insert , update , or delete , and so on.

    targetId

    string ( uint64 format)

    [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

    status

    enum

    [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.

    user

    string

    [Output Only] User who requested the operation, for example: user@example.com or alice_smith_identifier (global/workforcePools/example-com-us-employees) .

    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.

    insertTime

    string

    [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

    startTime

    string

    [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

    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

    [Output Only] The array of errors encountered while processing this operation.

    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.

    error.errors[].errorDetails[]

    object

    [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.

    error.errors[].errorDetails[].errorInfo

    object

    error.errors[].errorDetails[].errorInfo.reason

    string

    The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9] , which represents UPPER_SNAKE_CASE.

    error.errors[].errorDetails[].errorInfo.domain

    string

    The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".

    error.errors[].errorDetails[].errorInfo.metadatas

    map (key: string, value: string)

    Additional structured details about this error.

    Keys must match a regular expression of [a-z][a-zA-Z0-9-_]+ but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"} , should be returned as, {"instanceLimitPerRequest": "100"} , if the client exceeds the number of instances that can be created in a single (batch) request.

    error.errors[].errorDetails[].quotaInfo

    object

    error.errors[].errorDetails[].quotaInfo.metricName

    string

    The Compute Engine quota metric name.

    error.errors[].errorDetails[].quotaInfo.limitName

    string

    The name of the quota limit.

    error.errors[].errorDetails[].quotaInfo.dimensions

    map (key: string, value: string)

    The map holding related quota dimensions.

    error.errors[].errorDetails[].quotaInfo.limit

    number

    Current effective quota limit. The limit's unit depends on the quota type or metric.

    error.errors[].errorDetails[].quotaInfo.futureLimit

    number

    Future quota limit being rolled out. The limit's unit depends on the quota type or metric.

    error.errors[].errorDetails[].quotaInfo.rolloutStatus

    enum

    Rollout status of the future quota limit.

    error.errors[].errorDetails[].help

    object

    error.errors[].errorDetails[].help.links[]

    object

    URL(s) pointing to additional information on handling the current error.

    error.errors[].errorDetails[].help.links[].description

    string

    Describes what the link offers.

    error.errors[].errorDetails[].help.links[].url

    string

    The URL of the link.

    error.errors[].errorDetails[].localizedMessage

    object

    error.errors[].errorDetails[].localizedMessage.locale

    string

    The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt . Examples are: "en-US", "fr-CH", "es-MX"

    error.errors[].errorDetails[].localizedMessage.message

    string

    The localized error message in the above locale.

    warnings[]

    object

    [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

    warnings[].code

    enum

    [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[].message

    string

    [Output Only] A human-readable description of the warning code.

    warnings[].data[]

    object

    [Output Only] Metadata about this warning in key: value format. For example:

    "data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }
    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.

    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.

    httpErrorMessage

    string

    [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND .

    region

    string

    [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

    description

    string

    [Output Only] A textual description of the operation, which is set when the operation is created.

    operationGroupId

    string

    [Output Only] An ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.

    Union field metadata . [Output Only] Service-specific metadata attached to this operation. metadata can be only one of the following:
    setCommonInstanceMetadataOperationMetadata

    object

    [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.

    setCommonInstanceMetadataOperationMetadata.clientOperationId

    string

    [Output Only] The client operation id.

    setCommonInstanceMetadataOperationMetadata.perLocationOperations[]

    map (key: string, value: object)

    [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a

    setCommonInstanceMetadataOperationMetadata.perLocationOperations[].state

    enum

    [Output Only] Status of the action, which can be one of the following: PROPAGATING , PROPAGATED , ABANDONED , FAILED , or DONE .

    setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error

    object

    [Output Only] If state is ABANDONED or FAILED , this field is populated.

    setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.code

    integer

    The status code, which should be an enum value of google.rpc.Code .

    setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.message

    string

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

    setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.details[]

    object

    A list of messages that carry the error details. There is a common set of message types for APIs to use.

    An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" } .

    instancesBulkInsertOperationMetadata

    object

    instancesBulkInsertOperationMetadata.perLocationStatus[]

    map (key: string, value: object)

    Status information per location (location name is key). Example key: zones/us-central1-a

    instancesBulkInsertOperationMetadata.perLocationStatus[].status

    enum

    [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.

    instancesBulkInsertOperationMetadata.perLocationStatus[].targetVmCount

    integer

    [Output Only] Count of VMs originally planned to be created.

    instancesBulkInsertOperationMetadata.perLocationStatus[].createdVmCount

    integer

    [Output Only] Count of VMs successfully created so far.

    instancesBulkInsertOperationMetadata.perLocationStatus[].failedToCreateVmCount

    integer

    [Output Only] Count of VMs that started creating but encountered an error.

    instancesBulkInsertOperationMetadata.perLocationStatus[].deletedVmCount

    integer

    [Output Only] Count of VMs that got deleted during rollback.

    Authorization scopes

    Requires one of the following OAuth scopes:

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

    For more information, see the Authentication Overview .

    IAM Permissions

    In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:

    • compute.subnetworks.get
    • compute.subnetworks.update

    To find predefined roles that contain those permissions, see Compute Engine IAM Roles .
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: