Compute Engine API v1beta12

procedure
(_ [ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

This is not actually a function. This is just using Scribble’s defproc form to list the optional keyword arguments that may be passed to all functions for this service.

alt: Data format for the response.

fields: Selector specifying which fields to include in a partial response.

key: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_token: OAuth 2.0 token for the current user.

prettyPrint: Returns response with indentations and line breaks.

quotaUser: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

userIp: IP address of the site where the request originates. Use this if you want to enforce per-user limits.

2 Resources

2.1 instances

procedure
(compute-instances-list #:project project
[ #:filter filter
#:maxResults maxResults
#:pageToken pageToken
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  project : string?
  filter : string? = 'N/A
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves the list of instance resources contained within the specified project.

project: Name of the project scoping this request.

filter: Optional. Filter expression for filtering listed resources.

maxResults: Optional. Maximum count of results to be returned. Maximum and default value is 100.

pageToken: Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.

procedure
(compute-instances-get #:project project
#:instance instance
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  project : string?
  instance : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Returns the specified instance resource.

project: Name of the project scoping this request.

instance: Name of the instance resource to return.

procedure
(compute-instances-insert
#:project project
[ #:id id
#:name name
#:description description
#:kind kind
#:status status
#:creationTimestamp creationTimestamp
#:selfLink selfLink
#:zone zone
#:disks disks
#:image image
#:machineType machineType
#:metadata metadata
#:networkInterfaces networkInterfaces
#:serviceAccounts serviceAccounts
#:statusMessage statusMessage
#:tags tags
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  project : string?
  id : string? = 'N/A
  name : string? = 'N/A
  description : string? = 'N/A
  kind : string? = 'N/A
  status : string? = 'N/A
  creationTimestamp : string? = 'N/A
  selfLink : string? = 'N/A
  zone : string? = 'N/A
  disks : string? = 'N/A
  image : string? = 'N/A
  machineType : string? = 'N/A
  metadata : string? = 'N/A
  networkInterfaces : string? = 'N/A
  serviceAccounts : string? = 'N/A
  statusMessage : string? = 'N/A
  tags : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Creates an instance resource in the specified project using the data included in the request.

project: Name of the project scoping this request.

id: Unique identifier for the resource; defined by the server (output only).

name: 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.

description: An optional textual description of the resource; provided by the client when the resource is created.

kind: Type of the resource.

status: Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING" (output only).

creationTimestamp: Creation timestamp in RFC3339 text format (output only).

selfLink: Server defined URL for the resource (output only).

zone: URL of the zone resource describing where this instance should be hosted; provided by the client when the instance is created.

disks: Array of disks associated with this instance. Persistent disks must be created before you can assign them.

image: An optional URL of the disk image resource to be to be installed on this instance; provided by the client when the instance is created. If not specified, the server will choose a default image.

machineType: URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.

metadata: Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.

networkInterfaces: Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.

serviceAccounts: A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.

statusMessage: An optional, human-readable explanation of the status (output only).

tags: An optional set of tags applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client when the instance is created. Each tag must be 1-63 characters long, and comply with RFC1035.

procedure
(compute-instances-addAccessConfig
#:project project
#:instance instance
#:network_interface network_interface
[ #:name name
#:type type
#:kind kind
#:natIP natIP
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  project : string?
  instance : string?
  network_interface : string?
  name : string? = 'N/A
  type : string? = 'N/A
  kind : string? = 'N/A
  natIP : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Adds an access config to an instance’s network interface.

project: Project name.

instance: Instance name.

network_interface: Network interface name.

name: Name of this access configuration.

type: Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.

kind: Type of the resource.

natIP: An external IP address associated with this instance. Specify an unused static IP address available to the project. If left blank, the external IP will be drawn from a shared ephemeral pool.

procedure
(compute-instances-deleteAccessConfig
#:project project
#:instance instance
#:network_interface network_interface
#:access_config access_config
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  project : string?
  instance : string?
  network_interface : string?
  access_config : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Deletes an access config from an instance’s network interface.

project: Project name.

instance: Instance name.

network_interface: Network interface name.

access_config: Access config name.

procedure
(compute-instances-delete #:project project
#:instance instance
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  project : string?
  instance : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Deletes the specified instance resource.

project: Name of the project scoping this request.

instance: Name of the instance resource to delete.

2.2 disks

procedure
(compute-disks-list #:project project
[ #:filter filter
#:maxResults maxResults
#:pageToken pageToken
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  project : string?
  filter : string? = 'N/A
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves the list of persistent disk resources contained within the specified project.

project: Name of the project scoping this request.

filter: Optional. Filter expression for filtering listed resources.

maxResults: Optional. Maximum count of results to be returned. Maximum and default value is 100.

pageToken: Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.

procedure
(compute-disks-get #:disk disk
#:project project
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  disk : string?
  project : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Returns the specified persistent disk resource.

disk: Name of the persistent disk resource to return.

project: Name of the project scoping this request.

procedure
(compute-disks-insert #:project project
[ #:options options
#:id id
#:name name
#:description description
#:kind kind
#:status status
#:creationTimestamp creationTimestamp
#:selfLink selfLink
#:sizeGb sizeGb
#:sourceSnapshot sourceSnapshot
#:sourceSnapshotId sourceSnapshotId
#:zone zone
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  project : string?
  options : string? = 'N/A
  id : string? = 'N/A
  name : string? = 'N/A
  description : string? = 'N/A
  kind : string? = 'N/A
  status : string? = 'N/A
  creationTimestamp : string? = 'N/A
  selfLink : string? = 'N/A
  sizeGb : string? = 'N/A
  sourceSnapshot : string? = 'N/A
  sourceSnapshotId : string? = 'N/A
  zone : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Creates a persistent disk resource in the specified project using the data included in the request.

project: Name of the project scoping this request.

options: Internal use only.

id: Unique identifier for the resource; defined by the server (output only).

name: 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.

description: An optional textual description of the resource; provided by the client when the resource is created.

kind: Type of the resource.

status: The status of disk creation (output only).

creationTimestamp: Creation timestamp in RFC3339 text format (output only).

selfLink: Server defined URL for the resource (output only).

sizeGb: Size of the persistent disk, specified in GB.

sourceSnapshot: The source snapshot used to create this disk. Once the source snapshot has been deleted from the system, this field will be cleared, and will not be set even if a snapshot with the same name has been re-created.

sourceSnapshotId: The ’id’ value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.

zone: URL for the zone where the persistent disk resides; provided by the client when the disk is created. A persistent disk must reside in the same zone as the instance to which it is attached.

procedure
(compute-disks-delete #:disk disk
#:project project
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  disk : string?
  project : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Deletes the specified persistent disk resource.

disk: Name of the persistent disk resource to delete.

project: Name of the project scoping this request.

2.3 firewalls

procedure
(compute-firewalls-list #:project project
[ #:filter filter
#:maxResults maxResults
#:pageToken pageToken
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  project : string?
  filter : string? = 'N/A
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves the list of firewall resources available to the specified project.

project: Name of the project scoping this request.

filter: Optional. Filter expression for filtering listed resources.

maxResults: Optional. Maximum count of results to be returned. Maximum and default value is 100.

pageToken: Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.

procedure
(compute-firewalls-get #:project project
#:firewall firewall
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  project : string?
  firewall : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Returns the specified firewall resource.

project: Name of the project scoping this request.

firewall: Name of the firewall resource to return.

procedure
(compute-firewalls-insert
#:project project
[ #:id id
#:name name
#:description description
#:kind kind
#:creationTimestamp creationTimestamp
#:selfLink selfLink
#:allowed allowed
#:network network
#:sourceRanges sourceRanges
#:sourceTags sourceTags
#:targetTags targetTags
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  project : string?
  id : string? = 'N/A
  name : string? = 'N/A
  description : string? = 'N/A
  kind : string? = 'N/A
  creationTimestamp : string? = 'N/A
  selfLink : string? = 'N/A
  allowed : string? = 'N/A
  network : string? = 'N/A
  sourceRanges : string? = 'N/A
  sourceTags : string? = 'N/A
  targetTags : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Creates a firewall resource in the specified project using the data included in the request.

project: Name of the project scoping this request.

id: Unique identifier for the resource; defined by the server (output only).

name: 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.

description: An optional textual description of the resource; provided by the client when the resource is created.

kind: Type of the resource.

creationTimestamp: Creation timestamp in RFC3339 text format (output only).

selfLink: Server defined URL for the resource (output only).

allowed: The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

network: URL of the network to which this firewall is applied; provided by the client when the firewall is created.

sourceRanges: A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.

sourceTags: A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.

targetTags: A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.

procedure
(compute-firewalls-patch
#:project project
#:firewall firewall
[ #:id id
#:name name
#:description description
#:kind kind
#:creationTimestamp creationTimestamp
#:selfLink selfLink
#:allowed allowed
#:network network
#:sourceRanges sourceRanges
#:sourceTags sourceTags
#:targetTags targetTags
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  project : string?
  firewall : string?
  id : string? = 'N/A
  name : string? = 'N/A
  description : string? = 'N/A
  kind : string? = 'N/A
  creationTimestamp : string? = 'N/A
  selfLink : string? = 'N/A
  allowed : string? = 'N/A
  network : string? = 'N/A
  sourceRanges : string? = 'N/A
  sourceTags : string? = 'N/A
  targetTags : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Updates the specified firewall resource with the data included in the request. This method supports patch semantics.

project: Name of the project scoping this request.

firewall: Name of the firewall resource to update.

id: Unique identifier for the resource; defined by the server (output only).

name: 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.

description: An optional textual description of the resource; provided by the client when the resource is created.

kind: Type of the resource.

creationTimestamp: Creation timestamp in RFC3339 text format (output only).

selfLink: Server defined URL for the resource (output only).

allowed: The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

network: URL of the network to which this firewall is applied; provided by the client when the firewall is created.

procedure
(compute-firewalls-delete #:project project
#:firewall firewall
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  project : string?
  firewall : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Deletes the specified firewall resource.

project: Name of the project scoping this request.

firewall: Name of the firewall resource to delete.

procedure
(compute-firewalls-update
#:project project
#:firewall firewall
[ #:id id
#:name name
#:description description
#:kind kind
#:creationTimestamp creationTimestamp
#:selfLink selfLink
#:allowed allowed
#:network network
#:sourceRanges sourceRanges
#:sourceTags sourceTags
#:targetTags targetTags
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  project : string?
  firewall : string?
  id : string? = 'N/A
  name : string? = 'N/A
  description : string? = 'N/A
  kind : string? = 'N/A
  creationTimestamp : string? = 'N/A
  selfLink : string? = 'N/A
  allowed : string? = 'N/A
  network : string? = 'N/A
  sourceRanges : string? = 'N/A
  sourceTags : string? = 'N/A
  targetTags : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Updates the specified firewall resource with the data included in the request.

project: Name of the project scoping this request.

firewall: Name of the firewall resource to update.

id: Unique identifier for the resource; defined by the server (output only).

name: 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.

description: An optional textual description of the resource; provided by the client when the resource is created.

kind: Type of the resource.

creationTimestamp: Creation timestamp in RFC3339 text format (output only).

selfLink: Server defined URL for the resource (output only).

allowed: The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

network: URL of the network to which this firewall is applied; provided by the client when the firewall is created.

2.4 images

procedure
(compute-images-list #:project project
[ #:filter filter
#:maxResults maxResults
#:pageToken pageToken
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  project : string?
  filter : string? = 'N/A
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves the list of image resources available to the specified project.

project: Name of the project scoping this request.

filter: Optional. Filter expression for filtering listed resources.

maxResults: Optional. Maximum count of results to be returned. Maximum and default value is 100.

pageToken: Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.

procedure
(compute-images-get #:image image
#:project project
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  image : string?
  project : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Returns the specified image resource.

image: Name of the image resource to return.

project: Name of the project scoping this request.

procedure
(compute-images-insert #:project project
[ #:id id
#:name name
#:description description
#:kind kind
#:creationTimestamp creationTimestamp
#:selfLink selfLink
#:diskSnapshot diskSnapshot
#:preferredKernel preferredKernel
#:rawDisk rawDisk
#:sourceType sourceType
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  project : string?
  id : string? = 'N/A
  name : string? = 'N/A
  description : string? = 'N/A
  kind : string? = 'N/A
  creationTimestamp : string? = 'N/A
  selfLink : string? = 'N/A
  diskSnapshot : string? = 'N/A
  preferredKernel : string? = 'N/A
  rawDisk : string? = 'N/A
  sourceType : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Creates an image resource in the specified project using the data included in the request.

project: Name of the project scoping this request.

id: Unique identifier for the resource; defined by the server (output only).

name: 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.

description: Textual description of the resource; provided by the client when the resource is created.

kind: Type of the resource.

creationTimestamp: Creation timestamp in RFC3339 text format (output only).

selfLink: Server defined URL for the resource (output only).

diskSnapshot: Not yet implemented.

preferredKernel: An optional URL of the preferred kernel for use with this disk image. If not specified, a server defined default kernel will be used.

rawDisk: The raw disk image parameters.

sourceType: Must be "RAW"; provided by the client when the disk image is created.

procedure
(compute-images-delete #:image image
#:project project
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  image : string?
  project : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Deletes the specified image resource.

image: Name of the image resource to delete.

project: Name of the project scoping this request.

2.5 kernels

procedure
(compute-kernels-list #:project project
[ #:filter filter
#:maxResults maxResults
#:pageToken pageToken
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  project : string?
  filter : string? = 'N/A
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves the list of kernel resources available to the specified project.

project: Name of the project scoping this request.

filter: Optional. Filter expression for filtering listed resources.

maxResults: Optional. Maximum count of results to be returned. Maximum and default value is 100.

pageToken: Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.

procedure
(compute-kernels-get #:project project
#:kernel kernel
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  project : string?
  kernel : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Returns the specified kernel resource.

project: Name of the project scoping this request.

kernel: Name of the kernel resource to return.

2.6 machineTypes

procedure
(compute-machineTypes-list #:project project
[ #:filter filter
#:maxResults maxResults
#:pageToken pageToken
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  project : string?
  filter : string? = 'N/A
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves the list of machine type resources available to the specified project.

project: Name of the project scoping this request.

filter: Optional. Filter expression for filtering listed resources.

maxResults: Optional. Maximum count of results to be returned. Maximum and default value is 100.

pageToken: Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.

procedure
(compute-machineTypes-get #:machineType machineType
#:project project
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  machineType : string?
  project : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Returns the specified machine type resource.

machineType: Name of the machine type resource to return.

project: Name of the project scoping this request.

2.7 networks

procedure
(compute-networks-list #:project project
[ #:filter filter
#:maxResults maxResults
#:pageToken pageToken
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  project : string?
  filter : string? = 'N/A
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves the list of network resources available to the specified project.

project: Name of the project scoping this request.

filter: Optional. Filter expression for filtering listed resources.

maxResults: Optional. Maximum count of results to be returned. Maximum and default value is 100.

pageToken: Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.

procedure
(compute-networks-get #:network network
#:project project
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  network : string?
  project : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Returns the specified network resource.

network: Name of the network resource to return.

project: Name of the project scoping this request.

procedure
(compute-networks-insert
#:project project
[ #:id id
#:name name
#:description description
#:kind kind
#:creationTimestamp creationTimestamp
#:selfLink selfLink
#:IPv4Range IPv4Range
#:gatewayIPv4 gatewayIPv4
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  project : string?
  id : string? = 'N/A
  name : string? = 'N/A
  description : string? = 'N/A
  kind : string? = 'N/A
  creationTimestamp : string? = 'N/A
  selfLink : string? = 'N/A
  IPv4Range : string? = 'N/A
  gatewayIPv4 : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

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

project: Name of the project scoping this request.

id: Unique identifier for the resource; defined by the server (output only).

name: 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.

description: An optional textual description of the resource; provided by the client when the resource is created.

kind: Type of the resource.

creationTimestamp: Creation timestamp in RFC3339 text format (output only).

selfLink: Server defined URL for the resource (output only).

IPv4Range: Required; 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: An optional address that is used for default routing to other networks. This must be within the range specified by IPv4Range, and is typically the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.

procedure
(compute-networks-delete #:network network
#:project project
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  network : string?
  project : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Deletes the specified network resource.

network: Name of the network resource to delete.

project: Name of the project scoping this request.

2.8 operations

procedure
(compute-operations-list #:project project
[ #:filter filter
#:maxResults maxResults
#:pageToken pageToken
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  project : string?
  filter : string? = 'N/A
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves the list of operation resources contained within the specified project.

project: Name of the project scoping this request.

filter: Optional. Filter expression for filtering listed resources.

maxResults: Optional. Maximum count of results to be returned. Maximum and default value is 100.

pageToken: Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.

procedure
(compute-operations-get #:project project
#:operation operation
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  project : string?
  operation : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves the specified operation resource.

project: Name of the project scoping this request.

operation: Name of the operation resource to return.

procedure
(compute-operations-delete #:project project
#:operation operation
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  project : string?
  operation : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Deletes the specified operation resource.

project: Name of the project scoping this request.

operation: Name of the operation resource to delete.

2.9 projects

procedure
(compute-projects-get #:project project
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  project : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Returns the specified project resource.

project: Name of the project resource to retrieve.

procedure
(compute-projects-setCommonInstanceMetadata
#:project project
[ #:items items
#:kind kind
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  project : string?
  items : string? = 'N/A
  kind : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Sets metadata common to all instances within the specified project using the data included in the request.

project: Name of the project scoping this request.

items: Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

kind: Type of the resource.

2.10 snapshots

procedure
(compute-snapshots-list #:project project
[ #:filter filter
#:maxResults maxResults
#:pageToken pageToken
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  project : string?
  filter : string? = 'N/A
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves the list of persistent disk snapshot resources contained within the specified project.

project: Name of the project scoping this request.

filter: Optional. Filter expression for filtering listed resources.

maxResults: Optional. Maximum count of results to be returned. Maximum and default value is 100.

pageToken: Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.

procedure
(compute-snapshots-get #:project project
#:snapshot snapshot
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  project : string?
  snapshot : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Returns the specified persistent disk snapshot resource.

project: Name of the project scoping this request.

snapshot: Name of the persistent disk snapshot resource to return.

procedure
(compute-snapshots-insert
#:project project
[ #:id id
#:name name
#:description description
#:kind kind
#:status status
#:creationTimestamp creationTimestamp
#:selfLink selfLink
#:diskSizeGb diskSizeGb
#:sourceDisk sourceDisk
#:sourceDiskId sourceDiskId
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  project : string?
  id : string? = 'N/A
  name : string? = 'N/A
  description : string? = 'N/A
  kind : string? = 'N/A
  status : string? = 'N/A
  creationTimestamp : string? = 'N/A
  selfLink : string? = 'N/A
  diskSizeGb : string? = 'N/A
  sourceDisk : string? = 'N/A
  sourceDiskId : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Creates a persistent disk snapshot resource in the specified project using the data included in the request.

project: Name of the project scoping this request.

id: Unique identifier for the resource; defined by the server (output only).

name: 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.

description: An optional textual description of the resource; provided by the client when the resource is created.

kind: Type of the resource.

status: The status of the persistent disk snapshot (output only).

creationTimestamp: Creation timestamp in RFC3339 text format (output only).

selfLink: Server defined URL for the resource (output only).

diskSizeGb: Size of the persistent disk snapshot, specified in GB (output only).

sourceDisk: The source disk used to create this snapshot. Once the source disk has been deleted from the system, this field will be cleared, and will not be set even if a disk with the same name has been re-created.

sourceDiskId: The ’id’ value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.

procedure
(compute-snapshots-delete #:project project
#:snapshot snapshot
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  project : string?
  snapshot : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Deletes the specified persistent disk snapshot resource.

project: Name of the project scoping this request.

snapshot: Name of the persistent disk snapshot resource to delete.

2.11 zones

procedure
(compute-zones-list #:project project
[ #:filter filter
#:maxResults maxResults
#:pageToken pageToken
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  project : string?
  filter : string? = 'N/A
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves the list of zone resources available to the specified project.

project: Name of the project scoping this request.

filter: Optional. Filter expression for filtering listed resources.

maxResults: Optional. Maximum count of results to be returned. Maximum and default value is 100.

pageToken: Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.

procedure
(compute-zones-get #:zone zone
#:project project
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  zone : string?
  project : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Returns the specified zone resource.

zone: Name of the zone resource to return.

project: Name of the project scoping this request.