1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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.addresses.html">addresses</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 addresses.</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, region, address)</a></code></p> 85<p class="firstline">Deletes the specified address resource.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(project, region, address)</a></code></p> 88<p class="firstline">Returns the specified address resource.</p> 89<p class="toc_element"> 90 <code><a href="#insert">insert(project, region, body)</a></code></p> 91<p class="firstline">Creates an address resource in the specified project using the data included in the request.</p> 92<p class="toc_element"> 93 <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 94<p class="firstline">Retrieves a list of addresses contained within the specified region.</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<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 101 <pre>Retrieves an aggregated list of addresses. 102 103Args: 104 project: string, Project ID for this request. (required) 105 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 106 107You 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. 108 109Currently, only sorting by name or creationTimestamp desc is supported. 110 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) 111 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. 112 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. 113 114The 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. 115 116For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 117 118You 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. 119 120To 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. 121 122Returns: 123 An object of the form: 124 125 { 126 "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. 127 "items": { # [Output Only] A map of scoped address lists. 128 "a_key": { # [Output Only] Name of the scope containing this set of addresses. 129 "warning": { # [Output Only] Informational warning which replaces the list of addresses when the list is empty. 130 "message": "A String", # [Output Only] A human-readable description of the warning code. 131 "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. 132 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 133 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 134 { 135 "value": "A String", # [Output Only] A warning data value corresponding to the key. 136 "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). 137 }, 138 ], 139 }, 140 "addresses": [ # [Output Only] List of addresses contained in this scope. 141 { # A reserved address resource. 142 "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. 143 "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses. 144 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 145 "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses. 146 "address": "A String", # The static external IP address represented by this resource. 147 "users": [ # [Output Only] The URLs of the resources that are using this address. 148 "A String", 149 ], 150 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 151 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 152 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 153 "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. 154 }, 155 ], 156 }, 157 }, 158 "kind": "compute#addressAggregatedList", # [Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses. 159 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 160 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 161 }</pre> 162</div> 163 164<div class="method"> 165 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 166 <pre>Retrieves the next page of results. 167 168Args: 169 previous_request: The request for the previous page. (required) 170 previous_response: The response from the request for the previous page. (required) 171 172Returns: 173 A request object that you can call 'execute()' on to request the next 174 page. Returns None if there are no more items in the collection. 175 </pre> 176</div> 177 178<div class="method"> 179 <code class="details" id="delete">delete(project, region, address)</code> 180 <pre>Deletes the specified address resource. 181 182Args: 183 project: string, Project ID for this request. (required) 184 region: string, Name of the region for this request. (required) 185 address: string, Name of the address resource to delete. (required) 186 187Returns: 188 An object of the form: 189 190 { # An Operation resource, used to manage asynchronous API requests. 191 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 192 "clientOperationId": "A String", # [Output Only] Reserved for future use. 193 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 194 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 195 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 196 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 197 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 198 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 199 "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. 200 "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. 201 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 202 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 203 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 204 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 205 { 206 "message": "A String", # [Output Only] A human-readable description of the warning code. 207 "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. 208 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 209 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 210 { 211 "value": "A String", # [Output Only] A warning data value corresponding to the key. 212 "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). 213 }, 214 ], 215 }, 216 ], 217 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 218 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 219 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 220 "name": "A String", # [Output Only] Name of the resource. 221 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 222 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 223 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 224 { 225 "message": "A String", # [Output Only] An optional, human-readable error message. 226 "code": "A String", # [Output Only] The error type identifier for this error. 227 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 228 }, 229 ], 230 }, 231 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 232 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 233 "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. 234 }</pre> 235</div> 236 237<div class="method"> 238 <code class="details" id="get">get(project, region, address)</code> 239 <pre>Returns the specified address resource. 240 241Args: 242 project: string, Project ID for this request. (required) 243 region: string, Name of the region for this request. (required) 244 address: string, Name of the address resource to return. (required) 245 246Returns: 247 An object of the form: 248 249 { # A reserved address resource. 250 "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. 251 "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses. 252 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 253 "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses. 254 "address": "A String", # The static external IP address represented by this resource. 255 "users": [ # [Output Only] The URLs of the resources that are using this address. 256 "A String", 257 ], 258 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 259 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 260 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 261 "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. 262 }</pre> 263</div> 264 265<div class="method"> 266 <code class="details" id="insert">insert(project, region, body)</code> 267 <pre>Creates an address resource in the specified project using the data included in the request. 268 269Args: 270 project: string, Project ID for this request. (required) 271 region: string, Name of the region for this request. (required) 272 body: object, The request body. (required) 273 The object takes the form of: 274 275{ # A reserved address resource. 276 "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. 277 "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses. 278 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 279 "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses. 280 "address": "A String", # The static external IP address represented by this resource. 281 "users": [ # [Output Only] The URLs of the resources that are using this address. 282 "A String", 283 ], 284 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 285 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 286 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 287 "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. 288 } 289 290 291Returns: 292 An object of the form: 293 294 { # An Operation resource, used to manage asynchronous API requests. 295 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 296 "clientOperationId": "A String", # [Output Only] Reserved for future use. 297 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 298 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 299 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 300 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 301 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 302 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 303 "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. 304 "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. 305 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 306 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 307 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 308 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 309 { 310 "message": "A String", # [Output Only] A human-readable description of the warning code. 311 "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. 312 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 313 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 314 { 315 "value": "A String", # [Output Only] A warning data value corresponding to the key. 316 "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). 317 }, 318 ], 319 }, 320 ], 321 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 322 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 323 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 324 "name": "A String", # [Output Only] Name of the resource. 325 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 326 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 327 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 328 { 329 "message": "A String", # [Output Only] An optional, human-readable error message. 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 }, 333 ], 334 }, 335 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 336 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 337 "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. 338 }</pre> 339</div> 340 341<div class="method"> 342 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 343 <pre>Retrieves a list of addresses contained within the specified region. 344 345Args: 346 project: string, Project ID for this request. (required) 347 region: string, Name of the region for this request. (required) 348 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 349 350You 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. 351 352Currently, only sorting by name or creationTimestamp desc is supported. 353 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) 354 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. 355 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. 356 357The 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. 358 359For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 360 361You 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. 362 363To 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. 364 365Returns: 366 An object of the form: 367 368 { # Contains a list of addresses. 369 "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. 370 "items": [ # [Output Only] A list of addresses. 371 { # A reserved address resource. 372 "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. 373 "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses. 374 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 375 "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses. 376 "address": "A String", # The static external IP address represented by this resource. 377 "users": [ # [Output Only] The URLs of the resources that are using this address. 378 "A String", 379 ], 380 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 381 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 382 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 383 "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. 384 }, 385 ], 386 "kind": "compute#addressList", # [Output Only] Type of resource. Always compute#addressList for lists of addresses. 387 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 388 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 389 }</pre> 390</div> 391 392<div class="method"> 393 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 394 <pre>Retrieves the next page of results. 395 396Args: 397 previous_request: The request for the previous page. (required) 398 previous_response: The response from the request for the previous page. (required) 399 400Returns: 401 A request object that you can call 'execute()' on to request the next 402 page. Returns None if there are no more items in the collection. 403 </pre> 404</div> 405 406</body></html>