Blame - docs/dyn/compute_v1.autoscalers.html - platform/external/python/google-api-python-client

2016-02-19 16:02:29 -0800

[diff] [blame]

79

<p class="firstline">Retrieves an aggregated list of autoscalers.</p>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

80

81

<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>

82

<p class="firstline">Retrieves the next page of results.</p>

83

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

84

<code><a href="#delete">delete(project, zone, autoscaler, requestId=None)</a></code></p>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

85

<p class="firstline">Deletes the specified autoscaler.</p>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

86

87

<code><a href="#get">get(project, zone, autoscaler)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

88

<p class="firstline">Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request.</p>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

89

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

90

<code><a href="#insert">insert(project, zone, body=None, requestId=None)</a></code></p>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

91

<p class="firstline">Creates an autoscaler in the specified project using the data included in the request.</p>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

92

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

93

<code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None)</a></code></p>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

94

<p class="firstline">Retrieves a list of autoscalers contained within the specified zone.</p>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

95

96

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

97

<p class="firstline">Retrieves the next page of results.</p>

98

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

99

<code><a href="#patch">patch(project, zone, body=None, autoscaler=None, requestId=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

100

<p class="firstline">Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

101

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

102

<code><a href="#update">update(project, zone, body=None, autoscaler=None, requestId=None)</a></code></p>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

103

<p class="firstline">Updates an autoscaler in the specified project using the data included in the request.</p>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

104

<h3>Method Details</h3>

105

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

106

<code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None)</code>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

107

<pre>Retrieves an aggregated list of autoscalers.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

108

109

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

110

project: string, Project ID for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

111

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

112

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

113

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

114

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

115

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

116

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

117

To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

118

includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

119

maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

120

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

121

122

You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

123

124

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

125

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

126

127

Returns:

128

An object of the form:

129

130

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

131

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

132

