PHP Class Acquia\Cloud\Api\CloudApiClient

Inheritance: extends Guzzle\Service\Client, implements Acquia\Rest\ServiceManagerAware
Afficher le fichier Open project: acquia/acquia-sdk-php-cloud-api Class Usage Examples

Méthodes publiques

Méthode Description
addDatabase ( string $site, string $db, array $cluster_map = NULL ) : Acquia\Cloud\Api\Response\Task
addDomain ( string $site, string $env, string $domain ) : Acquia\Cloud\Api\Response\Task
addSshKey ( string $site, string $publicKey, string $nickname, boolean $shellAccess = true, boolean $vcsAccess = true, array $blacklist = [] ) : Acquia\Cloud\Api\Response\Task
addSvnUser ( string $site, string $username, string $password ) : Acquia\Cloud\Api\Response\Task
codeDeploy ( $site, $source, $target )
copyDatabase ( string $site, string $db, string $sourceEnv, string $targetEnv ) : Acquia\Cloud\Api\Response\Task
copyFiles ( string $site, string $sourceEnv, string $targetEnv ) : Acquia\Cloud\Api\Response\Task
createDatabaseBackup ( string $site, string $env, string $db ) : Acquia\Cloud\Api\Response\Task
database ( string $site, string $db ) : Acquia\Cloud\Api\Response\DatabaseName
databaseBackup ( string $site, string $env, string $db, integer $backupId ) : Acquia\Cloud\Api\Response\Task
databaseBackups ( string $site, string $env, string $db ) : Acquia\Cloud\Api\Response\DatabaseBackups
databases ( string $site ) : Acquia\Cloud\Api\Response\DatabaseNames
deleteDatabase ( string $site, string $db, boolean $backup = TRUE ) : Acquia\Cloud\Api\Response\Task
deleteDatabaseBackup ( string $site, string $env, string $db, integer $backupId ) : Acquia\Cloud\Api\Response\Task
deleteDomain ( string $site, string $env, string $domain ) : Acquia\Cloud\Api\Response\Task
deleteSshKey ( string $site, integer $keyId ) : Acquia\Cloud\Api\Response\Task
deleteSvnUser ( string $site, integer $userId ) : Acquia\Cloud\Api\Response\Task
deployCode ( string $site, string $sourceEnv, string $targetEnv ) : Acquia\Cloud\Api\Response\Task Deploy code from on environment to another.
disableLiveDev ( string $site, string $env, boolean $discard = false ) : Acquia\Cloud\Api\Response\Task
domain ( string $site, string $env, string $domain ) : Acquia\Cloud\Api\Response\Domain
domains ( string $site, string $env ) : Acquia\Cloud\Api\Response\Domains
downloadDatabaseBackup ( string $site, string $env, string $db, integer $backupId, string $outfile ) : Guzzle\Http\Message\Response
enableLiveDev ( string $site, string $env, boolean $discard = false ) : Acquia\Cloud\Api\Response\Task
environment ( string $site, string $env ) : Acquia\Cloud\Api\Response\Environment
environmentDatabase ( string $site, string $env, string $db ) : Acquia\Cloud\Api\Response\Database
environmentDatabases ( string $site, string $env ) : Acquia\Cloud\Api\Response\Databases
environments ( string $site ) : Acquia\Cloud\Api\Response\Environments
factory ( $config = [] ) : CloudApiClient
getBuilderParams ( )
installDistro ( string $site, string $env, string $type, string $source ) : Acquia\Cloud\Api\Response\Task
installDistroByMakefile ( string $site, string $env, string $makefileUrl ) : Acquia\Cloud\Api\Response\Task Install a distro by passing a URL to a Drush makefile.
installDistroByName ( string $site, string $env, string $distro ) : Acquia\Cloud\Api\Response\Task Install one of Acquia Cloud’s built-in supported distros.
installDistroByProject ( string $site, string $env, string $projectName, string $version ) : Acquia\Cloud\Api\Response\Task Install any publicly accessible, standard Drupal distribution.
liveDev ( string $site, string $env, string $action, boolean $discard = false ) : Acquia\Cloud\Api\Response\Task
moveDomain ( string $site, string | array $domains, string $sourceEnv, string $targetEnv, boolean $skipSiteUpdate = FALSE ) : Acquia\Cloud\Api\Response\Task Moves domains atomically from one environment to another.
purgeVarnishCache ( string $site, string $env, string $domain ) : Acquia\Cloud\Api\Response\Task
pushCode ( string $site, string $env, string $vcsPath ) : Acquia\Cloud\Api\Response\Task Deploy a tag or branch to an environment.
restoreDatabaseBackup ( string $site, string $env, string $db, string $backupId ) : Acquia\Cloud\Api\Response\Task
server ( string $site, string $env, string $server ) : Acquia\Cloud\Api\Response\Server
servers ( string $site, string $env ) : Acquia\Cloud\Api\Response\Servers
site ( string $site ) : Acquia\Cloud\Api\Response\Site
siteDatabase ( $site, $db )
siteDatabases ( $site )
sites ( ) : Acquia\Cloud\Api\Response\SiteNames
sshKey ( string $site, integer $keyId ) : Acquia\Cloud\Api\Response\SshKey
sshKeys ( string $site ) : Acquia\Cloud\Api\Response\SshKeys
svnUser ( string $site, integer $userId ) : Acquia\Cloud\Api\Response\SvnUser
svnUsers ( string $site ) : Acquia\Cloud\Api\Response\SvnUsers
task ( string $site, integer $taskId ) : Acquia\Cloud\Api\Response\Task
taskInfo ( $site, $taskId )
tasks ( string $site ) : Acquia\Cloud\Api\Response\Tasks

