from datetime import date
from typing import Literal
from datetime import date, datetime
from ..abstract import ClientAbstract
__all__ = ["Administration"]
MODE = Literal["STRONG", "MODERATE", "WEAK"]
[docs]
class Administration(ClientAbstract):
_endpoint1 = "administration"
@property
def Analytics(self) -> "_Analytics":
"""
>>> from jelastic import Jelastic
>>> jelastic = Jelastic('https://app.xapp.cloudmydc.com', token='d6f4e314a5b5fefd164995169f28ae32d987704f')
>>> jelastic.administration.Analytics
Ref: https://docs.jelastic.com/api/private/#!/api/administration.Analytics
"""
return _Analytics(
session=self._session,
token=self._token,
debug=self._debug,
ruk=self._ruk,
)
@property
def Cluster(self) -> "_Cluster":
"""
>>> from jelastic import Jelastic
>>> jelastic = Jelastic('https://app.xapp.cloudmydc.com', token='d6f4e314a5b5fefd164995169f28ae32d987704f')
>>> jelastic.administration.Cluster
Ref: https://docs.jelastic.com/api/private/#!/api/administration.Cluster
"""
return _Cluster(
session=self._session,
token=self._token,
debug=self._debug,
ruk=self._ruk,
)
@property
def Resource(self) -> "_Resource":
"""
>>> from jelastic import Jelastic
>>> jelastic = Jelastic('https://app.xapp.cloudmydc.com', token='d6f4e314a5b5fefd164995169f28ae32d987704f')
>>> jelastic.administration.Resource
Ref: https://docs.jelastic.com/api/private/#!/api/administration.Resource
"""
return _Resource(
session=self._session,
token=self._token,
debug=self._debug,
ruk=self._ruk,
)
@property
def Subscription(self) -> "_Subscription":
"""
>>> from jelastic import Jelastic
>>> jelastic = Jelastic('https://app.xapp.cloudmydc.com', token='d6f4e314a5b5fefd164995169f28ae32d987704f')
>>> jelastic.administration.Subscription
Ref: https://docs.jelastic.com/api/private/#!/api/administration.Subscription
"""
return _Subscription(
session=self._session,
token=self._token,
debug=self._debug,
ruk=self._ruk,
)
@property
def Update(self) -> "_Update":
"""
>>> from jelastic import Jelastic
>>> jelastic = Jelastic('https://app.xapp.cloudmydc.com', token='d6f4e314a5b5fefd164995169f28ae32d987704f')
>>> jelastic.administration.Update
Ref: https://docs.jelastic.com/api/private/#!/api/administration.Update
"""
return _Update(
session=self._session,
token=self._token,
debug=self._debug,
ruk=self._ruk,
)
@property
def Monitoring(self) -> "_Monitoring":
"""
>>> from jelastic import Jelastic
>>> jelastic = Jelastic('https://app.xapp.cloudmydc.com', token='d6f4e314a5b5fefd164995169f28ae32d987704f')
>>> jelastic.administration.Monitoring
Ref: https://docs.jelastic.com/api/private/#!/api/administration.Monitoring
"""
return _Monitoring(
session=self._session,
token=self._token,
debug=self._debug,
ruk=self._ruk,
)
@property
def Template(self) -> "_Template":
"""
>>> from jelastic import Jelastic
>>> jelastic = Jelastic('https://app.xapp.cloudmydc.com', token='d6f4e314a5b5fefd164995169f28ae32d987704f')
>>> jelastic.administration.Template
Ref: https://docs.jelastic.com/api/private/#!/api/administration.Template
"""
return _Template(
session=self._session,
token=self._token,
debug=self._debug,
ruk=self._ruk,
)
@property
def Host(self) -> "_Host":
"""
>>> from jelastic import Jelastic
>>> jelastic = Jelastic('https://app.xapp.cloudmydc.com', token='d6f4e314a5b5fefd164995169f28ae32d987704f')
>>> jelastic.administration.Host
Ref: https://docs.jelastic.com/api/private/#!/api/administration.Host
"""
return _Host(
session=self._session,
token=self._token,
debug=self._debug,
ruk=self._ruk,
)
@property
def HostGroup(self) -> "_HostGroup":
"""
>>> from jelastic import Jelastic
>>> jelastic = Jelastic('https://app.xapp.cloudmydc.com', token='d6f4e314a5b5fefd164995169f28ae32d987704f')
>>> jelastic.administration.HostGroup
Ref: https://docs.jelastic.com/api/private/#!/api/administration.HostGroup
"""
return _HostGroup(
session=self._session,
token=self._token,
debug=self._debug,
ruk=self._ruk,
)
@property
def Utils(self) -> "_Utils":
"""
>>> from jelastic import Jelastic
>>> jelastic = Jelastic('https://app.xapp.cloudmydc.com', token='d6f4e314a5b5fefd164995169f28ae32d987704f')
>>> jelastic.administration.Utils
Ref: https://docs.jelastic.com/api/private/#!/api/administration.Utils
"""
return _Utils(
session=self._session,
token=self._token,
debug=self._debug,
ruk=self._ruk,
)
@property
def Config(self) -> "_Config":
"""
>>> from jelastic import Jelastic
>>> jelastic = Jelastic('https://app.xapp.cloudmydc.com', token='d6f4e314a5b5fefd164995169f28ae32d987704f')
>>> jelastic.administration.Config
Ref: https://docs.jelastic.com/api/private/#!/api/administration.Config
"""
return _Config(
session=self._session,
token=self._token,
debug=self._debug,
ruk=self._ruk,
)
@property
def VirtualNetwork(self) -> "_VirtualNetwork":
"""
>>> from jelastic import Jelastic
>>> jelastic = Jelastic('https://app.xapp.cloudmydc.com', token='d6f4e314a5b5fefd164995169f28ae32d987704f')
>>> jelastic.administration.VirtualNetwork
Ref: https://docs.jelastic.com/api/private/#!/api/administration.VirtualNetwork
"""
return _VirtualNetwork(
session=self._session,
token=self._token,
debug=self._debug,
ruk=self._ruk,
)
[docs]
class _Analytics(Administration):
"""
Ref: https://docs.jelastic.com/api/private/#!/api/administration.Config
"""
_endpoint2 = "analytics"
[docs]
def GetNodesAffinitySuggestion(
self,
target_app_ids: list[str] = None,
node_groups: list[str] = None,
uids: list[int] = None,
thread_count: int = None,
ruk: str = None,
):
"""
A list of environments with one node in every layer where distribution can be optimized
:param target_app_ids: list of the exact environments that should be analyzed
:param node_groups: list of the node group IDs that should be analyzed
:param uids: list of the user IDs that should be analyzed
:param thread_count: a number of threads for container distribution analysis
"""
return self._get(
"GetNodesAffinitySuggestion",
params={
"targetAppIds": target_app_ids,
"nodeGroups": node_groups,
"uids": uids,
"threadCount": thread_count,
"ruk": ruk,
},
delimiter=",",
)
[docs]
def GetNodesAntiAffinitySuggestion(
self,
target_app_ids: list[str] = None,
mode: MODE = None,
node_groups: list[str] = None,
uids: list[int] = None,
thread_count: int = None,
ruk: str = None,
):
"""
A list of environments with non-optimal container distribution with optimization suggestions
:param target_app_ids: list of the exact environments that should be analyzed
:param mode: a mode of the anti-affinity analysis
:param node_groups: list of the node group IDs that should be analyzed
:param uids: list of the user IDs that should be analyzed
:param thread_count: a number of threads for container distribution analysis
"""
return self._get(
"GetNodesAntiAffinitySuggestion",
params={
"targetAppIds": target_app_ids,
"mode": mode,
"nodeGroups": node_groups,
"uids": uids,
"threadCount": thread_count,
"ruk": ruk,
},
delimiter=",",
)
[docs]
class _Cluster(Administration):
_endpoint2 = "cluster"
[docs]
def AddActionToIsolationQueue(
self, count: int = None, delay: int = None, ruk: str = None
):
return self._get(
"AddActionToIsolationQueue",
params={
"count": count,
"delay": delay,
"ruk": ruk,
},
)
[docs]
def AddCartridge(self, manifest_url: str, ruk: str = None):
return self._get(
"AddCartridge",
params={
"manifestUrl": manifest_url,
"ruk": ruk,
},
)
[docs]
def AddCertifiedTemplates(
self, repositories: str, publish: bool = None, ruk: str = None
):
return self._get(
"AddCertifiedTemplates",
params={
"repositories": repositories,
"publish": publish,
"ruk": ruk,
},
)
[docs]
def AddExtIps(self, ipfrom: str, ipto: str, regions: str, ruk: str = None):
return self._get(
"AddExtIps",
params={
"ipfrom": ipfrom,
"ipto": ipto,
"regions": regions,
"ruk": ruk,
},
)
[docs]
def AddHardWareNodeMessage(
self,
hn_id: int,
message_type: str,
process_response_code: int,
percentage: int,
message: str,
custom_data: str,
ruk: str = None,
):
return self._get(
"AddHardWareNodeMessage",
params={
"hnId": hn_id,
"messageType": message_type,
"processResponseCode": process_response_code,
"percentage": percentage,
"message": message,
"customData": custom_data,
"ruk": ruk,
},
)
[docs]
def AddHdNode(
self,
hdnode: dict,
set_as_docker_host: bool = None,
skip_configuration: bool = None,
ruk: str = None,
):
return self._get(
"AddHdNode",
params={
"hdnode": hdnode,
"setAsDockerHost": set_as_docker_host,
"skipConfiguration": skip_configuration,
"ruk": ruk,
},
)
[docs]
def AddHdNodeGroup(self, data: dict, ruk: str = None):
return self._get(
"AddHdNodeGroup",
params={
"data": data,
"ruk": ruk,
},
)
[docs]
def AddIps(self, ipfrom: str, ipto: str, region: str, ruk: str = None):
return self._get(
"AddIps",
params={
"ipfrom": ipfrom,
"ipto": ipto,
"region": region,
"ruk": ruk,
},
)
[docs]
def AddIpv6Network(self, region: str, network: str = None, ruk: str = None):
return self._get(
"AddIpv6Network",
params={
"network": network,
"region": region,
"ruk": ruk,
},
)
[docs]
def AddNameserver(self, node_id: int, nameserver: str, ruk: str = None):
return self._get(
"AddNameserver",
params={
"nodeId": node_id,
"nameserver": nameserver,
"ruk": ruk,
},
)
[docs]
def AddRegion(self, data: dict, test_authentication: bool = None, ruk: str = None):
"""
:param data: JSON object with the new hardware region data.
:param test_authentication: defines whether to check (true) or not (false) authentication on the region's Docker host.
"""
return self._get(
"AddRegion",
params={
"data": data,
"testAuthentication": test_authentication,
"ruk": ruk,
},
)
[docs]
def AddRegionDomain(
self, region_id: int, domain: str, primary: bool = None, ruk: str = None
):
"""
:param region_id: unique identifier of the target region.
:param domain: new domain name to be added for the region.
:param primary: defines whether to set the domain name as the region’s primary (true) or not (false).
"""
return self._get(
"AddRegionDomain",
params={
"regionId": region_id,
"domain": domain,
"primary": primary,
"ruk": ruk,
},
)
[docs]
def AddRegionReseller(
self,
reseller_id: int,
domain: str,
type: str,
generate_dns: bool,
ssl_type: str = None,
region_id: int = None,
key: str = None,
intermediate: str = None,
cert: str = None,
source502: str = None,
ruk: str = None,
):
"""
:param reseller_id: unique identifier of the target reseller platform.
:param domain: reseller platform domain name.
:param type: region type (PLATFORM or REGION).
:param generate_dns: defines whether to generate new DNS records (true) or just update existing SSL settings (false).
:param ssl_type: SSL certificate type (CUSTOM or LETSENCRYPT).
:param region_id: unique identifier of the existing region on the main platform.
:param key: SSL certificate key.
:param intermediate: intermediate SSL certificate.
:param cert: SSL certificate body.
:param source502: path to the 50x error pages source files.
"""
return self._get(
"AddRegionReseller",
params={
"resellerId": reseller_id,
"domain": domain,
"type": type,
"generateDns": generate_dns,
"sslType": ssl_type,
"regionId": region_id,
"key": key,
"intermediate": intermediate,
"cert": cert,
"source502": source502,
"ruk": ruk,
},
)
[docs]
def AddRegionSsl(
self,
region_id: int,
ssl_type: str,
domain_id: int = None,
cert_key: str = None,
intermediate: str = None,
cert: str = None,
ruk: str = None,
):
"""
:param region_id: unique identifier of the target region.
:param ssl_type: SSL certificates type (CUSTOM - manually provided certificates; LETSENCRYPT - automatically issued Let's Encrypt certificates).
:param domain_id: unique identifier of the target domain name.
:param cert_key: server key certificate (for CUSTOM sslType only).
:param intermediate: intermediate certificate CA (for CUSTOM sslType only).
:param cert: domain certificate (for CUSTOM sslType only).
"""
return self._get(
"AddRegionSsl",
params={
"regionId": region_id,
"sslType": ssl_type,
"domainId": domain_id,
"cert_key": cert_key,
"intermediate": intermediate,
"cert": cert,
"ruk": ruk,
},
)
[docs]
def AddTemplate(
self,
registry_id: int,
repository: str,
tags: str,
node_type: str,
node_mission: str,
display_name: str,
engine_type: str = None,
images_data: str = None,
auto_update: bool = None,
keep_selected_tags: bool = None,
update_default_tag: bool = None,
skip_tags_from_auto_update: str = None,
ruk: str = None,
):
return self._get(
"AddTemplate",
params={
"registryId": registry_id,
"repository": repository,
"tags": tags,
"nodeType": node_type,
"nodeMission": node_mission,
"displayName": display_name,
"engineType": engine_type,
"imagesData": images_data,
"autoUpdate": auto_update,
"keepSelectedTags": keep_selected_tags,
"updateDefaultTag": update_default_tag,
"skipTagsFromAutoUpdate": skip_tags_from_auto_update,
"ruk": ruk,
},
)
[docs]
def AddTemplateRegistry(
self,
data: str,
ruk: str = None,
):
return self._get(
"AddTemplateRegistry",
params={
"data": data,
"ruk": ruk,
},
)
[docs]
def AddUserToContainer(
self,
node_id: int = None,
container_id: int = None,
regenerate_keys: bool = None,
ruk: str = None,
):
return self._get(
"AddUserToContainer",
params={
"nodeId": node_id,
"containerId": container_id,
"regenerateKeys": regenerate_keys,
"ruk": ruk,
},
)
[docs]
def AddUsersToGate(self, ruk: str = None):
return self._get(
"AddUsersToGate",
params={
"ruk": ruk,
},
)
[docs]
def ApplyFirewallRules(self, ruk: str = None):
return self._get(
"ApplyFirewallRules",
params={
"ruk": ruk,
},
)
[docs]
def CheckMigrationEnvPossibility(
self, target_appid: str = None, hardware_node_group: str = None, ruk: str = None
):
return self._get(
"CheckMigrationEnvPossibility",
params={
"targetAppid": target_appid,
"hardwareNodeGroup": hardware_node_group,
"ruk": ruk,
},
)
[docs]
def CleanTemplateManifestCache(self, ruk: str = None):
return self._get(
"CleanTemplateManifestCache",
params={
"ruk": ruk,
},
)
[docs]
def ClearPool(self, hnid: int = None, ruk: str = None):
return self._get(
"ClearPool",
params={
"hnid": hnid,
"ruk": ruk,
},
)
[docs]
def ConvertPasswords(self, ruk: str = None):
return self._get(
"ConvertPasswords",
params={
"ruk": ruk,
},
)
[docs]
def DeactivateRegionDomain(self, region_id: int, domain_id: int, ruk: str = None):
return self._get(
"DeactivateRegionDomain",
params={
"regionId": region_id,
"domainId": domain_id,
"ruk": ruk,
},
)
[docs]
def DeleteEnv(self, target_appid: str, password: str, ruk: str = None):
return self._get(
"DeleteEnv",
params={
"targetAppid": target_appid,
"password": password,
"ruk": ruk,
},
)
[docs]
def DeleteEnvsByChecksum(
self, checksum: str, uid: int, target_appid: str, ruk: str = None
):
"""
:param checksum: checksum of the request.
:param uid: unique identifier of the target user.
:param target_appid: A semicolon-separated list of target environment IDs.
"""
return self._get(
"DeleteEnvsByChecksum",
params={
"checksum": checksum,
"uid": uid,
"targetAppid": target_appid,
"ruk": ruk,
},
)
[docs]
def DeleteEnvsByUidByChecksum(self, uid: int, ruk: str = None):
"""
:param uid: unique identifier of the target user.
"""
return self._get(
"DeleteEnvsByUidByChecksum",
params={
"uid": uid,
"ruk": ruk,
},
)
[docs]
def DeleteHDNode(self, hdnodeid: int, force: bool = None, ruk: str = None):
return self._get(
"DeleteHDNode",
params={
"hdnodeid": hdnodeid,
"force": force,
"ruk": ruk,
},
)
[docs]
def EditHdNode(
self, hdnode: dict, set_as_docker_host: bool = None, ruk: str = None
):
return self._get(
"EditHdNode",
params={
"hdnode": hdnode,
"set_as_docker_host": set_as_docker_host,
"ruk": ruk,
},
)
[docs]
def EditHdNodeGroup(self, data: dict, ruk: str = None):
return self._get(
"EditHdNodeGroup",
params={
"data": data,
"ruk": ruk,
},
)
[docs]
def EditRegion(self, data: dict, test_authentication: bool = None, ruk: str = None):
return self._get(
"EditRegion",
params={
"data": data,
"testAuthentication": test_authentication,
"ruk": ruk,
},
)
[docs]
def EditTemplate(
self,
node_type: str,
tags: str = None,
display_name: str = None,
engine_type: str = None,
images_data: str = None,
auto_update: bool = None,
keep_selected_tags: bool = None,
update_default_tag: bool = None,
skip_tags_from_auto_update: str = None,
ruk: str = None,
):
return self._get(
"EditTemplate",
params={
"nodeType": node_type,
"tags": tags,
"displayName": display_name,
"engineType": engine_type,
"imagesData": images_data,
"autoUpdate": auto_update,
"keepSelectedTags": keep_selected_tags,
"updateDefaultTag": update_default_tag,
"skipTagsFromAutoUpdate": skip_tags_from_auto_update,
"ruk": ruk,
},
)
[docs]
def EditTemplateRegistry(self, data: str, ruk: str = None):
return self._get(
"EditTemplateRegistry",
params={
"data": data,
"ruk": ruk,
},
)
[docs]
def EvacuateContainers(
self,
source_hn_id: str,
possible_target_node_ids: str = None,
is_online: bool = None,
ruk: str = None,
):
return self._get(
"EvacuateContainers",
params={
"sourceHnId": source_hn_id,
"possibleTargetNodeIds": possible_target_node_ids,
"isOnline": is_online,
"ruk": ruk,
},
)
[docs]
def ExecHnCMD(
self,
cmd: str,
hn_id: int = None,
infra_only: bool = None,
run_on_broken: bool = None,
vz_version: str = None,
docker_host_only: bool = None,
ruk: str = None,
):
return self._get(
"ExecHnCMD",
params={
"cmd": cmd,
"hnId": hn_id,
"infraOnly": infra_only,
"runOnBroken": run_on_broken,
"vzVersion": vz_version,
"dockerHostOnly": docker_host_only,
"ruk": ruk,
},
)
[docs]
def ExecHostCmd(
self,
cmd: str,
host_id: int = None,
infra_only: bool = None,
run_on_broken: bool = None,
vz_version: str = None,
docker_host_only: bool = None,
ruk: str = None,
):
return self._get(
"ExecHostCmd",
params={
"cmd": cmd,
"hostId": host_id,
"infraOnly": infra_only,
"runOnBroken": run_on_broken,
"vzVersion": vz_version,
"dockerHostOnly": docker_host_only,
"ruk": ruk,
},
)
[docs]
def GeneratePool(self, node_type: str = None, hnid: int = None, ruk: str = None):
return self._get(
"GeneratePool",
params={
"nodeType": node_type,
"hnId": hnid,
"ruk": ruk,
},
)
[docs]
def GetAddHdNodeCmd(self, hard_node_group: str = None, ruk: str = None):
return self._get(
"GetAddHdNodeCmd",
params={
"hardNodeGroup": hard_node_group,
"ruk": ruk,
},
)
[docs]
def GetAddHostCmd(self, host_group: str = None, ruk: str = None):
return self._get(
"GetAddHostCmd",
params={
"hostGroup": host_group,
"ruk": ruk,
},
)
[docs]
def GetAllContainers(self, ruk: str = None):
return self._get(
"GetAllContainers",
params={
"ruk": ruk,
},
)
[docs]
def GetAllRegionReseller(self, ruk: str = None):
return self._get(
"GetAllRegionReseller",
params={
"ruk": ruk,
},
)
[docs]
def GetAllSumStatByUid(
self,
duration: int = None,
endtime: datetime = None,
uid: int = None,
ruk: str = None,
):
return self._get(
"GetAllSumStatByUid",
params={
"duration": duration,
"endtime": endtime,
"uid": uid,
"ruk": ruk,
},
)
[docs]
def GetAppidByDomain(self, domain: str = None, ruk: str = None):
return self._get(
"GetAppidByDomain",
params={
"domain": domain,
"ruk": ruk,
},
)
[docs]
def GetBillableItems(self, ruk: str = None):
return self._get(
"GetBillableItems",
params={
"ruk": ruk,
},
)
[docs]
def GetClusterLoadHistory(
self, starttime: datetime, endtime: datetime, ruk: str = None
):
return self._get(
"GetClusterLoadHistory",
params={
"starttime": starttime,
"endtime": endtime,
"ruk": ruk,
},
datetime_format="%Y-%m-%d %H:%M:%S",
)
[docs]
def GetClusterLoadInfo(self, ruk: str = None):
return self._get(
"GetClusterLoadInfo",
params={
"ruk": ruk,
},
)
[docs]
def GetClusterLoadPercent(self, checksum: str, ruk: str = None):
return self._get(
"GetClusterLoadPercent",
params={
"checksum": checksum,
"ruk": ruk,
},
)
[docs]
def GetClusterStatus(
self, check_smtp: bool = None, cached: bool = None, ruk: str = None
):
return self._get(
"GetClusterStatus",
params={
"checkSMTP": check_smtp,
"cached": cached,
"ruk": ruk,
},
)
[docs]
def GetClusterUsage(self, ruk: str = None):
return self._get(
"GetClusterUsage",
params={
"ruk": ruk,
},
)
[docs]
def GetContainerConfig(self, node_id: int, ruk: str = None):
return self._get(
"GetContainerConfig",
params={
"nodeId": node_id,
"ruk": ruk,
},
)
[docs]
def GetDefaultRegion(self, ruk: str = None):
return self._get(
"GetDefaultRegion",
params={
"ruk": ruk,
},
)
[docs]
def GetDefaultTagInfo(self, node_type: str, engine: str = None, ruk: str = None):
return self._get(
"GetDefaultTagInfo",
params={
"nodeType": node_type,
"engine": engine,
"ruk": ruk,
},
)
[docs]
def GetDomainByIp(self, ips: str, ruk: str = None):
return self._get(
"GetDomainByIp",
params={
"ips": ips,
"ruk": ruk,
},
)
[docs]
def GetEngineTypes(self, ruk: str = None):
return self._get(
"GetEngineTypes",
params={
"ruk": ruk,
},
)
[docs]
def GetEnvGroupsByUid(self, uid: int, ruk: str = None):
return self._get(
"GetEnvGroupsByUid",
params={
"uid": uid,
"ruk": ruk,
},
)
[docs]
def GetEnvInfo(self, target_appid: str, ruk: str = None):
return self._get(
"GetEnvInfo",
params={
"targetAppid": target_appid,
"ruk": ruk,
},
)
[docs]
def GetEnvStat(self, starttime: datetime, endtime: datetime, ruk: str = None):
return self._get(
"GetEnvStat",
params={
"starttime": starttime,
"endtime": endtime,
"ruk": ruk,
},
datetime_format="%Y-%m-%d %H:%M:%S",
)
[docs]
def GetEnvironmentGroupPopulations(
self, start: datetime, end: datetime, ruk: str = None
):
"""
rows ordered by time asc not more than 1000 rows
:param start: slice start in date and time in ISO 8601
:param end: slice end in date and time in ISO 8601
"""
return self._get(
"GetEnvironmentGroupPopulations",
params={
"start": start,
"end": end,
"ruk": ruk,
},
datetime_format="%Y-%m-%d %H:%M:%S",
)
[docs]
def GetEnvs(
self,
uid: int,
rights: list[str] = None,
lazy: bool = None,
owner_uid: int = None,
ssh_access_only: bool = None,
ruk: str = None,
):
"""
A list of suitable environments.
:param uid: unique identifier of the target user.
:param rights: a comma-separated list of rights to filter environments. The filtering won't be applied if this parameter is not specified (all environments are displayed).
:param lazy: enables/disables lazy (on-demand) loading.
:param owner_uid: unique identifier of the target user account.
:param ssh_access_only: filter to environments with SSH access.
"""
return self._get(
"GetEnvs",
params={
"uid": uid,
"rights": rights,
"lazy": lazy,
"ownerUid": owner_uid,
"sshAccessOnly": ssh_access_only,
"ruk": ruk,
},
delimiter=",",
)
[docs]
def GetEvacuationState(self, hard_node_id: int, ruk: str = None):
"""
EvacuationState entity or null
"""
return self._get(
"GetEvacuationState",
params={
"hardNodeId": hard_node_id,
"ruk": ruk,
},
)
[docs]
def GetExtIpPoolInfo(self, search: dict, ruk: str = None):
return self._get(
"GetExtIpPoolInfo",
params={
"search": search,
"ruk": ruk,
},
)
[docs]
def GetHdNodeGroups(self, ruk: str = None):
return self._get(
"GetHdNodeGroups",
params={
"ruk": ruk,
},
)
[docs]
def GetHdNodeStatus(self, ruk: str = None):
return self._get(
"GetHdNodeStatus",
params={
"ruk": ruk,
},
)
[docs]
def GetHdNodes(self, ids: str = None, ruk: str = None):
return self._get(
"GetHdNodes",
params={
"ids": ids,
"ruk": ruk,
},
)
[docs]
def GetHdNodesLoad(self, duration: int, hdnodes: str = None, ruk: str = None):
return self._get(
"GetHdNodesLoad",
params={
"duration": duration,
"hdnodes": hdnodes,
"ruk": ruk,
},
)
[docs]
def GetHdNodesLoadInfo(self, ids: str = None, ruk: str = None):
return self._get(
"GetHdNodesLoadInfo",
params={
"ids": ids,
"ruk": ruk,
},
)
[docs]
def GetHosts(self, ids: str = None, ruk: str = None):
return self._get(
"GetHosts",
params={
"ids": ids,
"ruk": ruk,
},
)
[docs]
def GetIpPoolInfo(self, search: dict, ruk: str = None):
return self._get(
"GetIpPoolInfo",
params={
"search": search,
"ruk": ruk,
},
)
[docs]
def GetIpv6Networks(self, ruk: str = None):
return self._get(
"GetIpv6Networks",
params={
"ruk": ruk,
},
)
[docs]
def GetIpv6SubnetsInfo(self, search: str = None, ruk: str = None):
return self._get(
"GetIpv6SubnetsInfo",
params={
"search": search,
"ruk": ruk,
},
)
[docs]
def GetJelasticAppid(self, ruk: str = None):
return self._get(
"GetJelasticAppid",
params={
"ruk": ruk,
},
)
[docs]
def GetJobNames(self, ruk: str = None):
return self._get(
"GetJobNames",
params={
"ruk": ruk,
},
)
[docs]
def GetLastHardWareNodeMessage(self, id: int, ruk: str = None):
return self._get(
"GetLastHardWareNodeMessage",
params={
"id": id,
"ruk": ruk,
},
)
[docs]
def GetNodeInfo(self, target_appid: str, node_id: int, ruk: str = None):
"""
Result of operation or error.
:param target_appid: appid of user environment
:param node_id: id of SoftNode that belongs to env
"""
return self._get(
"GetNodeInfo",
params={
"targetAppid": target_appid,
"nodeId": node_id,
"ruk": ruk,
},
)
[docs]
def GetNodeMissions(self, ruk: str = None):
return self._get(
"GetNodeMissions",
params={
"ruk": ruk,
},
)
[docs]
def GetNodePassword(self, nodeid: int = None, ruk: str = None):
return self._get(
"GetNodePassword",
params={
"nodeid": nodeid,
"ruk": ruk,
},
)
[docs]
def GetNodes(
self,
hdnodeid: int,
name: str = None,
start_row: int = None,
result_count: int = None,
ruk: str = None,
):
return self._get(
"GetNodes",
params={
"hdnodeid": hdnodeid,
"name": name,
"startRow": start_row,
"resultCount": result_count,
"ruk": ruk,
},
)
[docs]
def GetOOMKilledProcesses(self, search: dict, ruk: str = None):
return self._get(
"GetOOMKilledProcesses",
params={
"search": search,
"ruk": ruk,
},
)
[docs]
def GetPcsClusterList(self, ruk: str = None):
return self._get(
"GetPcsClusterList",
params={
"ruk": ruk,
},
)
[docs]
def GetPoolStatus(self, ruk: str = None):
return self._get(
"GetPoolStatus",
params={
"ruk": ruk,
},
)
[docs]
def GetRegion(self, id: int, ruk: str = None):
return self._get(
"GetRegion",
params={
"id": id,
"ruk": ruk,
},
)
[docs]
def GetRegionDnsRecords(self, id: int, ruk: str = None):
return self._get(
"GetRegionDnsRecords",
params={
"id": id,
"ruk": ruk,
},
)
[docs]
def GetRegionDomains(self, region_id: int = None, ruk: str = None):
"""
param region_id: unique identifier of the target region.
"""
return self._get(
"GetRegionDomains",
params={
"regionId": region_id,
"ruk": ruk,
},
delimiter=",",
)
[docs]
def GetRegionResellerByResellerId(self, id: int, ruk: str = None):
return self._get(
"GetRegionResellerByResellerId",
params={
"id": id,
"ruk": ruk,
},
)
[docs]
def GetRegions(self, ruk: str = None):
return self._get(
"GetRegions",
params={
"ruk": ruk,
},
)
[docs]
def GetSoftNodeInfo(self, node_id: int, ruk: str = None):
return self._get(
"GetSoftNodeInfo",
params={
"nodeId": node_id,
"ruk": ruk,
},
)
[docs]
def GetStandByStatus(self, ruk: str = None):
return self._get(
"GetStandByStatus",
params={
"ruk": ruk,
},
)
[docs]
def GetStats(
self,
duration: int,
interval: int,
target_appid: str,
endtime: datetime = None,
nodeid: int = None,
nodetype: str = None,
node_group: str = None,
ruk: str = None,
):
return self._get(
"GetStats",
params={
"duration": duration,
"interval": interval,
"targetAppid": target_appid,
"endtime": endtime,
"nodeid": nodeid,
"nodetype": nodetype,
"nodeGroup": node_group,
"ruk": ruk,
},
datetime_format="%Y-%m-%d %H:%M:%S",
)
[docs]
def GetSumStat(
self,
duration: int = None,
endtime: datetime = None,
target_appid: str = None,
ruk: str = None,
):
return self._get(
"GetSumStat",
params={
"duration": duration,
"endtime": endtime,
"targetAppid": target_appid,
"ruk": ruk,
},
datetime_format="%Y-%m-%d %H:%M:%S",
)
[docs]
def GetSystemLog(self, search: str, ruk: str = None):
return self._get(
"GetSystemLog",
params={
"search": search,
"ruk": ruk,
},
)
[docs]
def GetTemplateInfo(self, node_type: str, ruk: str = None):
return self._get(
"GetTemplateInfo",
params={
"nodeType": node_type,
"ruk": ruk,
},
)
[docs]
def GetTemplateLabels(
self, repository: str, registry_id: int = None, tag: str = None, ruk: str = None
):
return self._get(
"GetTemplateLabels",
params={
"repository": repository,
"registryId": registry_id,
"tag": tag,
"ruk": ruk,
},
)
[docs]
def GetTemplateRegistries(self, ruk: str = None):
return self._get(
"GetTemplateRegistries",
params={
"ruk": ruk,
},
)
[docs]
def GetTemplates(
self,
type: str = None,
published: bool = None,
lazy: bool = None,
ruk: str = None,
):
return self._get(
"GetTemplates",
params={"type": type, "published": published, "lazy": lazy, "ruk": ruk},
)
[docs]
def GetUserActivity(
self,
uid: int,
starttime: datetime,
endtime: datetime,
target_appid: str = None,
start_row: int = None,
result_count: int = None,
service_name: str = None,
search_text: str = None,
action_types: str = None,
order_field: str = None,
order_direction: str = None,
ruk: str = None,
):
"""
param: uid: unique identifier of the target user.
param: starttime: a start time of a period for which user activity should be shown. In the format “yyyy-MM-dd hh:mm:ss”, e.g. "2022-11-16 00:00:00".
param: endtime: an end time of a period for which user activity should be shown. In the format “yyyy-MM-dd hh:mm:ss”, e.g. "2022-11-16 00:00:00".
param: target_appid: target environment name.
param: start_row: returns information starting from the specified row in the response (starts with 0, by default).
param: result_count: returns the specified number of rows from the response (0 – unlimited – by default).
param: service_name: filters results by the specified service name.
param: search_text: filters results by the provided string.
param: action_types: filters results by the action type.
params order_field: sorts results by the specified field.
param: order_direction: sorts results in the ascending (ASC) or descending (DESC) order.
"""
return self._get(
"GetUserActivity",
params={
"uid": uid,
"starttime": starttime,
"endtime": endtime,
"targetAppid": target_appid,
"startRow": start_row,
"resultCount": result_count,
"serviceName": service_name,
"searchText": search_text,
"actionTypes": action_types,
"orderField": order_field,
"orderDirection": order_direction,
"ruk": ruk,
},
datetime_format="%Y-%m-%d %H:%M:%S",
)
[docs]
def GetUsersActivities(
self,
starttime: datetime,
endtime: datetime,
start_row: int = None,
result_count: int = None,
ruk: str = None,
):
return self._get(
"GetUsersActivities",
params={
"starttime": starttime,
"endtime": endtime,
"startRow": start_row,
"resultCount": result_count,
"ruk": ruk,
},
datetime_format="%Y-%m-%d %H:%M:%S",
)
[docs]
def L2Update(self, hn_id: int, ruk: str = None):
return self._get(
"L2Update",
params={"hnId": hn_id, "ruk": ruk},
)
[docs]
def MigrateEnv(
self,
target_appid: str = None,
hardware_node_group: str = None,
is_online: bool = None,
ruk: str = None,
):
return self._get(
"MigrateEnv",
params={
"targetAppid": target_appid,
"hardwareNodeGroup": hardware_node_group,
"isOnline": is_online,
"ruk": ruk,
},
)
[docs]
def MigrateNode(
self,
nodeid: int,
hdnodeid: int,
is_online: bool = None,
manage_dns_state: bool = None,
ruk: str = None,
):
"""
param nodeid: unique identifier of the target node (container).
param hdnodeid: unique identifier of the target host.
param is_online: defines whether to perform online (true) or offline (false) migration.
param manage_dns_state: defines whether to exclude a target node from DNS for the duration of the operation (true) or not (false, by default). This parameter only works with the sequential processes (isSequential=true) and is ignored otherwise. Enabling the parameter will bring additional delay (as the DNS records have TTL and cannot be disabled instantly), while disabling can cause some of the requests to be lost.
"""
return self._get(
"MigrateNode",
params={
"nodeid": nodeid,
"hdnodeid": hdnodeid,
"isOnline": is_online,
"manageDNSState": manage_dns_state,
"ruk": ruk,
},
)
[docs]
def RedeployContainers(
self,
target_env_name: str,
tag: str,
node_group: str = None,
node_id: int = None,
use_existing_volumes: bool = None,
login: str = None,
password: str = None,
skip_reinstall: bool = None,
ruk: str = None,
):
return self._get(
"RedeployContainers",
params={
"targetEnvName": target_env_name,
"tag": tag,
"nodeGroup": node_group,
"nodeId": node_id,
"useExistingVolumes": use_existing_volumes,
"login": login,
"password": password,
"skipReinstall": skip_reinstall,
"ruk": ruk,
},
)
[docs]
def RefreshEmailTemplates(self, modules: str, ruk: str = None):
return self._get(
"RefreshEmailTemplates",
params={"modules": modules, "ruk": ruk},
)
[docs]
def RefreshUser(self, language: str = None, ruk: str = None):
return self._get(
"RefreshUser",
params={"language": language, "ruk": ruk},
)
[docs]
def RegeneratePool(self, node_type: str, exclude: str = None, ruk: str = None):
return self._get(
"RegeneratePool",
params={"nodeType": node_type, "exclude": exclude, "ruk": ruk},
)
[docs]
def RegisterInfaModule(
self,
module: str = None,
dst_env_name: str = None,
dry_run: bool = None,
ruk: str = None,
):
return self._get(
"RegisterInfaModule",
params={
"module": module,
"dstEnvName": dst_env_name,
"dryRun": dry_run,
"ruk": ruk,
},
)
[docs]
def RemoveExtIps(self, ips: str = None, ruk: str = None):
return self._get(
"RemoveExtIps",
params={"ips": ips, "ruk": ruk},
)
[docs]
def RemoveHdNodeGroup(self, id: int, ruk: str = None):
return self._get(
"RemoveHdNodeGroup",
params={"id": id, "ruk": ruk},
)
[docs]
def RemoveIpv6Network(self, id: int, ruk: str = None):
return self._get(
"RemoveIpv6Network",
params={"id": id, "ruk": ruk},
)
[docs]
def RemoveRegion(self, id: int, ruk: str = None):
return self._get(
"RemoveRegion",
params={"id": id, "ruk": ruk},
)
[docs]
def RemoveRegionReseller(
self, reseller_id: int, remove_dns: bool, region_id: int = None, ruk: str = None
):
return self._get(
"RemoveRegionReseller",
params={
"resellerId": reseller_id,
"dstEnvName": remove_dns,
"regionId": region_id,
"ruk": ruk,
},
)
[docs]
def RemoveRegionSsl(
self,
region_id: int,
domain_id: int = None,
reseller_id: int = None,
ruk: str = None,
):
"""
param region_id: unique identifier of the target region.
param domain_id: unique identifier of the target domain name.
param reseller_id: unique identifier of the target reseller platform.
"""
return self._get(
"RemoveRegionSsl",
params={
"regionId": region_id,
"domainId": domain_id,
"resellerId": reseller_id,
"ruk": ruk,
},
)
[docs]
def RemoveTemplate(self, node_type: str, ruk: str = None):
return self._get(
"RemoveTemplate",
params={"nodeType": node_type, "ruk": ruk},
)
[docs]
def RemoveTemplateRegistry(self, id: int, ruk: str = None):
return self._get(
"RemoveTemplateRegistry",
params={"id": id, "ruk": ruk},
)
[docs]
def ReplaceNodeInEnv(
self,
dst_env_name: str = None,
dst_node_id: int = None,
src_env_id: str = None,
src_hn_id: int = None,
ruk: str = None,
):
return self._get(
"ReplaceNodeInEnv",
params={
"dstEnvName": dst_env_name,
"dstNodeId": dst_node_id,
"srcEnvId": src_env_id,
"srcHnId": src_hn_id,
"ruk": ruk,
},
)
[docs]
def ReviveInstallHdNode(self, id: int, ruk: str = None):
return self._get(
"ReviveInstallHdNode",
params={"id": id, "ruk": ruk},
)
[docs]
def SearchEnvs(self, search: dict, ruk: str = None):
return self._get(
"SearchEnvs",
params={"search": search, "ruk": ruk},
)
[docs]
def SearchNodes(self, search: dict, ruk: str = None):
return self._get(
"SearchNodes",
params={"search": search, "ruk": ruk},
)
[docs]
def SetDefaultTemplateTag(self, node_type: str, tag: str, ruk: str = None):
return self._get(
"SetDefaultTemplateTag",
params={"nodeType": node_type, "tag": tag, "ruk": ruk},
)
[docs]
def SetEnvNote(self, target_appid: str = None, note: str = None, ruk: str = None):
"""
param target_appid: target environment name
param note: custom note for the target environment
"""
return self._get(
"SetEnvNote",
params={"targetAppid": target_appid, "note": note, "ruk": ruk},
)
[docs]
def SetEnvStatus(self, target_appid: str, status: int, ruk: str = None):
"""
param target_appid: appid of the required environment
param status: new status for the specified environment whose appid equals to {@code targetAppid}.
"""
return self._get(
"SetEnvStatus",
params={"targetAppid": target_appid, "status": status, "ruk": ruk},
)
[docs]
def SetEnvsStatus(self, target_appid: str, status: int, ruk: str = None):
"""
param target_appid: list of appids separated by commas
param status: new status for each environment whose appid is in {@code targetAppids}.
"""
return self._get(
"SetEnvsStatus",
params={"targetAppid": target_appid, "status": status, "ruk": ruk},
)
[docs]
def SetEnvsStatusByUid(self, uid: int, status: int, ruk: str = None):
return self._get(
"SetEnvsStatusByUid",
params={"uid": uid, "status": status, "ruk": ruk},
)
[docs]
def SetEnvsStatusByUidByChecksum(self, uid: int, status: int, ruk: str = None):
return self._get(
"SetEnvsStatusByUidByChecksum",
params={"uid": uid, "status": status, "ruk": ruk},
)
[docs]
def SetRegionDnsRecords(self, id: int, data: int, ruk: str = None):
return self._get(
"SetRegionDnsRecords",
params={"id": id, "data": data, "ruk": ruk},
)
[docs]
def SetRegionPrimaryDomain(self, region_id: int, domain_id: int, ruk: str = None):
"""
param region_id: unique identifier of the target region.
param domain_id: unique identifier of the target domain name.
"""
return self._get(
"SetRegionPrimaryDomain",
params={"regionId": region_id, "domainId": domain_id, "ruk": ruk},
)
[docs]
def SetStandbyMode(self, enabled: bool, ruk: str = None):
return self._get(
"SetStandbyMode",
params={"enabled": enabled, "ruk": ruk},
)
[docs]
def SetTemplatePublished(self, node_type: str, published: bool, ruk: str = None):
return self._get(
"SetTemplatePublished",
params={"nodeType": node_type, "published": published, "ruk": ruk},
)
[docs]
def Sleep(
self,
starttime: datetime = None,
endtime: datetime = None,
deactivate_after: int = None,
ruk: str = None,
):
"""
param starttime: start of the period (date and time in format yyyy-MM-dd HH:mm:ss, timezone GMT+0)
param endtime: end of the period (date and time in format yyyy-MM-dd HH:mm:ss, timezone GMT+0)
param deactivate_after: in milliseconds. deactivate only environment inactive more than this time. *
"""
return self._get(
"Sleep",
params={
"starttime": starttime,
"endtime": endtime,
"deactivateAfter": deactivate_after,
"ruk": ruk,
},
datetime_format="%Y-%m-%d %H:%M:%S",
)
[docs]
def StartEnv(self, target_appid: str, ruk: str = None):
return self._get(
"StartEnv(",
params={"targetAppid": target_appid, "ruk": ruk},
)
[docs]
def StopBalanceResources(self, ruk: str = None):
return self._get(
"StopBalanceResources(",
params={"ruk": ruk},
)
[docs]
def StopEnv(self, target_appid: str, ruk: str = None):
return self._get(
"StopEnv(",
params={"targetAppid": target_appid, "ruk": ruk},
)
[docs]
def StopEvacuation(self, hard_node_id: int, ruk: str = None):
return self._get(
"StopEvacuation",
params={"hardNodeId": hard_node_id, "ruk": ruk},
)
[docs]
def SyncCloudlets(self, starttime: datetime, debug: bool = None, ruk: str = None):
return self._get(
"SyncCloudlets(",
params={"starttime": starttime, "debug": debug, "ruk": ruk},
datetime_format="%Y-%m-%d %H:%M:%S",
)
[docs]
def SyncInfaModule(
self,
node_group: str,
dst_env_name: str,
components: str,
target_tag: str = None,
ruk: str = None,
):
return self._get(
"SyncInfaModule",
params={
"nodeGroup": node_group,
"dstEnvName": dst_env_name,
"components": components,
"targetTag": target_tag,
"ruk": ruk,
},
)
[docs]
def UpdateRegionSsl(self, region_id: int, domain_id: int = None, ruk: str = None):
"""
param region_id: unique identifier of the target region.
param domain_id: unique identifier of the target domain name.
"""
return self._get(
"UpdateRegionSsl",
params={"regionId": region_id, "domainId": domain_id, "ruk": ruk},
)
[docs]
def UpdateTemplate(self, node_type: int, icons_only: bool = None, ruk: str = None):
return self._get(
"UpdateTemplate",
params={"nodeType": node_type, "iconsOnly": icons_only, "ruk": ruk},
)
[docs]
def Validate(self, ruk: str = None):
return self._get(
"Validate",
params={"ruk": ruk},
)
[docs]
def ValidateAll(self, ruk: str = None):
return self._get(
"ValidateAll",
params={"ruk": ruk},
)
[docs]
def ValidateSsl(
self,
domain: str,
key: str = None,
intermediate: str = None,
cert: str = None,
ruk: str = None,
):
return self._get(
"ValidateSsl",
params={
"domain": domain,
"key": key,
"intermediate": intermediate,
"cert": cert,
"ruk": ruk,
},
)
[docs]
class _Config(Administration):
"""
Ref: https://docs.jelastic.com/api/private/#!/api/administration.Config
"""
_endpoint2 = "config"
[docs]
def ApplyConfig(self, type: str, password: str, ruk: str = None):
return self._get(
"ApplyConfig",
params={"type": type, "password": password, "ruk": ruk},
)
[docs]
def ApplyDefaults(self, edition: str, ruk: str = None):
return self._get(
"ApplyDefaults",
params={"edition": edition, "ruk": ruk},
)
[docs]
def ApplyResellerConfig(
self, type: str, password: str, reseller_id: str, ruk: str = None
):
return self._get(
"ApplyResellerConfig",
params={
"type": type,
"password": password,
"resellerId": reseller_id,
"ruk": ruk,
},
)
[docs]
def ChangeConfigKey(self, type: str, key: str, value: str = None, ruk: str = None):
return self._get(
"ChangeConfigKey",
params={"type": type, "key": key, "value": value, "ruk": ruk},
)
[docs]
def ChangePropertiesForReseller(self, reseller_id: str, ruk: str = None):
return self._get(
"ChangePropertiesForReseller",
params={"resellerId": reseller_id, "ruk": ruk},
)
[docs]
def CreatingConfigType(self, type: str, description: str, ruk: str = None):
return self._get(
"CreatingConfigType",
params={"type": type, "description": description, "ruk": ruk},
)
[docs]
def CreatingKeyConfig(
self,
type: str,
key: str,
value: str,
default_value: str,
expert: str,
description: str,
key_type: str,
ruk: str = None,
):
return self._get(
"CreatingKeyConfig",
params={
"type": type,
"key": key,
"value": value,
"default_value": default_value,
"expert": expert,
"description": description,
"keyType": key_type,
"ruk": ruk,
},
)
[docs]
def FindConfigKey(self, value: str, ruk: str = None):
return self._get(
"FindConfigKey",
params={"value": value, "ruk": ruk},
)
[docs]
def GetAllConfigType(self, expert: str, ruk: str = None):
return self._get(
"GetAllConfigType",
params={"expert": expert, "ruk": ruk},
)
[docs]
def GetAllKeyConfigByType(self, type: str, expert: str, ruk: str = None):
return self._get(
"GetAllKeyConfigByType",
params={"type": type, "expert": expert, "ruk": ruk},
)
[docs]
def GetConfigKey(self, type: str, key: str, ruk: str = None):
"""
:param type: configuration type
:param key: configuration key name
"""
return self._get(
"GetConfigKey",
params={"type": type, "key": key, "ruk": ruk},
)
[docs]
def GetConfigKeyByResellerId(
self, type: str, key: str, reseller_id: int = None, ruk: str = None
):
"""
:param type: configuration type
:param key: configuration key name
:param reseller_id: unique identifier of the reseller (Optional)
"""
return self._get(
"GetConfigKeyByResellerId",
params={"type": type, "key": key, "resellerId": reseller_id, "ruk": ruk},
)
[docs]
def GetConfigKeys(
self, type: list[str] = None, key: list[str] = None, ruk: str = None
):
"""
:param type: a comma-separated list of the setting types (for filtering).
:param key: a comma-separated list of the setting names (for filtering).
"""
return self._get(
"GetConfigKeys",
params={"type": type, "key": key, "ruk": ruk},
delimiter=",",
)
[docs]
def RemoveConfigKey(self, type: str, key: str, ruk: str = None):
return self._get(
"RemoveConfigKey",
params={"type": type, "key": key, "ruk": ruk},
)
[docs]
def RemoveConfigType(self, type: str, ruk: str = None):
return self._get(
"RemoveConfigType",
params={"type": type, "ruk": ruk},
)
[docs]
def RemoveResellerProperties(self, reseller_id: int, ruk: str = None):
return self._get(
"RemoveResellerProperties",
params={"resellerId": reseller_id, "ruk": ruk},
)
[docs]
def RevertConfigKey(self, type: str, key: str, ruk: str = None):
return self._get(
"RevertConfigKey",
params={"type": type, "key": key, "ruk": ruk},
)
[docs]
def SetResellerConfigKey(
self, type: str, key: str, value: str, reseller_id: int, ruk: str = None
):
return self._get(
"SetResellerConfigKey",
params={
"type": type,
"key": key,
"value": value,
"resellerId": reseller_id,
"ruk": ruk,
},
)
[docs]
class _Resource(Administration):
"""
Ref: https://docs.jelastic.com/api/private/#!/api/administration.Resource
"""
_endpoint2 = "resource"
[docs]
def AddStatistics(
self,
resource_name: str,
uid: int,
value: int,
start_date: date = None,
end_date: date = None,
env_name: str = None,
node_id: int = None,
note: str = None,
value_group: str = None,
ruk: str = None,
):
return self._get(
"AddStatistics",
params={
"resourceName": resource_name,
"uid": uid,
"value": value,
"startDate": start_date,
"endDate": end_date,
"envName": env_name,
"nodeId": node_id,
"note": note,
"valueGroup": value_group,
"ruk": ruk,
},
datetime_format="%Y-%m-%d",
)
[docs]
class _Update(Administration):
"""
Ref: https://docs.jelastic.com/api/private/#!/api/administration.Update
"""
_endpoint2 = "update"
[docs]
def FixExtDns(self, uid: int = None, target_app_id: str = None, ruk: str = None):
return self._get(
"FixExtDns",
params={"uid": uid, "targetAppIds": target_app_id, "ruk": ruk},
)
[docs]
def RestoreEnv(
self, env_name: str = None, uid: int = None, region: str = None, ruk: str = None
):
return self._get(
"RestoreEnv",
params={"envName": env_name, "uid": uid, "region": region, "ruk": ruk},
)
[docs]
def SyncInfraEnv(self, domain: str = None, registry: str = None, ruk: str = None):
return self._get(
"SyncInfraEnv",
params={"domain": domain, "registry": registry, "ruk": ruk},
)
[docs]
class _Monitoring(Administration):
"""
Ref: https://docs.jelastic.com/api/private/#!/api/administration.Monitoring
"""
_endpoint2 = "monitoring"
[docs]
def GetDockerPullStatus(self, ruk: str = None):
"""
Returns cached result of the "docker pull" operation (cache lifetime = 600s). Pulled image is selected randomly from the list of published DOCKERIZED templates. This method is used for monitoring.
"""
return self._get("GetDockerPullStatus", params={"ruk": ruk})
[docs]
def GetHostFirewallStatus(self, ruk: str = None):
return self._get("GetHostFirewallStatus", params={"ruk": ruk})
[docs]
class _Template(Administration):
"""
Ref: https://docs.jelastic.com/api/private/#!/api/administration.Template
"""
_endpoint2 = "template"
[docs]
def SetDefaultRegistry(self, id: int = None, ruk: str = None):
"""
:param id: identifier of the registry.
"""
return self._get(
"SetDefaultRegistry",
params={"id": id, "ruk": ruk},
)
[docs]
def SetDistribution(
self, node_types: str, distribution: str = None, ruk: str = None
):
"""
:param node_type: templates where distribution should be set.
:param distribution: zone configuration JSON string, example: {"mode":"STRICT","zones":"windows"}.
"""
return self._get(
"SetDistribution",
params={"nodeTypes": node_types, "distribution": distribution, "ruk": ruk},
)
[docs]
class _HostGroup(Administration):
"""
Ref: https://docs.jelastic.com/api/private/#!/api/administration.HostGroup
"""
_endpoint2 = "hostgroup"
[docs]
def Add(self, data: dict, ruk: str = None):
"""
:param data: JSON representation of an object (host group) that should be created.
"""
return self._get(
"Add",
params={"data": data, "ruk": ruk},
)
[docs]
def AddEndpoints(self, host_group: str, end_points: dict, ruk: str = None):
"""
:param host_group: unique identifier of the target host group.
:param end_points: JSON array of endpoint objects.
"""
return self._get(
"AddEndpoints",
params={"hostGroup": host_group, "endpoints": end_points, "ruk": ruk},
)
[docs]
def Edit(self, data: dict, ruk: str = None):
"""
:param data: JSON representation of an object (host group) that should be edited.
"""
return self._get(
"Edit",
params={"data": data, "ruk": ruk},
)
[docs]
def EditEndpoints(self, host_group: str, end_points: dict, ruk: str = None):
"""
:param end_points: JSON array of endpoint objects
"""
return self._get(
"EditEndpoints",
params={"hostGroup": host_group, "endpoints": end_points, "ruk": ruk},
)
[docs]
def Get(self, ruk: str = None):
return self._get("Get", params={"ruk": ruk})
[docs]
def GetEndpoints(self, host_group: str, ruk: str = None):
"""
:param host_group: unique identifier of the target host group.
"""
return self._get(
"GetEndpoints",
params={"hostGroup": host_group, "ruk": ruk},
)
[docs]
def Remove(self, id: int, ruk: str = None):
"""
:param id:unique identifier of the target host group.
"""
return self._get(
"Remove",
params={"id": id, "ruk": ruk},
)
[docs]
def RemoveEndpoints(self, id: int, ruk: str = None):
"""
:param id:unique identifier of the target endpoint.
"""
return self._get(
"RemoveEndpoints",
params={"id": id, "ruk": ruk},
)
[docs]
def RenameRemoteUser(self, uid: int, email: str, ruk: str = None):
"""
:param uid: unique identifier of the target user.
:param email: new email address for the user.
"""
return self._get(
"RenameRemoteUser",
params={"uid": uid, "email": email, "ruk": ruk},
)
[docs]
def TestEndpoints(self, end_points: dict, ruk: str = None):
"""
:param end_points: JSON array with endpoints objects with ids.
"""
return self._get(
"TestEndpoints",
params={"endPoints": end_points, "ruk": ruk},
)
[docs]
class _Host(Administration):
"""
Ref: https://docs.jelastic.com/api/private/#!/api/administration.Host
"""
_endpoint2 = "host"
[docs]
def AddLabels(self, ids: str, labels: str, ruk: str = None):
return self._get(
"AddLabels",
params={"ids": ids, "labels": labels, "ruk": ruk},
)
[docs]
def CheckHostConnection(
self,
host_id: str,
port: int = None,
check_external_ip: bool = None,
ruk: str = None,
):
"""
:param host_id: unique identifier of the target host.
:param port: checks the connection through the custom port (host's SSH port from the settings if not specified).
"""
return self._get(
"CheckHostConnection",
params={
"hostId": host_id,
"port": port,
"checkExternalIp": check_external_ip,
"ruk": ruk,
},
)
[docs]
def GetHostFirewallSets(self, ruk: str = None):
return self._get("GetHostFirewallSets", params={"ruk": ruk})
[docs]
def RemoveLabels(self, ids: str, labels: str, ruk: str = None):
return self._get(
"RemoveLabels", params={"ids": ids, "labels": labels, "ruk": ruk}
)
[docs]
def SetLabels(self, ids: str, labels: str, ruk: str = None):
return self._get("SetLabels", params={"ids": ids, "labels": labels, "ruk": ruk})
[docs]
def UpdateHostFirewall(
self,
host_id: int = None,
force: bool = None,
check_external_ip: bool = None,
ruk: str = None,
):
"""
:param host_id: unique identifier of the target host (all hosts if not defined).
:param force: proceeds (true) or interrupts (false) the operation in case of errors.
"""
return self._get(
"UpdateHostFirewall",
params={
"hostId": host_id,
"force": force,
"checkExternalIp": check_external_ip,
"ruk": ruk,
},
)
[docs]
class _Utils(Administration):
"""
Ref: https://docs.jelastic.com/api/private/#!/api/administration.Utils
"""
_endpoint2 = "utils"
[docs]
def AddSystemExternalDNSRecord(
self,
record_data: str,
name: str,
ttl: int,
record_data_type: str,
ssl_enabled: bool = None,
enabled: bool = None,
ruk: str = None,
):
"""
:param record_data: custom data for the DNS record.
:param name: name for DNS records (must be the same as one of the existing record).
:param ttl: TTL (time to live) value for the DNS record.
:param record_data_type: type of the DNS record data (currently, only the ‘TXT’ value is supported).
:param ssl_enabled: defines whether the SSL is enabled for the record (true, by default) or not (false).
:param enabled: defines whether the record is enabled (true, by default) or not (false).
"""
return self._get(
"AddSystemExternalDNSRecord",
params={
"recordData": record_data,
"name": name,
"ttl": ttl,
"recordDataType": record_data_type,
"sslEnabled": ssl_enabled,
"enabled": enabled,
"ruk": ruk,
},
)
[docs]
def AnalizeEnv(self, domain: str, ruk: str = None):
return self._get(
"AnalizeEnv",
params={"domain": domain, "ruk": ruk},
)
[docs]
def BalanceResources(self, domain: int, ruk: str = None):
return self._get("BalanceResources", params={"domain": domain, "ruk": ruk})
[docs]
def ClearEnvs(self, ruk: str = None):
return self._get("ClearEnvs", params={"ruk": ruk})
[docs]
def DeleteBrokenEnvs(self, target_app_ids: str = None, ruk: str = None):
return self._get(
"DeleteBrokenEnvs",
params={"targetAppIds": target_app_ids, "ruk": ruk},
)
[docs]
def EditSystemExternalDNSRecord(
self,
id: int,
record_data: str = None,
name: str = None,
ttl: int = None,
record_data_type: str = None,
ssl_enabled: bool = None,
enabled: bool = None,
ruk: str = None,
):
"""
:param id: unique identifier of the target custom external DNS record.
:param record_data: new custom data for the DNS record.
:param name: name for DNS records (must be the same as one of the existing record).
:param ttl: TTL (time to live) value for the DNS record.
:param record_data_type: type of the DNS record data (currently, only the ‘TXT’ value is supported).
:param ssl_enabled: defines whether the SSL is enabled for the record (true, by default) or not (false).
:param enabled: defines whether the record is enabled (true, by default) or not (false).
"""
return self._get(
"EditSystemExternalDNSRecord",
params={
"id": id,
"recordData": record_data,
"name": name,
"ttl": ttl,
"recordDataType": record_data_type,
"sslEnabled": ssl_enabled,
"enabled": enabled,
"ruk": ruk,
},
)
[docs]
def ExportEnv(self, target_app_id: str, ruk: str = None):
return self._get(
"ExportEnv",
params={"targetAppId": target_app_id, "ruk": ruk},
)
[docs]
def FixExtDns(self, uid: int = None, target_app_id: str = None, ruk: str = None):
return self._get(
"FixExtDns",
params={"uid": uid, "targetAppId": target_app_id, "ruk": ruk},
)
[docs]
def FixLaunching(self, ruk: str = None):
return self._get("FixLaunching", params={"ruk": ruk})
[docs]
def GenerateZone(self, generate_slept: bool, ruk: str = None):
return self._get(
"GenerateZone",
params={"generateSlept": generate_slept, "ruk": ruk},
)
[docs]
def GetAvgs(self, ruk: str = None):
return self._get("GetAvgs", params={"ruk": ruk})
[docs]
def GetAvgs2(self, ruk: str = None):
return self._get("GetAvgs2", params={"ruk": ruk})
[docs]
def GetBalancerStat(
self, start_time: datetime, end_time: datetime, ruk: str = None
):
return self._get(
"GetBalancerStat",
params={"starttime": start_time, "endtime": end_time, "ruk": ruk},
datetime_format="%Y-%m-%d %H:%M:%S",
)
[docs]
def GetCloudletsUsage(self, ruk: str = None):
return self._get("GetCloudletsUsage", params={"ruk": ruk})
[docs]
def GetDBCreationStat(
self, start_time: datetime, end_time: datetime, ruk: str = None
):
return self._get(
"GetDBCreationStat",
params={"startTime": start_time, "endTime": end_time, "ruk": ruk},
datetime_format="%Y-%m-%d %H:%M:%S",
)
[docs]
def GetErrors(
self,
start_time: datetime,
end_time: datetime,
start_row: int,
result_count: int,
filter: int = None,
ruk: str = None,
):
return self._get(
"GerErrors",
params={
"starttime": start_time,
"endtime": end_time,
"startrow": start_row,
"resultCount": result_count,
"filter": filter,
"ruk": ruk,
},
datetime_format="%Y-%m-%d %H:%M:%S",
)
[docs]
def GetErrorsByDate(
self,
start_time: datetime,
end_time: datetime,
interval: int,
filter: int = None,
ruk: str = None,
):
return self._get(
"GetErrorsByDate",
params={
"starttime": start_time,
"endtime": end_time,
"interval": interval,
"filter": filter,
"ruk": ruk,
},
datetime_format="%Y-%m-%d %H:%M:%S",
)
[docs]
def GetSystemExternalDNSRecords(self, ruk: str = None):
return self._get("GetSystemExternalDNSRecords", params={"ruk": ruk})
[docs]
def GetZone(self, ruk: str = None):
return self._get("GetZone", params={"ruk": ruk})
[docs]
def ImportEnv(
self,
env_info: str,
env_name: str = None,
enable_firewall: bool = None,
ruk: str = None,
):
return self._get(
"ImportEnv",
params={
"envInfo": env_info,
"envName": env_name,
"enableFirewall": enable_firewall,
"ruk": ruk,
},
)
[docs]
def InspectEnvs(self, remove: bool = None, ruk: str = None):
return self._get(
"InspectEnvs",
params={"remove": remove, "ruk": ruk},
)
[docs]
def ManageService(
self, node_id: int, command: str, service_name: str, ruk: str = None
):
return self._get(
"ManageServices",
params={
"nodeid": node_id,
"command": command,
"servicename": service_name,
"ruk": ruk,
},
)
[docs]
def RemoveSystemExternalDNSRecord(self, id: int, ruk: str = None):
return self._get(
"RemoveSystemExternalDNSRecord",
params={"id": id, "ruk": ruk},
)
[docs]
def UpdateEnv(self, target_app_id: str, ruk: str = None):
return self._get(
"UpdateEnv",
params={"targetAppId": target_app_id, "ruk": ruk},
)
[docs]
def UpdateEnvInThread(self, target_app_id: str, ruk: str = None):
return self._get(
"UpdateEnvInThread",
params={"targetAppId": target_app_id, "ruk": ruk},
)
[docs]
def UpdateNodes(self, ruk: str = None):
return self._get("UpdateNodes", params={"ruk": ruk})
[docs]
class _Subscription(Administration):
"""
Ref: https://docs.jelastic.com/api/private/#!/api/administration.Subscription
"""
_endpoint2 = "subscription"
[docs]
def AddCategory(self, category: dict, reseller_id: int = None, ruk: str = None):
"""
:param category: JSON representation of an object (subscription Category) that should be created
:param reseller_id: unique identifier of the target reseller platform.
"""
return self._get(
"AddCategory",
params={"category": category, "resellerId": reseller_id, "ruk": ruk},
)
[docs]
def AddProduct(
self, product: dict = None, reseller_id: int = None, ruk: str = None
):
"""
:param category: JSON representation of an object (subscription Product) that should be created.
:param product: unique identifier of the target reseller platform.
"""
return self._get(
"AddProduct",
params={"product": product, "resellerId": reseller_id, "ruk": ruk},
)
[docs]
def AddServicePlan(
self,
service_plan: dict,
reseller_id: int = None,
expand_fields: str = None,
ruk: str = None,
):
"""
:param service_plan: JSON representation of an object (subscription Service Plan) that should be created.
:param reseller_id: unique identifier of the target reseller platform.
:param expand_fields: there are fields that are not included in responses by default. You can request these fields as an expanded response by listing required object paths in this parameter (e.g. account.group).
"""
return self._get(
"AddServicePlan",
params={
"servicePlan": service_plan,
"resellerId": reseller_id,
"expandFields": expand_fields,
"ruk": ruk,
},
)
[docs]
def AddSubscriptionItemResource(
self,
subscription_id: int,
item_id: int,
item_resource_id: int,
resources: dict,
ruk: str = None,
):
"""
:param subscription_id: unique identifier of the target subscription.
:param item_id: unique identifier of the target subscription item.
:param item_resource_id: unique identifier of the target subscription item resource.
:param resources: JSON representation of an object (subscription item resource) that should be created.
"""
return self._get(
"AddSubscriptionItemResource",
params={
"subscriptionId": subscription_id,
"itemId": item_id,
"itemResourceId": item_resource_id,
"resources": resources,
"ruk": ruk,
},
)
[docs]
def AdjustProduct(
self, subscription_id: int, item_id: int, item_resource_id: int, ruk: str = None
):
"""
:param subscription_id: unique identifier of the target subscription.
:param item_id: unique identifier of the target subscription item.
:param item_resource_id: unique identifier of the target subscription item resource.
"""
return self._get(
"AdjustProduct",
params={
"subscriptionId": subscription_id,
"itemId": item_id,
"itemResourceId": item_resource_id,
"ruk": ruk,
},
)
[docs]
def DeleteCategory(self, id: int, reseller_id: int = None, ruk: str = None):
"""
:param id: unique identifier of the target category.
:param reseller_id: unique identifier of the target reseller platform.
"""
return self._get(
"DeleteCategory", params={"id": id, "resellerId": reseller_id, "ruk": ruk}
)
[docs]
def DeleteProduct(self, id: int, reseller_id: int = None, ruk: str = None):
"""
:param id: unique identifier of the target product.
:param reseller_id: unique identifier of the target reseller platform.
"""
return self._get(
"DeleteProduct", params={"id": id, "resellerId": reseller_id, "ruk": ruk}
)
[docs]
def DeleteServicePlan(self, id: int, reseller_id: int = None, ruk: str = None):
"""
:param id: unique identifier of the target service plan.
:param reseller_id: unique identifier of the target reseller platform.
"""
return self._get(
"DeleteServicePlan",
params={"id": id, "resellerId": reseller_id, "ruk": ruk},
)
[docs]
def EditCategory(self, category: dict, reseller_id: int = None, ruk: str = None):
"""
:param category: JSON representation of an object (subscription Category) that should be created.
:param reseller_id: unique identifier of the target reseller platform.
"""
return self._get(
"EditCategory",
params={"category": category, "resellerId": reseller_id, "ruk": ruk},
)
[docs]
def EditProduct(self, category: dict, reseller_id: int = None, ruk: str = None):
"""
:param category: JSON representation of an object (subscription Product) that should be created.
:param reseller_id: unique identifier of the target reseller platform.
"""
return self._get(
"EditProduct",
params={"category": category, "resellerId": reseller_id, "ruk": ruk},
)
[docs]
def EditServicePlan(
self,
service_plan: dict,
reseller_id: int = None,
expend_fields: str = None,
ruk: str = None,
):
"""
:param service_plan: JSON representation of an object (subscription Service Plan) that should be created.
:param reseller_id: unique identifier of the target reseller platform.
:param expend_fields: there are fields that are not included in responses by default. You can request these fields as an expanded response by listing required object paths in this parameter (e.g. account.group).
"""
return self._get(
"EditServicePlan",
params={
"servicePlan": service_plan,
"resellerId": reseller_id,
"expendFields": expend_fields,
"ruk": ruk,
},
)
[docs]
def GetCategories(
self, reseller_id: int = None, expend_fields: str = None, ruk: str = None
):
"""
:param reseller_id: unique identifier of the target reseller platform.
:param expend_fields: there are fields that are not included in responses by default. You can request these fields as an expanded response by listing required object paths in this parameter (e.g. account.group).
"""
return self._get(
"GetCategories",
params={
"resellerId": reseller_id,
"expendFields": expend_fields,
"ruk": ruk,
},
)
[docs]
def GetProducts(
self,
id: int = None,
status: list[str] = None,
reseller_id: int = None,
subscription_status: list[str] = None,
expend_fields: str = None,
start_row: int = None,
result_count: int = None,
order_field: str = None,
order_direction: str = None,
ruk: str = None,
):
"""
:param id: unique identifier of the product (for filtering).
:param status: a comma-separated list of the subscription Product statuses (ProductStatus) that should be returned.
:param reseller_id: unique identifier of the target reseller platform.
:param subscription_status: a comma-separated list of the subscription statuses (SubscriptionStatus) that should be returned.
:param expend_fields: there are fields that are not included in responses by default. You can request these fields as an expanded response by listing required object paths in this parameter (e.g. account.group).
:param start_row: returns information starting from the specified row in the response (starts with 0, by default).
:param result_count: returns the specified number of rows from the response (0 – unlimited – by default).
:param order_field: sorts results by the specified field
:param order_direction: sorts results in the ascending (ASC) or descending (DESC) order
"""
return self._get(
"GetProduct",
params={
"id": id,
"status": status,
"resellerId": reseller_id,
"subscriptionStatus": subscription_status,
"expandFields": expend_fields,
"startRow": start_row,
"resultCount": result_count,
"orderField": order_field,
"orderDirection": order_direction,
"ruk": ruk,
},
delimiter=",",
)
[docs]
def GetServicePlans(
self,
id: int = None,
has_products: bool = None,
subscription_status: list[str] = None,
product_id: int = None,
expend_fields: str = None,
reseller_id: int = None,
ruk: str = None,
):
"""
:param id: unique identifier of the service plan (for filtering).
:param has_products: a flag that indicates if returned Service Plans should have (true) or not (false) assigned products
:param subscription_status: a comma-separated list of the subscription statuses (SubscriptionStatus) that should be returned.
:param product_id: unique identifier of the subscription product (for filtering).
:param expend_fields: there are fields that are not included in responses by default. You can request these fields as an expanded response by listing required object paths in this parameter (e.g. account.group).
:param reseller_id: unique identifier of the target reseller platform.
"""
return self._get(
"GetServicePlans",
params={
"id": id,
"hasProducts": has_products,
"subscriptionStatus": subscription_status,
"productId": product_id,
"expandFields": expend_fields,
"resellerId": reseller_id,
"ruk": ruk,
},
delimiter=",",
)
[docs]
def GetSubscriptions(
self,
id: int = None,
uid: int = None,
status: list[str] = None,
reseller_id: int = None,
product_id: int = None,
service_plan_id: int = None,
expend_fields: str = None,
start_row: int = None,
result_count: int = None,
order_field: str = None,
order_direction: str = None,
ruk: str = None,
):
"""
:param id: unique identifier of the subscription (for filtering).
:param uid: unique identifier of the target user.
:param status: a comma-separated list of the subscription statuses (SubscriptionStatus) that should be returned.
:param reseller_id: unique identifier of the target reseller platform.
:param product_id: unique identifier of the target product.
:param service_plan_id: unique identifier of the target service plan.
:param expend_fields: there are fields that are not included in responses by default. You can request these fields as an expanded response by listing required object paths in this parameter (e.g. account.group).
:param start_row: returns information starting from the specified row in the response (starts with 0, by default).
:param result_count: returns the specified number of rows from the response (0 – unlimited – by default).
:param order_field: sorts results by the specified field
:param order_direction: sorts results in the ascending (ASC) or descending (DESC) order
"""
return self._get(
"GetSubscriptions",
params={
"id": id,
"uid": uid,
"status": status,
"resellerId": reseller_id,
"productId": product_id,
"servicePlanId": service_plan_id,
"expandFields": expend_fields,
"startRow": start_row,
"resultCount": result_count,
"orderField": order_field,
"orderDirection": order_direction,
"ruk": ruk,
},
delimiter=",",
)
[docs]
def SetCategoryPublished(
self, id: int, published: bool, reseller_id: int = None, ruk: str = None
):
"""
:param id: unique identifier of the target category.
:param published: publishes (true) or unpublishes (false) the subscription Category.
:param reseller_id: unique identifier of the target reseller platform.
"""
return self._get(
"SetCategoryPublished",
params={
"id": id,
"published": published,
"resellerId": reseller_id,
"ruk": ruk,
},
)
[docs]
def SetProductStatus(
self, id: int, status: str, reseller_id: int = None, ruk: str = None
):
"""
:param id: unique identifier of the target product.
:param status: a new status (ProductStatus) that should be set for the subscription Product.
:param reseller_id: unique identifier of the target reseller platform.
"""
return self._get(
"SetProductStatus",
params={"id": id, "status": status, "resellerId": reseller_id, "ruk": ruk},
)
[docs]
def SetServicePlanStatus(
self, id: int, status: str, reseller_id: int = None, ruk: str = None
):
"""
:param id: unique identifier of the target service plan.
:param status: a new status (ServicePlanStatus) that should be set for the subscription Service Plan.
:param reseller_id: unique identifier of the target reseller platform.
"""
return self._get(
"SetServicePlanStatus",
params={"id": id, "status": status, "resellerId": reseller_id, "ruk": ruk},
)
[docs]
def TerminateSubscription(
self, subscription_id: int, password: str, ruk: str = None
):
"""
:param subscription_id: unique identifier of the target subscription.
:param password: current (admin) user's password to confirm subscription resources deletion.
"""
return self._get(
"TerminateSubscription",
params={
"subscriptionId": subscription_id,
"password": password,
"ruk": ruk,
},
)
[docs]
class _VirtualNetwork(Administration):
"""
Ref: https://docs.jelastic.com/api/private/#!/api/administration.VirtualNetwork
"""
_endpoint2 = "virtualnetwork"
[docs]
def AddVirtualNetwork(
self,
virtual_network: dict,
ruk: str = None,
):
"""
:param virtual_network: a list of the target virtual networks' unique identifiers.
"""
return self._get(
"AddVirtualNetwork",
params={
"virtualNetwork": virtual_network,
"ruk": ruk,
},
)
[docs]
def ApplyVirtualNetworks(
self,
host_id: int = None,
ruk: str = None,
):
"""
:param host_id: unique identifier of the target host (all hosts if not defined).
"""
return self._get(
"ApplyVirtualNetworks",
params={
"hostId": host_id,
"ruk": ruk,
},
)
[docs]
def DeleteVirtualNetworks(self, ids: int = None, ruk: str = None):
"""
:param ids: a list of the target virtual networks' unique identifiers.
"""
return self._get(
"DeleteVirtualNetworks",
params={"ids": ids, "ruk": ruk},
)
[docs]
def GetVirtualNetworks(self, ids: int = None, ruk: str = None):
"""
:param ids: a list of the target virtual networks' unique identifiers.
"""
return self._get(
"GetVirtualNetworks",
params={"ids": ids, "ruk": ruk},
)