Метод | Описание | |
---|---|---|
__construct ( string $endpoint, string $apiKey, string $secretKey, string $platform = 'cloudstack' ) | Constructor | |
__get ( $name ) | It's used to retrieve service interface instances as public properties | |
_loadProductTypesData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\AvailableProductsData | Loads AvailableProductsData from json object | |
_loadProductTypesList ( object $productsList ) : Scalr\Service\CloudStack\DataType\AvailableProductsList | Loads AvailableProductsList from json object | |
associateIpAddress ( Scalr\Service\CloudStack\DataType\AssociateIpAddressData | array $requestData = null ) : |
Acquires and associates a public IP to an account. | |
disassociateIpAddress ( string $id ) : ResponseDeleteData | Disassociates an ip address from the account. | |
getApiKey ( ) : string | Gets the CloudStack api key | |
getAvailableServices ( ) : array | Gets a list of available services | |
getClient ( ) : |
Gets Client | |
getCloudIdentifier ( string $userId ) : Scalr\Service\CloudStack\DataType\CloudIdentifierData | Retrieves a cloud identifier. | |
getEndpoint ( ) : string | Gets the CloudStack api url | |
getPlatform ( ) : string | Gets the CloudStack platform | |
getProxy ( ) : array | boolean | Gets proxy configuration | |
getSecretKey ( ) : string | Gets the CloudStack secret key | |
listAccounts ( Scalr\Service\CloudStack\DataType\ListAccountsData | array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\AccountList | null | Lists accounts and provides detailed account information for listed accounts | |
listAsyncJobs ( |
Lists all pending asynchronous jobs for the account. | |
listAvailableProductTypes ( ) : Scalr\Service\CloudStack\DataType\AvailableProductsList | null | It is a command used in checking the list of products provided as those of server and by selecting one of resulted lists, users can check combination of templateid, serviceofferingid, diskofferingid and zoneid which can be created with VM | |
listCapabilities ( Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : null | Scalr\Service\CloudStack\DataType\CapabilityData | Lists capabilities | |
listDiskOfferings ( Scalr\Service\CloudStack\DataType\ListDiskOfferingsData | array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\DiskOfferingList | null | Lists all available disk offerings. | |
listEvents ( |
A command to list events. | |
listHypervisors ( string $zoneId = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : null | Scalr\Service\CloudStack\DataType\HypervisorsList | List hypervisors | |
listOsCategories ( string $id = null, string $name = null, string $keyword = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\OsCategoryList | null | Lists all supported OS categories for this cloud. | |
listOsTypes ( Scalr\Service\CloudStack\DataType\ListOsTypesData | array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\OsTypeList | null | Lists all supported OS types for this cloud. | |
listPublicIpAddresses ( Scalr\Service\CloudStack\DataType\ListIpAddressesData | array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\IpAddressResponseList | null | Lists all public ip addresses | |
listResourceLimits ( Scalr\Service\CloudStack\DataType\ListResourceLimitsData | array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\ResourceLimitList | null | Lists resource limits. | |
listServiceOfferings ( Scalr\Service\CloudStack\DataType\ListServiceOfferingsData | array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\ServiceOfferingList | null | Lists all available service offerings. | |
login ( string $userName, string $password, string $domain = null ) : Scalr\Service\CloudStack\DataType\LoginResponseData | Logs a user into the CloudStack. | |
logout ( ) | Logs out the user | |
queryAsyncJobResult ( string $jobId ) : |
Retrieves the current status of asynchronous job. | |
setApiKey ( string $apiKey ) : |
Sets the CloudStack api key | |
setDebug ( boolean $debug = true ) : |
Enables or disables debug mode | |
setEndpoint ( string $endpoint ) : |
Sets the CloudStack api url | |
setPlatform ( string $platform ) : |
Sets the CloudStack platform | |
setProxy ( string $host, integer $port = 3128, string $user = null, string $pass = null, integer $type, integer $authType = 1 ) | Set proxy configuration to connect to AWS services | |
setSecretKey ( string $secretKey ) : |
Sets the CloudStack secret key |
Метод | Описание | |
---|---|---|
_loadAccountData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\AccountData | Loads AccountData from json object | |
_loadAccountList ( object $accountList ) : Scalr\Service\CloudStack\DataType\AccountList | Loads AccountList from json object | |
_loadCapabilityData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\CapabilityData | Loads CapabilityData from json object | |
_loadCloudIdentifierData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\CloudIdentifierData | Loads CloudIdentifierData from json object | |
_loadDiskOfferingData ( object $resultObject ) : |
Loads DiskOfferingData from json object | |
_loadDiskOfferingList ( object $serviceList ) : Scalr\Service\CloudStack\DataType\DiskOfferingList | Loads DiskOfferingList from json object | |
_loadEventData ( object $resultObject ) : |
Loads EventResponseData from json object | |
_loadEventList ( object $eventList ) : Scalr\Service\CloudStack\DataType\EventResponseList | Loads EventResponseList from json object | |
_loadHypervisorsData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\HypervisorsData | Loads HypervisorsData from json object | |
_loadHypervisorsList ( object $hypervisorsList ) : Scalr\Service\CloudStack\DataType\HypervisorsList | Loads HypervisorsList from json object | |
_loadIpAddressData ( object $resultObject ) : |
Loads IpAddressResponseData from json object | |
_loadIpAddressList ( object $addressList ) : Scalr\Service\CloudStack\DataType\IpAddressResponseList | Loads IpAddressResponseList from json object | |
_loadJobResultData ( object $resultObject ) : |
Loads JobResultData from json object | |
_loadJobResultList ( object $jobsList ) : Scalr\Service\CloudStack\DataType\JobResultList | Loads JobResultList from json object | |
_loadLoginData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\LoginResponseData | Loads LoginResponseData from json object | |
_loadLogoutData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\LogoutResponseData | Loads LogoutResponseData from json object | |
_loadOsCategoryData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\OsCategoryData | Loads OsCategoryData from json object | |
_loadOsCategoryList ( object $categoryList ) : Scalr\Service\CloudStack\DataType\OsCategoryList | Loads OsCategoryList from json object | |
_loadOsTypeData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\OsTypeData | Loads OsTypeData from json object | |
_loadOsTypeList ( object $typeList ) : Scalr\Service\CloudStack\DataType\OsTypeList | Loads OsTypeList from json object | |
_loadResourceLimitData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\ResourceLimitData | Loads ResourceLimitData from json object | |
_loadResourceLimitList ( object $limitsList ) : Scalr\Service\CloudStack\DataType\ResourceLimitList | Loads ResourceLimitList from json object | |
_loadServiceOfferingData ( object $resultObject ) : |
Loads ServiceOfferingData from json object | |
_loadServiceOfferingList ( object $serviceList ) : Scalr\Service\CloudStack\DataType\ServiceOfferingList | Loads ServiceOfferingList from json object | |
_loadUserData ( object $resultObject ) : |
Loads UserData from json object | |
_loadUserList ( object $userList ) : Scalr\Service\CloudStack\DataType\UserList | Loads UserList from json object | |
escape ( string $str ) : string | Escapes string to pass it over http request |
public __get ( $name ) |
protected _loadAccountData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\AccountData | ||
$resultObject | object | |
Результат | Scalr\Service\CloudStack\DataType\AccountData | Returns AccountData |
protected _loadAccountList ( object $accountList ) : Scalr\Service\CloudStack\DataType\AccountList | ||
$accountList | object | |
Результат | Scalr\Service\CloudStack\DataType\AccountList | Returns AccountList |
protected _loadCapabilityData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\CapabilityData | ||
$resultObject | object | |
Результат | Scalr\Service\CloudStack\DataType\CapabilityData | Returns CapabilityData |
protected _loadCloudIdentifierData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\CloudIdentifierData | ||
$resultObject | object | |
Результат | Scalr\Service\CloudStack\DataType\CloudIdentifierData | Returns CloudIdentifierData |
protected _loadDiskOfferingData ( object $resultObject ) : |
||
$resultObject | object | |
Результат | Returns DiskOfferingData |
protected _loadDiskOfferingList ( object $serviceList ) : Scalr\Service\CloudStack\DataType\DiskOfferingList | ||
$serviceList | object | |
Результат | Scalr\Service\CloudStack\DataType\DiskOfferingList | Returns DiskOfferingList |
protected _loadEventData ( object $resultObject ) : |
||
$resultObject | object | |
Результат | Returns EventResponseData |
protected _loadEventList ( object $eventList ) : Scalr\Service\CloudStack\DataType\EventResponseList | ||
$eventList | object | |
Результат | Scalr\Service\CloudStack\DataType\EventResponseList | Returns EventResponseList |
protected _loadHypervisorsData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\HypervisorsData | ||
$resultObject | object | |
Результат | Scalr\Service\CloudStack\DataType\HypervisorsData | Returns HypervisorsData |
protected _loadHypervisorsList ( object $hypervisorsList ) : Scalr\Service\CloudStack\DataType\HypervisorsList | ||
$hypervisorsList | object | |
Результат | Scalr\Service\CloudStack\DataType\HypervisorsList | Returns HypervisorsList |
protected _loadIpAddressData ( object $resultObject ) : |
||
$resultObject | object | |
Результат | Returns IpAddressResponseData |
protected _loadIpAddressList ( object $addressList ) : Scalr\Service\CloudStack\DataType\IpAddressResponseList | ||
$addressList | object | |
Результат | Scalr\Service\CloudStack\DataType\IpAddressResponseList | Returns IpAddressResponseList |
protected _loadJobResultData ( object $resultObject ) : |
||
$resultObject | object | |
Результат | Returns JobResultData |
protected _loadJobResultList ( object $jobsList ) : Scalr\Service\CloudStack\DataType\JobResultList | ||
$jobsList | object | |
Результат | Scalr\Service\CloudStack\DataType\JobResultList | Returns JobResultList |
protected _loadLoginData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\LoginResponseData | ||
$resultObject | object | |
Результат | Scalr\Service\CloudStack\DataType\LoginResponseData | Returns LoginResponseData |
protected _loadLogoutData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\LogoutResponseData | ||
$resultObject | object | |
Результат | Scalr\Service\CloudStack\DataType\LogoutResponseData | Returns LogoutResponseData |
protected _loadOsCategoryData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\OsCategoryData | ||
$resultObject | object | |
Результат | Scalr\Service\CloudStack\DataType\OsCategoryData | Returns OsCategoryData |
protected _loadOsCategoryList ( object $categoryList ) : Scalr\Service\CloudStack\DataType\OsCategoryList | ||
$categoryList | object | |
Результат | Scalr\Service\CloudStack\DataType\OsCategoryList | Returns OsCategoryList |
protected _loadOsTypeData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\OsTypeData | ||
$resultObject | object | |
Результат | Scalr\Service\CloudStack\DataType\OsTypeData | Returns OsTypeData |
protected _loadOsTypeList ( object $typeList ) : Scalr\Service\CloudStack\DataType\OsTypeList | ||
$typeList | object | |
Результат | Scalr\Service\CloudStack\DataType\OsTypeList | Returns OsTypeList |
public _loadProductTypesData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\AvailableProductsData | ||
$resultObject | object | |
Результат | Scalr\Service\CloudStack\DataType\AvailableProductsData | Returns AvailableProductsData |
public _loadProductTypesList ( object $productsList ) : Scalr\Service\CloudStack\DataType\AvailableProductsList | ||
$productsList | object | |
Результат | Scalr\Service\CloudStack\DataType\AvailableProductsList | Returns AvailableProductsList |
protected _loadResourceLimitData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\ResourceLimitData | ||
$resultObject | object | |
Результат | Scalr\Service\CloudStack\DataType\ResourceLimitData | Returns ResourceLimitData |
protected _loadResourceLimitList ( object $limitsList ) : Scalr\Service\CloudStack\DataType\ResourceLimitList | ||
$limitsList | object | |
Результат | Scalr\Service\CloudStack\DataType\ResourceLimitList | Returns ResourceLimitList |
protected _loadServiceOfferingData ( object $resultObject ) : |
||
$resultObject | object | |
Результат | Returns ServiceOfferingData |
protected _loadServiceOfferingList ( object $serviceList ) : Scalr\Service\CloudStack\DataType\ServiceOfferingList | ||
$serviceList | object | |
Результат | Scalr\Service\CloudStack\DataType\ServiceOfferingList | Returns ServiceOfferingList |
protected _loadUserData ( object $resultObject ) : |
||
$resultObject | object | |
Результат | Returns UserData |
protected _loadUserList ( object $userList ) : Scalr\Service\CloudStack\DataType\UserList | ||
$userList | object | |
Результат | Scalr\Service\CloudStack\DataType\UserList | Returns UserList |
public associateIpAddress ( Scalr\Service\CloudStack\DataType\AssociateIpAddressData | array $requestData = null ) : |
||
$requestData | Scalr\Service\CloudStack\DataType\AssociateIpAddressData | array | Request data object |
Результат |
public disassociateIpAddress ( string $id ) : ResponseDeleteData | ||
$id | string | the id of the public ip address to disassociate |
Результат | ResponseDeleteData |
public static getAvailableServices ( ) : array | ||
Результат | array | Returns the list of available services looks like array(serviceName => className) |
public getClient ( ) : |
||
Результат | Returns QueryClient |
public getCloudIdentifier ( string $userId ) : Scalr\Service\CloudStack\DataType\CloudIdentifierData | ||
$userId | string | the user ID for the cloud identifier |
Результат | Scalr\Service\CloudStack\DataType\CloudIdentifierData |
public getEndpoint ( ) : string | ||
Результат | string | Returns api url |
public getPlatform ( ) : string | ||
Результат | string | Returns platform |
public getSecretKey ( ) : string | ||
Результат | string | Returns secret key |
public listAccounts ( Scalr\Service\CloudStack\DataType\ListAccountsData | array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\AccountList | null | ||
$requestData | Scalr\Service\CloudStack\DataType\ListAccountsData | array | Request data object |
$pagination | Scalr\Service\CloudStack\DataType\PaginationType | Pagination |
Результат | Scalr\Service\CloudStack\DataType\AccountList | null |
public listAsyncJobs ( |
||
$requestData | Request data object | |
$pagination | Scalr\Service\CloudStack\DataType\PaginationType | Pagination |
Результат | Scalr\Service\CloudStack\DataType\JobResultList | null |
public listAvailableProductTypes ( ) : Scalr\Service\CloudStack\DataType\AvailableProductsList | null | ||
Результат | Scalr\Service\CloudStack\DataType\AvailableProductsList | null |
public listCapabilities ( Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : null | Scalr\Service\CloudStack\DataType\CapabilityData | ||
$pagination | Scalr\Service\CloudStack\DataType\PaginationType | Pagination |
Результат | null | Scalr\Service\CloudStack\DataType\CapabilityData |
public listDiskOfferings ( Scalr\Service\CloudStack\DataType\ListDiskOfferingsData | array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\DiskOfferingList | null | ||
$requestData | Scalr\Service\CloudStack\DataType\ListDiskOfferingsData | array | Request data object |
$pagination | Scalr\Service\CloudStack\DataType\PaginationType | Pagination |
Результат | Scalr\Service\CloudStack\DataType\DiskOfferingList | null |
public listEvents ( |
||
$requestData | Request data object | |
$pagination | Scalr\Service\CloudStack\DataType\PaginationType | Pagination |
Результат | Scalr\Service\CloudStack\DataType\EventResponseList | null |
public listHypervisors ( string $zoneId = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : null | Scalr\Service\CloudStack\DataType\HypervisorsList | ||
$zoneId | string | the zone id for listing hypervisors. |
$pagination | Scalr\Service\CloudStack\DataType\PaginationType | Pagination |
Результат | null | Scalr\Service\CloudStack\DataType\HypervisorsList |
public listOsCategories ( string $id = null, string $name = null, string $keyword = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\OsCategoryList | null | ||
$id | string | List Os category by id |
$name | string | List os category by name |
$keyword | string | List by keyword |
$pagination | Scalr\Service\CloudStack\DataType\PaginationType | Pagination |
Результат | Scalr\Service\CloudStack\DataType\OsCategoryList | null |
public listOsTypes ( Scalr\Service\CloudStack\DataType\ListOsTypesData | array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\OsTypeList | null | ||
$requestData | Scalr\Service\CloudStack\DataType\ListOsTypesData | array | Request data object |
$pagination | Scalr\Service\CloudStack\DataType\PaginationType | Pagination |
Результат | Scalr\Service\CloudStack\DataType\OsTypeList | null |
public listPublicIpAddresses ( Scalr\Service\CloudStack\DataType\ListIpAddressesData | array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\IpAddressResponseList | null | ||
$requestData | Scalr\Service\CloudStack\DataType\ListIpAddressesData | array | Request data object |
$pagination | Scalr\Service\CloudStack\DataType\PaginationType | Pagination |
Результат | Scalr\Service\CloudStack\DataType\IpAddressResponseList | null |
public listResourceLimits ( Scalr\Service\CloudStack\DataType\ListResourceLimitsData | array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\ResourceLimitList | null | ||
$requestData | Scalr\Service\CloudStack\DataType\ListResourceLimitsData | array | Request data object |
$pagination | Scalr\Service\CloudStack\DataType\PaginationType | Pagination |
Результат | Scalr\Service\CloudStack\DataType\ResourceLimitList | null |
public listServiceOfferings ( Scalr\Service\CloudStack\DataType\ListServiceOfferingsData | array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\ServiceOfferingList | null | ||
$requestData | Scalr\Service\CloudStack\DataType\ListServiceOfferingsData | array | Request data object |
$pagination | Scalr\Service\CloudStack\DataType\PaginationType | Pagination |
Результат | Scalr\Service\CloudStack\DataType\ServiceOfferingList | null |
public login ( string $userName, string $password, string $domain = null ) : Scalr\Service\CloudStack\DataType\LoginResponseData | ||
$userName | string | Username |
$password | string | Password |
$domain | string | path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT domain is assumed. |
Результат | Scalr\Service\CloudStack\DataType\LoginResponseData |
public queryAsyncJobResult ( string $jobId ) : |
||
$jobId | string | the ID of the asychronous job |
Результат |
public setEndpoint ( string $endpoint ) : |
||
$endpoint | string | |
Результат |
public setPlatform ( string $platform ) : |
||
$platform | string | |
Результат |
public setProxy ( string $host, integer $port = 3128, string $user = null, string $pass = null, integer $type, integer $authType = 1 ) | ||
$host | string | |
$port | integer | |
$user | string | |
$pass | string | |
$type | integer | Allowed values 4 - SOCKS4, 5 - SOCKS5, 0 - HTTP |
$authType | integer | Allowed authtypes: 1 - Basic, Digest - 2, GSSNeg - 4, NTLM - 8, any - -1 |
public setSecretKey ( string $secretKey ) : |
||
$secretKey | string | |
Результат |