Method Details

addDatabase() public méthode

See also: http://cloudapi.acquia.com/#POST__sites__site_dbs-instance_route
public addDatabase ( string $site, string $db, array $cluster_map = NULL ) : Acquia\Cloud\Api\Response\Task
$site string
$db string
$cluster_map array Optional. A mapping containing all environments and the cluster to which the associated database should be created. Each entry consists of the environment name as the key and the database cluster ID as the value. Note that if more than one cluster is associated with a site group, this map is required.
Résultat Acquia\Cloud\Api\Response\Task

addDomain() public méthode

See also: http://cloudapi.acquia.com/#POST__sites__site_envs__env_domains__domain-instance_route
public addDomain ( string $site, string $env, string $domain ) : Acquia\Cloud\Api\Response\Task
$site string
$env string
$domain string
Résultat Acquia\Cloud\Api\Response\Task

addSshKey() public méthode

See also: http://cloudapi.acquia.com/#POST__sites__site_sshkeys-instance_route
public addSshKey ( string $site, string $publicKey, string $nickname, boolean $shellAccess = true, boolean $vcsAccess = true, array $blacklist = [] ) : Acquia\Cloud\Api\Response\Task
$site string
$publicKey string
$nickname string
$shellAccess boolean
$vcsAccess boolean
$blacklist array
Résultat Acquia\Cloud\Api\Response\Task

addSvnUser() public méthode

See also: http://cloudapi.acquia.com/#POST__sites__site_svnusers__username-instance_route
public addSvnUser ( string $site, string $username, string $password ) : Acquia\Cloud\Api\Response\Task
$site string
$username string
$password string
Résultat Acquia\Cloud\Api\Response\Task

codeDeploy() public méthode

Deprecation: since version 0.5.0
public codeDeploy ( $site, $source, $target )

copyDatabase() public méthode

See also: http://cloudapi.acquia.com/#POST__sites__site_dbs__db_db_copy__source__target-instance_route
public copyDatabase ( string $site, string $db, string $sourceEnv, string $targetEnv ) : Acquia\Cloud\Api\Response\Task
$site string
$db string
$sourceEnv string
$targetEnv string
Résultat Acquia\Cloud\Api\Response\Task

copyFiles() public méthode

See also: http://cloudapi.acquia.com/#POST__sites__site_files_copy__source__target-instance_route
public copyFiles ( string $site, string $sourceEnv, string $targetEnv ) : Acquia\Cloud\Api\Response\Task
$site string
$sourceEnv string
$targetEnv string
Résultat Acquia\Cloud\Api\Response\Task

createDatabaseBackup() public méthode

See also: http://cloudapi.acquia.com/#POST__sites__site_envs__env_dbs__db_backups-instance_route
public createDatabaseBackup ( string $site, string $env, string $db ) : Acquia\Cloud\Api\Response\Task
$site string
$env string
$db string
Résultat Acquia\Cloud\Api\Response\Task

database() public méthode