"items": { # A list of AutoscalersScopedList resources.

133

"a_key": { # [Output Only] Name of the scope containing this set of autoscalers.

134

"autoscalers": [ # [Output Only] A list of autoscalers contained in this scope.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

135

{ # Represents an Autoscaler resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

136

#

137

# Google Compute Engine has two Autoscaler resources:

138

#

139

# * [Global](/compute/docs/reference/rest/{$api_version}/autoscalers) * [Regional](/compute/docs/reference/rest/{$api_version}/regionAutoscalers)

140

#

141

# Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances.

142

#

143

# For zonal managed instance groups resource, use the autoscaler resource.

144

#

145

# For regional managed instance groups, use the regionAutoscalers resource. (== resource_for {$api_version}.autoscalers ==) (== resource_for {$api_version}.regionAutoscalers ==)

146

"autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

147

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

148

# If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.

149

"coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

150

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

151

# Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.

152

"cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.

153

"utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

154

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

155

# If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.

156

#

157

# If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

158

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

159

"customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.

160

{ # Custom utilization metric policy.

161

"metric": "A String", # The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values.

162

#

163

# The metric must have a value type of INT64 or DOUBLE.

164

"utilizationTarget": 3.14, # The target value of the metric that autoscaler should maintain. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric.

165

#

166

# For example, a good metric to use as a utilization_target is compute.googleapis.com/instance/network/received_bytes_count. The autoscaler will work to keep this value constant for each of the instances.

167

"utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

168

},

169

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

170

"loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.

171

"utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(S) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.

172

},

173

"maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.

174

"minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.

175

"mode": "A String", # Defines operating mode for this policy.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

176

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

177

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

178

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

179

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

180

"kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.

181

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

182

"recommendedSize": 42, # [Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates recommended MIG size even when autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to the existing managed instance group or autoscaler did not generate its prediction.

183

"region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).

184

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

185

"status": "A String", # [Output Only] The status of the autoscaler configuration. Current set of possible values:

186

# - PENDING: Autoscaler backend hasn't read new/updated configuration.

187

# - DELETING: Configuration is being deleted.

188

# - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field.

189

# - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future.

190

"statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.

191

{

192

"message": "A String", # The status message.

193

"type": "A String", # The type of error, warning, or notice returned. Current set of possible values:

194

# - ALL_INSTANCES_UNHEALTHY (WARNING): All instances in the instance group are unhealthy (not in RUNNING state).

195

# - BACKEND_SERVICE_DOES_NOT_EXIST (ERROR): There is no backend service attached to the instance group.

196

# - CAPPED_AT_MAX_NUM_REPLICAS (WARNING): Autoscaler recommends a size greater than maxNumReplicas.

197

# - CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING): The custom metric samples are not exported often enough to be a credible base for autoscaling.

198

# - CUSTOM_METRIC_INVALID (ERROR): The custom metric that was specified does not exist or does not have the necessary labels.

199

# - MIN_EQUALS_MAX (WARNING): The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group.

200

# - MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING): The autoscaler did not receive any data from the custom metric configured for autoscaling.

201

# - MISSING_LOAD_BALANCING_DATA_POINTS (WARNING): The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer.

202

# - MODE_OFF (WARNING): Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved.

203

# - MODE_ONLY_UP (WARNING): Autoscaling is in the "Autoscale only up" mode. The autoscaler can add instances but not remove any.

204

# - MORE_THAN_ONE_BACKEND_SERVICE (ERROR): The instance group cannot be autoscaled because it has more than one backend service attached to it.

205

# - NOT_ENOUGH_QUOTA_AVAILABLE (ERROR): There is insufficient quota for the necessary resources, such as CPU or number of instances.

206

# - REGION_RESOURCE_STOCKOUT (ERROR): Shown only for regional autoscalers: there is a resource stockout in the chosen region.

207

# - SCALING_TARGET_DOES_NOT_EXIST (ERROR): The target to be scaled does not exist.

208

# - UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION (ERROR): Autoscaling does not work with an HTTP/S load balancer that has been configured for maxRate.

209

# - ZONE_RESOURCE_STOCKOUT (ERROR): For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout. New values might be added in the future. Some of the values might not be available in all API versions.

210

},

211

],

212

"target": "A String", # URL of the managed instance group that this autoscaler will scale.

213

"zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).

214

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

215

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

216

"warning": { # [Output Only] Informational warning which replaces the list of autoscalers when the list is empty.

217

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

218

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

219

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

220

{

221

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

222

"value": "A String", # [Output Only] A warning data value corresponding to the key.

223

},

224

],

225

"message": "A String", # [Output Only] A human-readable description of the warning code.

226

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

227

},

228

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

229

"kind": "compute#autoscalerAggregatedList", # [Output Only] Type of resource. Always compute#autoscalerAggregatedList for aggregated lists of autoscalers.

230

"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

231

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

232

"warning": { # [Output Only] Informational warning message.

233

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

234

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

235

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

236

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

237

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

238

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

239

},

240

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

241

"message": "A String", # [Output Only] A human-readable description of the warning code.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

242

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>

248

<pre>Retrieves the next page of results.

249

250

Args:

251

previous_request: The request for the previous page. (required)

252

previous_response: The response from the request for the previous page. (required)

253

254

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

255

A request object that you can call 'execute()' on to request the next

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

256

page. Returns None if there are no more items in the collection.

</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

261

<code class="details" id="delete">delete(project, zone, autoscaler, requestId=None)</code>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

262

<pre>Deletes the specified autoscaler.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

263

264

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

265

project: string, Project ID for this request. (required)

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

266

zone: string, Name of the zone for this request. (required)

267

autoscaler: string, Name of the autoscaler to delete. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

268

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

269

270

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

271

272

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

273

274

Returns:

275

An object of the form:

276

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

277

{ # Represents an Operation resource.

278

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

279

# Google Compute Engine has three Operation resources:

280

#

281

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

282

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

283

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

284

#

285

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

286

# - For global operations, use the `globalOperations` resource.

287

# - For regional operations, use the `regionOperations` resource.

288

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

289

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

290

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

291

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

292

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

293

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

294

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

295

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

296

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

297

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

298

"code": "A String", # [Output Only] The error type identifier for this error.

299

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

300

"message": "A String", # [Output Only] An optional, human-readable error message.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

301

},

302

],

303

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

304

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

305

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

306

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

307

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

308

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

309

"name": "A String", # [Output Only] Name of the operation.

310

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

311

"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 when the operation will be complete. This number should monotonically increase as the operation progresses.

312

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

313

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

314

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

315

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

316

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

317

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

318

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

319

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

320

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

321

{

322

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

323

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

324

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

325

{

326

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

327

"value": "A String", # [Output Only] A warning data value corresponding to the key.

328

},

329

],

330

"message": "A String", # [Output Only] A human-readable description of the warning code.

331

},

332

],

