Console
    Contact Us Start free

    Method: networks.insert

    Creates a network in the specified project using the data included in the request.

    HTTP request

    POST https://compute.googleapis.com/compute/beta/projects/{project}/global/networks

    The URL uses gRPC Transcoding syntax.

    Path parameters

    Parameters
    project

    string

    Project ID for this request.

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

    Request body

    The request body contains data with the following structure:

    JSON representation 
     { 
 "kind" 
 : 
 string 
 , 
 "id" 
 : 
 string 
 , 
 "creationTimestamp" 
 : 
 string 
 , 
 "name" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "IPv4Range" 
 : 
 string 
 , 
 "gatewayIPv4" 
 : 
 string 
 , 
 "selfLink" 
 : 
 string 
 , 
 "selfLinkWithId" 
 : 
 string 
 , 
 "autoCreateSubnetworks" 
 : 
 boolean 
 , 
 "subnetworks" 
 : 
 [ 
 string 
 ] 
 , 
 "peerings" 
 : 
 [ 
 { 
 "name" 
 : 
 string 
 , 
 "network" 
 : 
 string 
 , 
 "state" 
 : 
 enum 
 , 
 "stateDetails" 
 : 
 string 
 , 
 "autoCreateRoutes" 
 : 
 boolean 
 , 
 "exportCustomRoutes" 
 : 
 boolean 
 , 
 "importCustomRoutes" 
 : 
 boolean 
 , 
 "exchangeSubnetRoutes" 
 : 
 boolean 
 , 
 "exportSubnetRoutesWithPublicIp" 
 : 
 boolean 
 , 
 "importSubnetRoutesWithPublicIp" 
 : 
 boolean 
 , 
 "peerMtu" 
 : 
 integer 
 , 
 "stackType" 
 : 
 enum 
 , 
 "updateStrategy" 
 : 
 enum 
 , 
 "connectionStatus" 
 : 
 { 
 "updateStrategy" 
 : 
 enum 
 , 
 "trafficConfiguration" 
 : 
 { 
 "stackType" 
 : 
 enum 
 , 
 "importCustomRoutesFromPeer" 
 : 
 boolean 
 , 
 "exportCustomRoutesToPeer" 
 : 
 boolean 
 , 
 "importSubnetRoutesWithPublicIpFromPeer" 
 : 
 boolean 
 , 
 "exportSubnetRoutesWithPublicIpToPeer" 
 : 
 boolean 
 } 
 , 
 "consensusState" 
 : 
 { 
 "deleteStatus" 
 : 
 enum 
 , 
 "updateStatus" 
 : 
 enum 
 } 
 } 
 } 
 ] 
 , 
 "routingConfig" 
 : 
 { 
 "routingMode" 
 : 
 enum 
 , 
 "bgpBestPathSelectionMode" 
 : 
 enum 
 , 
 "bgpAlwaysCompareMed" 
 : 
 boolean 
 , 
 "bgpInterRegionCost" 
 : 
 enum 
 , 
 "effectiveBgpAlwaysCompareMed" 
 : 
 boolean 
 , 
 "effectiveBgpInterRegionCost" 
 : 
 enum 
 } 
 , 
 "mtu" 
 : 
 integer 
 , 
 "firewallPolicy" 
 : 
 string 
 , 
 "networkFirewallPolicyEnforcementOrder" 
 : 
 enum 
 , 
 "enableUlaInternalIpv6" 
 : 
 boolean 
 , 
 "internalIpv6Range" 
 : 
 string 
 , 
 "networkProfile" 
 : 
 string 
 , 
 "params" 
 : 
 { 
 "resourceManagerTags" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 } 
 }
    Fields
    kind

    string

    [Output Only] Type of the resource. Always compute#network for networks.

    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

    [REQUIRED] Name of the resource. Provided by the client when the resource is created. 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])? . The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

    description

    string

    An optional description of this resource. Provide this field when you create the resource.

    IPv4Range
    (deprecated)

    string

    Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16 . Provided by the client when the network is created.

    gatewayIPv4

    string

    [Output Only] The gateway address for default routing out of the network, selected by Google Cloud.

    autoCreateSubnetworks

    boolean

    Must be set to create a VPC network. If not set, a legacy network is created.

    When set to true, the VPC network is created in auto mode. When set to false, the VPC network is created in custom mode.

    An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges .

    For custom mode VPC networks, you can add subnets using the subnetworks insert method.

    subnetworks[]

    string

    [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network.

    peerings[]

    object

    [Output Only] A list of network peerings for the resource.

    peerings[].name

    string

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

    peerings[].network

    string

    The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.

    peerings[].state

    enum

    [Output Only] State for the peering, either ACTIVE or INACTIVE . The peering is ACTIVE when there's a matching configuration in the peer network.

    peerings[].stateDetails

    string

    [Output Only] Details about the current state of the peering.

    peerings[].autoCreateRoutes

    boolean

    This field will be deprecated soon. Use the exchangeSubnetRoutes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE .

    peerings[].exportCustomRoutes

    boolean

    Whether to export the custom routes to peer network. The default value is false.

    peerings[].importCustomRoutes

    boolean

    Whether to import the custom routes from peer network. The default value is false.

    peerings[].exchangeSubnetRoutes

    boolean

    Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE .

    peerings[].exportSubnetRoutesWithPublicIp

    boolean

    Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. IPv4 special-use ranges are always exported to peers and are not controlled by this field.

    peerings[].importSubnetRoutesWithPublicIp

    boolean

    Whether subnet routes with public IP range are imported. The default value is false. IPv4 special-use ranges are always imported from peers and are not controlled by this field.

    peerings[].peerMtu

    integer

    [Output Only] Maximum Transmission Unit in bytes of the peer network.

    peerings[].stackType

    enum

    Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.

    peerings[].updateStrategy

    enum

    The update strategy determines the semantics for updates and deletes to the peering connection configuration.

    peerings[].connectionStatus

    object

    [Output Only] The effective state of the peering connection as a whole.

    peerings[].connectionStatus.updateStrategy

    enum

    The update strategy determines the update/delete semantics for this peering connection.

    peerings[].connectionStatus.trafficConfiguration

    object

    The active connectivity settings for the peering connection based on the settings of the network peerings.

    peerings[].connectionStatus.trafficConfiguration.stackType

    enum

    Which IP version(s) of traffic and routes are being imported or exported between peer networks.

    peerings[].connectionStatus.trafficConfiguration.importCustomRoutesFromPeer

    boolean

    Whether custom routes are being imported from the peer network.

    peerings[].connectionStatus.trafficConfiguration.exportCustomRoutesToPeer

    boolean

    Whether custom routes are being exported to the peer network.

    peerings[].connectionStatus.trafficConfiguration.importSubnetRoutesWithPublicIpFromPeer

    boolean

    Whether subnet routes with public IP ranges are being imported from the peer network.

    peerings[].connectionStatus.trafficConfiguration.exportSubnetRoutesWithPublicIpToPeer

    boolean

    Whether subnet routes with public IP ranges are being exported to the peer network.

    peerings[].connectionStatus.consensusState

    object

    The consensus state contains information about the status of update and delete for a consensus peering connection.

    peerings[].connectionStatus.consensusState.deleteStatus

    enum

    The status of the delete request.

    peerings[].connectionStatus.consensusState.updateStatus

    enum

    The status of the update request.

    routingConfig

    object

    The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce.

    routingConfig.routingMode

    enum

    The network-wide routing mode to use. If set to REGIONAL , this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL , this network's Cloud Routers will advertise routes with all subnets of this network, across regions.

    routingConfig.bgpBestPathSelectionMode

    enum

    The BGP best path selection algorithm to be employed within this network for dynamic routes learned by Cloud Routers. Can be LEGACY (default) or STANDARD .

    routingConfig.bgpAlwaysCompareMed

    boolean

    Enable comparison of Multi-Exit Discriminators (MED) across routes with different neighbor ASNs when using the STANDARD BGP best path selection algorithm.

    routingConfig.bgpInterRegionCost

    enum

    Allows to define a preferred approach for handling inter-region cost in the selection process when using the STANDARD BGP best path selection algorithm. Can be DEFAULT or ADD_COST_TO_MED .

    routingConfig.effectiveBgpAlwaysCompareMed

    boolean

    [Output Only] Effective value of the bgpAlwaysCompareMed field.

    routingConfig.effectiveBgpInterRegionCost

    enum

    [Output Only] Effective value of the bgpInterRegionCost field.

    mtu

    integer

    Maximum Transmission Unit in bytes. The minimum value for this field is 1300 and the maximum value is 8896. The suggested value is 1500, which is the default MTU used on the Internet, or 8896 if you want to use Jumbo frames. If unspecified, the value defaults to 1460.

    firewallPolicy

    string

    [Output Only] URL of the firewall policy the network is associated with.

    networkFirewallPolicyEnforcementOrder

    enum

    The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified.

    enableUlaInternalIpv6

    boolean

    Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. .

    internalIpv6Range

    string

    When enabling ula internal ipv6, caller optionally can specify the /48 range they want from the google defined ULA prefix fd20::/20. The input must be a valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will fail if the speficied /48 is already in used by another resource. If the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. .

    networkProfile

    string

    A full or partial URL of the network profile to apply to this network. This field can be set only at resource creation time. For example, the following are valid URLs:

    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.

    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.networks.create

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