See also: http://cloudapi.acquia.com/#GET__sites__site_dbs__db-instance_route
public database ( string $site, string $db ) : Acquia\Cloud\Api\Response\DatabaseName
$site string
$db string
Résultat Acquia\Cloud\Api\Response\DatabaseName

databaseBackup() public méthode

See also: http://cloudapi.acquia.com/#GET__sites__site_envs__env_dbs__db_backups__backup-instance_route
public databaseBackup ( string $site, string $env, string $db, integer $backupId ) : Acquia\Cloud\Api\Response\Task
$site string
$env string
$db string
$backupId integer
Résultat Acquia\Cloud\Api\Response\Task

databaseBackups() public méthode

See also: http://cloudapi.acquia.com/#GET__sites__site_envs__env_dbs__db_backups-instance_route
public databaseBackups ( string $site, string $env, string $db ) : Acquia\Cloud\Api\Response\DatabaseBackups
$site string
$env string
$db string
Résultat Acquia\Cloud\Api\Response\DatabaseBackups

databases() public méthode

See also: http://cloudapi.acquia.com/#GET__sites__site_dbs-instance_route
public databases ( string $site ) : Acquia\Cloud\Api\Response\DatabaseNames
$site string
Résultat Acquia\Cloud\Api\Response\DatabaseNames

deleteDatabase() public méthode

See also: http://cloudapi.acquia.com/#DELETE__sites__site_dbs__db-instance_route
public deleteDatabase ( string $site, string $db, boolean $backup = TRUE ) : Acquia\Cloud\Api\Response\Task
$site string
$db string
$backup boolean Optional. If TRUE, a final backup of the database instance in each environment is made before deletion.
Résultat Acquia\Cloud\Api\Response\Task

deleteDatabaseBackup() public méthode

See also: http://cloudapi.acquia.com/#DELETE__sites__site_envs__env_dbs__db_backups__backup-instance_route
public deleteDatabaseBackup ( string $site, string $env, string $db, integer $backupId ) : Acquia\Cloud\Api\Response\Task
$site string
$env string
$db string
$backupId integer
Résultat Acquia\Cloud\Api\Response\Task

deleteDomain() public méthode

See also: http://cloudapi.acquia.com/#DELETE__sites__site_envs__env_domains__domain-instance_route
public deleteDomain ( string $site, string $env, string $domain ) : Acquia\Cloud\Api\Response\Task
$site string
$env string
$domain string
Résultat Acquia\Cloud\Api\Response\Task

deleteSshKey() public méthode

See also: http://cloudapi.acquia.com/#DELETE__sites__site_sshkeys__sshkeyid-instance_route
public deleteSshKey ( string $site, integer $keyId ) : Acquia\Cloud\Api\Response\Task
$site string
$keyId integer
Résultat Acquia\Cloud\Api\Response\Task

deleteSvnUser() public méthode

See also: http://cloudapi.acquia.com/#DELETE__sites__site_svnusers__svnuserid-instance_route
public deleteSvnUser ( string $site, integer $userId ) : Acquia\Cloud\Api\Response\Task
$site string
$userId integer
Résultat Acquia\Cloud\Api\Response\Task

deployCode() public méthode

Deploy code from on environment to another.
See also: http://cloudapi.acquia.com/#POST__sites__site_code_deploy__source__target-instance_route
public deployCode ( string $site, string $sourceEnv, string $targetEnv ) : Acquia\Cloud\Api\Response\Task
$site string
$sourceEnv string
$targetEnv string
Résultat Acquia\Cloud\Api\Response\Task

disableLiveDev() public méthode

public disableLiveDev ( string $site, string $env, boolean $discard = false ) : Acquia\Cloud\Api\Response\Task
$site string
$env string
$discard boolean
Résultat Acquia\Cloud\Api\Response\Task

domain() public méthode

See also: http://cloudapi.acquia.com/#GET__sites__site_envs__env_domains__domain-instance_route
public domain ( string $site, string $env, string $domain ) : Acquia\Cloud\Api\Response\Domain
$site string
$env string
$domain string
Résultat Acquia\Cloud\Api\Response\Domain

domains() public méthode

See also: http://cloudapi.acquia.com/#GET__sites__site_envs__env_domains-instance_route
public domains ( string $site, string $env ) : Acquia\Cloud\Api\Response\Domains
$site string
$env string
Résultat Acquia\Cloud\Api\Response\Domains

