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

2016-10-21 13:59:49 -0700

[diff] [blame]

79

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

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>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

85

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

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>

Sai Cheemalapati

2016-10-21 13:59:49 -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>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

91

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

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>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

94

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

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>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

101

Dan O'Meara

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

[diff] [blame]

102

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

103

<p class="firstline">Returns permissions that a caller has on the specified resource.</p>

104

Bu Sun Kim

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

[diff] [blame]

105

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

106

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

107

<h3>Method Details</h3>

108

Bu Sun Kim

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

[diff] [blame]

109

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

110

<pre>Retrieves an aggregated list of autoscalers.

111

112

Args:

113

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

Dan O'Meara

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

[diff] [blame]

114

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

115

Dan O'Meara

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

[diff] [blame]

116

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

117

Dan O'Meara

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

[diff] [blame]

118

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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

119

Bu Sun Kim

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

[diff] [blame]

120

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]

121

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]

122

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

123

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

124

125

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.

126

127

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

128

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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

129

130

Returns:

131

An object of the form:

132

133

{

Bu Sun Kim

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

[diff] [blame]

134

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

135

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

136

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

137

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

Bu Sun Kim

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

[diff] [blame]

138

{ # Represents an Autoscaler resource.

Bu Sun Kim

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

[diff] [blame]

139

#

140

# Google Compute Engine has two Autoscaler resources:

141

#

142

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

143

#

144

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

145

#

146

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

147

#

148

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

149

"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]

150

#

Bu Sun Kim

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

[diff] [blame]

151

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

152

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

153

#

Bu Sun Kim

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

[diff] [blame]

154

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

155

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

156

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

157

#

Bu Sun Kim

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

[diff] [blame]

158

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

159

#

160

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

161

},

Bu Sun Kim

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

[diff] [blame]

162

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

163

{ # Custom utilization metric policy.

164

"filter": "A String", # A filter string, compatible with a Stackdriver Monitoring filter string for TimeSeries.list API call. This filter is used to select a specific TimeSeries for the purpose of autoscaling and to determine whether the metric is exporting per-instance or per-group data.

165

#

166

# For the filter to be valid for autoscaling purposes, the following rules apply:

167

# - You can only use the AND operator for joining selectors.

168

# - You can only use direct equality comparison operator (=) without any functions for each selector.

169

# - You can specify the metric in both the filter string and in the metric field. However, if specified in both places, the metric must be identical.

170

# - The monitored resource type determines what kind of values are expected for the metric. If it is a gce_instance, the autoscaler expects the metric to include a separate TimeSeries for each instance in a group. In such a case, you cannot filter on resource labels.

171

# If the resource type is any other value, the autoscaler expects this metric to contain values that apply to the entire autoscaled instance group and resource label filtering can be performed to point autoscaler at the correct TimeSeries to scale upon. This is called a per-group metric for the purpose of autoscaling.

172

#

173

# If not specified, the type defaults to gce_instance.

174

#

175

# You should provide a filter that is selective enough to pick just one TimeSeries for the autoscaled group or for each of the instances (if you are using gce_instance resource type). If multiple TimeSeries are returned upon the query execution, the autoscaler will sum their respective values to obtain its scaling value.

176

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

177

#

178

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

179

"singleInstanceAssignment": 3.14, # If scaling is based on a per-group metric value that represents the total amount of work to be done or resource usage, set this value to an amount assigned for a single instance of the scaled group. Autoscaler will keep the number of instances proportional to the value of this metric, the metric itself should not change value due to group resizing.

180

#

181

# A good metric to use with the target is for example pubsub.googleapis.com/subscription/num_undelivered_messages or a custom metric exporting the total number of requests coming to your instances.

182

#

183

# A bad example would be a metric exporting an average or median latency, since this value can't include a chunk assignable to a single instance, it could be better used with utilization_target instead.

184

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

185

#

186

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

187

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

188

},

189

],

Bu Sun Kim

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

[diff] [blame]

190

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

191

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

192

},

193

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

194

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

195

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

196