333

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(project, zone, autoscaler)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

339

<pre>Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

340

341

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

342

project: string, Project ID for this request. (required)

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

343

zone: string, Name of the zone for this request. (required)

344

autoscaler: string, Name of the autoscaler to return. (required)

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

345

346

Returns:

347

An object of the form:

348

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

349

{ # Represents an Autoscaler resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

350

#

351

# Google Compute Engine has two Autoscaler resources:

352

#

353

# * [Global](/compute/docs/reference/rest/{$api_version}/autoscalers) * [Regional](/compute/docs/reference/rest/{$api_version}/regionAutoscalers)

354

#

355

# Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances.

356

#

357

# For zonal managed instance groups resource, use the autoscaler resource.

358

#

359

# For regional managed instance groups, use the regionAutoscalers resource. (== resource_for {$api_version}.autoscalers ==) (== resource_for {$api_version}.regionAutoscalers ==)

360

"autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

361

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

362

# If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.

363

"coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

364

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

365

# Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.

366

"cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.

367

"utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

368

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

369

# If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.

370

#

371

# If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

372

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

373

"customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.

374

{ # Custom utilization metric policy.

375

"metric": "A String", # The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values.

376

#

377

# The metric must have a value type of INT64 or DOUBLE.

378

"utilizationTarget": 3.14, # The target value of the metric that autoscaler should maintain. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric.

379

#

380

# For example, a good metric to use as a utilization_target is compute.googleapis.com/instance/network/received_bytes_count. The autoscaler will work to keep this value constant for each of the instances.

381

"utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

382

},

383

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

384

"loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.

385

"utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(S) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.

386

},

387

"maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.

388

"minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.

389

"mode": "A String", # Defines operating mode for this policy.

390

},

391

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

392

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

393

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

394

"kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.

395

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

396

"recommendedSize": 42, # [Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates recommended MIG size even when autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to the existing managed instance group or autoscaler did not generate its prediction.

397

"region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).

398

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

399

"status": "A String", # [Output Only] The status of the autoscaler configuration. Current set of possible values:

400

# - PENDING: Autoscaler backend hasn't read new/updated configuration.

401

# - DELETING: Configuration is being deleted.

402

# - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field.

403

# - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future.

404

"statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.

405

{

406

"message": "A String", # The status message.

407

"type": "A String", # The type of error, warning, or notice returned. Current set of possible values:

408

# - ALL_INSTANCES_UNHEALTHY (WARNING): All instances in the instance group are unhealthy (not in RUNNING state).

409

# - BACKEND_SERVICE_DOES_NOT_EXIST (ERROR): There is no backend service attached to the instance group.

410

# - CAPPED_AT_MAX_NUM_REPLICAS (WARNING): Autoscaler recommends a size greater than maxNumReplicas.

411

# - CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING): The custom metric samples are not exported often enough to be a credible base for autoscaling.

412

# - CUSTOM_METRIC_INVALID (ERROR): The custom metric that was specified does not exist or does not have the necessary labels.

413

# - MIN_EQUALS_MAX (WARNING): The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group.

414

# - MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING): The autoscaler did not receive any data from the custom metric configured for autoscaling.

415

# - MISSING_LOAD_BALANCING_DATA_POINTS (WARNING): The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer.

416

# - MODE_OFF (WARNING): Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved.

417

# - MODE_ONLY_UP (WARNING): Autoscaling is in the "Autoscale only up" mode. The autoscaler can add instances but not remove any.

418

# - MORE_THAN_ONE_BACKEND_SERVICE (ERROR): The instance group cannot be autoscaled because it has more than one backend service attached to it.

419

# - NOT_ENOUGH_QUOTA_AVAILABLE (ERROR): There is insufficient quota for the necessary resources, such as CPU or number of instances.

420

# - REGION_RESOURCE_STOCKOUT (ERROR): Shown only for regional autoscalers: there is a resource stockout in the chosen region.

421

# - SCALING_TARGET_DOES_NOT_EXIST (ERROR): The target to be scaled does not exist.

422

# - UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION (ERROR): Autoscaling does not work with an HTTP/S load balancer that has been configured for maxRate.

423

# - ZONE_RESOURCE_STOCKOUT (ERROR): For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout. New values might be added in the future. Some of the values might not be available in all API versions.

424

},

425

],

426

"target": "A String", # URL of the managed instance group that this autoscaler will scale.

427

"zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).

