Apigee API . organizations . instances

Instance Methods

attachments()

Returns the attachments Resource.

create(parent, body=None, x__xgafv=None)

Creates an Apigee runtime instance. The instance is accessible from the

delete(name, x__xgafv=None)

Deletes an Apigee runtime instance. The instance stops serving

get(name, x__xgafv=None)

Gets the details for an Apigee runtime instance.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists all Apigee runtime instances for the organization.

list_next(previous_request, previous_response)

Retrieves the next page of results.

reportStatus(instance, body=None, x__xgafv=None)

Reports the latest status for a runtime instance.

Method Details

create(parent, body=None, x__xgafv=None)
Creates an Apigee runtime instance. The instance is accessible from the
authorized network configured on the organization.

**Note:** Not supported for Apigee hybrid.

Args:
  parent: string, Required. Name of the organization. Use the following structure in your request:
  `organizations/{org}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Apigee runtime instance.
  "location": "A String", # Required. Compute Engine location where the instance resides.
  "diskEncryptionKeyName": "A String", # Optional. Customer Managed Encryption Key (CMEK) used for disk & volume encryption.
  "displayName": "A String", # Optional. Display name for the instance.
  "name": "A String", # Required. Resource ID of the instance. Values must match the
      # regular expression `^a-z{0,30}[a-z\d]$`.
  "port": "A String", # Output only. Port number of the exposed Apigee endpoint.
  "createdAt": "A String", # Output only. Time the instance was created in milliseconds since epoch.
  "host": "A String", # Output only. Hostname or IP address of the exposed Apigee endpoint used by clients to
      # connect to the service.
  "lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch.
  "description": "A String", # Optional. Description of the instance.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "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.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "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`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "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.
    "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}`.
    "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.
        # 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).
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "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.
      "details": [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
  }
delete(name, x__xgafv=None)
Deletes an Apigee runtime instance. The instance stops serving
requests and the runtime data is deleted.

**Note:** Not supported for Apigee hybrid.

Args:
  name: string, Name of the instance. Use the following structure in your request:
  `organizations/{org}/instance/{instance}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "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.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "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`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "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.
    "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}`.
    "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.
        # 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).
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "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.
      "details": [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
  }
get(name, x__xgafv=None)
Gets the details for an Apigee runtime instance.

**Note:** Not supported for Apigee hybrid.

Args:
  name: string, Name of the instance. Use the following structure in your request:
  `organizations/{org}/instances/{instance}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Apigee runtime instance.
    "location": "A String", # Required. Compute Engine location where the instance resides.
    "diskEncryptionKeyName": "A String", # Optional. Customer Managed Encryption Key (CMEK) used for disk & volume encryption.
    "displayName": "A String", # Optional. Display name for the instance.
    "name": "A String", # Required. Resource ID of the instance. Values must match the
        # regular expression `^a-z{0,30}[a-z\d]$`.
    "port": "A String", # Output only. Port number of the exposed Apigee endpoint.
    "createdAt": "A String", # Output only. Time the instance was created in milliseconds since epoch.
    "host": "A String", # Output only. Hostname or IP address of the exposed Apigee endpoint used by clients to
        # connect to the service.
    "lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch.
    "description": "A String", # Optional. Description of the instance.
  }
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists all Apigee runtime instances for the organization.

**Note:** Not supported for Apigee hybrid.

Args:
  parent: string, Name of the organization. Use the following structure in your request:
  `organizations/{org}`. (required)
  pageSize: integer, Maximum number of instances to return. Defaults to 25.
  pageToken: string, Page token, returned from a previous ListInstances call, that you can
use to retrieve the next page of content.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for ListInstances.
    "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.
    "instances": [ # Instances in the specified organization.
      { # Apigee runtime instance.
        "location": "A String", # Required. Compute Engine location where the instance resides.
        "diskEncryptionKeyName": "A String", # Optional. Customer Managed Encryption Key (CMEK) used for disk & volume encryption.
        "displayName": "A String", # Optional. Display name for the instance.
        "name": "A String", # Required. Resource ID of the instance. Values must match the
            # regular expression `^a-z{0,30}[a-z\d]$`.
        "port": "A String", # Output only. Port number of the exposed Apigee endpoint.
        "createdAt": "A String", # Output only. Time the instance was created in milliseconds since epoch.
        "host": "A String", # Output only. Hostname or IP address of the exposed Apigee endpoint used by clients to
            # connect to the service.
        "lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch.
        "description": "A String", # Optional. Description of the instance.
      },
    ],
  }
list_next(previous_request, previous_response)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    
reportStatus(instance, body=None, x__xgafv=None)
Reports the latest status for a runtime instance.

Args:
  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)
  body: object, The request body.
    The object takes the form of:

{ # Request for ReportInstanceStatus.
    "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.
    "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.
    "resources": [ # Status for config resources
      { # The status of a resource loaded in the runtime.
        "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.
        "totalReplicas": 42, # The total number of replicas that should have this resource.
        "revisions": [ # Revisions of the resource currently deployed in the instance.
          { # The status of a specific resource revision.
            "replicas": 42, # The number of replicas that have successfully loaded this revision.
            "errors": [ # Errors reported when attempting to load this revision.
              { # Details on why a resource update failed in the runtime.
                "code": "A String", # Status code.
                "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.
                "message": "A String", # User-friendly error message.
                "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.
              },
            ],
            "jsonSpec": "A String", # The json content of the resource revision.
            "revisionId": "A String", # The revision of the resource.
          },
        ],
        "resource": "A String", # The resource name. Currently only two resources are supported:
            # EnvironmentGroup - organizations/{org}/envgroups/{envgroup}
            # EnvironmentConfig -
            # organizations/{org}/environments/{environment}/deployedConfig
      },
    ],
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Placeholder for future enhancements to status reporting protocol
  }