"scaleDownControl": { # Configuration that allows for slower scale down so that even if Autoscaler recommends an abrupt scale down of a MIG, it will be throttled as specified by the parameters below.

197

"maxScaledDownReplicas": { # Encapsulates numeric value that can be either absolute or relative. # Maximum allowed number (or %) of VMs that can be deducted from the peak recommendation during the window autoscaler looks at when computing recommendations. Possibly all these VMs can be deleted at once so user service needs to be prepared to lose that many VMs in one step.

198

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

199

#

200

#

201

# - If the value is fixed, then the calculated value is equal to the fixed value.

202

# - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded up.

203

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

204

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

205

},

206

"timeWindowSec": 42, # How long back autoscaling should look when computing recommendations to include directives regarding slower scale down, as described above.

207

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

208

},

Bu Sun Kim

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

[diff] [blame]

209

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

210

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

211

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

212

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

213

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

214

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

215

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

216

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

217

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

218

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

219

# - DELETING: Configuration is being deleted.

220

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

221

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

222

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

223

{

224

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

225

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

226

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

227

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

228

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

229

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

230

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

231

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

232

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

233

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

234

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

235

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

236

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

237

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

238

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

239

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

240

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

241

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

242

},

243

],

244

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

245

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

246

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

247

],

Bu Sun Kim

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

[diff] [blame]

248

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

249

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

250

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

251

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

252

{

253

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

254

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

255

},

256

],

257

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

258

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

259

},

260

},

Bu Sun Kim

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

[diff] [blame]

261

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

262

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

263

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

264

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

265

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

266

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

267

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

Bu Sun Kim

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

[diff] [blame]

268

{

Bu Sun Kim

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

[diff] [blame]

269

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

270

"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]

271

},

272

],

Bu Sun Kim

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

[diff] [blame]

273

"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]

274

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

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

280

<pre>Retrieves the next page of results.

281

282

Args:

283

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

284

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

285

286

Returns:

Bu Sun Kim

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

[diff] [blame]

287

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

288

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]

293

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

294

<pre>Deletes the specified autoscaler.

295

296

Args:

297

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

298

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

299

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

Bu Sun Kim

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

[diff] [blame]

300

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.

301

302

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.

303

304

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

305

306

Returns:

307

An object of the form:

308

Bu Sun Kim

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

[diff] [blame]

309

{ # Represents an Operation resource.

310

#

Dan O'Meara

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

[diff] [blame]

311

# Google Compute Engine has three Operation resources:

312

#

313

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

314

#

Bu Sun Kim

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

[diff] [blame]

315

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

316

#

317

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

318

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

319

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

320

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

Bu Sun Kim

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

[diff] [blame]

321

#

Dan O'Meara

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

[diff] [blame]

322

# 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]

323

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

324

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

325

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

326

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

327

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

328

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

329

{

Bu Sun Kim

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

[diff] [blame]

330

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

331

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

332

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

333

},

334

],

335

},

Bu Sun Kim

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

[diff] [blame]

336

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

337

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

338

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

339

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

340

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

341

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

342

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

343

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

344

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

345

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

346

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

347

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

348

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

349

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

350

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

351

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

352

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

353

{

354

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

355

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

356

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

357

{

358

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

359

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

360

},

361

],

362

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

363

},

364

],

365

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

Sai Cheemalapati

2016-10-21 13:59:49 -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]

371

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

372

373

Args:

374

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

375

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

376

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

377

378

Returns:

379

An object of the form:

380

Bu Sun Kim

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

[diff] [blame]

381

{ # Represents an Autoscaler resource.

Bu Sun Kim

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

[diff] [blame]

382

#

383

# Google Compute Engine has two Autoscaler resources:

384

#

385

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

386

#

387

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

388

#

389

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

390

#

391

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

392

"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]

393

#

Bu Sun Kim

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

[diff] [blame]

394

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

395

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

396

#

Bu Sun Kim

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

[diff] [blame]

397

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

398

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

399

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

400

#

Bu Sun Kim

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

[diff] [blame]

401

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

402

#

403

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

404

},

Bu Sun Kim

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

[diff] [blame]

405

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

406

