System

class jelastic.api.system.System(session: Session, token: str, debug: bool = False, ruk: str | None = None)

Bases: ClientAbstract

property Admin: _Admin

The methods of this service provide billing information about a user account (such as UID, balance, billing history, quotas, etc.) and allow managing it.

>>> from jelastic import Jelastic
>>> jelastic = Jelastic('https://app.xapp.cloudmydc.com', token='d6f4e314a5b5fefd164995169f28ae32d987704f')
>>> jelastic.system.Admin

Ref: https://docs.jelastic.com/api/private/#!/api/system.Admin

property Cluster: _Cluster

The methods of this service provide billing information about a user account (such as UID, balance, billing history, quotas, etc.) and allow managing it.

>>> from jelastic import Jelastic
>>> jelastic = Jelastic('https://app.xapp.cloudmydc.com', token='d6f4e314a5b5fefd164995169f28ae32d987704f')
>>> jelastic.system.Cluster

Ref: https://docs.jelastic.com/api/private/#!/api/system.Cluster

property Groups: _Groups

The methods of this service provide billing information about a user account (such as UID, balance, billing history, quotas, etc.) and allow managing it.

>>> from jelastic import Jelastic
>>> jelastic = Jelastic('https://app.xapp.cloudmydc.com', token='d6f4e314a5b5fefd164995169f28ae32d987704f')
>>> jelastic.system.Groups

Ref: https://docs.jelastic.com/api/private/#!/api/system.Groups

property IdentityProvider: _IdentityProvider

The methods of this service provide billing information about a user account (such as UID, balance, billing history, quotas, etc.) and allow managing it.

>>> from jelastic import Jelastic
>>> jelastic = Jelastic('https://app.xapp.cloudmydc.com', token='d6f4e314a5b5fefd164995169f28ae32d987704f')
>>> jelastic.system.IdentityProvider

Ref: https://docs.jelastic.com/api/private/#!/api/system.IdentityProvider

property Service: _Service

The methods of this service provide billing information about a user account (such as UID, balance, billing history, quotas, etc.) and allow managing it.

>>> from jelastic import Jelastic
>>> jelastic = Jelastic('https://app.xapp.cloudmydc.com', token='d6f4e314a5b5fefd164995169f28ae32d987704f')
>>> jelastic.system.Service

Ref: https://docs.jelastic.com/api/private/#!/api/system.Service

property Usage: _Usage

The methods of this service provide billing information about a user account (such as UID, balance, billing history, quotas, etc.) and allow managing it.

>>> from jelastic import Jelastic
>>> jelastic = Jelastic('https://app.xapp.cloudmydc.com', token='d6f4e314a5b5fefd164995169f28ae32d987704f')
>>> jelastic.system.Usage

Ref: https://docs.jelastic.com/api/private/#!/api/system.Usage

class jelastic.api.administration._Cluster(session: Session, token: str, debug: bool = False, ruk: str | None = None)

Bases: Administration

AddActionToIsolationQueue(count: int | None = None, delay: int | None = None, ruk: str | None = None)

AddCartridge(manifest_url: str, ruk: str | None = None)

AddCertifiedTemplates(repositories: str, publish: bool | None = None, ruk: str | None = None)

AddExtIps(ipfrom: str, ipto: str, regions: str, ruk: str | None = None)

AddHardWareNodeMessage(hn_id: int, message_type: str, process_response_code: int, percentage: int, message: str, custom_data: str, ruk: str | None = None)

AddHdNode(hdnode: dict, set_as_docker_host: bool | None = None, skip_configuration: bool | None = None, ruk: str | None = None)

AddHdNodeGroup(data: dict, ruk: str | None = None)

AddIps(ipfrom: str, ipto: str, region: str, ruk: str | None = None)

AddIpv6Network(region: str, network: str | None = None, ruk: str | None = None)

AddNameserver(node_id: int, nameserver: str, ruk: str | None = None)

AddRegion(data: dict, test_authentication: bool | None = None, ruk: str | None = None)

Parameters:

• data – JSON object with the new hardware region data.

• test_authentication – defines whether to check (true) or not (false) authentication on the region’s Docker host.

AddRegionDomain(region_id: int, domain: str, primary: bool | None = None, ruk: str | None = None)

Parameters:

• region_id – unique identifier of the target region.

• domain – new domain name to be added for the region.

• primary – defines whether to set the domain name as the region’s primary (true) or not (false).

AddRegionReseller(reseller_id: int, domain: str, type: str, generate_dns: bool, ssl_type: str | None = None, region_id: int | None = None, key: str | None = None, intermediate: str | None = None, cert: str | None = None, source502: str | None = None, ruk: str | None = None)