downloadDatabaseBackup() public méthode

See also: http://cloudapi.acquia.com/#GET__sites__site_envs__env_dbs__db_backups__backup_download-instance_route
public downloadDatabaseBackup ( string $site, string $env, string $db, integer $backupId, string $outfile ) : Guzzle\Http\Message\Response
$site string
$env string
$db string
$backupId integer
$outfile string
Résultat Guzzle\Http\Message\Response

enableLiveDev() public méthode

public enableLiveDev ( string $site, string $env, boolean $discard = false ) : Acquia\Cloud\Api\Response\Task
$site string
$env string
$discard boolean
Résultat Acquia\Cloud\Api\Response\Task

environment() public méthode

See also: http://cloudapi.acquia.com/#GET__sites__site_envs__env-instance_route
public environment ( string $site, string $env ) : Acquia\Cloud\Api\Response\Environment
$site string
$env string
Résultat Acquia\Cloud\Api\Response\Environment

environmentDatabase() public méthode

See also: http://cloudapi.acquia.com/#GET__sites__site_envs__env_dbs__db-instance_route
public environmentDatabase ( string $site, string $env, string $db ) : Acquia\Cloud\Api\Response\Database
$site string
$env string
$db string
Résultat Acquia\Cloud\Api\Response\Database

environmentDatabases() public méthode

See also: http://cloudapi.acquia.com/#GET__sites__site_envs__env_dbs-instance_route
public environmentDatabases ( string $site, string $env ) : Acquia\Cloud\Api\Response\Databases
$site string
$env string
Résultat Acquia\Cloud\Api\Response\Databases

environments() public méthode

See also: http://cloudapi.acquia.com/#GET__sites__site_envs-instance_route
public environments ( string $site ) : Acquia\Cloud\Api\Response\Environments
$site string
Résultat Acquia\Cloud\Api\Response\Environments

factory() public static méthode

public static factory ( $config = [] ) : CloudApiClient
Résultat CloudApiClient

getBuilderParams() public méthode

public getBuilderParams ( )

installDistro() public méthode

See also: http://cloudapi.acquia.com/#POST__sites__site_envs__env_install__type-instance_route
public installDistro ( string $site, string $env, string $type, string $source ) : Acquia\Cloud\Api\Response\Task
$site string
$env string
$type string
$source string
Résultat Acquia\Cloud\Api\Response\Task

installDistroByMakefile() public méthode

Install a distro by passing a URL to a Drush makefile.
public installDistroByMakefile ( string $site, string $env, string $makefileUrl ) : Acquia\Cloud\Api\Response\Task
$site string
$env string
$makefileUrl string
Résultat Acquia\Cloud\Api\Response\Task

installDistroByName() public méthode

Install one of Acquia Cloud’s built-in supported distros.
public installDistroByName ( string $site, string $env, string $distro ) : Acquia\Cloud\Api\Response\Task
$site string
$env string
$distro string
Résultat Acquia\Cloud\Api\Response\Task

installDistroByProject() public méthode

Install any publicly accessible, standard Drupal distribution.
public installDistroByProject ( string $site, string $env, string $projectName, string $version ) : Acquia\Cloud\Api\Response\Task
$site string
$env string
$projectName string
$version string
Résultat Acquia\Cloud\Api\Response\Task

liveDev() public méthode

See also: http://cloudapi.acquia.com/#POST__sites__site_envs__env_livedev__action-instance_route
public liveDev ( string $site, string $env, string $action, boolean $discard = false ) : Acquia\Cloud\Api\Response\Task
$site string
$env string
$action string
$discard boolean
Résultat Acquia\Cloud\Api\Response\Task

moveDomain() public méthode

Moves domains atomically from one environment to another.
See also: http://cloudapi.acquia.com/#POST__sites__site_domain_move__source__target-instance_route
public moveDomain ( string $site, string | array $domains, string $sourceEnv, string $targetEnv, boolean $skipSiteUpdate = FALSE ) : Acquia\Cloud\Api\Response\Task
$site string The site.
$domains string | array The domain name(s) as an array of strings, or the string '*' to move all domains.
$sourceEnv string The environment which currently has this domain.
$targetEnv string The destination environment for the domain.
$skipSiteUpdate boolean Optional. If set to TRUE this will inhibit running fields-config-web.php for this domain move.
Résultat Acquia\Cloud\Api\Response\Task