{ # Custom utilization metric policy.

407

"filter": "A String", # A filter string, compatible with a Stackdriver Monitoring filter string for TimeSeries.list API call. This filter is used to select a specific TimeSeries for the purpose of autoscaling and to determine whether the metric is exporting per-instance or per-group data.

408

#

409

# For the filter to be valid for autoscaling purposes, the following rules apply:

410

# - You can only use the AND operator for joining selectors.

411

# - You can only use direct equality comparison operator (=) without any functions for each selector.

412

# - You can specify the metric in both the filter string and in the metric field. However, if specified in both places, the metric must be identical.

413

# - The monitored resource type determines what kind of values are expected for the metric. If it is a gce_instance, the autoscaler expects the metric to include a separate TimeSeries for each instance in a group. In such a case, you cannot filter on resource labels.

414

# If the resource type is any other value, the autoscaler expects this metric to contain values that apply to the entire autoscaled instance group and resource label filtering can be performed to point autoscaler at the correct TimeSeries to scale upon. This is called a per-group metric for the purpose of autoscaling.

415

#

416

# If not specified, the type defaults to gce_instance.

417

#

418

# You should provide a filter that is selective enough to pick just one TimeSeries for the autoscaled group or for each of the instances (if you are using gce_instance resource type). If multiple TimeSeries are returned upon the query execution, the autoscaler will sum their respective values to obtain its scaling value.

419

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

420

#

421

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

422

"singleInstanceAssignment": 3.14, # If scaling is based on a per-group metric value that represents the total amount of work to be done or resource usage, set this value to an amount assigned for a single instance of the scaled group. Autoscaler will keep the number of instances proportional to the value of this metric, the metric itself should not change value due to group resizing.

423

#

424

# A good metric to use with the target is for example pubsub.googleapis.com/subscription/num_undelivered_messages or a custom metric exporting the total number of requests coming to your instances.

425

#

426

# A bad example would be a metric exporting an average or median latency, since this value can't include a chunk assignable to a single instance, it could be better used with utilization_target instead.

427

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

428

#

429

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

430

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

431

},

432

],

Bu Sun Kim

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

[diff] [blame]

433

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

434

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

435

},

436

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

437

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

438

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

439

"scaleDownControl": { # Configuration that allows for slower scale down so that even if Autoscaler recommends an abrupt scale down of a MIG, it will be throttled as specified by the parameters below.

440

"maxScaledDownReplicas": { # Encapsulates numeric value that can be either absolute or relative. # Maximum allowed number (or %) of VMs that can be deducted from the peak recommendation during the window autoscaler looks at when computing recommendations. Possibly all these VMs can be deleted at once so user service needs to be prepared to lose that many VMs in one step.

441

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

442

#

443

#

444

# - If the value is fixed, then the calculated value is equal to the fixed value.

445

# - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded up.

446

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

447

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

448

},

449

"timeWindowSec": 42, # How long back autoscaling should look when computing recommendations to include directives regarding slower scale down, as described above.

450

},

451

},

452

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

453

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

454

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

455

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

456

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

457

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

458

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

459

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

460

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

461

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

462

# - DELETING: Configuration is being deleted.

463

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

464

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

465

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

466

{

467

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

468

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

469

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

470

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

471

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

472

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

473

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

474

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

475

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

476

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

477

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

478

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

479

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

480

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

481

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

482

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

483

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

484

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

485

},

486

],

487

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

488

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

489

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

493

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

494

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

495

496

Args:

497

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

498

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

Dan O'Meara

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

[diff] [blame]

499

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

500

The object takes the form of:

501

Bu Sun Kim

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

[diff] [blame]

502

{ # Represents an Autoscaler resource.

Bu Sun Kim

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

[diff] [blame]

503

#

504

# Google Compute Engine has two Autoscaler resources:

505

#

506

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

507

#

508

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

509

#

510

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

511

#

512

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

513

"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]

514

#

Bu Sun Kim

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

[diff] [blame]

515

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

516

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

517

#

518

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

519

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

520

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

521

#

Bu Sun Kim

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

[diff] [blame]

522

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

523

#

524

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

525

},

Bu Sun Kim

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

[diff] [blame]

526

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

527

