| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.instanceTemplates.html">instanceTemplates</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(project, instanceTemplate)</a></code></p> |
| <p class="firstline">Deletes the specified instance template resource.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(project, instanceTemplate)</a></code></p> |
| <p class="firstline">Returns the specified instance template resource.</p> |
| <p class="toc_element"> |
| <code><a href="#insert">insert(project, body)</a></code></p> |
| <p class="firstline">Creates an instance template resource in the specified project using the data included in the request.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p> |
| <p class="firstline">Retrieves the list of instance template resources contained within the specified project.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="delete">delete(project, instanceTemplate)</code> |
| <pre>Deletes the specified instance template resource. |
| |
| Args: |
| project: string, Name of the project scoping this request. (required) |
| instanceTemplate: string, Name of the instance template resource to delete. (required) |
| |
| Returns: |
| An object of the form: |
| |
| { # An operation resource, used to manage asynchronous API requests. |
| "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. |
| "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| "zone": "A String", # [Output Only] URL of the zone where the operation resides. |
| "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. |
| "progress": 42, # [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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses. |
| "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| { |
| "message": "A String", # [Output Only] Optional human-readable details for this warning. |
| "code": "A String", # [Output Only] The warning type identifier for this warning. |
| "data": [ # [Output Only] Metadata for this warning in key: value format. |
| { |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| "key": "A String", # [Output Only] A key for the warning data. |
| }, |
| ], |
| }, |
| ], |
| "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. |
| "name": "A String", # [Output Only] Name of the resource. |
| "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. |
| "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| { |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional. |
| }, |
| ], |
| }, |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. |
| "selfLink": "A String", # [Output Only] Server defined URL for the resource. |
| "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(project, instanceTemplate)</code> |
| <pre>Returns the specified instance template resource. |
| |
| Args: |
| project: string, Name of the project scoping this request. (required) |
| instanceTemplate: string, Name of the instance template resource to return. (required) |
| |
| Returns: |
| An object of the form: |
| |
| { # An Instance Template resource. |
| "kind": "compute#instanceTemplate", # Type of the resource. |
| "description": "A String", # An optional textual description of the instance template resource; provided by the client when the resource is created. |
| "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only). |
| "properties": { # The instance properties portion of this instance template resource. |
| "machineType": "A String", # Name of the machine type resource describing which machine type to use to host the instances created based on this template; provided by the client when the instance template is created. |
| "description": "A String", # An optional textual description for the instances created based on the instance template resource; provided by the client when the template is created. |
| "tags": { # A set of instance tags. # A list of tags to be applied to the instances created based on this template used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. |
| "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. |
| "A String", |
| ], |
| "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata. |
| # |
| # To see the latest fingerprint, make get() request to the instance. |
| }, |
| "disks": [ # Array of disks associated with instance created based on this template. |
| { # An instance-attached disk resource. |
| "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/ tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. |
| # |
| # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. |
| "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. |
| "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. |
| # |
| # This property is mutually exclusive with the source property; you can only define one or the other, but not both. |
| # |
| # This property is mutually exclusive with the source property; you can only define one or the other, but not both. |
| "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. |
| "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. |
| "sourceImage": "A String", # A source image used to create the disk. You can provide a private (custom) image, and Compute Engine will use the corresponding image from your project. For example: |
| # |
| # global/images/my-private-image |
| # |
| # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL: |
| # |
| # projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD |
| # |
| # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases. |
| "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: |
| # |
| # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard |
| # |
| # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: |
| # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType |
| # - projects/project/zones/zone/diskTypes/diskType |
| # - zones/zone/diskTypes/diskType |
| }, |
| "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). |
| "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value. |
| "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. |
| "licenses": [ # [Output Only] Any valid publicly visible licenses. |
| "A String", |
| ], |
| "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. |
| "interface": "A String", |
| "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. |
| "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. |
| }, |
| ], |
| "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for the instances created based on this template. |
| "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). |
| "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. The default behavior is MIGRATE. For more information, see Setting maintenance behavior. |
| }, |
| "canIpForward": True or False, # Allows instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, say true. If unsure, leave this set to false. |
| "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instances created based on this template, through metadata queries. |
| { # A service account. |
| "scopes": [ # The list of scopes to be made available for this service account. |
| "A String", |
| ], |
| "email": "A String", # Email address of the service account. |
| }, |
| ], |
| "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to instances created based on this template. Consists of custom metadata or predefined keys; see Instance documentation for more information. |
| "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. |
| { |
| "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes. |
| "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project. |
| }, |
| ], |
| "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. |
| "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata. |
| }, |
| "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 instances created based based on this template will have no external internet access. |
| { # A network interface resource attached to an instance. |
| "accessConfigs": [ # An array of configurations for this interface. Currently, <codeONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access. |
| { # An access configuration attached to an instance's network interface. |
| "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. |
| "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. |
| "name": "A String", # Name of this access configuration. |
| "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. |
| }, |
| ], |
| "networkIP": "A String", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface. |
| "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc. |
| "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used: |
| # |
| # global/networks/default |
| # |
| # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: |
| # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network |
| # - projects/project/global/networks/network |
| # - global/networks/default |
| }, |
| ], |
| }, |
| "selfLink": "A String", # Server defined URL for the resource (output only). |
| "name": "A String", # Name of the instance template resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035 |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="insert">insert(project, body)</code> |
| <pre>Creates an instance template resource in the specified project using the data included in the request. |
| |
| Args: |
| project: string, Name of the project scoping this request. (required) |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { # An Instance Template resource. |
| "kind": "compute#instanceTemplate", # Type of the resource. |
| "description": "A String", # An optional textual description of the instance template resource; provided by the client when the resource is created. |
| "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only). |
| "properties": { # The instance properties portion of this instance template resource. |
| "machineType": "A String", # Name of the machine type resource describing which machine type to use to host the instances created based on this template; provided by the client when the instance template is created. |
| "description": "A String", # An optional textual description for the instances created based on the instance template resource; provided by the client when the template is created. |
| "tags": { # A set of instance tags. # A list of tags to be applied to the instances created based on this template used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. |
| "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. |
| "A String", |
| ], |
| "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata. |
| # |
| # To see the latest fingerprint, make get() request to the instance. |
| }, |
| "disks": [ # Array of disks associated with instance created based on this template. |
| { # An instance-attached disk resource. |
| "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/ tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. |
| # |
| # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. |
| "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. |
| "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. |
| # |
| # This property is mutually exclusive with the source property; you can only define one or the other, but not both. |
| # |
| # This property is mutually exclusive with the source property; you can only define one or the other, but not both. |
| "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. |
| "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. |
| "sourceImage": "A String", # A source image used to create the disk. You can provide a private (custom) image, and Compute Engine will use the corresponding image from your project. For example: |
| # |
| # global/images/my-private-image |
| # |
| # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL: |
| # |
| # projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD |
| # |
| # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases. |
| "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: |
| # |
| # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard |
| # |
| # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: |
| # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType |
| # - projects/project/zones/zone/diskTypes/diskType |
| # - zones/zone/diskTypes/diskType |
| }, |
| "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). |
| "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value. |
| "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. |
| "licenses": [ # [Output Only] Any valid publicly visible licenses. |
| "A String", |
| ], |
| "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. |
| "interface": "A String", |
| "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. |
| "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. |
| }, |
| ], |
| "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for the instances created based on this template. |
| "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). |
| "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. The default behavior is MIGRATE. For more information, see Setting maintenance behavior. |
| }, |
| "canIpForward": True or False, # Allows instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, say true. If unsure, leave this set to false. |
| "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instances created based on this template, through metadata queries. |
| { # A service account. |
| "scopes": [ # The list of scopes to be made available for this service account. |
| "A String", |
| ], |
| "email": "A String", # Email address of the service account. |
| }, |
| ], |
| "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to instances created based on this template. Consists of custom metadata or predefined keys; see Instance documentation for more information. |
| "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. |
| { |
| "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes. |
| "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project. |
| }, |
| ], |
| "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. |
| "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata. |
| }, |
| "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 instances created based based on this template will have no external internet access. |
| { # A network interface resource attached to an instance. |
| "accessConfigs": [ # An array of configurations for this interface. Currently, <codeONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access. |
| { # An access configuration attached to an instance's network interface. |
| "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. |
| "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. |
| "name": "A String", # Name of this access configuration. |
| "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. |
| }, |
| ], |
| "networkIP": "A String", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface. |
| "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc. |
| "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used: |
| # |
| # global/networks/default |
| # |
| # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: |
| # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network |
| # - projects/project/global/networks/network |
| # - global/networks/default |
| }, |
| ], |
| }, |
| "selfLink": "A String", # Server defined URL for the resource (output only). |
| "name": "A String", # Name of the instance template resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035 |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { # An operation resource, used to manage asynchronous API requests. |
| "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. |
| "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| "zone": "A String", # [Output Only] URL of the zone where the operation resides. |
| "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. |
| "progress": 42, # [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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses. |
| "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| { |
| "message": "A String", # [Output Only] Optional human-readable details for this warning. |
| "code": "A String", # [Output Only] The warning type identifier for this warning. |
| "data": [ # [Output Only] Metadata for this warning in key: value format. |
| { |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| "key": "A String", # [Output Only] A key for the warning data. |
| }, |
| ], |
| }, |
| ], |
| "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. |
| "name": "A String", # [Output Only] Name of the resource. |
| "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. |
| "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| { |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional. |
| }, |
| ], |
| }, |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. |
| "selfLink": "A String", # [Output Only] Server defined URL for the resource. |
| "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code> |
| <pre>Retrieves the list of instance template resources contained within the specified project. |
| |
| Args: |
| project: string, Name of the project scoping this request. (required) |
| maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500. |
| pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request. |
| filter: string, Optional. Filter expression for filtering listed resources. |
| |
| Returns: |
| An object of the form: |
| |
| { # Contains a list of instance template resources. |
| "nextPageToken": "A String", # A token used to continue a truncated list request (output only). |
| "items": [ # A list of InstanceTemplate resources. |
| { # An Instance Template resource. |
| "kind": "compute#instanceTemplate", # Type of the resource. |
| "description": "A String", # An optional textual description of the instance template resource; provided by the client when the resource is created. |
| "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only). |
| "properties": { # The instance properties portion of this instance template resource. |
| "machineType": "A String", # Name of the machine type resource describing which machine type to use to host the instances created based on this template; provided by the client when the instance template is created. |
| "description": "A String", # An optional textual description for the instances created based on the instance template resource; provided by the client when the template is created. |
| "tags": { # A set of instance tags. # A list of tags to be applied to the instances created based on this template used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. |
| "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. |
| "A String", |
| ], |
| "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata. |
| # |
| # To see the latest fingerprint, make get() request to the instance. |
| }, |
| "disks": [ # Array of disks associated with instance created based on this template. |
| { # An instance-attached disk resource. |
| "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/ tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. |
| # |
| # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. |
| "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. |
| "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. |
| # |
| # This property is mutually exclusive with the source property; you can only define one or the other, but not both. |
| # |
| # This property is mutually exclusive with the source property; you can only define one or the other, but not both. |
| "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. |
| "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. |
| "sourceImage": "A String", # A source image used to create the disk. You can provide a private (custom) image, and Compute Engine will use the corresponding image from your project. For example: |
| # |
| # global/images/my-private-image |
| # |
| # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL: |
| # |
| # projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD |
| # |
| # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases. |
| "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: |
| # |
| # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard |
| # |
| # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: |
| # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType |
| # - projects/project/zones/zone/diskTypes/diskType |
| # - zones/zone/diskTypes/diskType |
| }, |
| "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). |
| "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value. |
| "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. |
| "licenses": [ # [Output Only] Any valid publicly visible licenses. |
| "A String", |
| ], |
| "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. |
| "interface": "A String", |
| "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. |
| "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. |
| }, |
| ], |
| "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for the instances created based on this template. |
| "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). |
| "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. The default behavior is MIGRATE. For more information, see Setting maintenance behavior. |
| }, |
| "canIpForward": True or False, # Allows instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, say true. If unsure, leave this set to false. |
| "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instances created based on this template, through metadata queries. |
| { # A service account. |
| "scopes": [ # The list of scopes to be made available for this service account. |
| "A String", |
| ], |
| "email": "A String", # Email address of the service account. |
| }, |
| ], |
| "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to instances created based on this template. Consists of custom metadata or predefined keys; see Instance documentation for more information. |
| "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. |
| { |
| "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes. |
| "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project. |
| }, |
| ], |
| "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. |
| "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata. |
| }, |
| "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 instances created based based on this template will have no external internet access. |
| { # A network interface resource attached to an instance. |
| "accessConfigs": [ # An array of configurations for this interface. Currently, <codeONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access. |
| { # An access configuration attached to an instance's network interface. |
| "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. |
| "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. |
| "name": "A String", # Name of this access configuration. |
| "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. |
| }, |
| ], |
| "networkIP": "A String", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface. |
| "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc. |
| "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used: |
| # |
| # global/networks/default |
| # |
| # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: |
| # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network |
| # - projects/project/global/networks/network |
| # - global/networks/default |
| }, |
| ], |
| }, |
| "selfLink": "A String", # Server defined URL for the resource (output only). |
| "name": "A String", # Name of the instance template resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035 |
| }, |
| ], |
| "kind": "compute#instanceTemplateList", # Type of resource. |
| "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| "selfLink": "A String", # Server defined URL for this resource (output only). |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| </body></html> |