Method Detail

• list

  @Named(value="archive:list")
  @POST
  @Path(value="/archive/list/format/json")
  @Consumes(value="application/json")
  com.google.common.collect.FluentIterable<Archive> list()

  Lists all active disks on this account.

• get

  @Named(value="archive:details")
  @POST
  @Path(value="/archive/details/format/json")
  @Consumes(value="application/json")
  Archive get(@FormParam(value="username")
                                     String username)

  Get detailed information about an archive volume.

  Parameters:

  username - the username associated with the archive

  Returns:

  the archive information or null if not found

• createWithCredentialsAndSize

  @Named(value="archive:create")
  @POST
  @Path(value="/archive/create/format/json")
  @Consumes(value="application/json")
  Archive createWithCredentialsAndSize(@FormParam(value="username")
                                                              String username,
                                                              @FormParam(value="password")
                                                              String password,
                                                              @FormParam(value="size")
                                                              int size)

  Create a new backup volume.

  Parameters:

  username - the archive username, this must be prefixed by Glesys account name (in lower case) and an underscore, ex. "c100005_archive1"

  password - the new password

  size - the new size required in GB

• delete

  @Named(value="archive:delete")
  @POST
  @Path(value="/archive/delete/format/json")
  void delete(@FormParam(value="username")
                            String username)

  Delete an archive volume. All files on the volume

  Parameters:

  username - the username associated with the archive

• resize

  @Named(value="archive:resize")
  @POST
  @Path(value="/archive/resize/format/json")
  @Consumes(value="application/json")
  Archive resize(@FormParam(value="username")
                                        String username,
                                        @FormParam(value="size")
                                        int size)

  Resize an archive volume. It is only possible to upgrade the size of the disk. Downgrading is currently not supported. If you need to downgrade, please create a new volume and transfer all data to the new volume. Then delete the old volume.

  Parameters:

  username - the username associated with the archive

  size - the new size required, see #getAllowedArguments for valid values

• changePassword

  @Named(value="archive:changepassword")
  @POST
  @Path(value="/archive/changepassword/format/json")
  @Consumes(value="application/json")
  Archive changePassword(@FormParam(value="username")
                                                String username,
                                                @FormParam(value="password")
                                                String password)

  Change the password for an archive user.

  Parameters:

  username - the archive username

  password - the new password

• getAllowedArguments

  @Named(value="archive:allowedarguments")
  @GET
  @Path(value="/archive/allowedarguments/format/json")
  @Consumes(value="application/json")
  ArchiveAllowedArguments getAllowedArguments()

  Lists the allowed arguments for some of the functions in this module such as archive size.