| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 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="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="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| 84 | <p class="firstline">Creates an Apigee runtime instance. The instance is accessible from the</p> |
| 85 | <p class="toc_element"> |
| 86 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 87 | <p class="firstline">Deletes an Apigee runtime instance. The instance stops serving</p> |
| 88 | <p class="toc_element"> |
| 89 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 90 | <p class="firstline">Gets the details for an Apigee runtime instance.</p> |
| 91 | <p class="toc_element"> |
| 92 | <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 93 | <p class="firstline">Lists all Apigee runtime instances for the organization.</p> |
| 94 | <p class="toc_element"> |
| 95 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 96 | <p class="firstline">Retrieves the next page of results.</p> |
| 97 | <p class="toc_element"> |
| 98 | <code><a href="#reportStatus">reportStatus(instance, body=None, x__xgafv=None)</a></code></p> |
| 99 | <p class="firstline">Reports the latest status for a runtime instance.</p> |
| 100 | <h3>Method Details</h3> |
| 101 | <div class="method"> |
| 102 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| 103 | <pre>Creates an Apigee runtime instance. The instance is accessible from the |
| 104 | authorized network configured on the organization. |
| 105 | |
| 106 | **Note:** Not supported for Apigee hybrid. |
| 107 | |
| 108 | Args: |
| 109 | parent: string, Required. Name of the organization. Use the following structure in your request: |
| 110 | `organizations/{org}`. (required) |
| 111 | body: object, The request body. |
| 112 | The object takes the form of: |
| 113 | |
| 114 | { # Apigee runtime instance. |
| 115 | "location": "A String", # Required. Compute Engine location where the instance resides. |
| 116 | "diskEncryptionKeyName": "A String", # Optional. Customer Managed Encryption Key (CMEK) used for disk & volume encryption. |
| 117 | "displayName": "A String", # Optional. Display name for the instance. |
| 118 | "name": "A String", # Required. Resource ID of the instance. Values must match the |
| 119 | # regular expression `^a-z{0,30}[a-z\d]$`. |
| 120 | "port": "A String", # Output only. Port number of the exposed Apigee endpoint. |
| 121 | "createdAt": "A String", # Output only. Time the instance was created in milliseconds since epoch. |
| 122 | "host": "A String", # Output only. Hostname or IP address of the exposed Apigee endpoint used by clients to |
| 123 | # connect to the service. |
| 124 | "lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch. |
| 125 | "description": "A String", # Optional. Description of the instance. |
| 126 | } |
| 127 | |
| 128 | x__xgafv: string, V1 error format. |
| 129 | Allowed values |
| 130 | 1 - v1 error format |
| 131 | 2 - v2 error format |
| 132 | |
| 133 | Returns: |
| 134 | An object of the form: |
| 135 | |
| 136 | { # This resource represents a long-running operation that is the result of a |
| 137 | # network API call. |
| 138 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 139 | # contains progress information and common metadata such as create time. |
| 140 | # Some services might not provide such metadata. Any method that returns a |
| 141 | # long-running operation should document the metadata type, if any. |
| 142 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 143 | }, |
| 144 | "response": { # The normal response of the operation in case of success. If the original |
| 145 | # method returns no data on success, such as `Delete`, the response is |
| 146 | # `google.protobuf.Empty`. If the original method is standard |
| 147 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 148 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 149 | # is the original method name. For example, if the original method name |
| 150 | # is `TakeSnapshot()`, the inferred response type is |
| 151 | # `TakeSnapshotResponse`. |
| 152 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 153 | }, |
| 154 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 155 | # If `true`, the operation is completed, and either `error` or `response` is |
| 156 | # available. |
| 157 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 158 | # originally returns it. If you use the default HTTP mapping, the |
| 159 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| 160 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 161 | # different programming environments, including REST APIs and RPC APIs. It is |
| 162 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 163 | # three pieces of data: error code, error message, and error details. |
| 164 | # |
| 165 | # You can find out more about this error model and how to work with it in the |
| 166 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 167 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 168 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 169 | # user-facing error message should be localized and sent in the |
| 170 | # google.rpc.Status.details field, or localized by the client. |
| 171 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 172 | # message types for APIs to use. |
| 173 | { |
| 174 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 175 | }, |
| 176 | ], |
| 177 | }, |
| 178 | }</pre> |
| 179 | </div> |
| 180 | |
| 181 | <div class="method"> |
| 182 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 183 | <pre>Deletes an Apigee runtime instance. The instance stops serving |
| 184 | requests and the runtime data is deleted. |
| 185 | |
| 186 | **Note:** Not supported for Apigee hybrid. |
| 187 | |
| 188 | Args: |
| 189 | name: string, Name of the instance. Use the following structure in your request: |
| 190 | `organizations/{org}/instance/{instance}`. (required) |
| 191 | x__xgafv: string, V1 error format. |
| 192 | Allowed values |
| 193 | 1 - v1 error format |
| 194 | 2 - v2 error format |
| 195 | |
| 196 | Returns: |
| 197 | An object of the form: |
| 198 | |
| 199 | { # This resource represents a long-running operation that is the result of a |
| 200 | # network API call. |
| 201 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 202 | # contains progress information and common metadata such as create time. |
| 203 | # Some services might not provide such metadata. Any method that returns a |
| 204 | # long-running operation should document the metadata type, if any. |
| 205 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 206 | }, |
| 207 | "response": { # The normal response of the operation in case of success. If the original |
| 208 | # method returns no data on success, such as `Delete`, the response is |
| 209 | # `google.protobuf.Empty`. If the original method is standard |
| 210 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 211 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 212 | # is the original method name. For example, if the original method name |
| 213 | # is `TakeSnapshot()`, the inferred response type is |
| 214 | # `TakeSnapshotResponse`. |
| 215 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 216 | }, |
| 217 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 218 | # If `true`, the operation is completed, and either `error` or `response` is |
| 219 | # available. |
| 220 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 221 | # originally returns it. If you use the default HTTP mapping, the |
| 222 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| 223 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 224 | # different programming environments, including REST APIs and RPC APIs. It is |
| 225 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 226 | # three pieces of data: error code, error message, and error details. |
| 227 | # |
| 228 | # You can find out more about this error model and how to work with it in the |
| 229 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 230 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 231 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 232 | # user-facing error message should be localized and sent in the |
| 233 | # google.rpc.Status.details field, or localized by the client. |
| 234 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 235 | # message types for APIs to use. |
| 236 | { |
| 237 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 238 | }, |
| 239 | ], |
| 240 | }, |
| 241 | }</pre> |
| 242 | </div> |
| 243 | |
| 244 | <div class="method"> |
| 245 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 246 | <pre>Gets the details for an Apigee runtime instance. |
| 247 | |
| 248 | **Note:** Not supported for Apigee hybrid. |
| 249 | |
| 250 | Args: |
| 251 | name: string, Name of the instance. Use the following structure in your request: |
| 252 | `organizations/{org}/instances/{instance}`. (required) |
| 253 | x__xgafv: string, V1 error format. |
| 254 | Allowed values |
| 255 | 1 - v1 error format |
| 256 | 2 - v2 error format |
| 257 | |
| 258 | Returns: |
| 259 | An object of the form: |
| 260 | |
| 261 | { # Apigee runtime instance. |
| 262 | "location": "A String", # Required. Compute Engine location where the instance resides. |
| 263 | "diskEncryptionKeyName": "A String", # Optional. Customer Managed Encryption Key (CMEK) used for disk & volume encryption. |
| 264 | "displayName": "A String", # Optional. Display name for the instance. |
| 265 | "name": "A String", # Required. Resource ID of the instance. Values must match the |
| 266 | # regular expression `^a-z{0,30}[a-z\d]$`. |
| 267 | "port": "A String", # Output only. Port number of the exposed Apigee endpoint. |
| 268 | "createdAt": "A String", # Output only. Time the instance was created in milliseconds since epoch. |
| 269 | "host": "A String", # Output only. Hostname or IP address of the exposed Apigee endpoint used by clients to |
| 270 | # connect to the service. |
| 271 | "lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch. |
| 272 | "description": "A String", # Optional. Description of the instance. |
| 273 | }</pre> |
| 274 | </div> |
| 275 | |
| 276 | <div class="method"> |
| 277 | <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 278 | <pre>Lists all Apigee runtime instances for the organization. |
| 279 | |
| 280 | **Note:** Not supported for Apigee hybrid. |
| 281 | |
| 282 | Args: |
| 283 | parent: string, Name of the organization. Use the following structure in your request: |
| 284 | `organizations/{org}`. (required) |
| 285 | pageSize: integer, Maximum number of instances to return. Defaults to 25. |
| 286 | pageToken: string, Page token, returned from a previous ListInstances call, that you can |
| 287 | use to retrieve the next page of content. |
| 288 | x__xgafv: string, V1 error format. |
| 289 | Allowed values |
| 290 | 1 - v1 error format |
| 291 | 2 - v2 error format |
| 292 | |
| 293 | Returns: |
| 294 | An object of the form: |
| 295 | |
| 296 | { # Response for ListInstances. |
| 297 | "nextPageToken": "A String", # Page token that you can include in a ListInstance request to retrieve |
| 298 | # the next page of content. If omitted, no subsequent pages exist. |
| 299 | "instances": [ # Instances in the specified organization. |
| 300 | { # Apigee runtime instance. |
| 301 | "location": "A String", # Required. Compute Engine location where the instance resides. |
| 302 | "diskEncryptionKeyName": "A String", # Optional. Customer Managed Encryption Key (CMEK) used for disk & volume encryption. |
| 303 | "displayName": "A String", # Optional. Display name for the instance. |
| 304 | "name": "A String", # Required. Resource ID of the instance. Values must match the |
| 305 | # regular expression `^a-z{0,30}[a-z\d]$`. |
| 306 | "port": "A String", # Output only. Port number of the exposed Apigee endpoint. |
| 307 | "createdAt": "A String", # Output only. Time the instance was created in milliseconds since epoch. |
| 308 | "host": "A String", # Output only. Hostname or IP address of the exposed Apigee endpoint used by clients to |
| 309 | # connect to the service. |
| 310 | "lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch. |
| 311 | "description": "A String", # Optional. Description of the instance. |
| 312 | }, |
| 313 | ], |
| 314 | }</pre> |
| 315 | </div> |
| 316 | |
| 317 | <div class="method"> |
| 318 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 319 | <pre>Retrieves the next page of results. |
| 320 | |
| 321 | Args: |
| 322 | previous_request: The request for the previous page. (required) |
| 323 | previous_response: The response from the request for the previous page. (required) |
| 324 | |
| 325 | Returns: |
| 326 | A request object that you can call 'execute()' on to request the next |
| 327 | page. Returns None if there are no more items in the collection. |
| 328 | </pre> |
| 329 | </div> |
| 330 | |
| 331 | <div class="method"> |
| 332 | <code class="details" id="reportStatus">reportStatus(instance, body=None, x__xgafv=None)</code> |
| 333 | <pre>Reports the latest status for a runtime instance. |
| 334 | |
| 335 | Args: |
| 336 | instance: string, The name of the instance reporting this status. For SaaS the request |
| 337 | will be rejected if no instance exists under this name. |
| 338 | Format is organizations/{org}/instances/{instance} (required) |
| 339 | body: object, The request body. |
| 340 | The object takes the form of: |
| 341 | |
| 342 | { # Request for ReportInstanceStatus. |
| 343 | "reportTime": "A String", # The time the report was generated in the runtime. Used to prevent an old |
| 344 | # status from overwriting a newer one. An instance should space out it's |
| 345 | # status reports so that clock skew does not play a factor. |
| 346 | "instanceUid": "A String", # A unique ID for the instance which is guaranteed to be unique in case the |
| 347 | # user installs multiple hybrid runtimes with the same instance ID. |
| 348 | "resources": [ # Status for config resources |
| 349 | { # The status of a resource loaded in the runtime. |
| 350 | "uid": "A String", # The uid of the resource. In the unexpected case that the instance has |
| 351 | # multiple uids for the same name, they should be reported under separate |
| 352 | # ResourceStatuses. |
| 353 | "totalReplicas": 42, # The total number of replicas that should have this resource. |
| 354 | "revisions": [ # Revisions of the resource currently deployed in the instance. |
| 355 | { # The status of a specific resource revision. |
| 356 | "replicas": 42, # The number of replicas that have successfully loaded this revision. |
| 357 | "errors": [ # Errors reported when attempting to load this revision. |
| 358 | { # Details on why a resource update failed in the runtime. |
| 359 | "code": "A String", # Status code. |
| 360 | "resource": "A String", # The sub resource specific to this error (e.g. a proxy deployed within the |
| 361 | # EnvironmentConfig). If empty the error refers to the top level resource. |
| 362 | "message": "A String", # User-friendly error message. |
| 363 | "type": "A String", # A string that uniquely identifies the type of error. This provides a |
| 364 | # more reliable means to deduplicate errors across revisions and instances. |
| 365 | }, |
| 366 | ], |
| 367 | "jsonSpec": "A String", # The json content of the resource revision. |
| 368 | "revisionId": "A String", # The revision of the resource. |
| 369 | }, |
| 370 | ], |
| 371 | "resource": "A String", # The resource name. Currently only two resources are supported: |
| 372 | # EnvironmentGroup - organizations/{org}/envgroups/{envgroup} |
| 373 | # EnvironmentConfig - |
| 374 | # organizations/{org}/environments/{environment}/deployedConfig |
| 375 | }, |
| 376 | ], |
| 377 | } |
| 378 | |
| 379 | x__xgafv: string, V1 error format. |
| 380 | Allowed values |
| 381 | 1 - v1 error format |
| 382 | 2 - v2 error format |
| 383 | |
| 384 | Returns: |
| 385 | An object of the form: |
| 386 | |
| 387 | { # Placeholder for future enhancements to status reporting protocol |
| 388 | }</pre> |
| 389 | </div> |
| 390 | |
| 391 | </body></html> |