428

}</pre>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

432

<code class="details" id="insert">insert(project, zone, body=None, requestId=None)</code>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

433

<pre>Creates an autoscaler in the specified project using the data included in the request.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

434

435

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

436

project: string, Project ID for this request. (required)

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

437

zone: string, Name of the zone for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

438

body: object, The request body.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

439

The object takes the form of:

440

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

441

{ # Represents an Autoscaler resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

442

#

443

# Google Compute Engine has two Autoscaler resources:

444

#

445

# * [Global](/compute/docs/reference/rest/{$api_version}/autoscalers) * [Regional](/compute/docs/reference/rest/{$api_version}/regionAutoscalers)

446

#

447

# Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances.

448

#

449

# For zonal managed instance groups resource, use the autoscaler resource.

450

#

451

# For regional managed instance groups, use the regionAutoscalers resource. (== resource_for {$api_version}.autoscalers ==) (== resource_for {$api_version}.regionAutoscalers ==)

452

"autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

453

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

454

# If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.

455

"coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.

456

#

457

# Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.

458

"cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.

459

"utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

460

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

461

# If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.

462

#

463

# If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

464

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

465

"customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.

466

{ # Custom utilization metric policy.

467

"metric": "A String", # The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values.

468

#

469

# The metric must have a value type of INT64 or DOUBLE.

470

"utilizationTarget": 3.14, # The target value of the metric that autoscaler should maintain. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric.

471

#

472

# For example, a good metric to use as a utilization_target is compute.googleapis.com/instance/network/received_bytes_count. The autoscaler will work to keep this value constant for each of the instances.

473

"utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

474

},

475

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

476

"loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.

477

"utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(S) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.

478

},

479

"maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.

480

"minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.

481

"mode": "A String", # Defines operating mode for this policy.

482

},

483

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

484

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

485

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

486

"kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.

487

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

488

"recommendedSize": 42, # [Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates recommended MIG size even when autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to the existing managed instance group or autoscaler did not generate its prediction.

489

"region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).

490

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

491

"status": "A String", # [Output Only] The status of the autoscaler configuration. Current set of possible values:

492

# - PENDING: Autoscaler backend hasn't read new/updated configuration.

493

# - DELETING: Configuration is being deleted.

494

# - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field.

495

# - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future.

496

"statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.

497

{

498

"message": "A String", # The status message.

499

"type": "A String", # The type of error, warning, or notice returned. Current set of possible values:

500

# - ALL_INSTANCES_UNHEALTHY (WARNING): All instances in the instance group are unhealthy (not in RUNNING state).

501

# - BACKEND_SERVICE_DOES_NOT_EXIST (ERROR): There is no backend service attached to the instance group.

502

# - CAPPED_AT_MAX_NUM_REPLICAS (WARNING): Autoscaler recommends a size greater than maxNumReplicas.

503

# - CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING): The custom metric samples are not exported often enough to be a credible base for autoscaling.

504

# - CUSTOM_METRIC_INVALID (ERROR): The custom metric that was specified does not exist or does not have the necessary labels.

505

# - MIN_EQUALS_MAX (WARNING): The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group.

506

# - MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING): The autoscaler did not receive any data from the custom metric configured for autoscaling.

507

# - MISSING_LOAD_BALANCING_DATA_POINTS (WARNING): The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer.

508

# - MODE_OFF (WARNING): Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved.

509

# - MODE_ONLY_UP (WARNING): Autoscaling is in the "Autoscale only up" mode. The autoscaler can add instances but not remove any.

510

# - MORE_THAN_ONE_BACKEND_SERVICE (ERROR): The instance group cannot be autoscaled because it has more than one backend service attached to it.

511

# - NOT_ENOUGH_QUOTA_AVAILABLE (ERROR): There is insufficient quota for the necessary resources, such as CPU or number of instances.

512

# - REGION_RESOURCE_STOCKOUT (ERROR): Shown only for regional autoscalers: there is a resource stockout in the chosen region.

513

# - SCALING_TARGET_DOES_NOT_EXIST (ERROR): The target to be scaled does not exist.

514

# - UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION (ERROR): Autoscaling does not work with an HTTP/S load balancer that has been configured for maxRate.

515

# - ZONE_RESOURCE_STOCKOUT (ERROR): For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout. New values might be added in the future. Some of the values might not be available in all API versions.

516

},

517

],

518

