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></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="apigee_v1.organizations.instances.attachments.html">attachments()</a></code> 79</p> 80<p class="firstline">Returns the attachments Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="apigee_v1.organizations.instances.canaryevaluations.html">canaryevaluations()</a></code> 84</p> 85<p class="firstline">Returns the canaryevaluations Resource.</p> 86 87<p class="toc_element"> 88 <code><a href="apigee_v1.organizations.instances.natAddresses.html">natAddresses()</a></code> 89</p> 90<p class="firstline">Returns the natAddresses Resource.</p> 91 92<p class="toc_element"> 93 <code><a href="#close">close()</a></code></p> 94<p class="firstline">Close httplib2 connections.</p> 95<p class="toc_element"> 96 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Creates an Apigee runtime instance. The instance is accessible from the authorized network configured on the organization. **Note:** Not supported for Apigee hybrid.</p> 98<p class="toc_element"> 99 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 100<p class="firstline">Deletes an Apigee runtime instance. The instance stops serving requests and the runtime data is deleted. **Note:** Not supported for Apigee hybrid.</p> 101<p class="toc_element"> 102 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 103<p class="firstline">Gets the details for an Apigee runtime instance. **Note:** Not supported for Apigee hybrid.</p> 104<p class="toc_element"> 105 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 106<p class="firstline">Lists all Apigee runtime instances for the organization. **Note:** Not supported for Apigee hybrid.</p> 107<p class="toc_element"> 108 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 109<p class="firstline">Retrieves the next page of results.</p> 110<p class="toc_element"> 111 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 112<p class="firstline">Updates an Apigee runtime instance. You can update the fields described in NodeConfig. No other fields will be updated. **Note:** Not supported for Apigee hybrid.</p> 113<p class="toc_element"> 114 <code><a href="#reportStatus">reportStatus(instance, body=None, x__xgafv=None)</a></code></p> 115<p class="firstline">Reports the latest status for a runtime instance.</p> 116<h3>Method Details</h3> 117<div class="method"> 118 <code class="details" id="close">close()</code> 119 <pre>Close httplib2 connections.</pre> 120</div> 121 122<div class="method"> 123 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 124 <pre>Creates an Apigee runtime instance. The instance is accessible from the authorized network configured on the organization. **Note:** Not supported for Apigee hybrid. 125 126Args: 127 parent: string, Required. Name of the organization. Use the following structure in your request: `organizations/{org}`. (required) 128 body: object, The request body. 129 The object takes the form of: 130 131{ # Apigee runtime instance. 132 "createdAt": "A String", # Output only. Time the instance was created in milliseconds since epoch. 133 "description": "A String", # Optional. Description of the instance. 134 "diskEncryptionKeyName": "A String", # Customer Managed Encryption Key (CMEK) used for disk and volume encryption. Required for Apigee paid subscriptions only. Use the following format: `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)` 135 "displayName": "A String", # Optional. Display name for the instance. 136 "host": "A String", # Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service. 137 "lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch. 138 "location": "A String", # Required. Compute Engine location where the instance resides. 139 "name": "A String", # Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`. 140 "peeringCidrRange": "A String", # Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support `SLASH_16` to `SLASH_20` and defaults to `SLASH_16`. Evaluation organizations support only `SLASH_23`. 141 "port": "A String", # Output only. Port number of the exposed Apigee endpoint. 142 "runtimeVersion": "A String", # Output only. Version of the runtime system running in the instance. The runtime system is the set of components that serve the API Proxy traffic in your Environments. 143 "state": "A String", # Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use. 144} 145 146 x__xgafv: string, V1 error format. 147 Allowed values 148 1 - v1 error format 149 2 - v2 error format 150 151Returns: 152 An object of the form: 153 154 { # This resource represents a long-running operation that is the result of a network API call. 155 "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. 156 "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. 157 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 158 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 159 { 160 "a_key": "", # Properties of the object. Contains field @type with type URL. 161 }, 162 ], 163 "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. 164 }, 165 "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. 166 "a_key": "", # Properties of the object. Contains field @type with type URL. 167 }, 168 "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}`. 169 "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`. 170 "a_key": "", # Properties of the object. Contains field @type with type URL. 171 }, 172}</pre> 173</div> 174 175<div class="method"> 176 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 177 <pre>Deletes an Apigee runtime instance. The instance stops serving requests and the runtime data is deleted. **Note:** Not supported for Apigee hybrid. 178 179Args: 180 name: string, Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instances/{instance}`. (required) 181 x__xgafv: string, V1 error format. 182 Allowed values 183 1 - v1 error format 184 2 - v2 error format 185 186Returns: 187 An object of the form: 188 189 { # This resource represents a long-running operation that is the result of a network API call. 190 "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. 191 "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. 192 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 193 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 194 { 195 "a_key": "", # Properties of the object. Contains field @type with type URL. 196 }, 197 ], 198 "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. 199 }, 200 "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. 201 "a_key": "", # Properties of the object. Contains field @type with type URL. 202 }, 203 "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}`. 204 "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`. 205 "a_key": "", # Properties of the object. Contains field @type with type URL. 206 }, 207}</pre> 208</div> 209 210<div class="method"> 211 <code class="details" id="get">get(name, x__xgafv=None)</code> 212 <pre>Gets the details for an Apigee runtime instance. **Note:** Not supported for Apigee hybrid. 213 214Args: 215 name: string, Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instances/{instance}`. (required) 216 x__xgafv: string, V1 error format. 217 Allowed values 218 1 - v1 error format 219 2 - v2 error format 220 221Returns: 222 An object of the form: 223 224 { # Apigee runtime instance. 225 "createdAt": "A String", # Output only. Time the instance was created in milliseconds since epoch. 226 "description": "A String", # Optional. Description of the instance. 227 "diskEncryptionKeyName": "A String", # Customer Managed Encryption Key (CMEK) used for disk and volume encryption. Required for Apigee paid subscriptions only. Use the following format: `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)` 228 "displayName": "A String", # Optional. Display name for the instance. 229 "host": "A String", # Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service. 230 "lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch. 231 "location": "A String", # Required. Compute Engine location where the instance resides. 232 "name": "A String", # Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`. 233 "peeringCidrRange": "A String", # Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support `SLASH_16` to `SLASH_20` and defaults to `SLASH_16`. Evaluation organizations support only `SLASH_23`. 234 "port": "A String", # Output only. Port number of the exposed Apigee endpoint. 235 "runtimeVersion": "A String", # Output only. Version of the runtime system running in the instance. The runtime system is the set of components that serve the API Proxy traffic in your Environments. 236 "state": "A String", # Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use. 237}</pre> 238</div> 239 240<div class="method"> 241 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 242 <pre>Lists all Apigee runtime instances for the organization. **Note:** Not supported for Apigee hybrid. 243 244Args: 245 parent: string, Required. Name of the organization. Use the following structure in your request: `organizations/{org}`. (required) 246 pageSize: integer, Maximum number of instances to return. Defaults to 25. 247 pageToken: string, Page token, returned from a previous ListInstances call, that you can use to retrieve the next page of content. 248 x__xgafv: string, V1 error format. 249 Allowed values 250 1 - v1 error format 251 2 - v2 error format 252 253Returns: 254 An object of the form: 255 256 { # Response for ListInstances. 257 "instances": [ # Instances in the specified organization. 258 { # Apigee runtime instance. 259 "createdAt": "A String", # Output only. Time the instance was created in milliseconds since epoch. 260 "description": "A String", # Optional. Description of the instance. 261 "diskEncryptionKeyName": "A String", # Customer Managed Encryption Key (CMEK) used for disk and volume encryption. Required for Apigee paid subscriptions only. Use the following format: `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)` 262 "displayName": "A String", # Optional. Display name for the instance. 263 "host": "A String", # Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service. 264 "lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch. 265 "location": "A String", # Required. Compute Engine location where the instance resides. 266 "name": "A String", # Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`. 267 "peeringCidrRange": "A String", # Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support `SLASH_16` to `SLASH_20` and defaults to `SLASH_16`. Evaluation organizations support only `SLASH_23`. 268 "port": "A String", # Output only. Port number of the exposed Apigee endpoint. 269 "runtimeVersion": "A String", # Output only. Version of the runtime system running in the instance. The runtime system is the set of components that serve the API Proxy traffic in your Environments. 270 "state": "A String", # Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use. 271 }, 272 ], 273 "nextPageToken": "A String", # Page token that you can include in a ListInstance request to retrieve the next page of content. If omitted, no subsequent pages exist. 274}</pre> 275</div> 276 277<div class="method"> 278 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 279 <pre>Retrieves the next page of results. 280 281Args: 282 previous_request: The request for the previous page. (required) 283 previous_response: The response from the request for the previous page. (required) 284 285Returns: 286 A request object that you can call 'execute()' on to request the next 287 page. Returns None if there are no more items in the collection. 288 </pre> 289</div> 290 291<div class="method"> 292 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 293 <pre>Updates an Apigee runtime instance. You can update the fields described in NodeConfig. No other fields will be updated. **Note:** Not supported for Apigee hybrid. 294 295Args: 296 name: string, Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instances/{instance}`. (required) 297 body: object, The request body. 298 The object takes the form of: 299 300{ # Apigee runtime instance. 301 "createdAt": "A String", # Output only. Time the instance was created in milliseconds since epoch. 302 "description": "A String", # Optional. Description of the instance. 303 "diskEncryptionKeyName": "A String", # Customer Managed Encryption Key (CMEK) used for disk and volume encryption. Required for Apigee paid subscriptions only. Use the following format: `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)` 304 "displayName": "A String", # Optional. Display name for the instance. 305 "host": "A String", # Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service. 306 "lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch. 307 "location": "A String", # Required. Compute Engine location where the instance resides. 308 "name": "A String", # Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`. 309 "peeringCidrRange": "A String", # Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support `SLASH_16` to `SLASH_20` and defaults to `SLASH_16`. Evaluation organizations support only `SLASH_23`. 310 "port": "A String", # Output only. Port number of the exposed Apigee endpoint. 311 "runtimeVersion": "A String", # Output only. Version of the runtime system running in the instance. The runtime system is the set of components that serve the API Proxy traffic in your Environments. 312 "state": "A String", # Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use. 313} 314 315 updateMask: string, List of fields to be updated. 316 x__xgafv: string, V1 error format. 317 Allowed values 318 1 - v1 error format 319 2 - v2 error format 320 321Returns: 322 An object of the form: 323 324 { # This resource represents a long-running operation that is the result of a network API call. 325 "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. 326 "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. 327 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 328 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 329 { 330 "a_key": "", # Properties of the object. Contains field @type with type URL. 331 }, 332 ], 333 "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. 334 }, 335 "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. 336 "a_key": "", # Properties of the object. Contains field @type with type URL. 337 }, 338 "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}`. 339 "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`. 340 "a_key": "", # Properties of the object. Contains field @type with type URL. 341 }, 342}</pre> 343</div> 344 345<div class="method"> 346 <code class="details" id="reportStatus">reportStatus(instance, body=None, x__xgafv=None)</code> 347 <pre>Reports the latest status for a runtime instance. 348 349Args: 350 instance: string, The name of the instance reporting this status. For SaaS the request will be rejected if no instance exists under this name. Format is organizations/{org}/instances/{instance} (required) 351 body: object, The request body. 352 The object takes the form of: 353 354{ # Request for ReportInstanceStatus. 355 "instanceUid": "A String", # A unique ID for the instance which is guaranteed to be unique in case the user installs multiple hybrid runtimes with the same instance ID. 356 "reportTime": "A String", # The time the report was generated in the runtime. Used to prevent an old status from overwriting a newer one. An instance should space out it's status reports so that clock skew does not play a factor. 357 "resources": [ # Status for config resources 358 { # The status of a resource loaded in the runtime. 359 "resource": "A String", # The resource name. Currently only two resources are supported: EnvironmentGroup - organizations/{org}/envgroups/{envgroup} EnvironmentConfig - organizations/{org}/environments/{environment}/deployedConfig 360 "revisions": [ # Revisions of the resource currently deployed in the instance. 361 { # The status of a specific resource revision. 362 "errors": [ # Errors reported when attempting to load this revision. 363 { # Details on why a resource update failed in the runtime. 364 "code": "A String", # Status code. 365 "message": "A String", # User-friendly error message. 366 "resource": "A String", # The sub resource specific to this error (e.g. a proxy deployed within the EnvironmentConfig). If empty the error refers to the top level resource. 367 "type": "A String", # A string that uniquely identifies the type of error. This provides a more reliable means to deduplicate errors across revisions and instances. 368 }, 369 ], 370 "jsonSpec": "A String", # The json content of the resource revision. Large specs should be sent individually via the spec field to avoid hitting request size limits. 371 "replicas": 42, # The number of replicas that have successfully loaded this revision. 372 "revisionId": "A String", # The revision of the resource. 373 }, 374 ], 375 "totalReplicas": 42, # The total number of replicas that should have this resource. 376 "uid": "A String", # The uid of the resource. In the unexpected case that the instance has multiple uids for the same name, they should be reported under separate ResourceStatuses. 377 }, 378 ], 379} 380 381 x__xgafv: string, V1 error format. 382 Allowed values 383 1 - v1 error format 384 2 - v2 error format 385 386Returns: 387 An object of the form: 388 389 { # Placeholder for future enhancements to status reporting protocol 390}</pre> 391</div> 392 393</body></html>