PHP Класс Acquia\Cloud\Api\CloudApiClient

Наследование: extends Guzzle\Service\Client, implements Acquia\Rest\ServiceManagerAware
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
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

Описание методов

addDatabase() публичный метод

См. также: 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.
Результат Acquia\Cloud\Api\Response\Task

addDomain() публичный метод

См. также: 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
Результат Acquia\Cloud\Api\Response\Task

addSshKey() публичный метод

См. также: 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
Результат Acquia\Cloud\Api\Response\Task

addSvnUser() публичный метод

См. также: 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
Результат Acquia\Cloud\Api\Response\Task

codeDeploy() публичный метод

Устаревший: since version 0.5.0
public codeDeploy ( $site, $source, $target )

copyDatabase() публичный метод

См. также: 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
Результат Acquia\Cloud\Api\Response\Task

copyFiles() публичный метод

См. также: 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
Результат Acquia\Cloud\Api\Response\Task

createDatabaseBackup() публичный метод

См. также: 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
Результат Acquia\Cloud\Api\Response\Task

database() публичный метод

См. также: 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
Результат Acquia\Cloud\Api\Response\DatabaseName

databaseBackup() публичный метод

См. также: 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
Результат Acquia\Cloud\Api\Response\Task

databaseBackups() публичный метод

См. также: 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
Результат Acquia\Cloud\Api\Response\DatabaseBackups

databases() публичный метод

См. также: http://cloudapi.acquia.com/#GET__sites__site_dbs-instance_route
public databases ( string $site ) : Acquia\Cloud\Api\Response\DatabaseNames
$site string
Результат Acquia\Cloud\Api\Response\DatabaseNames

deleteDatabase() публичный метод

См. также: 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.
Результат Acquia\Cloud\Api\Response\Task

deleteDatabaseBackup() публичный метод

См. также: 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
Результат Acquia\Cloud\Api\Response\Task

deleteDomain() публичный метод

См. также: 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
Результат Acquia\Cloud\Api\Response\Task

deleteSshKey() публичный метод

См. также: 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
Результат Acquia\Cloud\Api\Response\Task

deleteSvnUser() публичный метод

См. также: 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
Результат Acquia\Cloud\Api\Response\Task

deployCode() публичный метод

Deploy code from on environment to another.
См. также: 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
Результат Acquia\Cloud\Api\Response\Task

disableLiveDev() публичный метод

public disableLiveDev ( string $site, string $env, boolean $discard = false ) : Acquia\Cloud\Api\Response\Task
$site string
$env string
$discard boolean
Результат Acquia\Cloud\Api\Response\Task

domain() публичный метод

См. также: 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
Результат Acquia\Cloud\Api\Response\Domain

domains() публичный метод

См. также: 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
Результат Acquia\Cloud\Api\Response\Domains

downloadDatabaseBackup() публичный метод

См. также: 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
Результат Guzzle\Http\Message\Response

enableLiveDev() публичный метод

public enableLiveDev ( string $site, string $env, boolean $discard = false ) : Acquia\Cloud\Api\Response\Task
$site string
$env string
$discard boolean
Результат Acquia\Cloud\Api\Response\Task

environment() публичный метод

См. также: 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
Результат Acquia\Cloud\Api\Response\Environment

environmentDatabase() публичный метод

См. также: 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
Результат Acquia\Cloud\Api\Response\Database

environmentDatabases() публичный метод

См. также: 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
Результат Acquia\Cloud\Api\Response\Databases

environments() публичный метод

См. также: http://cloudapi.acquia.com/#GET__sites__site_envs-instance_route
public environments ( string $site ) : Acquia\Cloud\Api\Response\Environments
$site string
Результат Acquia\Cloud\Api\Response\Environments

factory() публичный статический метод

public static factory ( $config = [] ) : CloudApiClient
Результат CloudApiClient

getBuilderParams() публичный метод

public getBuilderParams ( )

installDistro() публичный метод

См. также: 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
Результат Acquia\Cloud\Api\Response\Task

installDistroByMakefile() публичный метод

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
Результат Acquia\Cloud\Api\Response\Task

installDistroByName() публичный метод

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
Результат Acquia\Cloud\Api\Response\Task

installDistroByProject() публичный метод

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
Результат Acquia\Cloud\Api\Response\Task

liveDev() публичный метод

См. также: 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
Результат Acquia\Cloud\Api\Response\Task

moveDomain() публичный метод

Moves domains atomically from one environment to another.
См. также: 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.
Результат Acquia\Cloud\Api\Response\Task

purgeVarnishCache() публичный метод

См. также: 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
Результат Acquia\Cloud\Api\Response\Task

pushCode() публичный метод

Deploy a tag or branch to an environment.
См. также: 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
Результат Acquia\Cloud\Api\Response\Task

restoreDatabaseBackup() публичный метод

См. также: 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
Результат Acquia\Cloud\Api\Response\Task

server() публичный метод

См. также: 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
Результат Acquia\Cloud\Api\Response\Server

servers() публичный метод

См. также: 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
Результат Acquia\Cloud\Api\Response\Servers

site() публичный метод

См. также: http://cloudapi.acquia.com/#GET__sites__site-instance_route
public site ( string $site ) : Acquia\Cloud\Api\Response\Site
$site string
Результат Acquia\Cloud\Api\Response\Site

siteDatabase() публичный метод

Устаревший: since version 0.5.0
public siteDatabase ( $site, $db )

siteDatabases() публичный метод

Устаревший: since version 0.5.0
public siteDatabases ( $site )

sites() публичный метод

См. также: http://cloudapi.acquia.com/#GET___sites_-instance_route
public sites ( ) : Acquia\Cloud\Api\Response\SiteNames
Результат Acquia\Cloud\Api\Response\SiteNames

sshKey() публичный метод

См. также: 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
Результат Acquia\Cloud\Api\Response\SshKey

sshKeys() публичный метод

См. также: http://cloudapi.acquia.com/#GET__sites__site_sshkeys-instance_route
public sshKeys ( string $site ) : Acquia\Cloud\Api\Response\SshKeys
$site string
Результат Acquia\Cloud\Api\Response\SshKeys

svnUser() публичный метод

См. также: 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
Результат Acquia\Cloud\Api\Response\SvnUser

svnUsers() публичный метод

См. также: http://cloudapi.acquia.com/#GET__sites__site_svnusers-instance_route
public svnUsers ( string $site ) : Acquia\Cloud\Api\Response\SvnUsers
$site string
Результат Acquia\Cloud\Api\Response\SvnUsers

task() публичный метод

См. также: 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
Результат Acquia\Cloud\Api\Response\Task

taskInfo() публичный метод

Устаревший: since version 0.5.0
public taskInfo ( $site, $taskId )

tasks() публичный метод

См. также: http://cloudapi.acquia.com/#GET__sites__site_tasks-instance_route
public tasks ( string $site ) : Acquia\Cloud\Api\Response\Tasks
$site string
Результат Acquia\Cloud\Api\Response\Tasks