Methods summary
public static
SoapClient
|
#
_getSoapClient( mixed $parameters = array() )
Gets the singleton SoapClient which is used to connect to the TransIP
Api.
Gets the singleton SoapClient which is used to connect to the TransIP
Api.
Parameters
- $parameters
mixed
$parameters Parameters. Returns
SoapClientThe SoapClient object to which we can connect to the TransIP API
|
protected static
string
|
#
_sign( mixed $parameters )
Calculates the hash to sign our request with based on the given
parameters.
Calculates the hash to sign our request with based on the given
parameters.
Parameters
- $parameters
mixed
$parameters The parameters to sign. Returns
string
Base64 encoded signing hash.
|
protected static
string
|
#
_sha512Asn1( string $data )
Creates a digest of the given data, with an asn1 header.
Creates a digest of the given data, with an asn1 header.
Parameters
- $data
string
$data The data to create a digest of. Returns
string
The digest of the data, with asn1 header.
|
protected static
string
|
#
_encodeParameters( mixed $parameters, string $keyPrefix = null )
Encodes the given paramaters into a url encoded string based upon RFC
3986.
Encodes the given paramaters into a url encoded string based upon RFC
3986.
Parameters
- $parameters
mixed
$parameters The parameters to encode.- $keyPrefix
string
$keyPrefix Key prefix. Returns
string
The given parameters encoded according to RFC 3986.
|
protected static
string
|
#
_urlencode( string $string )
Our own function to encode a string according to RFC 3986 since. PHP <
5.3.0 encodes the ~ character which is not allowed.
Our own function to encode a string according to RFC 3986 since. PHP <
5.3.0 encodes the ~ character which is not allowed.
Parameters
- $string
string
$string The string to encode. Returns
string
The encoded string according to RFC 3986.
|
public static
Transip_Haip
|
#
getHaip( string $haipName )
Get a HA-IP by name
Parameters
- $haipName
string
$haipName The HA-IP name Returns
Throws
ApiException
|
public static
Transip_Haip[]
|
|
public static
|
#
changeHaipVps( string $haipName, string $vpsName )
Changes the VPS connected to the HA-IP.
Changes the VPS connected to the HA-IP.
Parameters
- $haipName
string
$haipName The HA-IP name- $vpsName
string
$vpsName The Vps name Throws
ApiException
|
public static
|
#
setHaipVpses( string $haipName, string[] $vpsNames )
Replaces currently attached VPSes to the HA-IP with the provided list of
VPSes.
Replaces currently attached VPSes to the HA-IP with the provided list of
VPSes.
Parameters
- $haipName
string
$haipName The HA-IP name- $vpsNames
string[]
$vpsNames The Vps names Throws
ApiException
|
public static
|
#
setIpSetup( string $haipName, string $ipSetup )
Sets the provided IP setup for the HA-IP.
Sets the provided IP setup for the HA-IP.
Parameters
- $haipName
string
$haipName The HA-IP name- $ipSetup
string
$ipSetup The IP setup ('both','noipv6','ipv6to4') Throws
ApiException
|
public static
|
#
setBalancingMode( string $haipName, string $balancingMode, string $cookieName )
Sets the provided balancing mode for the HA-IP. The cookieName argument may
be an empty string unless the balancing mode is set to 'cookie'.
Sets the provided balancing mode for the HA-IP. The cookieName argument may
be an empty string unless the balancing mode is set to 'cookie'.
This is a HA-IP Pro feature.
Parameters
- $haipName
string
$haipName The HA-IP name- $balancingMode
string
$balancingMode The balancing mode ('roundrobin','cookie','source')- $cookieName
string
$cookieName The cookie name that pins the session if the balancing mode is
'cookie' Throws
ApiException
|
public static
|
#
setHttpHealthCheck( string $haipName, string $path, integer $port )
Configures a HTTP health check for the HA-IP. To disable a HTTP health check
use setTcpHealthCheck().
Configures a HTTP health check for the HA-IP. To disable a HTTP health check
use setTcpHealthCheck().
This is a HA-IP Pro feature.
Parameters
- $haipName
string
$haipName The HA-IP name- $path
string
$path The path that will be accessed when performing health checks- $port
integer
$port The port that will be used when performing health checks Throws
ApiException
|
public static
|
#
setTcpHealthCheck( string $haipName )
Configures a TCP health check for the HA-IP (this is the default health
check).
Configures a TCP health check for the HA-IP (this is the default health
check).
This is a HA-IP Pro feature.
Parameters
- $haipName
string
$haipName The HA-IP name Throws
ApiException
|
public static
array
|
#
getStatusReport( string $haipName )
Get a status report for the HA-IP.
Get a status report for the HA-IP.
This is a HA-IP Pro feature.
Parameters
- $haipName
string
$haipName The HA-IP name Returns
array
Throws
ApiException
|
public static
array
|
#
getCertificatesByHaip( string $haipName )
Get all Certificates by Haip
Get all Certificates by Haip
Parameters
- $haipName
string
$haipName Returns
array
Throws
ApiException
|
public static
array
|
#
getAvailableCertificatesByHaip( string $haipName )
Get all available certificates ready to attach to your HAIP
Get all available certificates ready to attach to your HAIP
Parameters
- $haipName
string
$haipName Returns
array
Throws
ApiException
|
public static
|
#
addCertificateToHaip( string $haipName, integer $certificateId )
Add a HaipCertificate to this object
Add a HaipCertificate to this object
Parameters
- $haipName
string
$haipName- $certificateId
integer
$certificateId Throws
ApiException
|
public static
|
#
deleteCertificateFromHaip( string $haipName, integer $certificateId )
Removes a Certificate from this HA-IP
Removes a Certificate from this HA-IP
Parameters
- $haipName
string
$haipName- $certificateId
integer
$certificateId Throws
ApiException
|
public static
|
#
startHaipLetsEncryptCertificateIssue( string $haipName, string $commonName )
Add EncryptCertificate to HA-IP
Add EncryptCertificate to HA-IP
Parameters
- $haipName
string
$haipName- $commonName
string
$commonName Throws
ApiException
|
public static
string
|
#
getPtrForHaip( string $haipName )
Returns the current ptr for the given HA-IP
Returns the current ptr for the given HA-IP
Parameters
- $haipName
string
$haipName Returns
string
Throws
ApiException
|
public static
|
#
setPtrForHaip( string $haipName, string $ptr )
Update the ptr records for the given HA-IP
Update the ptr records for the given HA-IP
Parameters
- $haipName
string
$haipName- $ptr
string
$ptr Throws
ApiException
|
public static
|
#
setHaipDescription( string $haipName, string $description )
Update the description for HA-IP
Update the description for HA-IP
Parameters
- $haipName
string
$haipName- $description
string
$description Throws
ApiException
|
public static
array
|
#
getPortConfigurations( string $haipName )
Get all port configurations for given HA-IP
Get all port configurations for given HA-IP
Parameters
- $haipName
string
$haipName The HA-IP name Returns
array
Throws
ApiException
|
public static
|
#
setDefaultPortConfiguration( string $haipName )
Set default port configurations for given HA-IP
Set default port configurations for given HA-IP
Parameters
- $haipName
string
$haipName The HA-IP name Throws
ApiException
|
public static
|
#
addPortConfiguration( string $haipName, string $name, integer $sourcePort, integer $targetPort, string $mode, string $endpointSslMode )
Add port configuration to HA-IP
Add port configuration to HA-IP
Parameters
- $haipName
string
$haipName The HA-IP name- $name
string
$name The name describing the port configuration- $sourcePort
integer
$sourcePort The port that is addressed on the HA-IP IP- $targetPort
integer
$targetPort The port that is addressed on the VPS- $mode
string
$mode The port mode ('tcp','http','https','proxy')- $endpointSslMode
string
$endpointSslMode The SSL mode for the endpoint ('off','on','strict') Throws
ApiException
|
public static
|
#
updatePortConfiguration( string $haipName, integer $configurationId, string $name, integer $sourcePort, integer $targetPort, string $mode, string $endpointSslMode )
Update port configuration to HA-IP
Update port configuration to HA-IP
Parameters
- $haipName
string
$haipName The HA-IP name- $configurationId
integer
$configurationId The identifier for the configuration- $name
string
$name The name describing the port configuration- $sourcePort
integer
$sourcePort The port that is addressed on the HA-IP IP- $targetPort
integer
$targetPort The port that is addressed on the VPS- $mode
string
$mode The port mode ('tcp','http','https','proxy')- $endpointSslMode
string
$endpointSslMode The SSL mode for the endpoint ('off','on','strict') Throws
ApiException
|
public static
|
#
deletePortConfiguration( string $haipName, integer $configurationId )
Parameters
- $haipName
string
$haipName- $configurationId
integer
$configurationId Throws
ApiException
|
public static
|
#
cancelHaip( string $haipName, string $endTime )
Cancel a Haip
Parameters
- $haipName
string
$haipName The vps to cancel- $endTime
string
$endTime The time to cancel the haip (HaipService::CANCELLATIONTIME_END (end of
contract) Throws
ApiException
on error
|