-
Notifications
You must be signed in to change notification settings - Fork 5
/
tat_client.py
480 lines (397 loc) · 19.4 KB
/
tat_client.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
# -*- coding: utf8 -*-
# Copyright (c) 2017-2021 THL A29 Limited, a Tencent company. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import json
from tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException
from tencentcloud.common.abstract_client import AbstractClient
from tencentcloud.tat.v20201028 import models
class TatClient(AbstractClient):
_apiVersion = '2020-10-28'
_endpoint = 'tat.tencentcloudapi.com'
_service = 'tat'
def CancelInvocation(self, request):
"""This API is used to cancel the command executed on one or more CVM instances.
* If the command has not been delivered to the TAT agent, the task status is `PENDING`, `DELIVERING`, or `DELIVER_DELAYED`, and will be `CANCELLED` after the command is canceled.
* If the command has been delivered to the TAT agent, the task status is `RUNNING`, and will be `TERMINATED` after the command is canceled.
:param request: Request instance for CancelInvocation.
:type request: :class:`tencentcloud.tat.v20201028.models.CancelInvocationRequest`
:rtype: :class:`tencentcloud.tat.v20201028.models.CancelInvocationResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CancelInvocation", params, headers=headers)
response = json.loads(body)
model = models.CancelInvocationResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def CreateCommand(self, request):
"""This API is used to create a command.
:param request: Request instance for CreateCommand.
:type request: :class:`tencentcloud.tat.v20201028.models.CreateCommandRequest`
:rtype: :class:`tencentcloud.tat.v20201028.models.CreateCommandResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CreateCommand", params, headers=headers)
response = json.loads(body)
model = models.CreateCommandResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def CreateInvoker(self, request):
"""This API is used to create an invoker.
:param request: Request instance for CreateInvoker.
:type request: :class:`tencentcloud.tat.v20201028.models.CreateInvokerRequest`
:rtype: :class:`tencentcloud.tat.v20201028.models.CreateInvokerResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CreateInvoker", params, headers=headers)
response = json.loads(body)
model = models.CreateInvokerResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def DeleteCommand(self, request):
"""This API is used to delete a command.
Commands bound to an invoker cannot be deleted.
:param request: Request instance for DeleteCommand.
:type request: :class:`tencentcloud.tat.v20201028.models.DeleteCommandRequest`
:rtype: :class:`tencentcloud.tat.v20201028.models.DeleteCommandResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DeleteCommand", params, headers=headers)
response = json.loads(body)
model = models.DeleteCommandResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def DeleteInvoker(self, request):
"""This API is used to delete an invoker.
:param request: Request instance for DeleteInvoker.
:type request: :class:`tencentcloud.tat.v20201028.models.DeleteInvokerRequest`
:rtype: :class:`tencentcloud.tat.v20201028.models.DeleteInvokerResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DeleteInvoker", params, headers=headers)
response = json.loads(body)
model = models.DeleteInvokerResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def DescribeAutomationAgentStatus(self, request):
"""This API is used to query the status of the TAT agent.
:param request: Request instance for DescribeAutomationAgentStatus.
:type request: :class:`tencentcloud.tat.v20201028.models.DescribeAutomationAgentStatusRequest`
:rtype: :class:`tencentcloud.tat.v20201028.models.DescribeAutomationAgentStatusResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeAutomationAgentStatus", params, headers=headers)
response = json.loads(body)
model = models.DescribeAutomationAgentStatusResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def DescribeCommands(self, request):
"""This API is used to query command details.
:param request: Request instance for DescribeCommands.
:type request: :class:`tencentcloud.tat.v20201028.models.DescribeCommandsRequest`
:rtype: :class:`tencentcloud.tat.v20201028.models.DescribeCommandsResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeCommands", params, headers=headers)
response = json.loads(body)
model = models.DescribeCommandsResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def DescribeInvocationTasks(self, request):
"""This API is used to query execution task details.
:param request: Request instance for DescribeInvocationTasks.
:type request: :class:`tencentcloud.tat.v20201028.models.DescribeInvocationTasksRequest`
:rtype: :class:`tencentcloud.tat.v20201028.models.DescribeInvocationTasksResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeInvocationTasks", params, headers=headers)
response = json.loads(body)
model = models.DescribeInvocationTasksResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def DescribeInvocations(self, request):
"""This API is used to query execution activity details.
:param request: Request instance for DescribeInvocations.
:type request: :class:`tencentcloud.tat.v20201028.models.DescribeInvocationsRequest`
:rtype: :class:`tencentcloud.tat.v20201028.models.DescribeInvocationsResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeInvocations", params, headers=headers)
response = json.loads(body)
model = models.DescribeInvocationsResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def DescribeInvokerRecords(self, request):
"""This API is used to query the execution history of an invoker.
:param request: Request instance for DescribeInvokerRecords.
:type request: :class:`tencentcloud.tat.v20201028.models.DescribeInvokerRecordsRequest`
:rtype: :class:`tencentcloud.tat.v20201028.models.DescribeInvokerRecordsResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeInvokerRecords", params, headers=headers)
response = json.loads(body)
model = models.DescribeInvokerRecordsResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def DescribeInvokers(self, request):
"""This API is used to query invoker details.
:param request: Request instance for DescribeInvokers.
:type request: :class:`tencentcloud.tat.v20201028.models.DescribeInvokersRequest`
:rtype: :class:`tencentcloud.tat.v20201028.models.DescribeInvokersResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeInvokers", params, headers=headers)
response = json.loads(body)
model = models.DescribeInvokersResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def DescribeRegions(self, request):
"""This API is used to query the list of regions that supports TAT.
If the `RegionState` is `AVAILABLE`, it means that TAT is available in the region. If no value is returned, TAT is not available in the region.
:param request: Request instance for DescribeRegions.
:type request: :class:`tencentcloud.tat.v20201028.models.DescribeRegionsRequest`
:rtype: :class:`tencentcloud.tat.v20201028.models.DescribeRegionsResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeRegions", params, headers=headers)
response = json.loads(body)
model = models.DescribeRegionsResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def DisableInvoker(self, request):
"""This API is used to disable an invoker.
:param request: Request instance for DisableInvoker.
:type request: :class:`tencentcloud.tat.v20201028.models.DisableInvokerRequest`
:rtype: :class:`tencentcloud.tat.v20201028.models.DisableInvokerResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DisableInvoker", params, headers=headers)
response = json.loads(body)
model = models.DisableInvokerResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def EnableInvoker(self, request):
"""This API is used to enable an invoker.
:param request: Request instance for EnableInvoker.
:type request: :class:`tencentcloud.tat.v20201028.models.EnableInvokerRequest`
:rtype: :class:`tencentcloud.tat.v20201028.models.EnableInvokerResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("EnableInvoker", params, headers=headers)
response = json.loads(body)
model = models.EnableInvokerResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def InvokeCommand(self, request):
"""This API is used to trigger a command on the specified instance and returns the execution activity ID (inv-xxxxxxxx) on success. Each execution activity has one or more execution tasks (invt-xxxxxxxx) and each execution task indicates an execution record on a CVM or Lighthouse instance.
* If the agent is not installed on the instance or is offline, an error is returned.
* If the command type is not supported by the agent runtime environment, an error is returned.
* The specified instance needs to be in a VPC network.
* The specified instance needs to be in the RUNNING status.
* Only one type of instances (CVM or Lighthouse) can be specified in a single request.
:param request: Request instance for InvokeCommand.
:type request: :class:`tencentcloud.tat.v20201028.models.InvokeCommandRequest`
:rtype: :class:`tencentcloud.tat.v20201028.models.InvokeCommandResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("InvokeCommand", params, headers=headers)
response = json.loads(body)
model = models.InvokeCommandResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def ModifyCommand(self, request):
"""This API is used to modify a command.
:param request: Request instance for ModifyCommand.
:type request: :class:`tencentcloud.tat.v20201028.models.ModifyCommandRequest`
:rtype: :class:`tencentcloud.tat.v20201028.models.ModifyCommandResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("ModifyCommand", params, headers=headers)
response = json.loads(body)
model = models.ModifyCommandResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def ModifyInvoker(self, request):
"""This API is used to modify an invoker.
:param request: Request instance for ModifyInvoker.
:type request: :class:`tencentcloud.tat.v20201028.models.ModifyInvokerRequest`
:rtype: :class:`tencentcloud.tat.v20201028.models.ModifyInvokerResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("ModifyInvoker", params, headers=headers)
response = json.loads(body)
model = models.ModifyInvokerResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def PreviewReplacedCommandContent(self, request):
"""This API is used to preview the command with custom parameters. The command is not executed.
:param request: Request instance for PreviewReplacedCommandContent.
:type request: :class:`tencentcloud.tat.v20201028.models.PreviewReplacedCommandContentRequest`
:rtype: :class:`tencentcloud.tat.v20201028.models.PreviewReplacedCommandContentResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("PreviewReplacedCommandContent", params, headers=headers)
response = json.loads(body)
model = models.PreviewReplacedCommandContentResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def RunCommand(self, request):
"""This API is used to execute a command and returns the execution activity ID (inv-xxxxxxxx) on success. Each execution has one or more execution tasks (invt-xxxxxxxx) and each execution task indicates an execution record on a CVM or Lighthouse instance.
* If the agent is not installed on the instance or is offline, an error is returned.
* If the command type is not supported by the agent runtime environment, an error is returned.
* The specified instance needs to be in a VPC network.
* The specified instance needs to be in the `RUNNING` status.
* Only one type of instances (CVM or Lighthouse) can be specified in a single request.
:param request: Request instance for RunCommand.
:type request: :class:`tencentcloud.tat.v20201028.models.RunCommandRequest`
:rtype: :class:`tencentcloud.tat.v20201028.models.RunCommandResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("RunCommand", params, headers=headers)
response = json.loads(body)
model = models.RunCommandResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))