1 <html><body> 2 <style> 3 4 body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13 } 14 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51 } 52 53 .toc_element { 54 margin-top: 0.5em; 55 } 56 57 .firstline { 58 margin-left: 2 em; 59 } 60 61 .method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66 } 67 68 .details { 69 font-weight: bold; 70 font-size: 14px; 71 } 72 73 </style> 74 75 <h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.autoscalers.html">autoscalers</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 79 <p class="firstline">Retrieves an aggregated list of autoscalers.</p> 80 <p class="toc_element"> 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 <p class="toc_element"> 84 <code><a href="#delete">delete(project, zone, autoscaler)</a></code></p> 85 <p class="firstline">Deletes the specified autoscaler.</p> 86 <p class="toc_element"> 87 <code><a href="#get">get(project, zone, autoscaler)</a></code></p> 88 <p class="firstline">Returns the specified autoscaler resource. Get a list of available autoscalers by making a list() request.</p> 89 <p class="toc_element"> 90 <code><a href="#insert">insert(project, zone, body)</a></code></p> 91 <p class="firstline">Creates an autoscaler in the specified project using the data included in the request.</p> 92 <p class="toc_element"> 93 <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 94 <p class="firstline">Retrieves a list of autoscalers contained within the specified zone.</p> 95 <p class="toc_element"> 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 <p class="toc_element"> 99 <code><a href="#patch">patch(project, zone, body, autoscaler=None)</a></code></p> 100 <p class="firstline">Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.</p> 101 <p class="toc_element"> 102 <code><a href="#update">update(project, zone, body, autoscaler=None)</a></code></p> 103 <p class="firstline">Updates an autoscaler in the specified project using the data included in the request.</p> 104 <h3>Method Details</h3> 105 <div class="method"> 106 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 107 <pre>Retrieves an aggregated list of autoscalers. 108 109 Args: 110 project: string, Project ID for this request. (required) 111 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 112 113 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. 114 115 Currently, only sorting by name or creationTimestamp desc is supported. 116 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) 117 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. 118 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 119 120 The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 121 122 For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 123 124 You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. 125 126 To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 127 128 Returns: 129 An object of the form: 130 131 { 132 "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. 133 "items": { # A map of scoped autoscaler lists. 134 "a_key": { # [Output Only] Name of the scope containing this set of autoscalers. 135 "warning": { # [Output Only] Informational warning which replaces the list of autoscalers when the list is empty. 136 "message": "A String", # [Output Only] A human-readable description of the warning code. 137 "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. 138 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 139 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 140 { 141 "value": "A String", # [Output Only] A warning data value corresponding to the key. 142 "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). 143 }, 144 ], 145 }, 146 "autoscalers": [ # [Output Only] List of autoscalers contained in this scope. 147 { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances. 148 "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers. 149 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 150 "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope). 151 "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope). 152 "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. 153 # 154 # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%. 155 "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. 156 "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. 157 # 158 # 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. 159 "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer. 160 "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. 161 }, 162 "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric. 163 { # Custom utilization metric policy. 164 "metric": "A String", # The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. 165 # 166 # The metric must have a value type of INT64 or DOUBLE. 167 "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE. 168 "utilizationTarget": 3.14, # The target value of the metric that autoscaler should maintain. This must be a positive value. 169 # 170 # 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. 171 }, 172 ], 173 "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. 174 "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. 175 # 176 # 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. 177 # 178 # 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. 179 }, 180 "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. 181 }, 182 "target": "A String", # URL of the managed instance group that this autoscaler will scale. 183 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 184 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 185 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 186 "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. 187 }, 188 ], 189 }, 190 }, 191 "kind": "compute#autoscalerAggregatedList", # [Output Only] Type of resource. Always compute#autoscalerAggregatedList for aggregated lists of autoscalers. 192 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 193 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 194 }</pre> 195 </div> 196 197 <div class="method"> 198 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 199 <pre>Retrieves the next page of results. 200 201 Args: 202 previous_request: The request for the previous page. (required) 203 previous_response: The response from the request for the previous page. (required) 204 205 Returns: 206 A request object that you can call 'execute()' on to request the next 207 page. Returns None if there are no more items in the collection. 208 </pre> 209 </div> 210 211 <div class="method"> 212 <code class="details" id="delete">delete(project, zone, autoscaler)</code> 213 <pre>Deletes the specified autoscaler. 214 215 Args: 216 project: string, Project ID for this request. (required) 217 zone: string, Name of the zone for this request. (required) 218 autoscaler: string, Name of the autoscaler to delete. (required) 219 220 Returns: 221 An object of the form: 222 223 { # An Operation resource, used to manage asynchronous API requests. 224 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 225 "clientOperationId": "A String", # [Output Only] Reserved for future use. 226 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 227 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 228 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 229 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 230 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 231 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 232 "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. 233 "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. 234 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 235 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 236 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 237 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 238 { 239 "message": "A String", # [Output Only] A human-readable description of the warning code. 240 "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. 241 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 242 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 243 { 244 "value": "A String", # [Output Only] A warning data value corresponding to the key. 245 "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). 246 }, 247 ], 248 }, 249 ], 250 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 251 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 252 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 253 "name": "A String", # [Output Only] Name of the resource. 254 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 255 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 256 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 257 { 258 "message": "A String", # [Output Only] An optional, human-readable error message. 259 "code": "A String", # [Output Only] The error type identifier for this error. 260 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 261 }, 262 ], 263 }, 264 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 265 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 266 "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. 267 }</pre> 268 </div> 269 270 <div class="method"> 271 <code class="details" id="get">get(project, zone, autoscaler)</code> 272 <pre>Returns the specified autoscaler resource. Get a list of available autoscalers by making a list() request. 273 274 Args: 275 project: string, Project ID for this request. (required) 276 zone: string, Name of the zone for this request. (required) 277 autoscaler: string, Name of the autoscaler to return. (required) 278 279 Returns: 280 An object of the form: 281 282 { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances. 283 "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers. 284 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 285 "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope). 286 "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope). 287 "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. 288 # 289 # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%. 290 "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. 291 "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. 292 # 293 # 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. 294 "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer. 295 "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. 296 }, 297 "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric. 298 { # Custom utilization metric policy. 299 "metric": "A String", # The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. 300 # 301 # The metric must have a value type of INT64 or DOUBLE. 302 "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE. 303 "utilizationTarget": 3.14, # The target value of the metric that autoscaler should maintain. This must be a positive value. 304 # 305 # 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. 306 }, 307 ], 308 "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. 309 "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. 310 # 311 # 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. 312 # 313 # 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. 314 }, 315 "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. 316 }, 317 "target": "A String", # URL of the managed instance group that this autoscaler will scale. 318 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 319 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 320 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 321 "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. 322 }</pre> 323 </div> 324 325 <div class="method"> 326 <code class="details" id="insert">insert(project, zone, body)</code> 327 <pre>Creates an autoscaler in the specified project using the data included in the request. 328 329 Args: 330 project: string, Project ID for this request. (required) 331 zone: string, Name of the zone for this request. (required) 332 body: object, The request body. (required) 333 The object takes the form of: 334 335 { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances. 336 "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers. 337 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 338 "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope). 339 "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope). 340 "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. 341 # 342 # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%. 343 "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. 344 "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. 345 # 346 # 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. 347 "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer. 348 "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. 349 }, 350 "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric. 351 { # Custom utilization metric policy. 352 "metric": "A String", # The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. 353 # 354 # The metric must have a value type of INT64 or DOUBLE. 355 "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE. 356 "utilizationTarget": 3.14, # The target value of the metric that autoscaler should maintain. This must be a positive value. 357 # 358 # 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. 359 }, 360 ], 361 "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. 362 "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. 363 # 364 # 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. 365 # 366 # 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. 367 }, 368 "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. 369 }, 370 "target": "A String", # URL of the managed instance group that this autoscaler will scale. 371 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 372 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 373 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 374 "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. 375 } 376 377 378 Returns: 379 An object of the form: 380 381 { # An Operation resource, used to manage asynchronous API requests. 382 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 383 "clientOperationId": "A String", # [Output Only] Reserved for future use. 384 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 385 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 386 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 387 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 388 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 389 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 390 "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. 391 "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. 392 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 393 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 394 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 395 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 396 { 397 "message": "A String", # [Output Only] A human-readable description of the warning code. 398 "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. 399 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 400 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 401 { 402 "value": "A String", # [Output Only] A warning data value corresponding to the key. 403 "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). 404 }, 405 ], 406 }, 407 ], 408 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 409 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 410 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 411 "name": "A String", # [Output Only] Name of the resource. 412 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 413 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 414 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 415 { 416 "message": "A String", # [Output Only] An optional, human-readable error message. 417 "code": "A String", # [Output Only] The error type identifier for this error. 418 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 419 }, 420 ], 421 }, 422 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 423 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 424 "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. 425 }</pre> 426 </div> 427 428 <div class="method"> 429 <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 430 <pre>Retrieves a list of autoscalers contained within the specified zone. 431 432 Args: 433 project: string, Project ID for this request. (required) 434 zone: string, Name of the zone for this request. (required) 435 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 436 437 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. 438 439 Currently, only sorting by name or creationTimestamp desc is supported. 440 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) 441 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. 442 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 443 444 The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 445 446 For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 447 448 You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. 449 450 To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 451 452 Returns: 453 An object of the form: 454 455 { # Contains a list of Autoscaler resources. 456 "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. 457 "items": [ # A list of Autoscaler resources. 458 { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances. 459 "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers. 460 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 461 "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope). 462 "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope). 463 "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. 464 # 465 # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%. 466 "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. 467 "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. 468 # 469 # 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. 470 "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer. 471 "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. 472 }, 473 "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric. 474 { # Custom utilization metric policy. 475 "metric": "A String", # The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. 476 # 477 # The metric must have a value type of INT64 or DOUBLE. 478 "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE. 479 "utilizationTarget": 3.14, # The target value of the metric that autoscaler should maintain. This must be a positive value. 480 # 481 # 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. 482 }, 483 ], 484 "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. 485 "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. 486 # 487 # 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. 488 # 489 # 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. 490 }, 491 "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. 492 }, 493 "target": "A String", # URL of the managed instance group that this autoscaler will scale. 494 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 495 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 496 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 497 "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. 498 }, 499 ], 500 "kind": "compute#autoscalerList", # [Output Only] Type of resource. Always compute#autoscalerList for lists of autoscalers. 501 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 502 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 503 }</pre> 504 </div> 505 506 <div class="method"> 507 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 508 <pre>Retrieves the next page of results. 509 510 Args: 511 previous_request: The request for the previous page. (required) 512 previous_response: The response from the request for the previous page. (required) 513 514 Returns: 515 A request object that you can call 'execute()' on to request the next 516 page. Returns None if there are no more items in the collection. 517 </pre> 518 </div> 519 520 <div class="method"> 521 <code class="details" id="patch">patch(project, zone, body, autoscaler=None)</code> 522 <pre>Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics. 523 524 Args: 525 project: string, Project ID for this request. (required) 526 zone: string, Name of the zone for this request. (required) 527 body: object, The request body. (required) 528 The object takes the form of: 529 530 { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances. 531 "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers. 532 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 533 "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope). 534 "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope). 535 "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. 536 # 537 # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%. 538 "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. 539 "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. 540 # 541 # 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. 542 "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer. 543 "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. 544 }, 545 "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric. 546 { # Custom utilization metric policy. 547 "metric": "A String", # The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. 548 # 549 # The metric must have a value type of INT64 or DOUBLE. 550 "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE. 551 "utilizationTarget": 3.14, # The target value of the metric that autoscaler should maintain. This must be a positive value. 552 # 553 # 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. 554 }, 555 ], 556 "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. 557 "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. 558 # 559 # 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. 560 # 561 # 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. 562 }, 563 "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. 564 }, 565 "target": "A String", # URL of the managed instance group that this autoscaler will scale. 566 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 567 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 568 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 569 "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. 570 } 571 572 autoscaler: string, Name of the autoscaler to patch. 573 574 Returns: 575 An object of the form: 576 577 { # An Operation resource, used to manage asynchronous API requests. 578 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 579 "clientOperationId": "A String", # [Output Only] Reserved for future use. 580 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 581 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 582 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 583 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 584 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 585 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 586 "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. 587 "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. 588 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 589 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 590 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 591 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 592 { 593 "message": "A String", # [Output Only] A human-readable description of the warning code. 594 "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. 595 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 596 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 597 { 598 "value": "A String", # [Output Only] A warning data value corresponding to the key. 599 "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). 600 }, 601 ], 602 }, 603 ], 604 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 605 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 606 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 607 "name": "A String", # [Output Only] Name of the resource. 608 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 609 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 610 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 611 { 612 "message": "A String", # [Output Only] An optional, human-readable error message. 613 "code": "A String", # [Output Only] The error type identifier for this error. 614 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 615 }, 616 ], 617 }, 618 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 619 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 620 "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. 621 }</pre> 622 </div> 623 624 <div class="method"> 625 <code class="details" id="update">update(project, zone, body, autoscaler=None)</code> 626 <pre>Updates an autoscaler in the specified project using the data included in the request. 627 628 Args: 629 project: string, Project ID for this request. (required) 630 zone: string, Name of the zone for this request. (required) 631 body: object, The request body. (required) 632 The object takes the form of: 633 634 { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances. 635 "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers. 636 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 637 "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope). 638 "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope). 639 "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. 640 # 641 # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%. 642 "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. 643 "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. 644 # 645 # 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. 646 "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer. 647 "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. 648 }, 649 "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric. 650 { # Custom utilization metric policy. 651 "metric": "A String", # The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. 652 # 653 # The metric must have a value type of INT64 or DOUBLE. 654 "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE. 655 "utilizationTarget": 3.14, # The target value of the metric that autoscaler should maintain. This must be a positive value. 656 # 657 # 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. 658 }, 659 ], 660 "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. 661 "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. 662 # 663 # 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. 664 # 665 # 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. 666 }, 667 "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. 668 }, 669 "target": "A String", # URL of the managed instance group that this autoscaler will scale. 670 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 671 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 672 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 673 "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. 674 } 675 676 autoscaler: string, Name of the autoscaler to update. 677 678 Returns: 679 An object of the form: 680 681 { # An Operation resource, used to manage asynchronous API requests. 682 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 683 "clientOperationId": "A String", # [Output Only] Reserved for future use. 684 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 685 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 686 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 687 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 688 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 689 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 690 "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. 691 "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. 692 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 693 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 694 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 695 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 696 { 697 "message": "A String", # [Output Only] A human-readable description of the warning code. 698 "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. 699 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 700 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 701 { 702 "value": "A String", # [Output Only] A warning data value corresponding to the key. 703 "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). 704 }, 705 ], 706 }, 707 ], 708 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 709 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 710 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 711 "name": "A String", # [Output Only] Name of the resource. 712 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 713 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 714 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 715 { 716 "message": "A String", # [Output Only] An optional, human-readable error message. 717 "code": "A String", # [Output Only] The error type identifier for this error. 718 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 719 }, 720 ], 721 }, 722 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 723 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 724 "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. 725 }</pre> 726 </div> 727 728 </body></html>