{ # Custom utilization metric policy.

528

"filter": "A String", # A filter string, compatible with a Stackdriver Monitoring filter string for TimeSeries.list API call. This filter is used to select a specific TimeSeries for the purpose of autoscaling and to determine whether the metric is exporting per-instance or per-group data.

529

#

530

# For the filter to be valid for autoscaling purposes, the following rules apply:

531

# - You can only use the AND operator for joining selectors.

532

# - You can only use direct equality comparison operator (=) without any functions for each selector.

533

# - You can specify the metric in both the filter string and in the metric field. However, if specified in both places, the metric must be identical.

534

# - The monitored resource type determines what kind of values are expected for the metric. If it is a gce_instance, the autoscaler expects the metric to include a separate TimeSeries for each instance in a group. In such a case, you cannot filter on resource labels.

535

# If the resource type is any other value, the autoscaler expects this metric to contain values that apply to the entire autoscaled instance group and resource label filtering can be performed to point autoscaler at the correct TimeSeries to scale upon. This is called a per-group metric for the purpose of autoscaling.

536

#

537

# If not specified, the type defaults to gce_instance.

538

#

539

# You should provide a filter that is selective enough to pick just one TimeSeries for the autoscaled group or for each of the instances (if you are using gce_instance resource type). If multiple TimeSeries are returned upon the query execution, the autoscaler will sum their respective values to obtain its scaling value.

540

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

541

#

542

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

543

"singleInstanceAssignment": 3.14, # If scaling is based on a per-group metric value that represents the total amount of work to be done or resource usage, set this value to an amount assigned for a single instance of the scaled group. Autoscaler will keep the number of instances proportional to the value of this metric, the metric itself should not change value due to group resizing.

544

#

545

# A good metric to use with the target is for example pubsub.googleapis.com/subscription/num_undelivered_messages or a custom metric exporting the total number of requests coming to your instances.

546

#

547

# A bad example would be a metric exporting an average or median latency, since this value can't include a chunk assignable to a single instance, it could be better used with utilization_target instead.

548

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

549

#

550

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

551

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

552

},

553

],

Bu Sun Kim

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

[diff] [blame]

554

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

555

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

556

},

557

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

558

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

559

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

560

"scaleDownControl": { # Configuration that allows for slower scale down so that even if Autoscaler recommends an abrupt scale down of a MIG, it will be throttled as specified by the parameters below.

561

"maxScaledDownReplicas": { # Encapsulates numeric value that can be either absolute or relative. # Maximum allowed number (or %) of VMs that can be deducted from the peak recommendation during the window autoscaler looks at when computing recommendations. Possibly all these VMs can be deleted at once so user service needs to be prepared to lose that many VMs in one step.

562

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

563

#

564

#

565

# - If the value is fixed, then the calculated value is equal to the fixed value.

566

# - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded up.

567

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

568

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

569

},

570

"timeWindowSec": 42, # How long back autoscaling should look when computing recommendations to include directives regarding slower scale down, as described above.

571

},

572

},

573

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

574

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

575

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

576

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

577

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

578

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

579

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

580

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

581

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

582

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

583

# - DELETING: Configuration is being deleted.

584

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

585

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

586

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

587

{

588

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

589

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

590

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

591

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

592

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

593

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

594

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

595

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

596

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

597

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

598

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

599

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

600

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

601

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

602

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

603

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

604

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

605

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

606

},

607

],

608

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

609

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

610

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

611

Bu Sun Kim

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

[diff] [blame]

612

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.

613

614

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.

615

616

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

617

618

Returns:

619

An object of the form:

620

Bu Sun Kim

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

[diff] [blame]

621

{ # Represents an Operation resource.

622

#

Dan O'Meara

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

[diff] [blame]

623

# Google Compute Engine has three Operation resources:

624

#

625

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

626

#

Bu Sun Kim

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

[diff] [blame]

627

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

628

#

629

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

630

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

631

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

632

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

Bu Sun Kim

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

[diff] [blame]

633

#

Dan O'Meara

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

[diff] [blame]

634

# 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]

635

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

636

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

637

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

638

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

639

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

640

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

641

{

Bu Sun Kim

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

[diff] [blame]

642

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

643

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

644

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

645

},

646

],

647

},

Bu Sun Kim

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

[diff] [blame]

648

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

649

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

650

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

651

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

652

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

653

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

654

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

655

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

656

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

657

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

658

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

659

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

660

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

661

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

662

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

663

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

664

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

665

{

666

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

667

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

668

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

669

{

670

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

671

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

672

},

673

],