"target": "A String", # URL of the managed instance group that this autoscaler will scale.

519

"zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).

520

}

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

521

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

522

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

523

524

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

525

526

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

527

528

Returns:

529

An object of the form:

530

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

531

{ # Represents an Operation resource.

532

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

533

# Google Compute Engine has three Operation resources:

534

#

535

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

536

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

537

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

538

#

539

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

540

# - For global operations, use the `globalOperations` resource.

541

# - For regional operations, use the `regionOperations` resource.

542

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

543

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

544

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

545

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

546

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

547

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

548

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

549

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

550

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

551

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

552

"code": "A String", # [Output Only] The error type identifier for this error.

553

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

554

"message": "A String", # [Output Only] An optional, human-readable error message.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

555

},

556

],

557

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

558

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

559

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

560

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

561

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

562

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

563

"name": "A String", # [Output Only] Name of the operation.

564

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

565

"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 when the operation will be complete. This number should monotonically increase as the operation progresses.

566

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

567

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

568

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

569

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

570

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

571

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

572

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

573

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

574

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

575

{

576

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

577

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

578

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

579

{

580

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

581

"value": "A String", # [Output Only] A warning data value corresponding to the key.

582

},

583

],

584

"message": "A String", # [Output Only] A human-readable description of the warning code.

585

},

586

],

587

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

592

<code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None)</code>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

593

<pre>Retrieves a list of autoscalers contained within the specified zone.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

594

595

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

596

project: string, Project ID for this request. (required)

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

597

zone: string, Name of the zone for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

598

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

599

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

600

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

601

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

602

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

603

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

604

To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

605

maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

606

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

607

608

You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

609

610

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

611

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

612

613

Returns:

614

An object of the form:

615

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

616