Parameters:

• reseller_id – unique identifier of the target reseller platform.

• domain – reseller platform domain name.

• type – region type (PLATFORM or REGION).

• generate_dns – defines whether to generate new DNS records (true) or just update existing SSL settings (false).

• ssl_type – SSL certificate type (CUSTOM or LETSENCRYPT).

• region_id – unique identifier of the existing region on the main platform.

• key – SSL certificate key.

• intermediate – intermediate SSL certificate.

• cert – SSL certificate body.

• source502 – path to the 50x error pages source files.

AddRegionSsl(region_id: int, ssl_type: str, domain_id: int | None = None, cert_key: str | None = None, intermediate: str | None = None, cert: str | None = None, ruk: str | None = None)

Parameters:

• region_id – unique identifier of the target region.

• ssl_type – SSL certificates type (CUSTOM - manually provided certificates; LETSENCRYPT - automatically issued Let’s Encrypt certificates).

• domain_id – unique identifier of the target domain name.

• cert_key – server key certificate (for CUSTOM sslType only).

• intermediate – intermediate certificate CA (for CUSTOM sslType only).

• cert – domain certificate (for CUSTOM sslType only).

AddTemplate(registry_id: int, repository: str, tags: str, node_type: str, node_mission: str, display_name: str, engine_type: str | None = None, images_data: str | None = None, auto_update: bool | None = None, keep_selected_tags: bool | None = None, update_default_tag: bool | None = None, skip_tags_from_auto_update: str | None = None, ruk: str | None = None)

AddTemplateRegistry(data: str, ruk: str | None = None)

AddUserToContainer(node_id: int | None = None, container_id: int | None = None, regenerate_keys: bool | None = None, ruk: str | None = None)

AddUsersToGate(ruk: str | None = None)

ApplyFirewallRules(ruk: str | None = None)

CheckMigrationEnvPossibility(target_appid: str | None = None, hardware_node_group: str | None = None, ruk: str | None = None)

CleanTemplateManifestCache(ruk: str | None = None)

ClearPool(hnid: int | None = None, ruk: str | None = None)

ConvertPasswords(ruk: str | None = None)

DeactivateRegionDomain(region_id: int, domain_id: int, ruk: str | None = None)

DeleteEnv(target_appid: str, password: str, ruk: str | None = None)

DeleteEnvsByChecksum(checksum: str, uid: int, target_appid: str, ruk: str | None = None)

Parameters:

• checksum – checksum of the request.

• uid – unique identifier of the target user.

• target_appid – A semicolon-separated list of target environment IDs.

DeleteEnvsByUidByChecksum(uid: int, ruk: str | None = None)

Parameters:

uid – unique identifier of the target user.

DeleteHDNode(hdnodeid: int, force: bool | None = None, ruk: str | None = None)

EditHdNode(hdnode: dict, set_as_docker_host: bool | None = None, ruk: str | None = None)

EditHdNodeGroup(data: dict, ruk: str | None = None)

EditRegion(data: dict, test_authentication: bool | None = None, ruk: str | None = None)

EditTemplate(node_type: str, tags: str | None = None, display_name: str | None = None, engine_type: str | None = None, images_data: str | None = None, auto_update: bool | None = None, keep_selected_tags: bool | None = None, update_default_tag: bool | None = None, skip_tags_from_auto_update: str | None = None, ruk: str | None = None)

EditTemplateRegistry(data: str, ruk: str | None = None)

EvacuateContainers(source_hn_id: str, possible_target_node_ids: str | None = None, is_online: bool | None = None, ruk: str | None = None)

ExecHnCMD(cmd: str, hn_id: int | None = None, infra_only: bool | None = None, run_on_broken: bool | None = None, vz_version: str | None = None, docker_host_only: bool | None = None, ruk: str | None = None)

ExecHostCmd(cmd: str, host_id: int | None = None, infra_only: bool | None = None, run_on_broken: bool | None = None, vz_version: str | None = None, docker_host_only: bool | None = None, ruk: str | None = None)

GeneratePool(node_type: str | None = None, hnid: int | None = None, ruk: str | None = None)

GetAddHdNodeCmd(hard_node_group: str | None = None, ruk: str | None = None)

GetAddHostCmd(host_group: str | None = None, ruk: str | None = None)

GetAllContainers(ruk: str | None = None)

GetAllRegionReseller(ruk: str | None = None)

GetAllSumStatByUid(duration: int | None = None, endtime: datetime | None = None, uid: int | None = None, ruk: str | None = None)

GetAppidByDomain(domain: str | None = None, ruk: str | None = None)

GetBillableItems(ruk: str | None = None)