674

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

675

},

676

],

677

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

682

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

683

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

684

685

Args:

686

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

687

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

Dan O'Meara

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

[diff] [blame]

688

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

689

Dan O'Meara

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

[diff] [blame]

690

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

691

Dan O'Meara

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

[diff] [blame]

692

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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

693

Bu Sun Kim

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

[diff] [blame]

694

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

695

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

696

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

697

698

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.

699

700

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

701

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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

702

703

Returns:

704

An object of the form:

705

706

{ # Contains a list of Autoscaler resources.

Bu Sun Kim

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

[diff] [blame]

707

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

708

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

Bu Sun Kim

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

[diff] [blame]

709

{ # Represents an Autoscaler resource.

Bu Sun Kim

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

[diff] [blame]

710

#

711

# Google Compute Engine has two Autoscaler resources:

712

#

713

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

714

#

715

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

716

#

717

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

718

#

719

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

720

"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]

721

#

Bu Sun Kim

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

[diff] [blame]

722

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

723

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

724

#

Bu Sun Kim

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

[diff] [blame]

725

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

726

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

727

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

728

#

Bu Sun Kim

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

[diff] [blame]

729

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

730

#

731

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

732

},

Bu Sun Kim

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

[diff] [blame]

733

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

734

{ # Custom utilization metric policy.

735

"filter": "A String", # A filter string, compatible with a Stackdriver Monitoring filter string for TimeSeries.list API call. This filter is used to select a specific TimeSeries for the purpose of autoscaling and to determine whether the metric is exporting per-instance or per-group data.

736

#

737

# For the filter to be valid for autoscaling purposes, the following rules apply:

738

# - You can only use the AND operator for joining selectors.

739

# - You can only use direct equality comparison operator (=) without any functions for each selector.

740

# - You can specify the metric in both the filter string and in the metric field. However, if specified in both places, the metric must be identical.

741

# - The monitored resource type determines what kind of values are expected for the metric. If it is a gce_instance, the autoscaler expects the metric to include a separate TimeSeries for each instance in a group. In such a case, you cannot filter on resource labels.

742

# If the resource type is any other value, the autoscaler expects this metric to contain values that apply to the entire autoscaled instance group and resource label filtering can be performed to point autoscaler at the correct TimeSeries to scale upon. This is called a per-group metric for the purpose of autoscaling.

743

#

744

# If not specified, the type defaults to gce_instance.

745

#

746

# You should provide a filter that is selective enough to pick just one TimeSeries for the autoscaled group or for each of the instances (if you are using gce_instance resource type). If multiple TimeSeries are returned upon the query execution, the autoscaler will sum their respective values to obtain its scaling value.

747

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

748

#

749

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

750

"singleInstanceAssignment": 3.14, # If scaling is based on a per-group metric value that represents the total amount of work to be done or resource usage, set this value to an amount assigned for a single instance of the scaled group. Autoscaler will keep the number of instances proportional to the value of this metric, the metric itself should not change value due to group resizing.

751

#

752

# A good metric to use with the target is for example pubsub.googleapis.com/subscription/num_undelivered_messages or a custom metric exporting the total number of requests coming to your instances.

753

#

754

# A bad example would be a metric exporting an average or median latency, since this value can't include a chunk assignable to a single instance, it could be better used with utilization_target instead.

755

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

756

#

757

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

758

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

759

},

760

],

Bu Sun Kim

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

[diff] [blame]

761

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

762

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

763

},

764

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

765

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

766

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

767

"scaleDownControl": { # Configuration that allows for slower scale down so that even if Autoscaler recommends an abrupt scale down of a MIG, it will be throttled as specified by the parameters below.

768

"maxScaledDownReplicas": { # Encapsulates numeric value that can be either absolute or relative. # Maximum allowed number (or %) of VMs that can be deducted from the peak recommendation during the window autoscaler looks at when computing recommendations. Possibly all these VMs can be deleted at once so user service needs to be prepared to lose that many VMs in one step.

769

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

770

#

771

#

772

# - If the value is fixed, then the calculated value is equal to the fixed value.

773

# - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded up.

774

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

775

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

776

},

777

"timeWindowSec": 42, # How long back autoscaling should look when computing recommendations to include directives regarding slower scale down, as described above.

778

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

779

},

