Skip to content

ManageService

ManageService(domain, root_client, root_secret)

Manage service to interact with the manage endpoint. The manage endpoint uses basic auth using the root client and secret

Source code in TM1py/Services/ManageService.py 
13
14
15
16
17
18
def __init__(self, domain, root_client, root_secret):
    self._domain = domain
    self._root_client = root_client
    self._root_secret = root_secret
    self._auth_header = HTTPBasicAuth(self._root_client, self._root_secret)
    self._root_url = f"{self._domain}/manage/v1"

__enter__()

Source code in TM1py/Services/ManageService.py 
20
21
def __enter__(self):
    return self

__exit__(exception_type, exception_value, traceback)

Source code in TM1py/Services/ManageService.py 
23
24
def __exit__(self, exception_type, exception_value, traceback):
    pass

create_and_upload_database_backup_set_file(instance_name, database_name, backup_set_name)

Source code in TM1py/Services/ManageService.py 
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
def create_and_upload_database_backup_set_file(self, instance_name: str, database_name: str, backup_set_name: str):

    create_url = (
        f"{self._root_url}/Instances('{instance_name}')/Databases('{database_name}')"
        f"/Contents('Files')/Contents('.backupsets')/Contents"
    )
    payload = {"@odata.type": "#ibm.tm1.api.v1.Document", "Name": f"{backup_set_name}.tgz"}
    requests.post(url=create_url, json=payload, auth=self._auth_header)

    upload_url = (
        f"{self._root_url}/Instances('{instance_name}')/Databases('{database_name}')"
        f"/Contents('Files')/Contents('.backupsets')/Contents('{backup_set_name}.tgz')/Content"
    )
    response = requests.post(url=upload_url, json=payload, auth=self._auth_header)
    return response

create_application(instance_name, application_name)

Source code in TM1py/Services/ManageService.py 
198
199
200
201
202
203
def create_application(self, instance_name, application_name):
    url = f"{self._root_url}/Instances('{instance_name}')/Applications"
    payload = {"Name": application_name}
    response = requests.post(url=url, json=payload, auth=self._auth_header)
    response_json = json.loads(response.content)
    return response_json["ClientID"], response_json["ClientSecret"]

create_database(instance_name, database_name, number_replicas, product_version, cpu_requests='1000m', cpu_limits='2000m', memory_requests='1G', memory_limits='2G', storage_size='20Gi')

Source code in TM1py/Services/ManageService.py 
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
def create_database(
    self,
    instance_name,
    database_name,
    number_replicas,
    product_version,
    cpu_requests="1000m",
    cpu_limits="2000m",
    memory_requests="1G",
    memory_limits="2G",
    storage_size="20Gi",
):

    url = f"{self._root_url}/Instances('{instance_name}')/Databases"

    payload = {
        "Name": database_name,
        "Replicas": number_replicas,
        "ProductVersion": product_version,
        "Resources": {
            "Replica": {
                "CPU": {"Requests": cpu_requests, "Limits": cpu_limits},
                "Memory": {"Requests": memory_requests, "Limits": memory_limits},
            },
            "Storage": {"Size": storage_size},
        },
    }
    response = requests.post(url=url, json=payload, auth=self._auth_header)

    return response

create_database_backup(instance_name, database_name, backup_set_name)

Source code in TM1py/Services/ManageService.py 
154
155
156
157
158
def create_database_backup(self, instance_name: str, database_name: str, backup_set_name: str):
    url = f"{self._root_url}/Instances('{instance_name}')/Databases('{database_name}')/tm1s.Backup"
    payload = {"URL": f"{backup_set_name}.tgz"}
    response = requests.post(url=url, json=payload, auth=self._auth_header)
    return response

create_instance(instance_name)

Source code in TM1py/Services/ManageService.py 
36
37
38
39
40
def create_instance(self, instance_name):
    url = f"{self._root_url}/Instances"
    payload = {"Name": instance_name}
    response = requests.post(url=url, json=payload, auth=self._auth_header)
    return response

database_exists(instance_name, database_name)

Source code in TM1py/Services/ManageService.py 
140
141
142
143
144
145
146
def database_exists(self, instance_name, database_name):
    url = f"{self._root_url}/Instances('{instance_name}')/Databases('{database_name}')"
    response = requests.get(url=url, auth=self._auth_header)
    if response.ok:
        return True
    else:
        return False

delete_database(instance_name, database_name)

Source code in TM1py/Services/ManageService.py 
135
136
137
138
def delete_database(self, instance_name, database_name):
    url = f"{self._root_url}/Instances('{instance_name}')/Databases('{database_name}')"
    response = requests.delete(url=url, auth=self._auth_header)
    return response

delete_instance(instance_name)

Source code in TM1py/Services/ManageService.py 
42
43
44
45
def delete_instance(self, instance_name):
    url = f"{self._root_url}/Instances('{instance_name}')"
    response = requests.delete(url=url, auth=self._auth_header)
    return response

get_application(instance_name, application_name)

Source code in TM1py/Services/ManageService.py 
193
194
195
196
def get_application(self, instance_name, application_name):
    url = f"{self._root_url}/Instances('{instance_name}')/Applications('{application_name}')"
    response = requests.get(url=url, auth=self._auth_header)
    return json.loads(response.content)

get_applications(instance_name)

Source code in TM1py/Services/ManageService.py 
188
189
190
191
def get_applications(self, instance_name):
    url = f"{self._root_url}/Instances('{instance_name}')/Applications"
    response = requests.get(url=url, auth=self._auth_header)
    return json.loads(response.content)

get_database(instance_name, database_name)