GetClusterLoadHistory(starttime: datetime, endtime: datetime, ruk: str | None = None)

GetClusterLoadInfo(ruk: str | None = None)

GetClusterLoadPercent(checksum: str, ruk: str | None = None)

GetClusterStatus(check_smtp: bool | None = None, cached: bool | None = None, ruk: str | None = None)

GetClusterUsage(ruk: str | None = None)

GetContainerConfig(node_id: int, ruk: str | None = None)

GetDefaultRegion(ruk: str | None = None)

GetDefaultTagInfo(node_type: str, engine: str | None = None, ruk: str | None = None)

GetDomainByIp(ips: str, ruk: str | None = None)

GetEngineTypes(ruk: str | None = None)

GetEnvGroupsByUid(uid: int, ruk: str | None = None)

GetEnvInfo(target_appid: str, ruk: str | None = None)

GetEnvStat(starttime: datetime, endtime: datetime, ruk: str | None = None)

GetEnvironmentGroupPopulations(start: datetime, end: datetime, ruk: str | None = None)

rows ordered by time asc not more than 1000 rows

Parameters:

• start – slice start in date and time in ISO 8601

• end – slice end in date and time in ISO 8601

GetEnvs(uid: int, rights: list[str] | None = None, lazy: bool | None = None, owner_uid: int | None = None, ssh_access_only: bool | None = None, ruk: str | None = None)

A list of suitable environments.

Parameters:

• uid – unique identifier of the target user.

• 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).

• lazy – enables/disables lazy (on-demand) loading.

• owner_uid – unique identifier of the target user account.

• ssh_access_only – filter to environments with SSH access.

GetEvacuationState(hard_node_id: int, ruk: str | None = None)

EvacuationState entity or null

GetExtIpPoolInfo(search: dict, ruk: str | None = None)

GetHdNodeGroups(ruk: str | None = None)

GetHdNodeStatus(ruk: str | None = None)

GetHdNodes(ids: str | None = None, ruk: str | None = None)

GetHdNodesLoad(duration: int, hdnodes: str | None = None, ruk: str | None = None)

GetHdNodesLoadInfo(ids: str | None = None, ruk: str | None = None)

GetHosts(ids: str | None = None, ruk: str | None = None)

GetIpPoolInfo(search: dict, ruk: str | None = None)

GetIpv6Networks(ruk: str | None = None)

GetIpv6SubnetsInfo(search: str | None = None, ruk: str | None = None)

GetJelasticAppid(ruk: str | None = None)

GetJobNames(ruk: str | None = None)

GetLastHardWareNodeMessage(id: int, ruk: str | None = None)

GetNodeInfo(target_appid: str, node_id: int, ruk: str | None = None)

Result of operation or error.

Parameters:

• target_appid – appid of user environment

• node_id – id of SoftNode that belongs to env

GetNodeMissions(ruk: str | None = None)

GetNodePassword(nodeid: int | None = None, ruk: str | None = None)

GetNodes(hdnodeid: int, name: str | None = None, start_row: int | None = None, result_count: int | None = None, ruk: str | None = None)

GetOOMKilledProcesses(search: dict, ruk: str | None = None)

GetPcsClusterList(ruk: str | None = None)

GetPoolStatus(ruk: str | None = None)

GetRegion(id: int, ruk: str | None = None)

GetRegionDnsRecords(id: int, ruk: str | None = None)

GetRegionDomains(region_id: int | None = None, ruk: str | None = None)

param region_id: unique identifier of the target region.

GetRegionResellerByResellerId(id: int, ruk: str | None = None)

GetRegions(ruk: str | None = None)

GetRepositoryTags(repository: str, registry_id: int | None = None, ruk: str | None = None)

GetSoftNodeInfo(node_id: int, ruk: str | None = None)

GetStandByStatus(ruk: str | None = None)

GetStats(duration: int, interval: int, target_appid: str, endtime: datetime | None = None, nodeid: int | None = None, nodetype: str | None = None, node_group: str | None = None, ruk: str | None = None)

GetSumStat(duration: int | None = None, endtime: datetime | None = None, target_appid: str | None = None, ruk: str | None = None)

GetSystemLog(search: str, ruk: str | None = None)

GetTemplateInfo(node_type: str, ruk: str | None = None)

GetTemplateLabels(repository: str, registry_id: int | None = None, tag: str | None = None, ruk: str | None = None)

GetTemplateRegistries(ruk: str | None = None)

GetTemplates(type: str | None = None, published: bool | None = None, lazy: bool | None = None, ruk: str | None = None)