Bu Sun Kim

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

[diff] [blame]

780

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

781

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

782

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

783

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

784

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

785

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

786

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

787

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

788

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

789

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

790

# - DELETING: Configuration is being deleted.

791

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

792

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

793

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

794

{

795

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

796

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

797

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

798

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

799

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

800

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

801

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

802

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

803

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

804

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

805

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

806

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

807

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

808

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

809

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

810

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

811

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

812

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

813

},

814

],

815

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

816

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

817

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

818

],

Bu Sun Kim

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

[diff] [blame]

819

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

820

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

821

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

822

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

823

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

824

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

825

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

Bu Sun Kim

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

[diff] [blame]

826

{

Bu Sun Kim

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

[diff] [blame]

827

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

828

"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]

829

},

830

],

Bu Sun Kim

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

[diff] [blame]

831

"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]

832

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

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

838

<pre>Retrieves the next page of results.

839

840

Args:

841

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

842

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

843

844

Returns:

Bu Sun Kim

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

[diff] [blame]

845

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

846

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]

851

<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]

852

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

853

854

Args:

855

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

856

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

Dan O'Meara

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

[diff] [blame]

857

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

858

The object takes the form of:

859

Bu Sun Kim

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

[diff] [blame]

860

{ # Represents an Autoscaler resource.

Bu Sun Kim

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

[diff] [blame]

861

#

862

# Google Compute Engine has two Autoscaler resources:

863

#

864

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

865

#

866

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

867

#

868

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

869

#

870

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

871

"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]

872

#

Bu Sun Kim

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

[diff] [blame]

873

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

874

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

875

#

876

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

877

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

878

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

879

#

Bu Sun Kim

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

[diff] [blame]

880

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

881

#

882

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

883

},

Bu Sun Kim

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

[diff] [blame]

884

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

885

{ # Custom utilization metric policy.

886

"filter": "A String", # A filter string, compatible with a Stackdriver Monitoring filter string for TimeSeries.list API call. This filter is used to select a specific TimeSeries for the purpose of autoscaling and to determine whether the metric is exporting per-instance or per-group data.

887

#

888

# For the filter to be valid for autoscaling purposes, the following rules apply:

889

# - You can only use the AND operator for joining selectors.

890

# - You can only use direct equality comparison operator (=) without any functions for each selector.

891

# - You can specify the metric in both the filter string and in the metric field. However, if specified in both places, the metric must be identical.

892

# - The monitored resource type determines what kind of values are expected for the metric. If it is a gce_instance, the autoscaler expects the metric to include a separate TimeSeries for each instance in a group. In such a case, you cannot filter on resource labels.

893

# If the resource type is any other value, the autoscaler expects this metric to contain values that apply to the entire autoscaled instance group and resource label filtering can be performed to point autoscaler at the correct TimeSeries to scale upon. This is called a per-group metric for the purpose of autoscaling.

894

#

895

# If not specified, the type defaults to gce_instance.

896

#

897

# You should provide a filter that is selective enough to pick just one TimeSeries for the autoscaled group or for each of the instances (if you are using gce_instance resource type). If multiple TimeSeries are returned upon the query execution, the autoscaler will sum their respective values to obtain its scaling value.

898

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

899

#

900

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

901

"singleInstanceAssignment": 3.14, # If scaling is based on a per-group metric value that represents the total amount of work to be done or resource usage, set this value to an amount assigned for a single instance of the scaled group. Autoscaler will keep the number of instances proportional to the value of this metric, the metric itself should not change value due to group resizing.

902

#

903

# A good metric to use with the target is for example pubsub.googleapis.com/subscription/num_undelivered_messages or a custom metric exporting the total number of requests coming to your instances.

904

#

905

# A bad example would be a metric exporting an average or median latency, since this value can't include a chunk assignable to a single instance, it could be better used with utilization_target instead.

906

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

907

#

908

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

909

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

910

},

911

],

Bu Sun Kim

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

[diff] [blame]

912

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

913

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

914

},

915

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

916

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

917

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

918

