Blame - docs/dyn/appengine_v1.apps.services.versions.instances.html - platform/external/python/google-api-python-client

blob: 571a84c616aaf72b9cdbf49ef79e6d9e0242a92e [file] [log] [blame]

Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	75	<h1><a href="appengine_v1.html">App Engine Admin API</a> . <a href="appengine_v1.apps.html">apps</a> . <a href="appengine_v1.apps.services.html">services</a> . <a href="appengine_v1.apps.services.versions.html">versions</a> . <a href="appengine_v1.apps.services.versions.instances.html">instances</a></h1>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	81	<code><a href="#debug">debug(appsId, servicesId, versionsId, instancesId, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	82	<p class="firstline">Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.</p>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	83	<p class="toc_element">
				84	<code><a href="#delete">delete(appsId, servicesId, versionsId, instancesId, x__xgafv=None)</a></code></p>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	85	<p class="firstline">Stops a running instance.The instance might be automatically recreated based on the scaling settings of the version. For more information, see "How Instances are Managed" (standard environment (https://cloud.google.com/appengine/docs/standard/python/how-instances-are-managed) \| flexible environment (https://cloud.google.com/appengine/docs/flexible/python/how-instances-are-managed)).To ensure that instances are not re-created and avoid getting billed, you can stop all instances within the target version by changing the serving status of the version to STOPPED with the apps.services.versions.patch (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions/patch) method.</p>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	86	<p class="toc_element">
				87	<code><a href="#get">get(appsId, servicesId, versionsId, instancesId, x__xgafv=None)</a></code></p>
				88	<p class="firstline">Gets instance information.</p>
				89	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	90	<code><a href="#list">list(appsId, servicesId, versionsId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati	e833b79	2017-03-24 15:06:46 -0700	[diff] [blame]	91	<p class="firstline">Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).</p>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	92	<p class="toc_element">
				93	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				94	<p class="firstline">Retrieves the next page of results.</p>
				95	<h3>Method Details</h3>
				96	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	97	<code class="details" id="close">close()</code>
				98	<pre>Close httplib2 connections.</pre>
				99	</div>
				100
				101	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	102	<code class="details" id="debug">debug(appsId, servicesId, versionsId, instancesId, body=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	103	<pre>Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	104
				105	Args:
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	106	appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1. (required)
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	107	servicesId: string, Part of `name`. See documentation of `appsId`. (required)
				108	versionsId: string, Part of `name`. See documentation of `appsId`. (required)
				109	instancesId: string, Part of `name`. See documentation of `appsId`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	110	body: object, The request body.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	111	The object takes the form of:
				112
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	113	{ # Request message for Instances.DebugInstance.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	114	"sshKey": "A String", # Public SSH key to add to the instance. Examples: [USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).
				115	}
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	116
				117	x__xgafv: string, V1 error format.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	118	Allowed values
				119	1 - v1 error format
				120	2 - v2 error format
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	121
				122	Returns:
				123	An object of the form:
				124
				125	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	126	"done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
				127	"error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
				128	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				129	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				130	{
				131	"a_key": "", # Properties of the object. Contains field @type with type URL.
				132	},
				133	],
				134	"message": "A 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.
				135	},
				136	"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
				137	"a_key": "", # Properties of the object. Contains field @type with type URL.
				138	},
				139	"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
				140	"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
				141	"a_key": "", # Properties of the object. Contains field @type with type URL.
				142	},
				143	}</pre>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	144	</div>
				145
				146	<div class="method">
				147	<code class="details" id="delete">delete(appsId, servicesId, versionsId, instancesId, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	148	<pre>Stops a running instance.The instance might be automatically recreated based on the scaling settings of the version. For more information, see "How Instances are Managed" (standard environment (https://cloud.google.com/appengine/docs/standard/python/how-instances-are-managed) \| flexible environment (https://cloud.google.com/appengine/docs/flexible/python/how-instances-are-managed)).To ensure that instances are not re-created and avoid getting billed, you can stop all instances within the target version by changing the serving status of the version to STOPPED with the apps.services.versions.patch (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions/patch) method.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	149
				150	Args:
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	151	appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1. (required)
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	152	servicesId: string, Part of `name`. See documentation of `appsId`. (required)
				153	versionsId: string, Part of `name`. See documentation of `appsId`. (required)
				154	instancesId: string, Part of `name`. See documentation of `appsId`. (required)
				155	x__xgafv: string, V1 error format.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	156	Allowed values
				157	1 - v1 error format
				158	2 - v2 error format
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	159
				160	Returns:
				161	An object of the form:
				162
				163	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	164	"done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
				165	"error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
				166	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				167	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				168	{
				169	"a_key": "", # Properties of the object. Contains field @type with type URL.
				170	},
				171	],
				172	"message": "A 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.
				173	},
				174	"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
				175	"a_key": "", # Properties of the object. Contains field @type with type URL.
				176	},
				177	"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
				178	"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
				179	"a_key": "", # Properties of the object. Contains field @type with type URL.
				180	},
				181	}</pre>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	182	</div>
				183
				184	<div class="method">
				185	<code class="details" id="get">get(appsId, servicesId, versionsId, instancesId, x__xgafv=None)</code>
				186	<pre>Gets instance information.
				187
				188	Args:
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	189	appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1. (required)
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	190	servicesId: string, Part of `name`. See documentation of `appsId`. (required)
				191	versionsId: string, Part of `name`. See documentation of `appsId`. (required)
				192	instancesId: string, Part of `name`. See documentation of `appsId`. (required)
				193	x__xgafv: string, V1 error format.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	194	Allowed values
				195	1 - v1 error format
				196	2 - v2 error format
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	197
				198	Returns:
				199	An object of the form:
				200
				201	{ # An Instance resource is the computing unit that App Engine uses to automatically scale an application.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	202	"appEngineRelease": "A String", # Output only. App Engine release this instance is running on.
				203	"availability": "A String", # Output only. Availability of the instance.
				204	"averageLatency": 42, # Output only. Average latency (ms) over the last minute.
				205	"errors": 42, # Output only. Number of errors since this instance was started.
				206	"id": "A String", # Output only. Relative name of the instance within the version. Example: instance-1.
				207	"memoryUsage": "A String", # Output only. Total memory in use (bytes).
				208	"name": "A String", # Output only. Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.
				209	"qps": 3.14, # Output only. Average queries per second (QPS) over the last minute.
				210	"requests": 42, # Output only. Number of requests since this instance was started.
				211	"startTime": "A String", # Output only. Time that this instance was started.@OutputOnly
				212	"vmDebugEnabled": True or False, # Output only. Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.
				213	"vmId": "A String", # Output only. Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.
				214	"vmIp": "A String", # Output only. The IP address of this instance. Only applicable for instances in App Engine flexible environment.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	215	"vmLiveness": "A String", # Output only. The liveness health check of this instance. Only applicable for instances in App Engine flexible environment.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	216	"vmName": "A String", # Output only. Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.
				217	"vmStatus": "A String", # Output only. Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.
				218	"vmZoneName": "A String", # Output only. Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.
				219	}</pre>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	220	</div>
				221
				222	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	223	<code class="details" id="list">list(appsId, servicesId, versionsId, pageSize=None, pageToken=None, x__xgafv=None)</code>