{ # Contains a list of Autoscaler resources.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

617

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

618

"items": [ # A list of Autoscaler resources.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

619

{ # Represents an Autoscaler resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

620

#

621

# Google Compute Engine has two Autoscaler resources:

622

#

623

# * [Global](/compute/docs/reference/rest/{$api_version}/autoscalers) * [Regional](/compute/docs/reference/rest/{$api_version}/regionAutoscalers)

624

#

625

# Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances.

626

#

627

# For zonal managed instance groups resource, use the autoscaler resource.

628

#

629

# For regional managed instance groups, use the regionAutoscalers resource. (== resource_for {$api_version}.autoscalers ==) (== resource_for {$api_version}.regionAutoscalers ==)

630

"autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

631

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

632

# If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.

633

"coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

634

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

635

# Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.

636

"cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.

637

"utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

638

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

639

# If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.

640

#

641

# If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

642

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

643

"customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.

644

{ # Custom utilization metric policy.

645

"metric": "A String", # The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values.

646

#

647

# The metric must have a value type of INT64 or DOUBLE.

648

"utilizationTarget": 3.14, # The target value of the metric that autoscaler should maintain. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric.

649

#

650

# For example, a good metric to use as a utilization_target is compute.googleapis.com/instance/network/received_bytes_count. The autoscaler will work to keep this value constant for each of the instances.

651

"utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

652

},

653

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

654

"loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.

655

"utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(S) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.

656

},

657

"maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.

658

"minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.

659

"mode": "A String", # Defines operating mode for this policy.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

660

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

661

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

662

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

663

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

664

"kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.

665

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

666

"recommendedSize": 42, # [Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates recommended MIG size even when autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to the existing managed instance group or autoscaler did not generate its prediction.

667

"region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).

668

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

669

"status": "A String", # [Output Only] The status of the autoscaler configuration. Current set of possible values:

670

# - PENDING: Autoscaler backend hasn't read new/updated configuration.

671

# - DELETING: Configuration is being deleted.

672

# - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field.

673

# - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future.

674

"statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.

675

{

676

"message": "A String", # The status message.

677

"type": "A String", # The type of error, warning, or notice returned. Current set of possible values:

678

# - ALL_INSTANCES_UNHEALTHY (WARNING): All instances in the instance group are unhealthy (not in RUNNING state).

679

# - BACKEND_SERVICE_DOES_NOT_EXIST (ERROR): There is no backend service attached to the instance group.

680

# - CAPPED_AT_MAX_NUM_REPLICAS (WARNING): Autoscaler recommends a size greater than maxNumReplicas.

681

# - CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING): The custom metric samples are not exported often enough to be a credible base for autoscaling.

682

# - CUSTOM_METRIC_INVALID (ERROR): The custom metric that was specified does not exist or does not have the necessary labels.

683

# - MIN_EQUALS_MAX (WARNING): The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group.

684

# - MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING): The autoscaler did not receive any data from the custom metric configured for autoscaling.

685

# - MISSING_LOAD_BALANCING_DATA_POINTS (WARNING): The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer.

686

# - MODE_OFF (WARNING): Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved.

687

# - MODE_ONLY_UP (WARNING): Autoscaling is in the "Autoscale only up" mode. The autoscaler can add instances but not remove any.

688

# - MORE_THAN_ONE_BACKEND_SERVICE (ERROR): The instance group cannot be autoscaled because it has more than one backend service attached to it.

689

# - NOT_ENOUGH_QUOTA_AVAILABLE (ERROR): There is insufficient quota for the necessary resources, such as CPU or number of instances.

690

# - REGION_RESOURCE_STOCKOUT (ERROR): Shown only for regional autoscalers: there is a resource stockout in the chosen region.

691

# - SCALING_TARGET_DOES_NOT_EXIST (ERROR): The target to be scaled does not exist.

692

# - UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION (ERROR): Autoscaling does not work with an HTTP/S load balancer that has been configured for maxRate.

693

# - ZONE_RESOURCE_STOCKOUT (ERROR): For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout. New values might be added in the future. Some of the values might not be available in all API versions.

694

},

695

],

696

"target": "A String", # URL of the managed instance group that this autoscaler will scale.

697

"zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).

698

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

699

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

700

"kind": "compute#autoscalerList", # [Output Only] Type of resource. Always compute#autoscalerList for lists of autoscalers.

701

"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

702

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

703

"warning": { # [Output Only] Informational warning message.

704

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

705

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

706

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

707

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

708

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

709

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

710

},

711

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

712

"message": "A String", # [Output Only] A human-readable description of the warning code.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

713

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

719

<pre>Retrieves the next page of results.

720

721

Args:

722

previous_request: The request for the previous page. (required)

723

previous_response: The response from the request for the previous page. (required)

724

725

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

726

A request object that you can call 'execute()' on to request the next

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

727

page. Returns None if there are no more items in the collection.

</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

732

<code class="details" id="patch">patch(project, zone, body=None, autoscaler=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

733

<pre>Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

734

735

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

736

project: string, Project ID for this request. (required)

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

737

zone: string, Name of the zone for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

738

body: object, The request body.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

739

The object takes the form of:

740

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

741

{ # Represents an Autoscaler resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

742

#

743

# Google Compute Engine has two Autoscaler resources:

744

#

745

# * [Global](/compute/docs/reference/rest/{$api_version}/autoscalers) * [Regional](/compute/docs/reference/rest/{$api_version}/regionAutoscalers)

746

#

747

# Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances.

748

#

749

# For zonal managed instance groups resource, use the autoscaler resource.

750

#

751

# For regional managed instance groups, use the regionAutoscalers resource. (== resource_for {$api_version}.autoscalers ==) (== resource_for {$api_version}.regionAutoscalers ==)

752

"autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

753

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

754

# If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.

755

"coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.

756

#

757

# Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.

758

"cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.

759

"utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

760

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

761

# If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.

762

#

763

# If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

764

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

765

"customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.

766

{ # Custom utilization metric policy.

767

"metric": "A String", # The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values.

768

#

769

# The metric must have a value type of INT64 or DOUBLE.

770

"utilizationTarget": 3.14, # The target value of the metric that autoscaler should maintain. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric.

771

#

772

# For example, a good metric to use as a utilization_target is compute.googleapis.com/instance/network/received_bytes_count. The autoscaler will work to keep this value constant for each of the instances.

773

"utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

774

},

775

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

776

"loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.

777

"utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(S) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.

778

},

779

"maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.

780

"minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.

781

"mode": "A String", # Defines operating mode for this policy.

782

},

783

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

784

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

785

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

786

"kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.

787

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

788

"recommendedSize": 42, # [Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates recommended MIG size even when autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to the existing managed instance group or autoscaler did not generate its prediction.

789

"region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).

790

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

791

"status": "A String", # [Output Only] The status of the autoscaler configuration. Current set of possible values:

792

# - PENDING: Autoscaler backend hasn't read new/updated configuration.

793

# - DELETING: Configuration is being deleted.

794

# - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field.

795

# - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future.

796

"statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.

797

{

798

"message": "A String", # The status message.

799

"type": "A String", # The type of error, warning, or notice returned. Current set of possible values:

800

# - ALL_INSTANCES_UNHEALTHY (WARNING): All instances in the instance group are unhealthy (not in RUNNING state).

801

# - BACKEND_SERVICE_DOES_NOT_EXIST (ERROR): There is no backend service attached to the instance group.

802

# - CAPPED_AT_MAX_NUM_REPLICAS (WARNING): Autoscaler recommends a size greater than maxNumReplicas.

803

# - CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING): The custom metric samples are not exported often enough to be a credible base for autoscaling.

804

# - CUSTOM_METRIC_INVALID (ERROR): The custom metric that was specified does not exist or does not have the necessary labels.

805

# - MIN_EQUALS_MAX (WARNING): The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group.

806

# - MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING): The autoscaler did not receive any data from the custom metric configured for autoscaling.

807

# - MISSING_LOAD_BALANCING_DATA_POINTS (WARNING): The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer.

808

# - MODE_OFF (WARNING): Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved.

809

# - MODE_ONLY_UP (WARNING): Autoscaling is in the "Autoscale only up" mode. The autoscaler can add instances but not remove any.

810

# - MORE_THAN_ONE_BACKEND_SERVICE (ERROR): The instance group cannot be autoscaled because it has more than one backend service attached to it.

811

# - NOT_ENOUGH_QUOTA_AVAILABLE (ERROR): There is insufficient quota for the necessary resources, such as CPU or number of instances.

812

# - REGION_RESOURCE_STOCKOUT (ERROR): Shown only for regional autoscalers: there is a resource stockout in the chosen region.

813

# - SCALING_TARGET_DOES_NOT_EXIST (ERROR): The target to be scaled does not exist.

814

# - UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION (ERROR): Autoscaling does not work with an HTTP/S load balancer that has been configured for maxRate.

815

# - ZONE_RESOURCE_STOCKOUT (ERROR): For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout. New values might be added in the future. Some of the values might not be available in all API versions.

816

},

817

],