"scaleDownControl": { # Configuration that allows for slower scale down so that even if Autoscaler recommends an abrupt scale down of a MIG, it will be throttled as specified by the parameters below.

919

"maxScaledDownReplicas": { # Encapsulates numeric value that can be either absolute or relative. # Maximum allowed number (or %) of VMs that can be deducted from the peak recommendation during the window autoscaler looks at when computing recommendations. Possibly all these VMs can be deleted at once so user service needs to be prepared to lose that many VMs in one step.

920

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

921

#

922

#

923

# - If the value is fixed, then the calculated value is equal to the fixed value.

924

# - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded up.

925

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

926

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

927

},

928

"timeWindowSec": 42, # How long back autoscaling should look when computing recommendations to include directives regarding slower scale down, as described above.

929

},

930

},

931

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

932

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

933

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

934

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

935

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

936

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

937

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

938

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

939

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

940

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

941

# - DELETING: Configuration is being deleted.

942

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

943

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

944

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

945

{

946

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

947

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

948

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

949

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

950

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

951

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

952

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

953

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

954

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

955

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

956

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

957

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

958

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

959

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

960

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

961

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

962

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

963

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

964

},

965

],

966

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

967

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

968

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

969

Bu Sun Kim

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

[diff] [blame]

970

autoscaler: string, Name of the autoscaler to patch.

Bu Sun Kim

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

[diff] [blame]

971

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.

972

973

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.

974

975

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

976

977

Returns:

978

An object of the form:

979

Bu Sun Kim

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

[diff] [blame]

980

{ # Represents an Operation resource.

981

#

Dan O'Meara

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

[diff] [blame]

982

# Google Compute Engine has three Operation resources:

983

#

984

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

985

#

Bu Sun Kim

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

[diff] [blame]

986

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

987

#

988

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

989

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

990

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

991

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

Bu Sun Kim

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

[diff] [blame]

992

#

Dan O'Meara

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

[diff] [blame]

993

# 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]

994

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

995

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

996

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

997

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

998

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

999

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1000

{

Bu Sun Kim

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

[diff] [blame]

1001

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

1002

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

1003

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1004

},

1005

],

1006

},

Bu Sun Kim

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

[diff] [blame]

1007

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

1008

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

1009

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

1010

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

1011

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

1012

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

1013

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

1014

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

1015

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

1016

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

1017

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

1018

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

1019

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

1020

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

1021

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

1022

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

1023

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

1024

{

1025

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

1026

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

1027

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

1028

{

1029

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

1030

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

1031

},

1032

],

1033

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

1034

},

1035

],

1036

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1041

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1042

<pre>Returns permissions that a caller has on the specified resource.

1043

1044

Args:

1045

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

1046

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

Bu Sun Kim

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

[diff] [blame]

1047

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

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

[diff] [blame]

1048

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1049

The object takes the form of:

1050

1051

{

Bu Sun Kim

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

[diff] [blame]

1052

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

1053

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

],

}

Returns:

An object of the form:

1060

1061

{

Bu Sun Kim

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

[diff] [blame]

1062

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

1063

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

],

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

1069

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1070

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

1071

1072

Args:

1073

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

1074

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

Dan O'Meara

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

[diff] [blame]

1075

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1076

The object takes the form of:

1077

Bu Sun Kim

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

[diff] [blame]

1078

{ # Represents an Autoscaler resource.

Bu Sun Kim

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

[diff] [blame]

1079

#

1080

# Google Compute Engine has two Autoscaler resources:

1081

#

1082

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

1083

#

1084

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

1085

#

1086

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

1087

#

1088

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

1089

"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]

1090

#

Bu Sun Kim

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

[diff] [blame]

1091

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

1092

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

1093

#

1094

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

1095

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

1096

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1097

#

Bu Sun Kim

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

[diff] [blame]

1098

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

1099

#

1100

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1101

},

Bu Sun Kim

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

[diff] [blame]

1102

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

1103