purgeVarnishCache() public méthode

See also: http://cloudapi.acquia.com/#DELETE__sites__site_envs__env_domains__domain_cache-instance_route
public purgeVarnishCache ( string $site, string $env, string $domain ) : Acquia\Cloud\Api\Response\Task
$site string
$env string
$domain string
Résultat Acquia\Cloud\Api\Response\Task

pushCode() public méthode

Deploy a tag or branch to an environment.
See also: http://cloudapi.acquia.com/#POST__sites__site_envs__env_code_deploy-instance_route
public pushCode ( string $site, string $env, string $vcsPath ) : Acquia\Cloud\Api\Response\Task
$site string
$env string
$vcsPath string
Résultat Acquia\Cloud\Api\Response\Task

restoreDatabaseBackup() public méthode

See also: http://cloudapi.acquia.com/#POST__sites__site_envs__env_dbs__db_backups__backup_restore-instance_route
public restoreDatabaseBackup ( string $site, string $env, string $db, string $backupId ) : Acquia\Cloud\Api\Response\Task
$site string
$env string
$db string
$backupId string
Résultat Acquia\Cloud\Api\Response\Task

server() public méthode

See also: http://cloudapi.acquia.com/#GET__sites__site_envs__env_servers__server-instance_route
public server ( string $site, string $env, string $server ) : Acquia\Cloud\Api\Response\Server
$site string
$env string
$server string
Résultat Acquia\Cloud\Api\Response\Server

servers() public méthode

See also: http://cloudapi.acquia.com/#GET__sites__site_envs__env_servers-instance_route
public servers ( string $site, string $env ) : Acquia\Cloud\Api\Response\Servers
$site string
$env string
Résultat Acquia\Cloud\Api\Response\Servers

site() public méthode

See also: http://cloudapi.acquia.com/#GET__sites__site-instance_route
public site ( string $site ) : Acquia\Cloud\Api\Response\Site
$site string
Résultat Acquia\Cloud\Api\Response\Site

siteDatabase() public méthode

Deprecation: since version 0.5.0
public siteDatabase ( $site, $db )

siteDatabases() public méthode

Deprecation: since version 0.5.0
public siteDatabases ( $site )

sites() public méthode

See also: http://cloudapi.acquia.com/#GET___sites_-instance_route
public sites ( ) : Acquia\Cloud\Api\Response\SiteNames
Résultat Acquia\Cloud\Api\Response\SiteNames

sshKey() public méthode

See also: http://cloudapi.acquia.com/#GET__sites__site_sshkeys__sshkeyid-instance_route
public sshKey ( string $site, integer $keyId ) : Acquia\Cloud\Api\Response\SshKey
$site string
$keyId integer
Résultat Acquia\Cloud\Api\Response\SshKey

sshKeys() public méthode

See also: http://cloudapi.acquia.com/#GET__sites__site_sshkeys-instance_route
public sshKeys ( string $site ) : Acquia\Cloud\Api\Response\SshKeys
$site string
Résultat Acquia\Cloud\Api\Response\SshKeys

svnUser() public méthode

See also: http://cloudapi.acquia.com/#GET__sites__site_svnusers__svnuserid-instance_route
public svnUser ( string $site, integer $userId ) : Acquia\Cloud\Api\Response\SvnUser
$site string
$userId integer
Résultat Acquia\Cloud\Api\Response\SvnUser

svnUsers() public méthode

See also: http://cloudapi.acquia.com/#GET__sites__site_svnusers-instance_route
public svnUsers ( string $site ) : Acquia\Cloud\Api\Response\SvnUsers
$site string
Résultat Acquia\Cloud\Api\Response\SvnUsers

task() public méthode

See also: http://cloudapi.acquia.com/#GET__sites__site_tasks__task-instance_route
public task ( string $site, integer $taskId ) : Acquia\Cloud\Api\Response\Task
$site string
$taskId integer
Résultat Acquia\Cloud\Api\Response\Task

taskInfo() public méthode

Deprecation: since version 0.5.0
public taskInfo ( $site, $taskId )

tasks() public méthode

See also: http://cloudapi.acquia.com/#GET__sites__site_tasks-instance_route
public tasks ( string $site ) : Acquia\Cloud\Api\Response\Tasks
$site string
Résultat Acquia\Cloud\Api\Response\Tasks