818

"target": "A String", # URL of the managed instance group that this autoscaler will scale.

819

"zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).

820

}

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

821

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

822

autoscaler: string, Name of the autoscaler to patch.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

823

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

824

825

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

826

827

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

828

829

Returns:

830

An object of the form:

831

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

832

{ # Represents an Operation resource.

833

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

834

# Google Compute Engine has three Operation resources:

835

#

836

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

837

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

838

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

839

#

840

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

841

# - For global operations, use the `globalOperations` resource.

842

# - For regional operations, use the `regionOperations` resource.

843

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

844

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

845

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

846

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

847

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

848

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

849

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

850

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

851

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

852

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

853

"code": "A String", # [Output Only] The error type identifier for this error.

854

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

855

"message": "A String", # [Output Only] An optional, human-readable error message.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

856

},

857

],

858

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

859

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

860

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

861

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

862

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

863

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

864

"name": "A String", # [Output Only] Name of the operation.

865

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

866

"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 when the operation will be complete. This number should monotonically increase as the operation progresses.

867

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

868

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

869

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

870

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

871

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

872

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

873

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

874

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

875

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

876

{

877

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

878

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

879

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

880

{

881

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

882

"value": "A String", # [Output Only] A warning data value corresponding to the key.

883

},

884

],

885

"message": "A String", # [Output Only] A human-readable description of the warning code.

886

},

887

],

888

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

893

<code class="details" id="update">update(project, zone, body=None, autoscaler=None, requestId=None)</code>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

894

<pre>Updates an autoscaler in the specified project using the data included in the request.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

895

896

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

897

project: string, Project ID for this request. (required)

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

898

zone: string, Name of the zone for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

899

body: object, The request body.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

900

The object takes the form of:

901

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

902