{ # Custom utilization metric policy.

1104

"filter": "A String", # A filter string, compatible with a Stackdriver Monitoring filter string for TimeSeries.list API call. This filter is used to select a specific TimeSeries for the purpose of autoscaling and to determine whether the metric is exporting per-instance or per-group data.

1105

#

1106

# For the filter to be valid for autoscaling purposes, the following rules apply:

1107

# - You can only use the AND operator for joining selectors.

1108

# - You can only use direct equality comparison operator (=) without any functions for each selector.

1109

# - You can specify the metric in both the filter string and in the metric field. However, if specified in both places, the metric must be identical.

1110

# - The monitored resource type determines what kind of values are expected for the metric. If it is a gce_instance, the autoscaler expects the metric to include a separate TimeSeries for each instance in a group. In such a case, you cannot filter on resource labels.

1111

# If the resource type is any other value, the autoscaler expects this metric to contain values that apply to the entire autoscaled instance group and resource label filtering can be performed to point autoscaler at the correct TimeSeries to scale upon. This is called a per-group metric for the purpose of autoscaling.

1112

#

1113

# If not specified, the type defaults to gce_instance.

1114

#

1115

# You should provide a filter that is selective enough to pick just one TimeSeries for the autoscaled group or for each of the instances (if you are using gce_instance resource type). If multiple TimeSeries are returned upon the query execution, the autoscaler will sum their respective values to obtain its scaling value.

1116

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

1117

#

1118

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

1119

"singleInstanceAssignment": 3.14, # If scaling is based on a per-group metric value that represents the total amount of work to be done or resource usage, set this value to an amount assigned for a single instance of the scaled group. Autoscaler will keep the number of instances proportional to the value of this metric, the metric itself should not change value due to group resizing.

1120

#

1121

# A good metric to use with the target is for example pubsub.googleapis.com/subscription/num_undelivered_messages or a custom metric exporting the total number of requests coming to your instances.

1122

#

1123

# A bad example would be a metric exporting an average or median latency, since this value can't include a chunk assignable to a single instance, it could be better used with utilization_target instead.

1124

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

1125

#

1126

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

1127

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1128

},

1129

],

Bu Sun Kim

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

[diff] [blame]

1130

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

1131

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

1132

},

1133

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

1134

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

1135

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

1136

"scaleDownControl": { # Configuration that allows for slower scale down so that even if Autoscaler recommends an abrupt scale down of a MIG, it will be throttled as specified by the parameters below.

1137

"maxScaledDownReplicas": { # Encapsulates numeric value that can be either absolute or relative. # Maximum allowed number (or %) of VMs that can be deducted from the peak recommendation during the window autoscaler looks at when computing recommendations. Possibly all these VMs can be deleted at once so user service needs to be prepared to lose that many VMs in one step.

1138

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1139

#

1140

#

1141

# - If the value is fixed, then the calculated value is equal to the fixed value.

1142

# - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded up.

1143

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1144

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

1145

},

1146

"timeWindowSec": 42, # How long back autoscaling should look when computing recommendations to include directives regarding slower scale down, as described above.

1147

},

1148

},

1149

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

1150

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

1151

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

1152

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

1153

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

1154

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

1155

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

1156

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

1157

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

1158

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

1159

# - DELETING: Configuration is being deleted.

1160

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

1161

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

1162

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

1163

{

1164

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

1165

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

1166

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

1167

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

1168

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

1169

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

1170

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

1171

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

1172

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

1173

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

1174

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

1175

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

1176

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

1177

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

1178

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

1179

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

1180

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

1181

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

1182

},

1183

],

1184

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

1185

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

1186

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1187

Bu Sun Kim

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

[diff] [blame]

1188

autoscaler: string, Name of the autoscaler to update.

Bu Sun Kim

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

[diff] [blame]

1189

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.

1190

1191

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.

1192

1193

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1194

1195

Returns:

1196

An object of the form:

1197

Bu Sun Kim

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

[diff] [blame]

1198

{ # Represents an Operation resource.

1199

#

Dan O'Meara

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

[diff] [blame]

1200

# Google Compute Engine has three Operation resources:

1201

#

1202

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

1203

#

Bu Sun Kim

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

[diff] [blame]

1204

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

1205

#

1206

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1207

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

1208

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

1209

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

Bu Sun Kim

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

[diff] [blame]

1210

#

Dan O'Meara

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

[diff] [blame]

1211

# 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]

1212

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

1213

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

1214

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

1215

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

1216

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

1217

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1218

{

Bu Sun Kim

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

[diff] [blame]

1219

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

1220

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

1221

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1222

},

1223

],

1224

},

Bu Sun Kim