GetUserActivity(uid: int, starttime: datetime, endtime: datetime, target_appid: str | None = None, start_row: int | None = None, result_count: int | None = None, service_name: str | None = None, search_text: str | None = None, action_types: str | None = None, order_field: str | None = None, order_direction: str | None = None, ruk: str | None = 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.

GetUsersActivities(starttime: datetime, endtime: datetime, start_row: int | None = None, result_count: int | None = None, ruk: str | None = None)

L2Update(hn_id: int, ruk: str | None = None)

MigrateEnv(target_appid: str | None = None, hardware_node_group: str | None = None, is_online: bool | None = None, ruk: str | None = None)

MigrateNode(nodeid: int, hdnodeid: int, is_online: bool | None = None, manage_dns_state: bool | None = None, ruk: str | None = 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.

RedeployContainers(target_env_name: str, tag: str, node_group: str | None = None, node_id: int | None = None, use_existing_volumes: bool | None = None, login: str | None = None, password: str | None = None, skip_reinstall: bool | None = None, ruk: str | None = None)

RefreshEmailTemplates(modules: str, ruk: str | None = None)

RefreshUser(language: str | None = None, ruk: str | None = None)

RegeneratePool(node_type: str, exclude: str | None = None, ruk: str | None = None)

RegisterInfaModule(module: str | None = None, dst_env_name: str | None = None, dry_run: bool | None = None, ruk: str | None = None)

RemoveExtIps(ips: str | None = None, ruk: str | None = None)

RemoveHdNodeGroup(id: int, ruk: str | None = None)

RemoveIpv6Network(id: int, ruk: str | None = None)

RemoveRegion(id: int, ruk: str | None = None)

RemoveRegionReseller(reseller_id: int, remove_dns: bool, region_id: int | None = None, ruk: str | None = None)

RemoveRegionSsl(region_id: int, domain_id: int | None = None, reseller_id: int | None = None, ruk: str | None = 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.

RemoveTemplate(node_type: str, ruk: str | None = None)

RemoveTemplateRegistry(id: int, ruk: str | None = None)

ReplaceNodeInEnv(dst_env_name: str | None = None, dst_node_id: int | None = None, src_env_id: str | None = None, src_hn_id: int | None = None, ruk: str | None = None)

ReviveInstallHdNode(id: int, ruk: str | None = None)

SearchEnvs(search: dict, ruk: str | None = None)

SearchNodes(search: dict, ruk: str | None = None)

SetDefaultTemplateTag(node_type: str, tag: str, ruk: str | None = None)

SetEnvNote(target_appid: str | None = None, note: str | None = None, ruk: str | None = None)

param target_appid: target environment name param note: custom note for the target environment

SetEnvStatus(target_appid: str, status: int, ruk: str | None = None)

param target_appid: appid of the required environment param status: new status for the specified environment whose appid equals to {@code targetAppid}.

SetEnvsStatus(target_appid: str, status: int, ruk: str | None = None)

param target_appid: list of appids separated by commas param status: new status for each environment whose appid is in {@code targetAppids}.

SetEnvsStatusByUid(uid: int, status: int, ruk: str | None = None)

SetEnvsStatusByUidByChecksum(uid: int, status: int, ruk: str | None = None)

SetRegionDnsRecords(id: int, data: int, ruk: str | None = None)

SetRegionPrimaryDomain(region_id: int, domain_id: int, ruk: str | None = None)

param region_id: unique identifier of the target region. param domain_id: unique identifier of the target domain name.

SetStandbyMode(enabled: bool, ruk: str | None = None)

SetTemplatePublished(node_type: str, published: bool, ruk: str | None = None)

Sleep(starttime: datetime | None = None, endtime: datetime | None = None, deactivate_after: int | None = None, ruk: str | None = 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. *

StartEnv(target_appid: str, ruk: str | None = None)

StopBalanceResources(ruk: str | None = None)

StopEnv(target_appid: str, ruk: str | None = None)

StopEvacuation(hard_node_id: int, ruk: str | None = None)

SyncCloudlets(starttime: datetime, debug: bool | None = None, ruk: str | None = None)

SyncInfaModule(node_group: str, dst_env_name: str, components: str, target_tag: str | None = None, ruk: str | None = None)

UpdateRegionSsl(region_id: int, domain_id: int | None = None, ruk: str | None = None)

param region_id: unique identifier of the target region. param domain_id: unique identifier of the target domain name.

UpdateResellerSsl(region_id: int, reseller_id: int, ruk: str | None = None)

UpdateTemplate(node_type: int, icons_only: bool | None = None, ruk: str | None = None)

Validate(ruk: str | None = None)

ValidateAll(ruk: str | None = None)

ValidateSsl(domain: str, key: str | None = None, intermediate: str | None = None, cert: str | None = None, ruk: str | None = None)