Method: projects.locations.appConnectors.resolveInstanceConfig

Gets instance configuration for a given AppConnector. An internal method called by a AppConnector to get its container config.

HTTP request

GET https://beyondcorp.googleapis.com/v1/{appConnector=projects/*/locations/*/appConnectors/*}:resolveInstanceConfig

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
appConnector

string

Required. BeyondCorp AppConnector name using the form: projects/{project_id}/locations/{locationId}/appConnectors/{appConnector}

Authorization requires the following IAM permission on the specified resource appConnector:

  • beyondcorp.appConnectors.list

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for BeyondCorp.ResolveInstanceConfig.

JSON representation
{
  "instanceConfig": {
    object (AppConnectorInstanceConfig)
  }
}
Fields
instanceConfig

object (AppConnectorInstanceConfig)

AppConnectorInstanceConfig.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

AppConnectorInstanceConfig

AppConnectorInstanceConfig defines the instance config of a AppConnector.

JSON representation
{
  "sequenceNumber": string,
  "instanceConfig": {
    "@type": string,
    field1: ...,
    ...
  },
  "notificationConfig": {
    object (NotificationConfig)
  },
  "imageConfig": {
    object (ImageConfig)
  }
}
Fields
sequenceNumber

string (int64 format)

Required. A monotonically increasing number generated and maintained by the API provider. Every time a config changes in the backend, the sequenceNumber should be bumped up to reflect the change.

instanceConfig

object

The SLM instance agent configuration.

An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }.

notificationConfig

object (NotificationConfig)

NotificationConfig defines the notification mechanism that the remote instance should subscribe to in order to receive notification.

imageConfig

object (ImageConfig)

ImageConfig defines the GCR images to run for the remote agent's control plane.

NotificationConfig

NotificationConfig defines the mechanisms to notify instance agent.

JSON representation
{
  "pubsubNotification": {
    object (CloudPubSubNotificationConfig)
  }
}
Fields
pubsubNotification

object (CloudPubSubNotificationConfig)

Cloud Pub/Sub Configuration to receive notifications.

CloudPubSubNotificationConfig

The configuration for Pub/Sub messaging for the AppConnector.

JSON representation
{
  "pubsubSubscription": string
}
Fields
pubsubSubscription

string

The Pub/Sub subscription the AppConnector uses to receive notifications.

ImageConfig

ImageConfig defines the control plane images to run.

JSON representation
{
  "targetImage": string,
  "stableImage": string
}
Fields
targetImage

string

The initial image the remote agent will attempt to run for the control plane. Format would be a gcr image path, e.g.: gcr.io/PROJECT-ID/my-image:tag1

stableImage

string

The stable image that the remote agent will fallback to if the target image fails. Format would be a gcr image path, e.g.: gcr.io/PROJECT-ID/my-image:tag1