{ # Represents an Autoscaler resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

903

#

904

# Google Compute Engine has two Autoscaler resources:

905

#

906

# * [Global](/compute/docs/reference/rest/{$api_version}/autoscalers) * [Regional](/compute/docs/reference/rest/{$api_version}/regionAutoscalers)

907

#

908

# Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances.

909

#

910

# For zonal managed instance groups resource, use the autoscaler resource.

911

#

912

# For regional managed instance groups, use the regionAutoscalers resource. (== resource_for {$api_version}.autoscalers ==) (== resource_for {$api_version}.regionAutoscalers ==)

913

"autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

914

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

915

# If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.

916

"coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.

917

#

918

# Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.

919

"cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.

920

"utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

921

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

922

# If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.

923

#

924

# If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

925

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

926

"customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.

927

{ # Custom utilization metric policy.

928

"metric": "A String", # The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values.

929

#

930

# The metric must have a value type of INT64 or DOUBLE.

931

"utilizationTarget": 3.14, # The target value of the metric that autoscaler should maintain. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric.

932

#

933

# For example, a good metric to use as a utilization_target is compute.googleapis.com/instance/network/received_bytes_count. The autoscaler will work to keep this value constant for each of the instances.

934

"utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

935

},

936

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

937

"loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.

938

"utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(S) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.

939

},

940

"maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.

941

"minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.

942

"mode": "A String", # Defines operating mode for this policy.

943

},

944

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

945

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

946

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

947

"kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.

948

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

949

"recommendedSize": 42, # [Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates recommended MIG size even when autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to the existing managed instance group or autoscaler did not generate its prediction.

950

"region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).

951

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

952

"status": "A String", # [Output Only] The status of the autoscaler configuration. Current set of possible values:

953

# - PENDING: Autoscaler backend hasn't read new/updated configuration.

954

# - DELETING: Configuration is being deleted.

955

# - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field.

956

# - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future.

957

"statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.

958

{

959

"message": "A String", # The status message.

960

"type": "A String", # The type of error, warning, or notice returned. Current set of possible values:

961

# - ALL_INSTANCES_UNHEALTHY (WARNING): All instances in the instance group are unhealthy (not in RUNNING state).

962

# - BACKEND_SERVICE_DOES_NOT_EXIST (ERROR): There is no backend service attached to the instance group.

963

# - CAPPED_AT_MAX_NUM_REPLICAS (WARNING): Autoscaler recommends a size greater than maxNumReplicas.

964

# - CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING): The custom metric samples are not exported often enough to be a credible base for autoscaling.

965

# - CUSTOM_METRIC_INVALID (ERROR): The custom metric that was specified does not exist or does not have the necessary labels.

966

# - MIN_EQUALS_MAX (WARNING): The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group.

967

# - MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING): The autoscaler did not receive any data from the custom metric configured for autoscaling.

968

# - MISSING_LOAD_BALANCING_DATA_POINTS (WARNING): The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer.

969

# - MODE_OFF (WARNING): Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved.

970

# - MODE_ONLY_UP (WARNING): Autoscaling is in the "Autoscale only up" mode. The autoscaler can add instances but not remove any.

971

# - MORE_THAN_ONE_BACKEND_SERVICE (ERROR): The instance group cannot be autoscaled because it has more than one backend service attached to it.

972

# - NOT_ENOUGH_QUOTA_AVAILABLE (ERROR): There is insufficient quota for the necessary resources, such as CPU or number of instances.

973

# - REGION_RESOURCE_STOCKOUT (ERROR): Shown only for regional autoscalers: there is a resource stockout in the chosen region.

974

# - SCALING_TARGET_DOES_NOT_EXIST (ERROR): The target to be scaled does not exist.

975

# - UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION (ERROR): Autoscaling does not work with an HTTP/S load balancer that has been configured for maxRate.

976

# - ZONE_RESOURCE_STOCKOUT (ERROR): For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout. New values might be added in the future. Some of the values might not be available in all API versions.

977

},

978

],

979

"target": "A String", # URL of the managed instance group that this autoscaler will scale.

980

"zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).

981

}

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

982

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

983

autoscaler: string, Name of the autoscaler to update.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

984

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

985

986

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

987

988

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

989

990

Returns:

991

An object of the form:

992

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

993

{ # Represents an Operation resource.

994

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

995

# Google Compute Engine has three Operation resources:

996

#

997

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

998

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

999

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

1000

#

1001

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1002

# - For global operations, use the `globalOperations` resource.

1003

# - For regional operations, use the `regionOperations` resource.

1004

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1005

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1006

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1007

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1008

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1009

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

1010

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1011

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1012

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1013

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1014

"code": "A String", # [Output Only] The error type identifier for this error.

1015

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1016

"message": "A String", # [Output Only] An optional, human-readable error message.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1017

},

1018

],

1019

},

Bu Sun Kim