Source code in TM1py/Services/ManageService.py 
60
61
62
63
def get_database(self, instance_name, database_name):
    url = f"{self._root_url}/Instances('{instance_name}')/Databases('{database_name}')"
    response = requests.get(url=url, auth=self._auth_header)
    return json.loads(response.content)

get_databases(instance_name)

Source code in TM1py/Services/ManageService.py 
55
56
57
58
def get_databases(self, instance_name):
    url = f"{self._root_url}/Instances('{instance_name}')/Databases"
    response = requests.get(url=url, auth=self._auth_header)
    return json.loads(response.content).get("value")

get_instance(instance_name)

Source code in TM1py/Services/ManageService.py 
31
32
33
34
def get_instance(self, instance_name):
    url = f"{self._root_url}/Instances('{instance_name}')"
    response = requests.get(url=url, auth=self._auth_header)
    return json.loads(response.content)

get_instances()

Source code in TM1py/Services/ManageService.py 
26
27
28
29
def get_instances(self):
    url = f"{self._root_url}/Instances"
    response = requests.get(url=url, auth=self._auth_header)
    return json.loads(response.content).get("value")

get_metadata()

Source code in TM1py/Services/ManageService.py 
205
206
207
208
def get_metadata(self):
    url = f"{self._root_url}/$metadata?$format=json"
    response = requests.get(url=url, auth=self._auth_header)
    return json.loads(response.content)

instance_exists(instance_name)

Source code in TM1py/Services/ManageService.py 
47
48
49
50
51
52
53
def instance_exists(self, instance_name):
    url = f"{self._root_url}/Instances('{instance_name}')"
    response = requests.get(url=url, auth=self._auth_header)
    if response.ok:
        return True
    else:
        return False

restore_database(instance_name, database_name, backup_url)

Source code in TM1py/Services/ManageService.py 
176
177
178
179
180
def restore_database(self, instance_name: str, database_name: str, backup_url: str):
    url = f"{self._root_url}/Instances('{instance_name}')/Databases('{database_name}')/tm1s.Restore"
    payload = {"URL": backup_url}
    response = requests.post(url=url, json=payload, auth=self._auth_header)
    return response

scale_database(instance_name, database_name, replicas)

Source code in TM1py/Services/ManageService.py 
182
183
184
185
186
def scale_database(self, instance_name: str, database_name: str, replicas: int):
    url = f"{self._root_url}/Instances('{instance_name}')/Databases('{database_name}')"
    payload = {"Replicas": replicas}
    response = requests.patch(url=url, json=payload, auth=self._auth_header)
    return response

subscribe_to_data_changes(instance_name, database_name, target_url, additional_properties={})

Source code in TM1py/Services/ManageService.py 
210
211
212
213
214
def subscribe_to_data_changes(self, instance_name, database_name, target_url, additional_properties: dict = {}):
    url = f"{self._root_url}/Instances('{instance_name}')/Databases('{database_name}')/tm1.Subscribe"
    payload = {"URL": target_url, "AdditionalProperties": additional_properties}
    response = requests.post(url=url, json=payload, auth=self._auth_header)
    return response

unsubscribe_from_data_changes(instance_name, database_name, target_url)

Source code in TM1py/Services/ManageService.py 
216
217
218
219
def unsubscribe_from_data_changes(self, instance_name, database_name, target_url):
    url = f"{self._root_url}/Instances('{instance_name}')/Databases('{database_name}')/tm1.Unsubscribe"
    response = requests.post(url=url, auth=self._auth_header)
    return response

update_database_cpu(instance_name, database_name, cpu_requests, cpu_limits)

Source code in TM1py/Services/ManageService.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
def update_database_cpu(
    self,
    instance_name,
    database_name,
    cpu_requests,
    cpu_limits,
):
    url = f"{self._root_url}/Instances('{instance_name}')/Databases('{database_name}')"

    payload = {
        "Resources": {
            "Replica": {
                "CPU": {"Requests": cpu_requests, "Limits": cpu_limits},
            }
        }
    }
    response = requests.patch(url=url, json=payload, auth=self._auth_header)
    return response

update_database_memory(instance_name, database_name, memory_requests, memory_limits)

Source code in TM1py/Services/ManageService.py 
115
116
117
118
119
120
121
122
123
124
125
126
def update_database_memory(
    self,
    instance_name,
    database_name,
    memory_requests,
    memory_limits,
):
    url = f"{self._root_url}/Instances('{instance_name}')/Databases('{database_name}')"

    payload = {"Resources": {"Replica": {"Memory": {"Requests": memory_requests, "Limits": memory_limits}}}}
    response = requests.patch(url=url, json=payload, auth=self._auth_header)
    return response

update_database_storage(instance_name, database_name, storage_size)

Source code in TM1py/Services/ManageService.py 
128
129
130
131
132
133
def update_database_storage(self, instance_name, database_name, storage_size):
    url = f"{self._root_url}/Instances('{instance_name}')/Databases('{database_name}')"

    payload = {"Resources": {"Storage": {"Size": storage_size}}}
    response = requests.patch(url=url, json=payload, auth=self._auth_header)
    return response

upgrade_database(instance_name, database_name, target_version='')

Source code in TM1py/Services/ManageService.py 
148
149
150
151
152
def upgrade_database(self, instance_name: str, database_name: str, target_version: str = ""):
    url = f"{self._root_url}/Instances('{instance_name}')/Databases('{database_name}')/tm1s.Upgrade"
    payload = {"ProductVersion": target_version}
    response = requests.post(url=url, json=payload, auth=self._auth_header)
    return response