Sai Cheemalapati	e833b79	2017-03-24 15:06:46 -0700	[diff] [blame]	224	<pre>Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	225
				226	Args:
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	227	appsId: string, Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1. (required)
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	228	servicesId: string, Part of `parent`. See documentation of `appsId`. (required)
				229	versionsId: string, Part of `parent`. See documentation of `appsId`. (required)
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	230	pageSize: integer, Maximum results to return per page.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	231	pageToken: string, Continuation token for fetching the next page of results.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	232	x__xgafv: string, V1 error format.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	233	Allowed values
				234	1 - v1 error format
				235	2 - v2 error format
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	236
				237	Returns:
				238	An object of the form:
				239
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	240	{ # Response message for Instances.ListInstances.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	241	"instances": [ # The instances belonging to the requested version.
				242	{ # An Instance resource is the computing unit that App Engine uses to automatically scale an application.
				243	"appEngineRelease": "A String", # Output only. App Engine release this instance is running on.
				244	"availability": "A String", # Output only. Availability of the instance.
				245	"averageLatency": 42, # Output only. Average latency (ms) over the last minute.
				246	"errors": 42, # Output only. Number of errors since this instance was started.
				247	"id": "A String", # Output only. Relative name of the instance within the version. Example: instance-1.
				248	"memoryUsage": "A String", # Output only. Total memory in use (bytes).
				249	"name": "A String", # Output only. Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.
				250	"qps": 3.14, # Output only. Average queries per second (QPS) over the last minute.
				251	"requests": 42, # Output only. Number of requests since this instance was started.
				252	"startTime": "A String", # Output only. Time that this instance was started.@OutputOnly
				253	"vmDebugEnabled": True or False, # Output only. Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.
				254	"vmId": "A String", # Output only. Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.
				255	"vmIp": "A String", # Output only. The IP address of this instance. Only applicable for instances in App Engine flexible environment.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	256	"vmLiveness": "A String", # Output only. The liveness health check of this instance. Only applicable for instances in App Engine flexible environment.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	257	"vmName": "A String", # Output only. Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.
				258	"vmStatus": "A String", # Output only. Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.
				259	"vmZoneName": "A String", # Output only. Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.
				260	},
				261	],
				262	"nextPageToken": "A String", # Continuation token for fetching the next page of results.
				263	}</pre>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	264	</div>
				265
				266	<div class="method">
				267	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				268	<pre>Retrieves the next page of results.
				269
				270	Args:
				271	previous_request: The request for the previous page. (required)
				272	previous_response: The response from the request for the previous page. (required)
				273
				274	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	275	A request object that you can call 'execute()' on to request the next
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	276	page. Returns None if there are no more items in the collection.
				277	</pre>
				278	</div>
				279
				280	</body></html>