ControllerAPIv3 provides the v3 Controller API.

Hierarchy

  • default

Implements

Constructors

Properties

NAME: string = "Controller"
VERSION: number = 3
_transport: Transport
NAME: string = "Controller"
VERSION: number = 3

Methods

  • AllModels allows controller administrators to get the list of all the models in the controller.

    Parameters

    • params: any

    Returns Promise<UserModelList>

  • ControllerConfig returns the controller's configuration.

    Parameters

    • params: any

    Returns Promise<ControllerConfigResult>

  • DestroyController destroys the controller.

    The v3 implementation of DestroyController ignores the DestroyStorage field of the arguments, and unconditionally destroys all storage in the controller.

    See ControllerAPIv4.DestroyController for more details.

    Parameters

    Returns Promise<any>

  • GetCloudSpec constructs the CloudSpec for a validated and authorized model.

    Parameters

    Returns Promise<CloudSpecResult>

  • GetControllerAccess returns the level of access the specified users have on the controller.

    Parameters

    Returns Promise<UserAccessResults>

  • HostedModelConfigs returns all the information that the client needs in order to connect directly with the host model's provider and destroy it directly.

    Parameters

    • params: any

    Returns Promise<HostedModelConfigsResults>

  • IdentityProviderURL isn't on the v6 API.

    Parameters

    • params: any

    Returns Promise<any>

  • ListBlockedModels returns a list of all models on the controller which have a block in place. The resulting slice is sorted by model name, then owner. Callers must be controller administrators to retrieve the list.

    Parameters

    • params: any

    Returns Promise<ModelBlockInfoList>

  • ModelConfig returns the model config for the controller model. For information on the current model, use client.ModelGet

    Parameters

    • params: any

    Returns Promise<ModelConfigResults>

  • ModelStatus is a legacy method call to ensure that we preserve backward compatibility. TODO (anastasiamac 2017-10-26) This should be made obsolete/removed.

    Parameters

    Returns Promise<ModelStatusResults>

  • MongoVersion isn't on the v5 API.

    Parameters

    • params: any

    Returns Promise<any>

  • RemoveBlocks removes all the blocks in the controller.

    Parameters

    Returns Promise<any>

  • WatchAllModels starts watching events for all models in the controller. The returned AllWatcherId should be used with Next on the AllModelWatcher endpoint to receive deltas.

    Parameters

    • params: any

    Returns Promise<AllWatcherId>

Generated using TypeDoc