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="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.instances.html">instances</a> . <a href="apigee_v1.organizations.instances.natAddresses.html">natAddresses</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#activate">activate(name, body=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Activates the NAT address. The Apigee instance can now use this for Internet egress traffic. **Note:** Not supported for Apigee hybrid.</p> 80<p class="toc_element"> 81 <code><a href="#close">close()</a></code></p> 82<p class="firstline">Close httplib2 connections.</p> 83<p class="toc_element"> 84 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Creates a NAT address. The address is created in the RESERVED state and a static external IP address will be provisioned. At this time, the instance will not use this IP address for Internet egress traffic. The address can be activated for use once any required firewall IP whitelisting has been completed. **Note:** Not supported for Apigee hybrid.</p> 86<p class="toc_element"> 87 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Deletes the NAT address. Connections that are actively using the address are drained before it is removed. **Note:** Not supported for Apigee hybrid.</p> 89<p class="toc_element"> 90 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 91<p class="firstline">Gets the details of a NAT address. **Note:** Not supported for Apigee hybrid.</p> 92<p class="toc_element"> 93 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Lists the NAT addresses for an Apigee instance. **Note:** Not supported for Apigee hybrid.</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="activate">activate(name, body=None, x__xgafv=None)</code> 101 <pre>Activates the NAT address. The Apigee instance can now use this for Internet egress traffic. **Note:** Not supported for Apigee hybrid. 102 103Args: 104 name: string, Required. Name of the nat address. Use the following structure in your request: `organizations/{org}/instances/{instances}/natAddresses/{nataddress}`` (required) 105 body: object, The request body. 106 The object takes the form of: 107 108{ # Request for ActivateNatAddressRequest. Activate the nat address request. 109} 110 111 x__xgafv: string, V1 error format. 112 Allowed values 113 1 - v1 error format 114 2 - v2 error format 115 116Returns: 117 An object of the form: 118 119 { # This resource represents a long-running operation that is the result of a network API call. 120 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 121 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 122 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 123 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 124 { 125 "a_key": "", # Properties of the object. Contains field @type with type URL. 126 }, 127 ], 128 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 129 }, 130 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 131 "a_key": "", # Properties of the object. Contains field @type with type URL. 132 }, 133 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 134 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 135 "a_key": "", # Properties of the object. Contains field @type with type URL. 136 }, 137}</pre> 138</div> 139 140<div class="method"> 141 <code class="details" id="close">close()</code> 142 <pre>Close httplib2 connections.</pre> 143</div> 144 145<div class="method"> 146 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 147 <pre>Creates a NAT address. The address is created in the RESERVED state and a static external IP address will be provisioned. At this time, the instance will not use this IP address for Internet egress traffic. The address can be activated for use once any required firewall IP whitelisting has been completed. **Note:** Not supported for Apigee hybrid. 148 149Args: 150 parent: string, Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instances/{instance}` (required) 151 body: object, The request body. 152 The object takes the form of: 153 154{ # Apigee NAT(network address translation) address. A NAT address is a static external IP address used for Internet egress traffic. 155 "ipAddress": "A String", # Output only. The static IPV4 address. 156 "name": "A String", # Required. Resource ID of the NAT address. 157 "state": "A String", # Output only. State of the nat address. 158} 159 160 x__xgafv: string, V1 error format. 161 Allowed values 162 1 - v1 error format 163 2 - v2 error format 164 165Returns: 166 An object of the form: 167 168 { # This resource represents a long-running operation that is the result of a network API call. 169 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 170 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 171 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 172 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 173 { 174 "a_key": "", # Properties of the object. Contains field @type with type URL. 175 }, 176 ], 177 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 178 }, 179 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 180 "a_key": "", # Properties of the object. Contains field @type with type URL. 181 }, 182 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 183 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 184 "a_key": "", # Properties of the object. Contains field @type with type URL. 185 }, 186}</pre> 187</div> 188 189<div class="method"> 190 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 191 <pre>Deletes the NAT address. Connections that are actively using the address are drained before it is removed. **Note:** Not supported for Apigee hybrid. 192 193Args: 194 name: string, Required. Name of the nat address. Use the following structure in your request: `organizations/{org}/instances/{instances}/natAddresses/{nataddress}`` (required) 195 x__xgafv: string, V1 error format. 196 Allowed values 197 1 - v1 error format 198 2 - v2 error format 199 200Returns: 201 An object of the form: 202 203 { # This resource represents a long-running operation that is the result of a network API call. 204 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 205 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 206 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 207 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 208 { 209 "a_key": "", # Properties of the object. Contains field @type with type URL. 210 }, 211 ], 212 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 213 }, 214 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 215 "a_key": "", # Properties of the object. Contains field @type with type URL. 216 }, 217 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 218 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 219 "a_key": "", # Properties of the object. Contains field @type with type URL. 220 }, 221}</pre> 222</div> 223 224<div class="method"> 225 <code class="details" id="get">get(name, x__xgafv=None)</code> 226 <pre>Gets the details of a NAT address. **Note:** Not supported for Apigee hybrid. 227 228Args: 229 name: string, Required. Name of the nat address. Use the following structure in your request: `organizations/{org}/instances/{instances}/natAddresses/{nataddress}` (required) 230 x__xgafv: string, V1 error format. 231 Allowed values 232 1 - v1 error format 233 2 - v2 error format 234 235Returns: 236 An object of the form: 237 238 { # Apigee NAT(network address translation) address. A NAT address is a static external IP address used for Internet egress traffic. 239 "ipAddress": "A String", # Output only. The static IPV4 address. 240 "name": "A String", # Required. Resource ID of the NAT address. 241 "state": "A String", # Output only. State of the nat address. 242}</pre> 243</div> 244 245<div class="method"> 246 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 247 <pre>Lists the NAT addresses for an Apigee instance. **Note:** Not supported for Apigee hybrid. 248 249Args: 250 parent: string, Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instances/{instance}` (required) 251 pageSize: integer, Maximum number of natAddresses to return. Defaults to 25. 252 pageToken: string, Page token, returned from a previous ListNatAddresses call, that you can use to retrieve the next page of content. 253 x__xgafv: string, V1 error format. 254 Allowed values 255 1 - v1 error format 256 2 - v2 error format 257 258Returns: 259 An object of the form: 260 261 { # Response for ListNatAddresses. 262 "natAddresses": [ # List of NAT Addresses for the instance. 263 { # Apigee NAT(network address translation) address. A NAT address is a static external IP address used for Internet egress traffic. 264 "ipAddress": "A String", # Output only. The static IPV4 address. 265 "name": "A String", # Required. Resource ID of the NAT address. 266 "state": "A String", # Output only. State of the nat address. 267 }, 268 ], 269 "nextPageToken": "A String", # Page token that you can include in a ListNatAddresses request to retrieve the next page of content. If omitted, no subsequent pages exist. 270}</pre> 271</div> 272 273<div class="method"> 274 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 275 <pre>Retrieves the next page of results. 276 277Args: 278 previous_request: The request for the previous page. (required) 279 previous_response: The response from the request for the previous page. (required) 280 281Returns: 282 A request object that you can call 'execute()' on to request the next 283 page. Returns None if there are no more items in the collection. 284 </pre> 285</div> 286 287</body></html>