tencentcloud-sdk-python-intl-en 3.0.1074__py2.py3-none-any.whl → 3.0.1076__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of tencentcloud-sdk-python-intl-en might be problematic. Click here for more details.
- tencentcloud/__init__.py +1 -1
- tencentcloud/advisor/v20200721/models.py +120 -0
- tencentcloud/aiart/v20221229/models.py +95 -0
- tencentcloud/ams/v20201229/models.py +432 -0
- tencentcloud/antiddos/v20200309/models.py +2806 -0
- tencentcloud/apigateway/v20180808/models.py +3945 -0
- tencentcloud/autoscaling/v20180419/models.py +2449 -5
- tencentcloud/batch/v20170312/models.py +1566 -0
- tencentcloud/billing/v20180709/models.py +2418 -0
- tencentcloud/cam/v20190116/models.py +1697 -0
- tencentcloud/captcha/v20190722/models.py +70 -0
- tencentcloud/car/v20220110/models.py +803 -0
- tencentcloud/cbs/v20170312/models.py +1245 -0
- tencentcloud/ccc/v20200210/models.py +1949 -1
- tencentcloud/cdb/v20170320/models.py +4821 -0
- tencentcloud/cdn/v20180606/models.py +4870 -8
- tencentcloud/cdwdoris/v20211228/models.py +3337 -0
- tencentcloud/cfg/v20210820/models.py +1194 -0
- tencentcloud/cfs/v20190719/models.py +1178 -0
- tencentcloud/cfw/v20190904/models.py +2378 -0
- tencentcloud/chdfs/v20201112/models.py +513 -0
- tencentcloud/ciam/v20210420/models.py +49 -0
- tencentcloud/ciam/v20220331/models.py +789 -0
- tencentcloud/ckafka/v20190819/models.py +2576 -0
- tencentcloud/clb/v20180317/models.py +3220 -1
- tencentcloud/cloudaudit/v20190319/models.py +519 -0
- tencentcloud/cls/v20201016/models.py +3652 -1
- tencentcloud/cmq/v20190304/models.py +571 -0
- tencentcloud/controlcenter/v20230110/models.py +15 -0
- tencentcloud/csip/v20221121/models.py +2881 -2
- tencentcloud/cvm/v20170312/models.py +2827 -0
- tencentcloud/cwp/v20180228/models.py +16412 -0
- tencentcloud/cynosdb/v20190107/models.py +4267 -4
- tencentcloud/dataintegration/v20220613/models.py +18 -0
- tencentcloud/dayu/v20180709/models.py +3541 -12
- tencentcloud/dbbrain/v20191016/models.py +1056 -0
- tencentcloud/dbbrain/v20210527/models.py +1763 -0
- tencentcloud/dc/v20180410/models.py +767 -0
- tencentcloud/dcdb/v20180411/models.py +2335 -0
- tencentcloud/dlc/v20210125/models.py +3985 -5
- tencentcloud/dms/v20200819/models.py +51 -0
- tencentcloud/dnspod/v20210323/models.py +1286 -0
- tencentcloud/domain/v20180808/models.py +855 -0
- tencentcloud/dts/v20180330/models.py +791 -0
- tencentcloud/dts/v20211206/models.py +2317 -1
- tencentcloud/eb/v20210416/models.py +858 -0
- tencentcloud/ecdn/v20191012/models.py +811 -0
- tencentcloud/ecm/v20190719/models.py +3972 -1
- tencentcloud/eiam/v20210420/models.py +1265 -0
- tencentcloud/emr/v20190103/models.py +2926 -7
- tencentcloud/es/v20180416/errorcodes.py +48 -0
- tencentcloud/es/v20180416/models.py +1525 -2
- tencentcloud/facefusion/v20220927/errorcodes.py +18 -0
- tencentcloud/facefusion/v20220927/facefusion_client.py +46 -0
- tencentcloud/facefusion/v20220927/models.py +818 -0
- tencentcloud/faceid/v20180301/models.py +2071 -0
- tencentcloud/gaap/v20180529/models.py +3103 -8
- tencentcloud/gme/v20180711/models.py +388 -0
- tencentcloud/gpm/v20200820/models.py +674 -0
- tencentcloud/gse/v20191112/models.py +972 -0
- tencentcloud/iai/v20200303/models.py +1430 -0
- tencentcloud/ims/v20201229/models.py +329 -0
- tencentcloud/intlpartnersmgt/v20220928/models.py +988 -0
- tencentcloud/iotcloud/v20210408/models.py +585 -0
- tencentcloud/ip/v20210409/models.py +178 -0
- tencentcloud/kms/v20190118/models.py +869 -0
- tencentcloud/lcic/v20220817/models.py +1658 -0
- tencentcloud/lighthouse/v20200324/models.py +2088 -0
- tencentcloud/live/v20180801/models.py +4287 -0
- tencentcloud/mariadb/v20170312/models.py +1905 -0
- tencentcloud/mdc/v20200828/models.py +1104 -0
- tencentcloud/mdl/v20200326/models.py +1911 -1
- tencentcloud/mdp/v20200527/models.py +452 -0
- tencentcloud/mongodb/v20190725/models.py +1234 -0
- tencentcloud/monitor/v20180724/models.py +5798 -2
- tencentcloud/mps/v20190612/models.py +8699 -105
- tencentcloud/msp/v20180319/models.py +183 -0
- tencentcloud/ocr/v20181119/models.py +3160 -1
- tencentcloud/omics/v20221128/models.py +1086 -0
- tencentcloud/organization/v20181225/models.py +285 -0
- tencentcloud/organization/v20210331/models.py +2267 -0
- tencentcloud/postgres/v20170312/models.py +3248 -0
- tencentcloud/privatedns/v20201028/errorcodes.py +34 -1
- tencentcloud/privatedns/v20201028/models.py +1700 -0
- tencentcloud/privatedns/v20201028/privatedns_client.py +115 -0
- tencentcloud/redis/v20180412/models.py +3298 -3
- tencentcloud/rum/v20210622/models.py +2114 -0
- tencentcloud/scf/v20180416/models.py +1561 -0
- tencentcloud/ses/v20201002/models.py +649 -0
- tencentcloud/sms/v20190711/models.py +575 -0
- tencentcloud/sms/v20210111/models.py +593 -0
- tencentcloud/sqlserver/v20180328/models.py +2921 -2
- tencentcloud/ssl/v20191205/models.py +2267 -0
- tencentcloud/ssm/v20190923/models.py +678 -0
- tencentcloud/sts/v20180813/models.py +161 -0
- tencentcloud/tag/v20180813/models.py +784 -0
- tencentcloud/tat/v20201028/models.py +806 -0
- tencentcloud/tcaplusdb/v20190823/models.py +1860 -0
- tencentcloud/tchd/v20230306/models.py +41 -0
- tencentcloud/tcmpp/v20240801/models.py +3761 -1
- tencentcloud/tcr/v20190924/models.py +1851 -0
- tencentcloud/tcss/v20201101/models.py +12523 -0
- tencentcloud/tdid/v20210519/models.py +1258 -0
- tencentcloud/tdmq/v20200217/models.py +3495 -0
- tencentcloud/tem/v20201221/models.py +803 -0
- tencentcloud/tem/v20210701/models.py +2551 -1
- tencentcloud/teo/v20220106/models.py +4731 -0
- tencentcloud/teo/v20220901/models.py +6066 -0
- tencentcloud/tiw/v20190919/models.py +1678 -1
- tencentcloud/tke/v20180525/models.py +3662 -0
- tencentcloud/tms/v20201229/models.py +176 -0
- tencentcloud/tmt/v20180321/models.py +65 -0
- tencentcloud/trtc/v20190722/models.py +1698 -8
- tencentcloud/tts/v20190823/models.py +72 -0
- tencentcloud/vm/v20201229/models.py +568 -0
- tencentcloud/vm/v20210922/models.py +636 -0
- tencentcloud/vod/v20180717/models.py +14078 -1
- tencentcloud/vod/v20180717/vod_client.py +33 -0
- tencentcloud/vpc/v20170312/models.py +6543 -1
- tencentcloud/waf/v20180125/models.py +4814 -0
- tencentcloud/wedata/v20210820/models.py +12594 -0
- tencentcloud/yunjing/v20180228/models.py +1867 -0
- {tencentcloud_sdk_python_intl_en-3.0.1074.dist-info → tencentcloud_sdk_python_intl_en-3.0.1076.dist-info}/METADATA +1 -1
- {tencentcloud_sdk_python_intl_en-3.0.1074.dist-info → tencentcloud_sdk_python_intl_en-3.0.1076.dist-info}/RECORD +126 -126
- {tencentcloud_sdk_python_intl_en-3.0.1074.dist-info → tencentcloud_sdk_python_intl_en-3.0.1076.dist-info}/WHEEL +0 -0
- {tencentcloud_sdk_python_intl_en-3.0.1074.dist-info → tencentcloud_sdk_python_intl_en-3.0.1076.dist-info}/top_level.txt +0 -0
|
@@ -51,6 +51,9 @@ class AutomationAgentInfo(AbstractModel):
|
|
|
51
51
|
|
|
52
52
|
@property
|
|
53
53
|
def InstanceId(self):
|
|
54
|
+
"""Instance ID.
|
|
55
|
+
:rtype: str
|
|
56
|
+
"""
|
|
54
57
|
return self._InstanceId
|
|
55
58
|
|
|
56
59
|
@InstanceId.setter
|
|
@@ -59,6 +62,9 @@ class AutomationAgentInfo(AbstractModel):
|
|
|
59
62
|
|
|
60
63
|
@property
|
|
61
64
|
def Version(self):
|
|
65
|
+
"""Agent version.
|
|
66
|
+
:rtype: str
|
|
67
|
+
"""
|
|
62
68
|
return self._Version
|
|
63
69
|
|
|
64
70
|
@Version.setter
|
|
@@ -67,6 +73,9 @@ class AutomationAgentInfo(AbstractModel):
|
|
|
67
73
|
|
|
68
74
|
@property
|
|
69
75
|
def LastHeartbeatTime(self):
|
|
76
|
+
"""Last heartbeat time
|
|
77
|
+
:rtype: str
|
|
78
|
+
"""
|
|
70
79
|
return self._LastHeartbeatTime
|
|
71
80
|
|
|
72
81
|
@LastHeartbeatTime.setter
|
|
@@ -75,6 +84,11 @@ class AutomationAgentInfo(AbstractModel):
|
|
|
75
84
|
|
|
76
85
|
@property
|
|
77
86
|
def AgentStatus(self):
|
|
87
|
+
"""Agent status. Valid values:
|
|
88
|
+
<li> `Online`
|
|
89
|
+
<li> `Offline`
|
|
90
|
+
:rtype: str
|
|
91
|
+
"""
|
|
78
92
|
return self._AgentStatus
|
|
79
93
|
|
|
80
94
|
@AgentStatus.setter
|
|
@@ -83,6 +97,11 @@ class AutomationAgentInfo(AbstractModel):
|
|
|
83
97
|
|
|
84
98
|
@property
|
|
85
99
|
def Environment(self):
|
|
100
|
+
"""Agent runtime environment. Valid values:
|
|
101
|
+
<li> `Linux`: Linux instance
|
|
102
|
+
<li> `Windows`: Windows instance
|
|
103
|
+
:rtype: str
|
|
104
|
+
"""
|
|
86
105
|
return self._Environment
|
|
87
106
|
|
|
88
107
|
@Environment.setter
|
|
@@ -91,6 +110,9 @@ class AutomationAgentInfo(AbstractModel):
|
|
|
91
110
|
|
|
92
111
|
@property
|
|
93
112
|
def SupportFeatures(self):
|
|
113
|
+
"""Features supported by the TAT agent.
|
|
114
|
+
:rtype: list of str
|
|
115
|
+
"""
|
|
94
116
|
return self._SupportFeatures
|
|
95
117
|
|
|
96
118
|
@SupportFeatures.setter
|
|
@@ -134,6 +156,9 @@ class CancelInvocationRequest(AbstractModel):
|
|
|
134
156
|
|
|
135
157
|
@property
|
|
136
158
|
def InvocationId(self):
|
|
159
|
+
"""Execution activity ID
|
|
160
|
+
:rtype: str
|
|
161
|
+
"""
|
|
137
162
|
return self._InvocationId
|
|
138
163
|
|
|
139
164
|
@InvocationId.setter
|
|
@@ -142,6 +167,11 @@ class CancelInvocationRequest(AbstractModel):
|
|
|
142
167
|
|
|
143
168
|
@property
|
|
144
169
|
def InstanceIds(self):
|
|
170
|
+
"""Instance ID list. A maximum of 100 IDs are allowed. Supported instance types:
|
|
171
|
+
<li> `CVM`
|
|
172
|
+
<li> `LIGHTHOUSE`
|
|
173
|
+
:rtype: list of str
|
|
174
|
+
"""
|
|
145
175
|
return self._InstanceIds
|
|
146
176
|
|
|
147
177
|
@InstanceIds.setter
|
|
@@ -176,6 +206,9 @@ class CancelInvocationResponse(AbstractModel):
|
|
|
176
206
|
|
|
177
207
|
@property
|
|
178
208
|
def RequestId(self):
|
|
209
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
210
|
+
:rtype: str
|
|
211
|
+
"""
|
|
179
212
|
return self._RequestId
|
|
180
213
|
|
|
181
214
|
@RequestId.setter
|
|
@@ -249,6 +282,9 @@ class Command(AbstractModel):
|
|
|
249
282
|
|
|
250
283
|
@property
|
|
251
284
|
def CommandId(self):
|
|
285
|
+
"""Command ID.
|
|
286
|
+
:rtype: str
|
|
287
|
+
"""
|
|
252
288
|
return self._CommandId
|
|
253
289
|
|
|
254
290
|
@CommandId.setter
|
|
@@ -257,6 +293,9 @@ class Command(AbstractModel):
|
|
|
257
293
|
|
|
258
294
|
@property
|
|
259
295
|
def CommandName(self):
|
|
296
|
+
"""Command name.
|
|
297
|
+
:rtype: str
|
|
298
|
+
"""
|
|
260
299
|
return self._CommandName
|
|
261
300
|
|
|
262
301
|
@CommandName.setter
|
|
@@ -265,6 +304,9 @@ class Command(AbstractModel):
|
|
|
265
304
|
|
|
266
305
|
@property
|
|
267
306
|
def Description(self):
|
|
307
|
+
"""Command description.
|
|
308
|
+
:rtype: str
|
|
309
|
+
"""
|
|
268
310
|
return self._Description
|
|
269
311
|
|
|
270
312
|
@Description.setter
|
|
@@ -273,6 +315,9 @@ class Command(AbstractModel):
|
|
|
273
315
|
|
|
274
316
|
@property
|
|
275
317
|
def Content(self):
|
|
318
|
+
"""Base64-encoded command.
|
|
319
|
+
:rtype: str
|
|
320
|
+
"""
|
|
276
321
|
return self._Content
|
|
277
322
|
|
|
278
323
|
@Content.setter
|
|
@@ -281,6 +326,9 @@ class Command(AbstractModel):
|
|
|
281
326
|
|
|
282
327
|
@property
|
|
283
328
|
def CommandType(self):
|
|
329
|
+
"""Command type.
|
|
330
|
+
:rtype: str
|
|
331
|
+
"""
|
|
284
332
|
return self._CommandType
|
|
285
333
|
|
|
286
334
|
@CommandType.setter
|
|
@@ -289,6 +337,9 @@ class Command(AbstractModel):
|
|
|
289
337
|
|
|
290
338
|
@property
|
|
291
339
|
def WorkingDirectory(self):
|
|
340
|
+
"""Command execution path.
|
|
341
|
+
:rtype: str
|
|
342
|
+
"""
|
|
292
343
|
return self._WorkingDirectory
|
|
293
344
|
|
|
294
345
|
@WorkingDirectory.setter
|
|
@@ -297,6 +348,9 @@ class Command(AbstractModel):
|
|
|
297
348
|
|
|
298
349
|
@property
|
|
299
350
|
def Timeout(self):
|
|
351
|
+
"""Command timeout period.
|
|
352
|
+
:rtype: int
|
|
353
|
+
"""
|
|
300
354
|
return self._Timeout
|
|
301
355
|
|
|
302
356
|
@Timeout.setter
|
|
@@ -305,6 +359,9 @@ class Command(AbstractModel):
|
|
|
305
359
|
|
|
306
360
|
@property
|
|
307
361
|
def CreatedTime(self):
|
|
362
|
+
"""Command creation time.
|
|
363
|
+
:rtype: str
|
|
364
|
+
"""
|
|
308
365
|
return self._CreatedTime
|
|
309
366
|
|
|
310
367
|
@CreatedTime.setter
|
|
@@ -313,6 +370,9 @@ class Command(AbstractModel):
|
|
|
313
370
|
|
|
314
371
|
@property
|
|
315
372
|
def UpdatedTime(self):
|
|
373
|
+
"""Command update time.
|
|
374
|
+
:rtype: str
|
|
375
|
+
"""
|
|
316
376
|
return self._UpdatedTime
|
|
317
377
|
|
|
318
378
|
@UpdatedTime.setter
|
|
@@ -321,6 +381,9 @@ class Command(AbstractModel):
|
|
|
321
381
|
|
|
322
382
|
@property
|
|
323
383
|
def EnableParameter(self):
|
|
384
|
+
"""Whether to enable the custom parameter feature.
|
|
385
|
+
:rtype: bool
|
|
386
|
+
"""
|
|
324
387
|
return self._EnableParameter
|
|
325
388
|
|
|
326
389
|
@EnableParameter.setter
|
|
@@ -329,6 +392,9 @@ class Command(AbstractModel):
|
|
|
329
392
|
|
|
330
393
|
@property
|
|
331
394
|
def DefaultParameters(self):
|
|
395
|
+
"""Default custom parameter value.
|
|
396
|
+
:rtype: str
|
|
397
|
+
"""
|
|
332
398
|
return self._DefaultParameters
|
|
333
399
|
|
|
334
400
|
@DefaultParameters.setter
|
|
@@ -337,6 +403,9 @@ class Command(AbstractModel):
|
|
|
337
403
|
|
|
338
404
|
@property
|
|
339
405
|
def FormattedDescription(self):
|
|
406
|
+
"""Formatted description of the command. This parameter is an empty string for user commands and contains values for public commands.
|
|
407
|
+
:rtype: str
|
|
408
|
+
"""
|
|
340
409
|
return self._FormattedDescription
|
|
341
410
|
|
|
342
411
|
@FormattedDescription.setter
|
|
@@ -345,6 +414,9 @@ class Command(AbstractModel):
|
|
|
345
414
|
|
|
346
415
|
@property
|
|
347
416
|
def CreatedBy(self):
|
|
417
|
+
"""Command creator. `TAT` indicates a public command and `USER` indicates a personal command.
|
|
418
|
+
:rtype: str
|
|
419
|
+
"""
|
|
348
420
|
return self._CreatedBy
|
|
349
421
|
|
|
350
422
|
@CreatedBy.setter
|
|
@@ -353,6 +425,9 @@ class Command(AbstractModel):
|
|
|
353
425
|
|
|
354
426
|
@property
|
|
355
427
|
def Tags(self):
|
|
428
|
+
"""The list of tags bound to the command.
|
|
429
|
+
:rtype: list of Tag
|
|
430
|
+
"""
|
|
356
431
|
return self._Tags
|
|
357
432
|
|
|
358
433
|
@Tags.setter
|
|
@@ -361,6 +436,9 @@ class Command(AbstractModel):
|
|
|
361
436
|
|
|
362
437
|
@property
|
|
363
438
|
def Username(self):
|
|
439
|
+
"""The user who executes the command on the instance.
|
|
440
|
+
:rtype: str
|
|
441
|
+
"""
|
|
364
442
|
return self._Username
|
|
365
443
|
|
|
366
444
|
@Username.setter
|
|
@@ -369,6 +447,9 @@ class Command(AbstractModel):
|
|
|
369
447
|
|
|
370
448
|
@property
|
|
371
449
|
def OutputCOSBucketUrl(self):
|
|
450
|
+
"""The COS bucket URL for uploading logs.
|
|
451
|
+
:rtype: str
|
|
452
|
+
"""
|
|
372
453
|
return self._OutputCOSBucketUrl
|
|
373
454
|
|
|
374
455
|
@OutputCOSBucketUrl.setter
|
|
@@ -377,6 +458,9 @@ class Command(AbstractModel):
|
|
|
377
458
|
|
|
378
459
|
@property
|
|
379
460
|
def OutputCOSKeyPrefix(self):
|
|
461
|
+
"""The COS bucket directory where the logs are saved.
|
|
462
|
+
:rtype: str
|
|
463
|
+
"""
|
|
380
464
|
return self._OutputCOSKeyPrefix
|
|
381
465
|
|
|
382
466
|
@OutputCOSKeyPrefix.setter
|
|
@@ -449,6 +533,9 @@ class CommandDocument(AbstractModel):
|
|
|
449
533
|
|
|
450
534
|
@property
|
|
451
535
|
def Content(self):
|
|
536
|
+
"""Base64-encoded command.
|
|
537
|
+
:rtype: str
|
|
538
|
+
"""
|
|
452
539
|
return self._Content
|
|
453
540
|
|
|
454
541
|
@Content.setter
|
|
@@ -457,6 +544,9 @@ class CommandDocument(AbstractModel):
|
|
|
457
544
|
|
|
458
545
|
@property
|
|
459
546
|
def CommandType(self):
|
|
547
|
+
"""Command type.
|
|
548
|
+
:rtype: str
|
|
549
|
+
"""
|
|
460
550
|
return self._CommandType
|
|
461
551
|
|
|
462
552
|
@CommandType.setter
|
|
@@ -465,6 +555,9 @@ class CommandDocument(AbstractModel):
|
|
|
465
555
|
|
|
466
556
|
@property
|
|
467
557
|
def Timeout(self):
|
|
558
|
+
"""Timeout period.
|
|
559
|
+
:rtype: int
|
|
560
|
+
"""
|
|
468
561
|
return self._Timeout
|
|
469
562
|
|
|
470
563
|
@Timeout.setter
|
|
@@ -473,6 +566,9 @@ class CommandDocument(AbstractModel):
|
|
|
473
566
|
|
|
474
567
|
@property
|
|
475
568
|
def WorkingDirectory(self):
|
|
569
|
+
"""Execution path.
|
|
570
|
+
:rtype: str
|
|
571
|
+
"""
|
|
476
572
|
return self._WorkingDirectory
|
|
477
573
|
|
|
478
574
|
@WorkingDirectory.setter
|
|
@@ -481,6 +577,9 @@ class CommandDocument(AbstractModel):
|
|
|
481
577
|
|
|
482
578
|
@property
|
|
483
579
|
def Username(self):
|
|
580
|
+
"""The user who executes the command.
|
|
581
|
+
:rtype: str
|
|
582
|
+
"""
|
|
484
583
|
return self._Username
|
|
485
584
|
|
|
486
585
|
@Username.setter
|
|
@@ -489,6 +588,9 @@ class CommandDocument(AbstractModel):
|
|
|
489
588
|
|
|
490
589
|
@property
|
|
491
590
|
def OutputCOSBucketUrl(self):
|
|
591
|
+
"""URL of the COS bucket to store the output
|
|
592
|
+
:rtype: str
|
|
593
|
+
"""
|
|
492
594
|
return self._OutputCOSBucketUrl
|
|
493
595
|
|
|
494
596
|
@OutputCOSBucketUrl.setter
|
|
@@ -497,6 +599,9 @@ class CommandDocument(AbstractModel):
|
|
|
497
599
|
|
|
498
600
|
@property
|
|
499
601
|
def OutputCOSKeyPrefix(self):
|
|
602
|
+
"""Prefix of the output file name
|
|
603
|
+
:rtype: str
|
|
604
|
+
"""
|
|
500
605
|
return self._OutputCOSKeyPrefix
|
|
501
606
|
|
|
502
607
|
@OutputCOSKeyPrefix.setter
|
|
@@ -579,6 +684,9 @@ The principle of least privilege is the best practice for permission management.
|
|
|
579
684
|
|
|
580
685
|
@property
|
|
581
686
|
def CommandName(self):
|
|
687
|
+
"""Command name. The name can be up to 60 bytes, and contain [a-z], [A-Z], [0-9] and [_-.].
|
|
688
|
+
:rtype: str
|
|
689
|
+
"""
|
|
582
690
|
return self._CommandName
|
|
583
691
|
|
|
584
692
|
@CommandName.setter
|
|
@@ -587,6 +695,9 @@ The principle of least privilege is the best practice for permission management.
|
|
|
587
695
|
|
|
588
696
|
@property
|
|
589
697
|
def Content(self):
|
|
698
|
+
"""Base64-encoded command. The maximum length is 64 KB.
|
|
699
|
+
:rtype: str
|
|
700
|
+
"""
|
|
590
701
|
return self._Content
|
|
591
702
|
|
|
592
703
|
@Content.setter
|
|
@@ -595,6 +706,9 @@ The principle of least privilege is the best practice for permission management.
|
|
|
595
706
|
|
|
596
707
|
@property
|
|
597
708
|
def Description(self):
|
|
709
|
+
"""Command description. The maximum length is 120 characters.
|
|
710
|
+
:rtype: str
|
|
711
|
+
"""
|
|
598
712
|
return self._Description
|
|
599
713
|
|
|
600
714
|
@Description.setter
|
|
@@ -603,6 +717,9 @@ The principle of least privilege is the best practice for permission management.
|
|
|
603
717
|
|
|
604
718
|
@property
|
|
605
719
|
def CommandType(self):
|
|
720
|
+
"""Command type. `SHELL` and `POWERSHELL` are supported. The default value is `SHELL`.
|
|
721
|
+
:rtype: str
|
|
722
|
+
"""
|
|
606
723
|
return self._CommandType
|
|
607
724
|
|
|
608
725
|
@CommandType.setter
|
|
@@ -611,6 +728,9 @@ The principle of least privilege is the best practice for permission management.
|
|
|
611
728
|
|
|
612
729
|
@property
|
|
613
730
|
def WorkingDirectory(self):
|
|
731
|
+
"""Command execution path. The default value is /root for `SHELL` commands and C:\Program Files\qcloud\tat_agent\workdir for `POWERSHELL` commands.
|
|
732
|
+
:rtype: str
|
|
733
|
+
"""
|
|
614
734
|
return self._WorkingDirectory
|
|
615
735
|
|
|
616
736
|
@WorkingDirectory.setter
|
|
@@ -619,6 +739,9 @@ The principle of least privilege is the best practice for permission management.
|
|
|
619
739
|
|
|
620
740
|
@property
|
|
621
741
|
def Timeout(self):
|
|
742
|
+
"""Command timeout period. Default value: 60 seconds. Value range: [1, 86400].
|
|
743
|
+
:rtype: int
|
|
744
|
+
"""
|
|
622
745
|
return self._Timeout
|
|
623
746
|
|
|
624
747
|
@Timeout.setter
|
|
@@ -627,6 +750,11 @@ The principle of least privilege is the best practice for permission management.
|
|
|
627
750
|
|
|
628
751
|
@property
|
|
629
752
|
def EnableParameter(self):
|
|
753
|
+
"""Whether to enable the custom parameter feature.
|
|
754
|
+
This cannot be modified once created.
|
|
755
|
+
Default value: `false`.
|
|
756
|
+
:rtype: bool
|
|
757
|
+
"""
|
|
630
758
|
return self._EnableParameter
|
|
631
759
|
|
|
632
760
|
@EnableParameter.setter
|
|
@@ -635,6 +763,13 @@ The principle of least privilege is the best practice for permission management.
|
|
|
635
763
|
|
|
636
764
|
@property
|
|
637
765
|
def DefaultParameters(self):
|
|
766
|
+
"""The default value of the custom parameter value when it is enabled. The field type is JSON encoded string. For example, {\"varA\": \"222\"}.
|
|
767
|
+
`key` is the name of the custom parameter and `value` is the default value. Both `key` and `value` are strings.
|
|
768
|
+
If no parameter value is provided in the `InvokeCommand` API, the default value is used.
|
|
769
|
+
Up to 20 custom parameters are supported.
|
|
770
|
+
The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_].
|
|
771
|
+
:rtype: str
|
|
772
|
+
"""
|
|
638
773
|
return self._DefaultParameters
|
|
639
774
|
|
|
640
775
|
@DefaultParameters.setter
|
|
@@ -643,6 +778,9 @@ The principle of least privilege is the best practice for permission management.
|
|
|
643
778
|
|
|
644
779
|
@property
|
|
645
780
|
def Tags(self):
|
|
781
|
+
"""Tags bound to the command. At most 10 tags are allowed.
|
|
782
|
+
:rtype: list of Tag
|
|
783
|
+
"""
|
|
646
784
|
return self._Tags
|
|
647
785
|
|
|
648
786
|
@Tags.setter
|
|
@@ -651,6 +789,10 @@ The principle of least privilege is the best practice for permission management.
|
|
|
651
789
|
|
|
652
790
|
@property
|
|
653
791
|
def Username(self):
|
|
792
|
+
"""The username used to execute the command on the CVM or Lighthouse instance.
|
|
793
|
+
The principle of least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. By default, the root user is used to execute commands on Linux and the System user is used on Windows.
|
|
794
|
+
:rtype: str
|
|
795
|
+
"""
|
|
654
796
|
return self._Username
|
|
655
797
|
|
|
656
798
|
@Username.setter
|
|
@@ -659,6 +801,9 @@ The principle of least privilege is the best practice for permission management.
|
|
|
659
801
|
|
|
660
802
|
@property
|
|
661
803
|
def OutputCOSBucketUrl(self):
|
|
804
|
+
"""The COS bucket URL for uploading logs. The URL must start with `https`, such as `https://BucketName-123454321.cos.ap-beijing.myqcloud.com`.
|
|
805
|
+
:rtype: str
|
|
806
|
+
"""
|
|
662
807
|
return self._OutputCOSBucketUrl
|
|
663
808
|
|
|
664
809
|
@OutputCOSBucketUrl.setter
|
|
@@ -667,6 +812,12 @@ The principle of least privilege is the best practice for permission management.
|
|
|
667
812
|
|
|
668
813
|
@property
|
|
669
814
|
def OutputCOSKeyPrefix(self):
|
|
815
|
+
"""The COS bucket directory where the logs are saved. Check below for the rules of the directory name.
|
|
816
|
+
1. It must be a combination of number, letters, and visible characters. Up to 60 characters are allowed.
|
|
817
|
+
2. Use a slash (/) to create a subdirectory.
|
|
818
|
+
3. Consecutive dots (.) and slashes (/) are not allowed. It can not start with a slash (/).
|
|
819
|
+
:rtype: str
|
|
820
|
+
"""
|
|
670
821
|
return self._OutputCOSKeyPrefix
|
|
671
822
|
|
|
672
823
|
@OutputCOSKeyPrefix.setter
|
|
@@ -719,6 +870,9 @@ class CreateCommandResponse(AbstractModel):
|
|
|
719
870
|
|
|
720
871
|
@property
|
|
721
872
|
def CommandId(self):
|
|
873
|
+
"""Command ID.
|
|
874
|
+
:rtype: str
|
|
875
|
+
"""
|
|
722
876
|
return self._CommandId
|
|
723
877
|
|
|
724
878
|
@CommandId.setter
|
|
@@ -727,6 +881,9 @@ class CreateCommandResponse(AbstractModel):
|
|
|
727
881
|
|
|
728
882
|
@property
|
|
729
883
|
def RequestId(self):
|
|
884
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
885
|
+
:rtype: str
|
|
886
|
+
"""
|
|
730
887
|
return self._RequestId
|
|
731
888
|
|
|
732
889
|
@RequestId.setter
|
|
@@ -771,6 +928,9 @@ class CreateInvokerRequest(AbstractModel):
|
|
|
771
928
|
|
|
772
929
|
@property
|
|
773
930
|
def Name(self):
|
|
931
|
+
"""Invoker name.
|
|
932
|
+
:rtype: str
|
|
933
|
+
"""
|
|
774
934
|
return self._Name
|
|
775
935
|
|
|
776
936
|
@Name.setter
|
|
@@ -779,6 +939,9 @@ class CreateInvokerRequest(AbstractModel):
|
|
|
779
939
|
|
|
780
940
|
@property
|
|
781
941
|
def Type(self):
|
|
942
|
+
"""Invoker type. It can only be `SCHEDULE` (recurring invokers).
|
|
943
|
+
:rtype: str
|
|
944
|
+
"""
|
|
782
945
|
return self._Type
|
|
783
946
|
|
|
784
947
|
@Type.setter
|
|
@@ -787,6 +950,9 @@ class CreateInvokerRequest(AbstractModel):
|
|
|
787
950
|
|
|
788
951
|
@property
|
|
789
952
|
def CommandId(self):
|
|
953
|
+
"""Remote command ID.
|
|
954
|
+
:rtype: str
|
|
955
|
+
"""
|
|
790
956
|
return self._CommandId
|
|
791
957
|
|
|
792
958
|
@CommandId.setter
|
|
@@ -795,6 +961,9 @@ class CreateInvokerRequest(AbstractModel):
|
|
|
795
961
|
|
|
796
962
|
@property
|
|
797
963
|
def InstanceIds(self):
|
|
964
|
+
"""ID of the instance bound to the trigger. Up to 100 IDs are allowed.
|
|
965
|
+
:rtype: list of str
|
|
966
|
+
"""
|
|
798
967
|
return self._InstanceIds
|
|
799
968
|
|
|
800
969
|
@InstanceIds.setter
|
|
@@ -803,6 +972,9 @@ class CreateInvokerRequest(AbstractModel):
|
|
|
803
972
|
|
|
804
973
|
@property
|
|
805
974
|
def Username(self):
|
|
975
|
+
"""The user who executes the command.
|
|
976
|
+
:rtype: str
|
|
977
|
+
"""
|
|
806
978
|
return self._Username
|
|
807
979
|
|
|
808
980
|
@Username.setter
|
|
@@ -811,6 +983,9 @@ class CreateInvokerRequest(AbstractModel):
|
|
|
811
983
|
|
|
812
984
|
@property
|
|
813
985
|
def Parameters(self):
|
|
986
|
+
"""Custom parameters of the command.
|
|
987
|
+
:rtype: str
|
|
988
|
+
"""
|
|
814
989
|
return self._Parameters
|
|
815
990
|
|
|
816
991
|
@Parameters.setter
|
|
@@ -819,6 +994,9 @@ class CreateInvokerRequest(AbstractModel):
|
|
|
819
994
|
|
|
820
995
|
@property
|
|
821
996
|
def ScheduleSettings(self):
|
|
997
|
+
"""Settings required for a recurring invoker.
|
|
998
|
+
:rtype: :class:`tencentcloud.tat.v20201028.models.ScheduleSettings`
|
|
999
|
+
"""
|
|
822
1000
|
return self._ScheduleSettings
|
|
823
1001
|
|
|
824
1002
|
@ScheduleSettings.setter
|
|
@@ -863,6 +1041,9 @@ class CreateInvokerResponse(AbstractModel):
|
|
|
863
1041
|
|
|
864
1042
|
@property
|
|
865
1043
|
def InvokerId(self):
|
|
1044
|
+
"""Invoker ID.
|
|
1045
|
+
:rtype: str
|
|
1046
|
+
"""
|
|
866
1047
|
return self._InvokerId
|
|
867
1048
|
|
|
868
1049
|
@InvokerId.setter
|
|
@@ -871,6 +1052,9 @@ class CreateInvokerResponse(AbstractModel):
|
|
|
871
1052
|
|
|
872
1053
|
@property
|
|
873
1054
|
def RequestId(self):
|
|
1055
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
1056
|
+
:rtype: str
|
|
1057
|
+
"""
|
|
874
1058
|
return self._RequestId
|
|
875
1059
|
|
|
876
1060
|
@RequestId.setter
|
|
@@ -897,6 +1081,9 @@ class DeleteCommandRequest(AbstractModel):
|
|
|
897
1081
|
|
|
898
1082
|
@property
|
|
899
1083
|
def CommandId(self):
|
|
1084
|
+
"""ID of the command to be deleted.
|
|
1085
|
+
:rtype: str
|
|
1086
|
+
"""
|
|
900
1087
|
return self._CommandId
|
|
901
1088
|
|
|
902
1089
|
@CommandId.setter
|
|
@@ -930,6 +1117,9 @@ class DeleteCommandResponse(AbstractModel):
|
|
|
930
1117
|
|
|
931
1118
|
@property
|
|
932
1119
|
def RequestId(self):
|
|
1120
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
1121
|
+
:rtype: str
|
|
1122
|
+
"""
|
|
933
1123
|
return self._RequestId
|
|
934
1124
|
|
|
935
1125
|
@RequestId.setter
|
|
@@ -955,6 +1145,9 @@ class DeleteInvokerRequest(AbstractModel):
|
|
|
955
1145
|
|
|
956
1146
|
@property
|
|
957
1147
|
def InvokerId(self):
|
|
1148
|
+
"""ID of the invoker to be deleted.
|
|
1149
|
+
:rtype: str
|
|
1150
|
+
"""
|
|
958
1151
|
return self._InvokerId
|
|
959
1152
|
|
|
960
1153
|
@InvokerId.setter
|
|
@@ -988,6 +1181,9 @@ class DeleteInvokerResponse(AbstractModel):
|
|
|
988
1181
|
|
|
989
1182
|
@property
|
|
990
1183
|
def RequestId(self):
|
|
1184
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
1185
|
+
:rtype: str
|
|
1186
|
+
"""
|
|
991
1187
|
return self._RequestId
|
|
992
1188
|
|
|
993
1189
|
@RequestId.setter
|
|
@@ -1022,6 +1218,9 @@ class DescribeAutomationAgentStatusRequest(AbstractModel):
|
|
|
1022
1218
|
|
|
1023
1219
|
@property
|
|
1024
1220
|
def InstanceIds(self):
|
|
1221
|
+
"""List of instance IDs for the query.
|
|
1222
|
+
:rtype: list of str
|
|
1223
|
+
"""
|
|
1025
1224
|
return self._InstanceIds
|
|
1026
1225
|
|
|
1027
1226
|
@InstanceIds.setter
|
|
@@ -1030,6 +1229,9 @@ class DescribeAutomationAgentStatusRequest(AbstractModel):
|
|
|
1030
1229
|
|
|
1031
1230
|
@property
|
|
1032
1231
|
def Filters(self):
|
|
1232
|
+
"""Filter conditions.<br> <li>`agent-status` - String - Required: No - (Filter condition) Filter by agent status. Valid values: `Online`, `Offline`.<br> <li> `environment` - String - Required: No - (Filter condition) Filter by the agent environment. Valid value: `Linux`.<br> <li> `instance-id` - String - Required: No - (Filter condition) Filter by the instance ID. <br>Up to 10 `Filters` allowed in one request. For each filter, five `Filter.Values` can be specified. `InstanceIds` and `Filters` cannot be specified at the same time.
|
|
1233
|
+
:rtype: list of Filter
|
|
1234
|
+
"""
|
|
1033
1235
|
return self._Filters
|
|
1034
1236
|
|
|
1035
1237
|
@Filters.setter
|
|
@@ -1038,6 +1240,9 @@ class DescribeAutomationAgentStatusRequest(AbstractModel):
|
|
|
1038
1240
|
|
|
1039
1241
|
@property
|
|
1040
1242
|
def Limit(self):
|
|
1243
|
+
"""Number of returned results. It defaults to `20`. The maximum is 100. For more information on `Limit`, see the relevant section in the API [Overview](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1).
|
|
1244
|
+
:rtype: int
|
|
1245
|
+
"""
|
|
1041
1246
|
return self._Limit
|
|
1042
1247
|
|
|
1043
1248
|
@Limit.setter
|
|
@@ -1046,6 +1251,9 @@ class DescribeAutomationAgentStatusRequest(AbstractModel):
|
|
|
1046
1251
|
|
|
1047
1252
|
@property
|
|
1048
1253
|
def Offset(self):
|
|
1254
|
+
"""Offset. The default value is `0`. For more information on `Offset`, see the relevant section in API [Introduction](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1).
|
|
1255
|
+
:rtype: int
|
|
1256
|
+
"""
|
|
1049
1257
|
return self._Offset
|
|
1050
1258
|
|
|
1051
1259
|
@Offset.setter
|
|
@@ -1093,6 +1301,9 @@ class DescribeAutomationAgentStatusResponse(AbstractModel):
|
|
|
1093
1301
|
|
|
1094
1302
|
@property
|
|
1095
1303
|
def AutomationAgentSet(self):
|
|
1304
|
+
"""Agent information list.
|
|
1305
|
+
:rtype: list of AutomationAgentInfo
|
|
1306
|
+
"""
|
|
1096
1307
|
return self._AutomationAgentSet
|
|
1097
1308
|
|
|
1098
1309
|
@AutomationAgentSet.setter
|
|
@@ -1101,6 +1312,9 @@ class DescribeAutomationAgentStatusResponse(AbstractModel):
|
|
|
1101
1312
|
|
|
1102
1313
|
@property
|
|
1103
1314
|
def TotalCount(self):
|
|
1315
|
+
"""Total number of matching agents.
|
|
1316
|
+
:rtype: int
|
|
1317
|
+
"""
|
|
1104
1318
|
return self._TotalCount
|
|
1105
1319
|
|
|
1106
1320
|
@TotalCount.setter
|
|
@@ -1109,6 +1323,9 @@ class DescribeAutomationAgentStatusResponse(AbstractModel):
|
|
|
1109
1323
|
|
|
1110
1324
|
@property
|
|
1111
1325
|
def RequestId(self):
|
|
1326
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
1327
|
+
:rtype: str
|
|
1328
|
+
"""
|
|
1112
1329
|
return self._RequestId
|
|
1113
1330
|
|
|
1114
1331
|
@RequestId.setter
|
|
@@ -1159,6 +1376,9 @@ Up to 10 `Filters` are allowed in one request. Each filter can have up to 5 `Fil
|
|
|
1159
1376
|
|
|
1160
1377
|
@property
|
|
1161
1378
|
def CommandIds(self):
|
|
1379
|
+
"""List of command IDs. Up to 100 IDs are allowed for each request. `CommandIds` and `Filters` cannot be specified at the same time.
|
|
1380
|
+
:rtype: list of str
|
|
1381
|
+
"""
|
|
1162
1382
|
return self._CommandIds
|
|
1163
1383
|
|
|
1164
1384
|
@CommandIds.setter
|
|
@@ -1167,6 +1387,18 @@ Up to 10 `Filters` are allowed in one request. Each filter can have up to 5 `Fil
|
|
|
1167
1387
|
|
|
1168
1388
|
@property
|
|
1169
1389
|
def Filters(self):
|
|
1390
|
+
"""Filter conditions.
|
|
1391
|
+
<li> `command-id` - String - Required: No - (Filter condition) Filter by the command ID.
|
|
1392
|
+
<li> `command-name` - String - Required: No - (Filter condition) Filter by the command name.
|
|
1393
|
+
<li> `command-type` - String - Required: No - (Filter condition) Filter by the command type. Valid values: `SHELL` or `POWERSHELL`.
|
|
1394
|
+
<li> `created-by` - String - Required: No - (Filter condition) Filter by the creator. Valid values: `TAT` (public commands) or `USER` (custom commands).
|
|
1395
|
+
<li> `tag-key` - String - Required: No - (Filter condition) Filter by the tag key.</li>
|
|
1396
|
+
<li> `tag-value` - String - Required: No - (Filter condition) Filter by the tag value.</li>
|
|
1397
|
+
<li> `tag:tag-key` - String - Required: No - (Filter) Filter by the tag key-value pair. The tag-key should be replaced with a specified tag key. For detailed usage, see sample 4.</li>
|
|
1398
|
+
|
|
1399
|
+
Up to 10 `Filters` are allowed in one request. Each filter can have up to 5 `Filter.Values`. `CommandIds` and `Filters` cannot be specified at the same time.
|
|
1400
|
+
:rtype: list of Filter
|
|
1401
|
+
"""
|
|
1170
1402
|
return self._Filters
|
|
1171
1403
|
|
|
1172
1404
|
@Filters.setter
|
|
@@ -1175,6 +1407,9 @@ Up to 10 `Filters` are allowed in one request. Each filter can have up to 5 `Fil
|
|
|
1175
1407
|
|
|
1176
1408
|
@property
|
|
1177
1409
|
def Limit(self):
|
|
1410
|
+
"""Number of returned results. It defaults to `20`. The maximum is 100. For more information on `Limit`, see the relevant section in the API [Overview](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1).
|
|
1411
|
+
:rtype: int
|
|
1412
|
+
"""
|
|
1178
1413
|
return self._Limit
|
|
1179
1414
|
|
|
1180
1415
|
@Limit.setter
|
|
@@ -1183,6 +1418,9 @@ Up to 10 `Filters` are allowed in one request. Each filter can have up to 5 `Fil
|
|
|
1183
1418
|
|
|
1184
1419
|
@property
|
|
1185
1420
|
def Offset(self):
|
|
1421
|
+
"""Offset. The default value is `0`. For more information on `Offset`, see the relevant section in API [Introduction](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1).
|
|
1422
|
+
:rtype: int
|
|
1423
|
+
"""
|
|
1186
1424
|
return self._Offset
|
|
1187
1425
|
|
|
1188
1426
|
@Offset.setter
|
|
@@ -1230,6 +1468,9 @@ class DescribeCommandsResponse(AbstractModel):
|
|
|
1230
1468
|
|
|
1231
1469
|
@property
|
|
1232
1470
|
def TotalCount(self):
|
|
1471
|
+
"""Total number of matching commands.
|
|
1472
|
+
:rtype: int
|
|
1473
|
+
"""
|
|
1233
1474
|
return self._TotalCount
|
|
1234
1475
|
|
|
1235
1476
|
@TotalCount.setter
|
|
@@ -1238,6 +1479,9 @@ class DescribeCommandsResponse(AbstractModel):
|
|
|
1238
1479
|
|
|
1239
1480
|
@property
|
|
1240
1481
|
def CommandSet(self):
|
|
1482
|
+
"""List of command details.
|
|
1483
|
+
:rtype: list of Command
|
|
1484
|
+
"""
|
|
1241
1485
|
return self._CommandSet
|
|
1242
1486
|
|
|
1243
1487
|
@CommandSet.setter
|
|
@@ -1246,6 +1490,9 @@ class DescribeCommandsResponse(AbstractModel):
|
|
|
1246
1490
|
|
|
1247
1491
|
@property
|
|
1248
1492
|
def RequestId(self):
|
|
1493
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
1494
|
+
:rtype: str
|
|
1495
|
+
"""
|
|
1249
1496
|
return self._RequestId
|
|
1250
1497
|
|
|
1251
1498
|
@RequestId.setter
|
|
@@ -1290,6 +1537,9 @@ class DescribeInvocationTasksRequest(AbstractModel):
|
|
|
1290
1537
|
|
|
1291
1538
|
@property
|
|
1292
1539
|
def InvocationTaskIds(self):
|
|
1540
|
+
"""List of execution task IDs. Up to 100 IDs are allowed for each request. `InvocationTaskIds` and `Filters` cannot be specified at the same time.
|
|
1541
|
+
:rtype: list of str
|
|
1542
|
+
"""
|
|
1293
1543
|
return self._InvocationTaskIds
|
|
1294
1544
|
|
|
1295
1545
|
@InvocationTaskIds.setter
|
|
@@ -1298,6 +1548,9 @@ class DescribeInvocationTasksRequest(AbstractModel):
|
|
|
1298
1548
|
|
|
1299
1549
|
@property
|
|
1300
1550
|
def Filters(self):
|
|
1551
|
+
"""Filter conditions.<br> <li> `invocation-id` - String - Required: No - (Filter condition) Filter by the execution activity ID.<br> <li> `invocation-task-id` - String - Required: No - (Filter condition) Filter by the execution task ID.<br> <li> `instance-id` - String - Required: No - (Filter condition) Filter by the instance ID. <br> <li> `command-id` - String - Required: No - (Filter condition) Filter by the command ID. <br>Up to 10 `Filters` are allowed for each request. Each filter can have up to five `Filter.Values`. `InvocationTaskIds` and `Filters` cannot be specified at the same time.
|
|
1552
|
+
:rtype: list of Filter
|
|
1553
|
+
"""
|
|
1301
1554
|
return self._Filters
|
|
1302
1555
|
|
|
1303
1556
|
@Filters.setter
|
|
@@ -1306,6 +1559,9 @@ class DescribeInvocationTasksRequest(AbstractModel):
|
|
|
1306
1559
|
|
|
1307
1560
|
@property
|
|
1308
1561
|
def Limit(self):
|
|
1562
|
+
"""Number of returned results. It defaults to `20`. The maximum is 100. For more information on `Limit`, see the relevant section in the API [Overview](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1).
|
|
1563
|
+
:rtype: int
|
|
1564
|
+
"""
|
|
1309
1565
|
return self._Limit
|
|
1310
1566
|
|
|
1311
1567
|
@Limit.setter
|
|
@@ -1314,6 +1570,9 @@ class DescribeInvocationTasksRequest(AbstractModel):
|
|
|
1314
1570
|
|
|
1315
1571
|
@property
|
|
1316
1572
|
def Offset(self):
|
|
1573
|
+
"""Offset. The default value is `0`. For more information on `Offset`, see the relevant section in API [Introduction](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1).
|
|
1574
|
+
:rtype: int
|
|
1575
|
+
"""
|
|
1317
1576
|
return self._Offset
|
|
1318
1577
|
|
|
1319
1578
|
@Offset.setter
|
|
@@ -1322,6 +1581,9 @@ class DescribeInvocationTasksRequest(AbstractModel):
|
|
|
1322
1581
|
|
|
1323
1582
|
@property
|
|
1324
1583
|
def HideOutput(self):
|
|
1584
|
+
"""Whether to hide the output. Valid values:<br><li>`True` (default): Hide the output <br><li>`False`: Show the output <br>
|
|
1585
|
+
:rtype: bool
|
|
1586
|
+
"""
|
|
1325
1587
|
return self._HideOutput
|
|
1326
1588
|
|
|
1327
1589
|
@HideOutput.setter
|
|
@@ -1370,6 +1632,9 @@ class DescribeInvocationTasksResponse(AbstractModel):
|
|
|
1370
1632
|
|
|
1371
1633
|
@property
|
|
1372
1634
|
def TotalCount(self):
|
|
1635
|
+
"""Total number of matching execution tasks.
|
|
1636
|
+
:rtype: int
|
|
1637
|
+
"""
|
|
1373
1638
|
return self._TotalCount
|
|
1374
1639
|
|
|
1375
1640
|
@TotalCount.setter
|
|
@@ -1378,6 +1643,9 @@ class DescribeInvocationTasksResponse(AbstractModel):
|
|
|
1378
1643
|
|
|
1379
1644
|
@property
|
|
1380
1645
|
def InvocationTaskSet(self):
|
|
1646
|
+
"""List of execution tasks.
|
|
1647
|
+
:rtype: list of InvocationTask
|
|
1648
|
+
"""
|
|
1381
1649
|
return self._InvocationTaskSet
|
|
1382
1650
|
|
|
1383
1651
|
@InvocationTaskSet.setter
|
|
@@ -1386,6 +1654,9 @@ class DescribeInvocationTasksResponse(AbstractModel):
|
|
|
1386
1654
|
|
|
1387
1655
|
@property
|
|
1388
1656
|
def RequestId(self):
|
|
1657
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
1658
|
+
:rtype: str
|
|
1659
|
+
"""
|
|
1389
1660
|
return self._RequestId
|
|
1390
1661
|
|
|
1391
1662
|
@RequestId.setter
|
|
@@ -1431,6 +1702,9 @@ class DescribeInvocationsRequest(AbstractModel):
|
|
|
1431
1702
|
|
|
1432
1703
|
@property
|
|
1433
1704
|
def InvocationIds(self):
|
|
1705
|
+
"""List of execution activity IDs. Up to 100 IDs are allowed for each request. `InvocationIds` and `Filters` cannot be specified at the same time.
|
|
1706
|
+
:rtype: list of str
|
|
1707
|
+
"""
|
|
1434
1708
|
return self._InvocationIds
|
|
1435
1709
|
|
|
1436
1710
|
@InvocationIds.setter
|
|
@@ -1439,6 +1713,13 @@ class DescribeInvocationsRequest(AbstractModel):
|
|
|
1439
1713
|
|
|
1440
1714
|
@property
|
|
1441
1715
|
def Filters(self):
|
|
1716
|
+
"""Filter conditions.<br> <li> `invocation-id` - String - Required: No - (Filter condition) Filter by the execution activity ID.<br>
|
|
1717
|
+
<li> `command-id` - String - Required: No - (Filter condition) Filter by the command ID.
|
|
1718
|
+
<li> `command-created-by` - String - Required: No - (Filter condition) Filter by the command type. Valid values: `TAT` (public commands) or `USER` (custom commands).
|
|
1719
|
+
<li> `instance-kind` - String - Required: No - (Filter condition) Filter by the instance type. Valid values: `CVM` or `LIGHTHOUSE`.
|
|
1720
|
+
<br>Up to 10 `Filters` are allowed for each request. Each filter can have up to five `Filter.Values`. `InvocationIds` and `Filters` cannot be specified at the same time.
|
|
1721
|
+
:rtype: list of Filter
|
|
1722
|
+
"""
|
|
1442
1723
|
return self._Filters
|
|
1443
1724
|
|
|
1444
1725
|
@Filters.setter
|
|
@@ -1447,6 +1728,9 @@ class DescribeInvocationsRequest(AbstractModel):
|
|
|
1447
1728
|
|
|
1448
1729
|
@property
|
|
1449
1730
|
def Limit(self):
|
|
1731
|
+
"""Number of returned results. It defaults to `20`. The maximum is 100. For more information on `Limit`, see the relevant section in the API [Overview](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1).
|
|
1732
|
+
:rtype: int
|
|
1733
|
+
"""
|
|
1450
1734
|
return self._Limit
|
|
1451
1735
|
|
|
1452
1736
|
@Limit.setter
|
|
@@ -1455,6 +1739,9 @@ class DescribeInvocationsRequest(AbstractModel):
|
|
|
1455
1739
|
|
|
1456
1740
|
@property
|
|
1457
1741
|
def Offset(self):
|
|
1742
|
+
"""Offset. The default value is `0`. For more information on `Offset`, see the relevant section in API [Introduction](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1).
|
|
1743
|
+
:rtype: int
|
|
1744
|
+
"""
|
|
1458
1745
|
return self._Offset
|
|
1459
1746
|
|
|
1460
1747
|
@Offset.setter
|
|
@@ -1502,6 +1789,9 @@ class DescribeInvocationsResponse(AbstractModel):
|
|
|
1502
1789
|
|
|
1503
1790
|
@property
|
|
1504
1791
|
def TotalCount(self):
|
|
1792
|
+
"""Total number of matching execution activities.
|
|
1793
|
+
:rtype: int
|
|
1794
|
+
"""
|
|
1505
1795
|
return self._TotalCount
|
|
1506
1796
|
|
|
1507
1797
|
@TotalCount.setter
|
|
@@ -1510,6 +1800,9 @@ class DescribeInvocationsResponse(AbstractModel):
|
|
|
1510
1800
|
|
|
1511
1801
|
@property
|
|
1512
1802
|
def InvocationSet(self):
|
|
1803
|
+
"""List of execution activities.
|
|
1804
|
+
:rtype: list of Invocation
|
|
1805
|
+
"""
|
|
1513
1806
|
return self._InvocationSet
|
|
1514
1807
|
|
|
1515
1808
|
@InvocationSet.setter
|
|
@@ -1518,6 +1811,9 @@ class DescribeInvocationsResponse(AbstractModel):
|
|
|
1518
1811
|
|
|
1519
1812
|
@property
|
|
1520
1813
|
def RequestId(self):
|
|
1814
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
1815
|
+
:rtype: str
|
|
1816
|
+
"""
|
|
1521
1817
|
return self._RequestId
|
|
1522
1818
|
|
|
1523
1819
|
@RequestId.setter
|
|
@@ -1556,6 +1852,9 @@ class DescribeInvokerRecordsRequest(AbstractModel):
|
|
|
1556
1852
|
|
|
1557
1853
|
@property
|
|
1558
1854
|
def InvokerIds(self):
|
|
1855
|
+
"""List of invoker IDs. Up to 100 IDs are allowed.
|
|
1856
|
+
:rtype: list of str
|
|
1857
|
+
"""
|
|
1559
1858
|
return self._InvokerIds
|
|
1560
1859
|
|
|
1561
1860
|
@InvokerIds.setter
|
|
@@ -1564,6 +1863,9 @@ class DescribeInvokerRecordsRequest(AbstractModel):
|
|
|
1564
1863
|
|
|
1565
1864
|
@property
|
|
1566
1865
|
def Limit(self):
|
|
1866
|
+
"""Number of returned results. Default value: 20. Maximum value: 100.
|
|
1867
|
+
:rtype: int
|
|
1868
|
+
"""
|
|
1567
1869
|
return self._Limit
|
|
1568
1870
|
|
|
1569
1871
|
@Limit.setter
|
|
@@ -1572,6 +1874,9 @@ class DescribeInvokerRecordsRequest(AbstractModel):
|
|
|
1572
1874
|
|
|
1573
1875
|
@property
|
|
1574
1876
|
def Offset(self):
|
|
1877
|
+
"""Offset. Default value: 0.
|
|
1878
|
+
:rtype: int
|
|
1879
|
+
"""
|
|
1575
1880
|
return self._Offset
|
|
1576
1881
|
|
|
1577
1882
|
@Offset.setter
|
|
@@ -1613,6 +1918,9 @@ class DescribeInvokerRecordsResponse(AbstractModel):
|
|
|
1613
1918
|
|
|
1614
1919
|
@property
|
|
1615
1920
|
def TotalCount(self):
|
|
1921
|
+
"""Number of matching records.
|
|
1922
|
+
:rtype: int
|
|
1923
|
+
"""
|
|
1616
1924
|
return self._TotalCount
|
|
1617
1925
|
|
|
1618
1926
|
@TotalCount.setter
|
|
@@ -1621,6 +1929,9 @@ class DescribeInvokerRecordsResponse(AbstractModel):
|
|
|
1621
1929
|
|
|
1622
1930
|
@property
|
|
1623
1931
|
def InvokerRecordSet(self):
|
|
1932
|
+
"""Execution history of an invoker.
|
|
1933
|
+
:rtype: list of InvokerRecord
|
|
1934
|
+
"""
|
|
1624
1935
|
return self._InvokerRecordSet
|
|
1625
1936
|
|
|
1626
1937
|
@InvokerRecordSet.setter
|
|
@@ -1629,6 +1940,9 @@ class DescribeInvokerRecordsResponse(AbstractModel):
|
|
|
1629
1940
|
|
|
1630
1941
|
@property
|
|
1631
1942
|
def RequestId(self):
|
|
1943
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
1944
|
+
:rtype: str
|
|
1945
|
+
"""
|
|
1632
1946
|
return self._RequestId
|
|
1633
1947
|
|
|
1634
1948
|
@RequestId.setter
|
|
@@ -1674,6 +1988,9 @@ class DescribeInvokersRequest(AbstractModel):
|
|
|
1674
1988
|
|
|
1675
1989
|
@property
|
|
1676
1990
|
def InvokerIds(self):
|
|
1991
|
+
"""List of invoker IDs.
|
|
1992
|
+
:rtype: list of str
|
|
1993
|
+
"""
|
|
1677
1994
|
return self._InvokerIds
|
|
1678
1995
|
|
|
1679
1996
|
@InvokerIds.setter
|
|
@@ -1682,6 +1999,13 @@ class DescribeInvokersRequest(AbstractModel):
|
|
|
1682
1999
|
|
|
1683
2000
|
@property
|
|
1684
2001
|
def Filters(self):
|
|
2002
|
+
"""Filter conditions:
|
|
2003
|
+
|
|
2004
|
+
<li> `invoker-id` - String - Required: No - (Filter condition) Filter by the invoker ID.
|
|
2005
|
+
<li> `command-id` - String - Required: No - (Filter condition) Filter by the command ID.
|
|
2006
|
+
<li> `type` - String - Required: No - (Filter condition) Filter by the invoker type.
|
|
2007
|
+
:rtype: list of Filter
|
|
2008
|
+
"""
|
|
1685
2009
|
return self._Filters
|
|
1686
2010
|
|
|
1687
2011
|
@Filters.setter
|
|
@@ -1690,6 +2014,9 @@ class DescribeInvokersRequest(AbstractModel):
|
|
|
1690
2014
|
|
|
1691
2015
|
@property
|
|
1692
2016
|
def Limit(self):
|
|
2017
|
+
"""Number of returned results. Default value: 20. Maximum value: 100.
|
|
2018
|
+
:rtype: int
|
|
2019
|
+
"""
|
|
1693
2020
|
return self._Limit
|
|
1694
2021
|
|
|
1695
2022
|
@Limit.setter
|
|
@@ -1698,6 +2025,9 @@ class DescribeInvokersRequest(AbstractModel):
|
|
|
1698
2025
|
|
|
1699
2026
|
@property
|
|
1700
2027
|
def Offset(self):
|
|
2028
|
+
"""Offset. Default value: 0.
|
|
2029
|
+
:rtype: int
|
|
2030
|
+
"""
|
|
1701
2031
|
return self._Offset
|
|
1702
2032
|
|
|
1703
2033
|
@Offset.setter
|
|
@@ -1745,6 +2075,9 @@ class DescribeInvokersResponse(AbstractModel):
|
|
|
1745
2075
|
|
|
1746
2076
|
@property
|
|
1747
2077
|
def TotalCount(self):
|
|
2078
|
+
"""Number of matching invokers.
|
|
2079
|
+
:rtype: int
|
|
2080
|
+
"""
|
|
1748
2081
|
return self._TotalCount
|
|
1749
2082
|
|
|
1750
2083
|
@TotalCount.setter
|
|
@@ -1753,6 +2086,9 @@ class DescribeInvokersResponse(AbstractModel):
|
|
|
1753
2086
|
|
|
1754
2087
|
@property
|
|
1755
2088
|
def InvokerSet(self):
|
|
2089
|
+
"""Invoker information.
|
|
2090
|
+
:rtype: list of Invoker
|
|
2091
|
+
"""
|
|
1756
2092
|
return self._InvokerSet
|
|
1757
2093
|
|
|
1758
2094
|
@InvokerSet.setter
|
|
@@ -1761,6 +2097,9 @@ class DescribeInvokersResponse(AbstractModel):
|
|
|
1761
2097
|
|
|
1762
2098
|
@property
|
|
1763
2099
|
def RequestId(self):
|
|
2100
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
2101
|
+
:rtype: str
|
|
2102
|
+
"""
|
|
1764
2103
|
return self._RequestId
|
|
1765
2104
|
|
|
1766
2105
|
@RequestId.setter
|
|
@@ -1805,6 +2144,9 @@ class DescribeRegionsResponse(AbstractModel):
|
|
|
1805
2144
|
|
|
1806
2145
|
@property
|
|
1807
2146
|
def TotalCount(self):
|
|
2147
|
+
"""Number of regions
|
|
2148
|
+
:rtype: int
|
|
2149
|
+
"""
|
|
1808
2150
|
return self._TotalCount
|
|
1809
2151
|
|
|
1810
2152
|
@TotalCount.setter
|
|
@@ -1813,6 +2155,9 @@ class DescribeRegionsResponse(AbstractModel):
|
|
|
1813
2155
|
|
|
1814
2156
|
@property
|
|
1815
2157
|
def RegionSet(self):
|
|
2158
|
+
"""Region information list
|
|
2159
|
+
:rtype: list of RegionInfo
|
|
2160
|
+
"""
|
|
1816
2161
|
return self._RegionSet
|
|
1817
2162
|
|
|
1818
2163
|
@RegionSet.setter
|
|
@@ -1821,6 +2166,9 @@ class DescribeRegionsResponse(AbstractModel):
|
|
|
1821
2166
|
|
|
1822
2167
|
@property
|
|
1823
2168
|
def RequestId(self):
|
|
2169
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
2170
|
+
:rtype: str
|
|
2171
|
+
"""
|
|
1824
2172
|
return self._RequestId
|
|
1825
2173
|
|
|
1826
2174
|
@RequestId.setter
|
|
@@ -1853,6 +2201,9 @@ class DisableInvokerRequest(AbstractModel):
|
|
|
1853
2201
|
|
|
1854
2202
|
@property
|
|
1855
2203
|
def InvokerId(self):
|
|
2204
|
+
"""ID of the invoker to be disabled.
|
|
2205
|
+
:rtype: str
|
|
2206
|
+
"""
|
|
1856
2207
|
return self._InvokerId
|
|
1857
2208
|
|
|
1858
2209
|
@InvokerId.setter
|
|
@@ -1886,6 +2237,9 @@ class DisableInvokerResponse(AbstractModel):
|
|
|
1886
2237
|
|
|
1887
2238
|
@property
|
|
1888
2239
|
def RequestId(self):
|
|
2240
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
2241
|
+
:rtype: str
|
|
2242
|
+
"""
|
|
1889
2243
|
return self._RequestId
|
|
1890
2244
|
|
|
1891
2245
|
@RequestId.setter
|
|
@@ -1911,6 +2265,9 @@ class EnableInvokerRequest(AbstractModel):
|
|
|
1911
2265
|
|
|
1912
2266
|
@property
|
|
1913
2267
|
def InvokerId(self):
|
|
2268
|
+
"""ID of the invoker to be enabled.
|
|
2269
|
+
:rtype: str
|
|
2270
|
+
"""
|
|
1914
2271
|
return self._InvokerId
|
|
1915
2272
|
|
|
1916
2273
|
@InvokerId.setter
|
|
@@ -1944,6 +2301,9 @@ class EnableInvokerResponse(AbstractModel):
|
|
|
1944
2301
|
|
|
1945
2302
|
@property
|
|
1946
2303
|
def RequestId(self):
|
|
2304
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
2305
|
+
:rtype: str
|
|
2306
|
+
"""
|
|
1947
2307
|
return self._RequestId
|
|
1948
2308
|
|
|
1949
2309
|
@RequestId.setter
|
|
@@ -1983,6 +2343,9 @@ class Filter(AbstractModel):
|
|
|
1983
2343
|
|
|
1984
2344
|
@property
|
|
1985
2345
|
def Name(self):
|
|
2346
|
+
"""Field to be filtered.
|
|
2347
|
+
:rtype: str
|
|
2348
|
+
"""
|
|
1986
2349
|
return self._Name
|
|
1987
2350
|
|
|
1988
2351
|
@Name.setter
|
|
@@ -1991,6 +2354,9 @@ class Filter(AbstractModel):
|
|
|
1991
2354
|
|
|
1992
2355
|
@property
|
|
1993
2356
|
def Values(self):
|
|
2357
|
+
"""Filter values of the field.
|
|
2358
|
+
:rtype: list of str
|
|
2359
|
+
"""
|
|
1994
2360
|
return self._Values
|
|
1995
2361
|
|
|
1996
2362
|
@Values.setter
|
|
@@ -2088,6 +2454,9 @@ class Invocation(AbstractModel):
|
|
|
2088
2454
|
|
|
2089
2455
|
@property
|
|
2090
2456
|
def InvocationId(self):
|
|
2457
|
+
"""Execution activity ID.
|
|
2458
|
+
:rtype: str
|
|
2459
|
+
"""
|
|
2091
2460
|
return self._InvocationId
|
|
2092
2461
|
|
|
2093
2462
|
@InvocationId.setter
|
|
@@ -2096,6 +2465,9 @@ class Invocation(AbstractModel):
|
|
|
2096
2465
|
|
|
2097
2466
|
@property
|
|
2098
2467
|
def CommandId(self):
|
|
2468
|
+
"""Command ID.
|
|
2469
|
+
:rtype: str
|
|
2470
|
+
"""
|
|
2099
2471
|
return self._CommandId
|
|
2100
2472
|
|
|
2101
2473
|
@CommandId.setter
|
|
@@ -2104,6 +2476,15 @@ class Invocation(AbstractModel):
|
|
|
2104
2476
|
|
|
2105
2477
|
@property
|
|
2106
2478
|
def InvocationStatus(self):
|
|
2479
|
+
"""Execution task status. Valid values:
|
|
2480
|
+
<li> PENDING: Pending
|
|
2481
|
+
<li> RUNNING: Running
|
|
2482
|
+
<li> SUCCESS: Success
|
|
2483
|
+
<li> FAILED: Failed
|
|
2484
|
+
<li> TIMEOUT: Command timed out
|
|
2485
|
+
<li> PARTIAL_FAILED: Partial failure
|
|
2486
|
+
:rtype: str
|
|
2487
|
+
"""
|
|
2107
2488
|
return self._InvocationStatus
|
|
2108
2489
|
|
|
2109
2490
|
@InvocationStatus.setter
|
|
@@ -2112,6 +2493,9 @@ class Invocation(AbstractModel):
|
|
|
2112
2493
|
|
|
2113
2494
|
@property
|
|
2114
2495
|
def InvocationTaskBasicInfoSet(self):
|
|
2496
|
+
"""Execution task information list.
|
|
2497
|
+
:rtype: list of InvocationTaskBasicInfo
|
|
2498
|
+
"""
|
|
2115
2499
|
return self._InvocationTaskBasicInfoSet
|
|
2116
2500
|
|
|
2117
2501
|
@InvocationTaskBasicInfoSet.setter
|
|
@@ -2120,6 +2504,9 @@ class Invocation(AbstractModel):
|
|
|
2120
2504
|
|
|
2121
2505
|
@property
|
|
2122
2506
|
def Description(self):
|
|
2507
|
+
"""Execution activity description.
|
|
2508
|
+
:rtype: str
|
|
2509
|
+
"""
|
|
2123
2510
|
return self._Description
|
|
2124
2511
|
|
|
2125
2512
|
@Description.setter
|
|
@@ -2128,6 +2515,9 @@ class Invocation(AbstractModel):
|
|
|
2128
2515
|
|
|
2129
2516
|
@property
|
|
2130
2517
|
def StartTime(self):
|
|
2518
|
+
"""Start time of the execution activity.
|
|
2519
|
+
:rtype: str
|
|
2520
|
+
"""
|
|
2131
2521
|
return self._StartTime
|
|
2132
2522
|
|
|
2133
2523
|
@StartTime.setter
|
|
@@ -2136,6 +2526,9 @@ class Invocation(AbstractModel):
|
|
|
2136
2526
|
|
|
2137
2527
|
@property
|
|
2138
2528
|
def EndTime(self):
|
|
2529
|
+
"""End time of the execution activity.
|
|
2530
|
+
:rtype: str
|
|
2531
|
+
"""
|
|
2139
2532
|
return self._EndTime
|
|
2140
2533
|
|
|
2141
2534
|
@EndTime.setter
|
|
@@ -2144,6 +2537,9 @@ class Invocation(AbstractModel):
|
|
|
2144
2537
|
|
|
2145
2538
|
@property
|
|
2146
2539
|
def CreatedTime(self):
|
|
2540
|
+
"""Time when the execution activity is created.
|
|
2541
|
+
:rtype: str
|
|
2542
|
+
"""
|
|
2147
2543
|
return self._CreatedTime
|
|
2148
2544
|
|
|
2149
2545
|
@CreatedTime.setter
|
|
@@ -2152,6 +2548,9 @@ class Invocation(AbstractModel):
|
|
|
2152
2548
|
|
|
2153
2549
|
@property
|
|
2154
2550
|
def UpdatedTime(self):
|
|
2551
|
+
"""Time when the execution activity is updated.
|
|
2552
|
+
:rtype: str
|
|
2553
|
+
"""
|
|
2155
2554
|
return self._UpdatedTime
|
|
2156
2555
|
|
|
2157
2556
|
@UpdatedTime.setter
|
|
@@ -2160,6 +2559,9 @@ class Invocation(AbstractModel):
|
|
|
2160
2559
|
|
|
2161
2560
|
@property
|
|
2162
2561
|
def Parameters(self):
|
|
2562
|
+
"""Values of custom parameters.
|
|
2563
|
+
:rtype: str
|
|
2564
|
+
"""
|
|
2163
2565
|
return self._Parameters
|
|
2164
2566
|
|
|
2165
2567
|
@Parameters.setter
|
|
@@ -2168,6 +2570,9 @@ class Invocation(AbstractModel):
|
|
|
2168
2570
|
|
|
2169
2571
|
@property
|
|
2170
2572
|
def DefaultParameters(self):
|
|
2573
|
+
"""Default custom parameter value.
|
|
2574
|
+
:rtype: str
|
|
2575
|
+
"""
|
|
2171
2576
|
return self._DefaultParameters
|
|
2172
2577
|
|
|
2173
2578
|
@DefaultParameters.setter
|
|
@@ -2176,6 +2581,9 @@ class Invocation(AbstractModel):
|
|
|
2176
2581
|
|
|
2177
2582
|
@property
|
|
2178
2583
|
def InstanceKind(self):
|
|
2584
|
+
"""Type of the instance executing the command. Valid values: `CVM`, `LIGHTHOUSE`.
|
|
2585
|
+
:rtype: str
|
|
2586
|
+
"""
|
|
2179
2587
|
return self._InstanceKind
|
|
2180
2588
|
|
|
2181
2589
|
@InstanceKind.setter
|
|
@@ -2184,6 +2592,9 @@ class Invocation(AbstractModel):
|
|
|
2184
2592
|
|
|
2185
2593
|
@property
|
|
2186
2594
|
def Username(self):
|
|
2595
|
+
"""The user who executes the command on the instance.
|
|
2596
|
+
:rtype: str
|
|
2597
|
+
"""
|
|
2187
2598
|
return self._Username
|
|
2188
2599
|
|
|
2189
2600
|
@Username.setter
|
|
@@ -2192,6 +2603,9 @@ class Invocation(AbstractModel):
|
|
|
2192
2603
|
|
|
2193
2604
|
@property
|
|
2194
2605
|
def InvocationSource(self):
|
|
2606
|
+
"""Invocation source.
|
|
2607
|
+
:rtype: str
|
|
2608
|
+
"""
|
|
2195
2609
|
return self._InvocationSource
|
|
2196
2610
|
|
|
2197
2611
|
@InvocationSource.setter
|
|
@@ -2200,6 +2614,9 @@ class Invocation(AbstractModel):
|
|
|
2200
2614
|
|
|
2201
2615
|
@property
|
|
2202
2616
|
def CommandContent(self):
|
|
2617
|
+
"""Base64-encoded command
|
|
2618
|
+
:rtype: str
|
|
2619
|
+
"""
|
|
2203
2620
|
return self._CommandContent
|
|
2204
2621
|
|
|
2205
2622
|
@CommandContent.setter
|
|
@@ -2208,6 +2625,9 @@ class Invocation(AbstractModel):
|
|
|
2208
2625
|
|
|
2209
2626
|
@property
|
|
2210
2627
|
def CommandType(self):
|
|
2628
|
+
"""Command type
|
|
2629
|
+
:rtype: str
|
|
2630
|
+
"""
|
|
2211
2631
|
return self._CommandType
|
|
2212
2632
|
|
|
2213
2633
|
@CommandType.setter
|
|
@@ -2216,6 +2636,9 @@ class Invocation(AbstractModel):
|
|
|
2216
2636
|
|
|
2217
2637
|
@property
|
|
2218
2638
|
def Timeout(self):
|
|
2639
|
+
"""Command timeout period, in seconds.
|
|
2640
|
+
:rtype: int
|
|
2641
|
+
"""
|
|
2219
2642
|
return self._Timeout
|
|
2220
2643
|
|
|
2221
2644
|
@Timeout.setter
|
|
@@ -2224,6 +2647,9 @@ class Invocation(AbstractModel):
|
|
|
2224
2647
|
|
|
2225
2648
|
@property
|
|
2226
2649
|
def WorkingDirectory(self):
|
|
2650
|
+
"""Working directory for executing the command.
|
|
2651
|
+
:rtype: str
|
|
2652
|
+
"""
|
|
2227
2653
|
return self._WorkingDirectory
|
|
2228
2654
|
|
|
2229
2655
|
@WorkingDirectory.setter
|
|
@@ -2232,6 +2658,9 @@ class Invocation(AbstractModel):
|
|
|
2232
2658
|
|
|
2233
2659
|
@property
|
|
2234
2660
|
def OutputCOSBucketUrl(self):
|
|
2661
|
+
"""The COS bucket URL for uploading logs.
|
|
2662
|
+
:rtype: str
|
|
2663
|
+
"""
|
|
2235
2664
|
return self._OutputCOSBucketUrl
|
|
2236
2665
|
|
|
2237
2666
|
@OutputCOSBucketUrl.setter
|
|
@@ -2240,6 +2669,9 @@ class Invocation(AbstractModel):
|
|
|
2240
2669
|
|
|
2241
2670
|
@property
|
|
2242
2671
|
def OutputCOSKeyPrefix(self):
|
|
2672
|
+
"""The COS bucket directory where the logs are saved.
|
|
2673
|
+
:rtype: str
|
|
2674
|
+
"""
|
|
2243
2675
|
return self._OutputCOSKeyPrefix
|
|
2244
2676
|
|
|
2245
2677
|
@OutputCOSKeyPrefix.setter
|
|
@@ -2346,6 +2778,9 @@ class InvocationTask(AbstractModel):
|
|
|
2346
2778
|
|
|
2347
2779
|
@property
|
|
2348
2780
|
def InvocationId(self):
|
|
2781
|
+
"""Execution activity ID.
|
|
2782
|
+
:rtype: str
|
|
2783
|
+
"""
|
|
2349
2784
|
return self._InvocationId
|
|
2350
2785
|
|
|
2351
2786
|
@InvocationId.setter
|
|
@@ -2354,6 +2789,9 @@ class InvocationTask(AbstractModel):
|
|
|
2354
2789
|
|
|
2355
2790
|
@property
|
|
2356
2791
|
def InvocationTaskId(self):
|
|
2792
|
+
"""Execution task ID.
|
|
2793
|
+
:rtype: str
|
|
2794
|
+
"""
|
|
2357
2795
|
return self._InvocationTaskId
|
|
2358
2796
|
|
|
2359
2797
|
@InvocationTaskId.setter
|
|
@@ -2362,6 +2800,9 @@ class InvocationTask(AbstractModel):
|
|
|
2362
2800
|
|
|
2363
2801
|
@property
|
|
2364
2802
|
def CommandId(self):
|
|
2803
|
+
"""Command ID.
|
|
2804
|
+
:rtype: str
|
|
2805
|
+
"""
|
|
2365
2806
|
return self._CommandId
|
|
2366
2807
|
|
|
2367
2808
|
@CommandId.setter
|
|
@@ -2370,6 +2811,22 @@ class InvocationTask(AbstractModel):
|
|
|
2370
2811
|
|
|
2371
2812
|
@property
|
|
2372
2813
|
def TaskStatus(self):
|
|
2814
|
+
"""Execution task status. Valid values:
|
|
2815
|
+
<li> PENDING: Pending
|
|
2816
|
+
<li> DELIVERING: Delivering
|
|
2817
|
+
<li> DELIVER_DELAYED: Delivery delayed
|
|
2818
|
+
<li> DELIVER_FAILED: Delivery failed
|
|
2819
|
+
<li> START_FAILED: Failed to start the command
|
|
2820
|
+
<li> RUNNING: Running
|
|
2821
|
+
<li> SUCCESS: Success
|
|
2822
|
+
<li> FAILED: Failed to execute the command. The exit code is not 0 after execution.
|
|
2823
|
+
<li> TIMEOUT: Command timed out
|
|
2824
|
+
<li> TASK_TIMEOUT: Task timed out
|
|
2825
|
+
<li> CANCELLING: Canceling
|
|
2826
|
+
<li> CANCELLED: Canceled (canceled before execution)
|
|
2827
|
+
<li> TERMINATED: Terminated (canceled during execution)
|
|
2828
|
+
:rtype: str
|
|
2829
|
+
"""
|
|
2373
2830
|
return self._TaskStatus
|
|
2374
2831
|
|
|
2375
2832
|
@TaskStatus.setter
|
|
@@ -2378,6 +2835,9 @@ class InvocationTask(AbstractModel):
|
|
|
2378
2835
|
|
|
2379
2836
|
@property
|
|
2380
2837
|
def InstanceId(self):
|
|
2838
|
+
"""Instance ID.
|
|
2839
|
+
:rtype: str
|
|
2840
|
+
"""
|
|
2381
2841
|
return self._InstanceId
|
|
2382
2842
|
|
|
2383
2843
|
@InstanceId.setter
|
|
@@ -2386,6 +2846,9 @@ class InvocationTask(AbstractModel):
|
|
|
2386
2846
|
|
|
2387
2847
|
@property
|
|
2388
2848
|
def TaskResult(self):
|
|
2849
|
+
"""Execution result.
|
|
2850
|
+
:rtype: :class:`tencentcloud.tat.v20201028.models.TaskResult`
|
|
2851
|
+
"""
|
|
2389
2852
|
return self._TaskResult
|
|
2390
2853
|
|
|
2391
2854
|
@TaskResult.setter
|
|
@@ -2394,6 +2857,9 @@ class InvocationTask(AbstractModel):
|
|
|
2394
2857
|
|
|
2395
2858
|
@property
|
|
2396
2859
|
def StartTime(self):
|
|
2860
|
+
"""Start time of the execution task.
|
|
2861
|
+
:rtype: str
|
|
2862
|
+
"""
|
|
2397
2863
|
return self._StartTime
|
|
2398
2864
|
|
|
2399
2865
|
@StartTime.setter
|
|
@@ -2402,6 +2868,9 @@ class InvocationTask(AbstractModel):
|
|
|
2402
2868
|
|
|
2403
2869
|
@property
|
|
2404
2870
|
def EndTime(self):
|
|
2871
|
+
"""End time of the execution task.
|
|
2872
|
+
:rtype: str
|
|
2873
|
+
"""
|
|
2405
2874
|
return self._EndTime
|
|
2406
2875
|
|
|
2407
2876
|
@EndTime.setter
|
|
@@ -2410,6 +2879,9 @@ class InvocationTask(AbstractModel):
|
|
|
2410
2879
|
|
|
2411
2880
|
@property
|
|
2412
2881
|
def CreatedTime(self):
|
|
2882
|
+
"""Creation time.
|
|
2883
|
+
:rtype: str
|
|
2884
|
+
"""
|
|
2413
2885
|
return self._CreatedTime
|
|
2414
2886
|
|
|
2415
2887
|
@CreatedTime.setter
|
|
@@ -2418,6 +2890,9 @@ class InvocationTask(AbstractModel):
|
|
|
2418
2890
|
|
|
2419
2891
|
@property
|
|
2420
2892
|
def UpdatedTime(self):
|
|
2893
|
+
"""Update time.
|
|
2894
|
+
:rtype: str
|
|
2895
|
+
"""
|
|
2421
2896
|
return self._UpdatedTime
|
|
2422
2897
|
|
|
2423
2898
|
@UpdatedTime.setter
|
|
@@ -2426,6 +2901,9 @@ class InvocationTask(AbstractModel):
|
|
|
2426
2901
|
|
|
2427
2902
|
@property
|
|
2428
2903
|
def CommandDocument(self):
|
|
2904
|
+
"""Command details of the execution task.
|
|
2905
|
+
:rtype: :class:`tencentcloud.tat.v20201028.models.CommandDocument`
|
|
2906
|
+
"""
|
|
2429
2907
|
return self._CommandDocument
|
|
2430
2908
|
|
|
2431
2909
|
@CommandDocument.setter
|
|
@@ -2434,6 +2912,9 @@ class InvocationTask(AbstractModel):
|
|
|
2434
2912
|
|
|
2435
2913
|
@property
|
|
2436
2914
|
def ErrorInfo(self):
|
|
2915
|
+
"""Error message displayed when the execution task fails.
|
|
2916
|
+
:rtype: str
|
|
2917
|
+
"""
|
|
2437
2918
|
return self._ErrorInfo
|
|
2438
2919
|
|
|
2439
2920
|
@ErrorInfo.setter
|
|
@@ -2442,6 +2923,9 @@ class InvocationTask(AbstractModel):
|
|
|
2442
2923
|
|
|
2443
2924
|
@property
|
|
2444
2925
|
def InvocationSource(self):
|
|
2926
|
+
"""Invocation source.
|
|
2927
|
+
:rtype: str
|
|
2928
|
+
"""
|
|
2445
2929
|
return self._InvocationSource
|
|
2446
2930
|
|
|
2447
2931
|
@InvocationSource.setter
|
|
@@ -2510,6 +2994,9 @@ class InvocationTaskBasicInfo(AbstractModel):
|
|
|
2510
2994
|
|
|
2511
2995
|
@property
|
|
2512
2996
|
def InvocationTaskId(self):
|
|
2997
|
+
"""Execution task ID.
|
|
2998
|
+
:rtype: str
|
|
2999
|
+
"""
|
|
2513
3000
|
return self._InvocationTaskId
|
|
2514
3001
|
|
|
2515
3002
|
@InvocationTaskId.setter
|
|
@@ -2518,6 +3005,22 @@ class InvocationTaskBasicInfo(AbstractModel):
|
|
|
2518
3005
|
|
|
2519
3006
|
@property
|
|
2520
3007
|
def TaskStatus(self):
|
|
3008
|
+
"""Execution task status. Valid values:
|
|
3009
|
+
<li> PENDING: Pending
|
|
3010
|
+
<li> DELIVERING: Delivering
|
|
3011
|
+
<li> DELIVER_DELAYED: Delivery delayed
|
|
3012
|
+
<li> DELIVER_FAILED: Delivery failed
|
|
3013
|
+
<li> START_FAILED: Failed to start the command
|
|
3014
|
+
<li> RUNNING: Running
|
|
3015
|
+
<li> SUCCESS: Success
|
|
3016
|
+
<li> FAILED: Failed to execute the command. The exit code is not 0 after execution.
|
|
3017
|
+
<li> TIMEOUT: Command timed out
|
|
3018
|
+
<li> TASK_TIMEOUT: Task timed out
|
|
3019
|
+
<li> CANCELLING: Canceling
|
|
3020
|
+
<li> CANCELLED: Canceled (canceled before execution)
|
|
3021
|
+
<li> TERMINATED: Terminated (canceled during execution)
|
|
3022
|
+
:rtype: str
|
|
3023
|
+
"""
|
|
2521
3024
|
return self._TaskStatus
|
|
2522
3025
|
|
|
2523
3026
|
@TaskStatus.setter
|
|
@@ -2526,6 +3029,9 @@ class InvocationTaskBasicInfo(AbstractModel):
|
|
|
2526
3029
|
|
|
2527
3030
|
@property
|
|
2528
3031
|
def InstanceId(self):
|
|
3032
|
+
"""Instance ID.
|
|
3033
|
+
:rtype: str
|
|
3034
|
+
"""
|
|
2529
3035
|
return self._InstanceId
|
|
2530
3036
|
|
|
2531
3037
|
@InstanceId.setter
|
|
@@ -2590,6 +3096,9 @@ The principle of the least privilege is the best practice for permission managem
|
|
|
2590
3096
|
|
|
2591
3097
|
@property
|
|
2592
3098
|
def CommandId(self):
|
|
3099
|
+
"""ID of the command to be triggered.
|
|
3100
|
+
:rtype: str
|
|
3101
|
+
"""
|
|
2593
3102
|
return self._CommandId
|
|
2594
3103
|
|
|
2595
3104
|
@CommandId.setter
|
|
@@ -2598,6 +3107,9 @@ The principle of the least privilege is the best practice for permission managem
|
|
|
2598
3107
|
|
|
2599
3108
|
@property
|
|
2600
3109
|
def InstanceIds(self):
|
|
3110
|
+
"""IDs of instances about to execute commands. At most 100 IDs are allowed.
|
|
3111
|
+
:rtype: list of str
|
|
3112
|
+
"""
|
|
2601
3113
|
return self._InstanceIds
|
|
2602
3114
|
|
|
2603
3115
|
@InstanceIds.setter
|
|
@@ -2606,6 +3118,13 @@ The principle of the least privilege is the best practice for permission managem
|
|
|
2606
3118
|
|
|
2607
3119
|
@property
|
|
2608
3120
|
def Parameters(self):
|
|
3121
|
+
"""Custom parameters of the command. The field type is JSON encoded string. For example, {\"varA\": \"222\"}.
|
|
3122
|
+
`key` is the name of the custom parameter and `value` is the default value. Both `key` and `value` are strings.
|
|
3123
|
+
If no parameter value is provided, the DefaultParameters of the command is used.
|
|
3124
|
+
Up to 20 custom parameters are supported.
|
|
3125
|
+
The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_].
|
|
3126
|
+
:rtype: str
|
|
3127
|
+
"""
|
|
2609
3128
|
return self._Parameters
|
|
2610
3129
|
|
|
2611
3130
|
@Parameters.setter
|
|
@@ -2614,6 +3133,10 @@ The principle of the least privilege is the best practice for permission managem
|
|
|
2614
3133
|
|
|
2615
3134
|
@property
|
|
2616
3135
|
def Username(self):
|
|
3136
|
+
"""The username used to execute the command on the CVM or Lighthouse instance.
|
|
3137
|
+
The principle of the least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. If this is not specified, the Username of the command is used by default.
|
|
3138
|
+
:rtype: str
|
|
3139
|
+
"""
|
|
2617
3140
|
return self._Username
|
|
2618
3141
|
|
|
2619
3142
|
@Username.setter
|
|
@@ -2622,6 +3145,9 @@ The principle of the least privilege is the best practice for permission managem
|
|
|
2622
3145
|
|
|
2623
3146
|
@property
|
|
2624
3147
|
def WorkingDirectory(self):
|
|
3148
|
+
"""Execution path of the command. The WorkingDirectory of the command is used by default.
|
|
3149
|
+
:rtype: str
|
|
3150
|
+
"""
|
|
2625
3151
|
return self._WorkingDirectory
|
|
2626
3152
|
|
|
2627
3153
|
@WorkingDirectory.setter
|
|
@@ -2630,6 +3156,9 @@ The principle of the least privilege is the best practice for permission managem
|
|
|
2630
3156
|
|
|
2631
3157
|
@property
|
|
2632
3158
|
def Timeout(self):
|
|
3159
|
+
"""Command timeout period. Value range: [1, 86400]. The Timeout of the command is used by default.
|
|
3160
|
+
:rtype: int
|
|
3161
|
+
"""
|
|
2633
3162
|
return self._Timeout
|
|
2634
3163
|
|
|
2635
3164
|
@Timeout.setter
|
|
@@ -2638,6 +3167,9 @@ The principle of the least privilege is the best practice for permission managem
|
|
|
2638
3167
|
|
|
2639
3168
|
@property
|
|
2640
3169
|
def OutputCOSBucketUrl(self):
|
|
3170
|
+
"""The COS bucket URL for uploading logs. The URL must start with `https`, such as `https://BucketName-123454321.cos.ap-beijing.myqcloud.com`.
|
|
3171
|
+
:rtype: str
|
|
3172
|
+
"""
|
|
2641
3173
|
return self._OutputCOSBucketUrl
|
|
2642
3174
|
|
|
2643
3175
|
@OutputCOSBucketUrl.setter
|
|
@@ -2646,6 +3178,12 @@ The principle of the least privilege is the best practice for permission managem
|
|
|
2646
3178
|
|
|
2647
3179
|
@property
|
|
2648
3180
|
def OutputCOSKeyPrefix(self):
|
|
3181
|
+
"""The COS bucket directory where the logs are saved. Check below for the rules of the directory name.
|
|
3182
|
+
1. It must be a combination of number, letters, and visible characters. Up to 60 characters are allowed.
|
|
3183
|
+
2. Use a slash (/) to create a subdirectory.
|
|
3184
|
+
3. ".." can not be used as the folder name. It cannot start with a slash (/), and cannot contain consecutive slashes.
|
|
3185
|
+
:rtype: str
|
|
3186
|
+
"""
|
|
2649
3187
|
return self._OutputCOSKeyPrefix
|
|
2650
3188
|
|
|
2651
3189
|
@OutputCOSKeyPrefix.setter
|
|
@@ -2689,6 +3227,9 @@ class InvokeCommandResponse(AbstractModel):
|
|
|
2689
3227
|
|
|
2690
3228
|
@property
|
|
2691
3229
|
def InvocationId(self):
|
|
3230
|
+
"""Execution activity ID.
|
|
3231
|
+
:rtype: str
|
|
3232
|
+
"""
|
|
2692
3233
|
return self._InvocationId
|
|
2693
3234
|
|
|
2694
3235
|
@InvocationId.setter
|
|
@@ -2697,6 +3238,9 @@ class InvokeCommandResponse(AbstractModel):
|
|
|
2697
3238
|
|
|
2698
3239
|
@property
|
|
2699
3240
|
def RequestId(self):
|
|
3241
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
3242
|
+
:rtype: str
|
|
3243
|
+
"""
|
|
2700
3244
|
return self._RequestId
|
|
2701
3245
|
|
|
2702
3246
|
@RequestId.setter
|
|
@@ -2754,6 +3298,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
|
|
|
2754
3298
|
|
|
2755
3299
|
@property
|
|
2756
3300
|
def InvokerId(self):
|
|
3301
|
+
"""Invoker ID.
|
|
3302
|
+
:rtype: str
|
|
3303
|
+
"""
|
|
2757
3304
|
return self._InvokerId
|
|
2758
3305
|
|
|
2759
3306
|
@InvokerId.setter
|
|
@@ -2762,6 +3309,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
|
|
|
2762
3309
|
|
|
2763
3310
|
@property
|
|
2764
3311
|
def Name(self):
|
|
3312
|
+
"""Invoker name.
|
|
3313
|
+
:rtype: str
|
|
3314
|
+
"""
|
|
2765
3315
|
return self._Name
|
|
2766
3316
|
|
|
2767
3317
|
@Name.setter
|
|
@@ -2770,6 +3320,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
|
|
|
2770
3320
|
|
|
2771
3321
|
@property
|
|
2772
3322
|
def Type(self):
|
|
3323
|
+
"""Invoker type.
|
|
3324
|
+
:rtype: str
|
|
3325
|
+
"""
|
|
2773
3326
|
return self._Type
|
|
2774
3327
|
|
|
2775
3328
|
@Type.setter
|
|
@@ -2778,6 +3331,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
|
|
|
2778
3331
|
|
|
2779
3332
|
@property
|
|
2780
3333
|
def CommandId(self):
|
|
3334
|
+
"""Command ID.
|
|
3335
|
+
:rtype: str
|
|
3336
|
+
"""
|
|
2781
3337
|
return self._CommandId
|
|
2782
3338
|
|
|
2783
3339
|
@CommandId.setter
|
|
@@ -2786,6 +3342,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
|
|
|
2786
3342
|
|
|
2787
3343
|
@property
|
|
2788
3344
|
def Username(self):
|
|
3345
|
+
"""Username.
|
|
3346
|
+
:rtype: str
|
|
3347
|
+
"""
|
|
2789
3348
|
return self._Username
|
|
2790
3349
|
|
|
2791
3350
|
@Username.setter
|
|
@@ -2794,6 +3353,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
|
|
|
2794
3353
|
|
|
2795
3354
|
@property
|
|
2796
3355
|
def Parameters(self):
|
|
3356
|
+
"""Custom parameters.
|
|
3357
|
+
:rtype: str
|
|
3358
|
+
"""
|
|
2797
3359
|
return self._Parameters
|
|
2798
3360
|
|
|
2799
3361
|
@Parameters.setter
|
|
@@ -2802,6 +3364,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
|
|
|
2802
3364
|
|
|
2803
3365
|
@property
|
|
2804
3366
|
def InstanceIds(self):
|
|
3367
|
+
"""Instance ID list.
|
|
3368
|
+
:rtype: list of str
|
|
3369
|
+
"""
|
|
2805
3370
|
return self._InstanceIds
|
|
2806
3371
|
|
|
2807
3372
|
@InstanceIds.setter
|
|
@@ -2810,6 +3375,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
|
|
|
2810
3375
|
|
|
2811
3376
|
@property
|
|
2812
3377
|
def Enable(self):
|
|
3378
|
+
"""Whether to enable the invoker.
|
|
3379
|
+
:rtype: bool
|
|
3380
|
+
"""
|
|
2813
3381
|
return self._Enable
|
|
2814
3382
|
|
|
2815
3383
|
@Enable.setter
|
|
@@ -2818,6 +3386,10 @@ Note: This field may return `null`, indicating that no valid values can be obtai
|
|
|
2818
3386
|
|
|
2819
3387
|
@property
|
|
2820
3388
|
def ScheduleSettings(self):
|
|
3389
|
+
"""Execution schedule of the invoker. This field is returned for recurring invokers.
|
|
3390
|
+
Note: This field may return `null`, indicating that no valid values can be obtained.
|
|
3391
|
+
:rtype: :class:`tencentcloud.tat.v20201028.models.ScheduleSettings`
|
|
3392
|
+
"""
|
|
2821
3393
|
return self._ScheduleSettings
|
|
2822
3394
|
|
|
2823
3395
|
@ScheduleSettings.setter
|
|
@@ -2826,6 +3398,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
|
|
|
2826
3398
|
|
|
2827
3399
|
@property
|
|
2828
3400
|
def CreatedTime(self):
|
|
3401
|
+
"""Creation time.
|
|
3402
|
+
:rtype: str
|
|
3403
|
+
"""
|
|
2829
3404
|
return self._CreatedTime
|
|
2830
3405
|
|
|
2831
3406
|
@CreatedTime.setter
|
|
@@ -2834,6 +3409,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
|
|
|
2834
3409
|
|
|
2835
3410
|
@property
|
|
2836
3411
|
def UpdatedTime(self):
|
|
3412
|
+
"""Modification time.
|
|
3413
|
+
:rtype: str
|
|
3414
|
+
"""
|
|
2837
3415
|
return self._UpdatedTime
|
|
2838
3416
|
|
|
2839
3417
|
@UpdatedTime.setter
|
|
@@ -2891,6 +3469,9 @@ class InvokerRecord(AbstractModel):
|
|
|
2891
3469
|
|
|
2892
3470
|
@property
|
|
2893
3471
|
def InvokerId(self):
|
|
3472
|
+
"""Invoker ID.
|
|
3473
|
+
:rtype: str
|
|
3474
|
+
"""
|
|
2894
3475
|
return self._InvokerId
|
|
2895
3476
|
|
|
2896
3477
|
@InvokerId.setter
|
|
@@ -2899,6 +3480,9 @@ class InvokerRecord(AbstractModel):
|
|
|
2899
3480
|
|
|
2900
3481
|
@property
|
|
2901
3482
|
def InvokeTime(self):
|
|
3483
|
+
"""Execution time.
|
|
3484
|
+
:rtype: str
|
|
3485
|
+
"""
|
|
2902
3486
|
return self._InvokeTime
|
|
2903
3487
|
|
|
2904
3488
|
@InvokeTime.setter
|
|
@@ -2907,6 +3491,9 @@ class InvokerRecord(AbstractModel):
|
|
|
2907
3491
|
|
|
2908
3492
|
@property
|
|
2909
3493
|
def Reason(self):
|
|
3494
|
+
"""Execution reason.
|
|
3495
|
+
:rtype: str
|
|
3496
|
+
"""
|
|
2910
3497
|
return self._Reason
|
|
2911
3498
|
|
|
2912
3499
|
@Reason.setter
|
|
@@ -2915,6 +3502,9 @@ class InvokerRecord(AbstractModel):
|
|
|
2915
3502
|
|
|
2916
3503
|
@property
|
|
2917
3504
|
def InvocationId(self):
|
|
3505
|
+
"""Command execution ID.
|
|
3506
|
+
:rtype: str
|
|
3507
|
+
"""
|
|
2918
3508
|
return self._InvocationId
|
|
2919
3509
|
|
|
2920
3510
|
@InvocationId.setter
|
|
@@ -2923,6 +3513,9 @@ class InvokerRecord(AbstractModel):
|
|
|
2923
3513
|
|
|
2924
3514
|
@property
|
|
2925
3515
|
def Result(self):
|
|
3516
|
+
"""Trigger result.
|
|
3517
|
+
:rtype: str
|
|
3518
|
+
"""
|
|
2926
3519
|
return self._Result
|
|
2927
3520
|
|
|
2928
3521
|
@Result.setter
|
|
@@ -2999,6 +3592,9 @@ The principle of least privilege is the best practice for permission management.
|
|
|
2999
3592
|
|
|
3000
3593
|
@property
|
|
3001
3594
|
def CommandId(self):
|
|
3595
|
+
"""Command ID.
|
|
3596
|
+
:rtype: str
|
|
3597
|
+
"""
|
|
3002
3598
|
return self._CommandId
|
|
3003
3599
|
|
|
3004
3600
|
@CommandId.setter
|
|
@@ -3007,6 +3603,9 @@ The principle of least privilege is the best practice for permission management.
|
|
|
3007
3603
|
|
|
3008
3604
|
@property
|
|
3009
3605
|
def CommandName(self):
|
|
3606
|
+
"""Command name. The name can be up to 60 bytes, and contain [a-z], [A-Z], [0-9] and [_-.].
|
|
3607
|
+
:rtype: str
|
|
3608
|
+
"""
|
|
3010
3609
|
return self._CommandName
|
|
3011
3610
|
|
|
3012
3611
|
@CommandName.setter
|
|
@@ -3015,6 +3614,9 @@ The principle of least privilege is the best practice for permission management.
|
|
|
3015
3614
|
|
|
3016
3615
|
@property
|
|
3017
3616
|
def Description(self):
|
|
3617
|
+
"""Command description. The maximum length is 120 characters.
|
|
3618
|
+
:rtype: str
|
|
3619
|
+
"""
|
|
3018
3620
|
return self._Description
|
|
3019
3621
|
|
|
3020
3622
|
@Description.setter
|
|
@@ -3023,6 +3625,9 @@ The principle of least privilege is the best practice for permission management.
|
|
|
3023
3625
|
|
|
3024
3626
|
@property
|
|
3025
3627
|
def Content(self):
|
|
3628
|
+
"""Base64-encoded command. The maximum length is 64 KB.
|
|
3629
|
+
:rtype: str
|
|
3630
|
+
"""
|
|
3026
3631
|
return self._Content
|
|
3027
3632
|
|
|
3028
3633
|
@Content.setter
|
|
@@ -3031,6 +3636,9 @@ The principle of least privilege is the best practice for permission management.
|
|
|
3031
3636
|
|
|
3032
3637
|
@property
|
|
3033
3638
|
def CommandType(self):
|
|
3639
|
+
"""Command type. `SHELL` and `POWERSHELL` are supported.
|
|
3640
|
+
:rtype: str
|
|
3641
|
+
"""
|
|
3034
3642
|
return self._CommandType
|
|
3035
3643
|
|
|
3036
3644
|
@CommandType.setter
|
|
@@ -3039,6 +3647,9 @@ The principle of least privilege is the best practice for permission management.
|
|
|
3039
3647
|
|
|
3040
3648
|
@property
|
|
3041
3649
|
def WorkingDirectory(self):
|
|
3650
|
+
"""Command execution path.
|
|
3651
|
+
:rtype: str
|
|
3652
|
+
"""
|
|
3042
3653
|
return self._WorkingDirectory
|
|
3043
3654
|
|
|
3044
3655
|
@WorkingDirectory.setter
|
|
@@ -3047,6 +3658,9 @@ The principle of least privilege is the best practice for permission management.
|
|
|
3047
3658
|
|
|
3048
3659
|
@property
|
|
3049
3660
|
def Timeout(self):
|
|
3661
|
+
"""Command timeout period. Value range: [1, 86400].
|
|
3662
|
+
:rtype: int
|
|
3663
|
+
"""
|
|
3050
3664
|
return self._Timeout
|
|
3051
3665
|
|
|
3052
3666
|
@Timeout.setter
|
|
@@ -3055,6 +3669,14 @@ The principle of least privilege is the best practice for permission management.
|
|
|
3055
3669
|
|
|
3056
3670
|
@property
|
|
3057
3671
|
def DefaultParameters(self):
|
|
3672
|
+
"""The default value of the custom parameter value when it is enabled. The field type is JSON encoded string. For example, {\"varA\": \"222\"}.
|
|
3673
|
+
All parameters are overwritten. All default values are required for modification.
|
|
3674
|
+
Modification is only allowed when `EnableParameter` is `true`.
|
|
3675
|
+
`key` is the name of the custom parameter and `value` is the default value. Both `key` and `value` are strings.
|
|
3676
|
+
Up to 20 custom parameters are supported.
|
|
3677
|
+
The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_].
|
|
3678
|
+
:rtype: str
|
|
3679
|
+
"""
|
|
3058
3680
|
return self._DefaultParameters
|
|
3059
3681
|
|
|
3060
3682
|
@DefaultParameters.setter
|
|
@@ -3063,6 +3685,10 @@ The principle of least privilege is the best practice for permission management.
|
|
|
3063
3685
|
|
|
3064
3686
|
@property
|
|
3065
3687
|
def Username(self):
|
|
3688
|
+
"""The username used to execute the command on the CVM or Lighthouse instance.
|
|
3689
|
+
The principle of least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user.
|
|
3690
|
+
:rtype: str
|
|
3691
|
+
"""
|
|
3066
3692
|
return self._Username
|
|
3067
3693
|
|
|
3068
3694
|
@Username.setter
|
|
@@ -3071,6 +3697,9 @@ The principle of least privilege is the best practice for permission management.
|
|
|
3071
3697
|
|
|
3072
3698
|
@property
|
|
3073
3699
|
def OutputCOSBucketUrl(self):
|
|
3700
|
+
"""The COS bucket URL for uploading logs. The URL must start with `https`, such as `https://BucketName-123454321.cos.ap-beijing.myqcloud.com`.
|
|
3701
|
+
:rtype: str
|
|
3702
|
+
"""
|
|
3074
3703
|
return self._OutputCOSBucketUrl
|
|
3075
3704
|
|
|
3076
3705
|
@OutputCOSBucketUrl.setter
|
|
@@ -3079,6 +3708,12 @@ The principle of least privilege is the best practice for permission management.
|
|
|
3079
3708
|
|
|
3080
3709
|
@property
|
|
3081
3710
|
def OutputCOSKeyPrefix(self):
|
|
3711
|
+
"""The COS bucket directory where the logs are saved. Check below for the rules of the directory name.
|
|
3712
|
+
1. It must be a combination of number, letters, and visible characters. Up to 60 characters are allowed.
|
|
3713
|
+
2. Use a slash (/) to create a subdirectory.
|
|
3714
|
+
3. ".." can not be used as the folder name. It cannot start with a slash (/), and cannot contain consecutive slashes.
|
|
3715
|
+
:rtype: str
|
|
3716
|
+
"""
|
|
3082
3717
|
return self._OutputCOSKeyPrefix
|
|
3083
3718
|
|
|
3084
3719
|
@OutputCOSKeyPrefix.setter
|
|
@@ -3122,6 +3757,9 @@ class ModifyCommandResponse(AbstractModel):
|
|
|
3122
3757
|
|
|
3123
3758
|
@property
|
|
3124
3759
|
def RequestId(self):
|
|
3760
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
3761
|
+
:rtype: str
|
|
3762
|
+
"""
|
|
3125
3763
|
return self._RequestId
|
|
3126
3764
|
|
|
3127
3765
|
@RequestId.setter
|
|
@@ -3168,6 +3806,9 @@ class ModifyInvokerRequest(AbstractModel):
|
|
|
3168
3806
|
|
|
3169
3807
|
@property
|
|
3170
3808
|
def InvokerId(self):
|
|
3809
|
+
"""ID of the invoker to be modified.
|
|
3810
|
+
:rtype: str
|
|
3811
|
+
"""
|
|
3171
3812
|
return self._InvokerId
|
|
3172
3813
|
|
|
3173
3814
|
@InvokerId.setter
|
|
@@ -3176,6 +3817,9 @@ class ModifyInvokerRequest(AbstractModel):
|
|
|
3176
3817
|
|
|
3177
3818
|
@property
|
|
3178
3819
|
def Name(self):
|
|
3820
|
+
"""Name of the invoker to be modified.
|
|
3821
|
+
:rtype: str
|
|
3822
|
+
"""
|
|
3179
3823
|
return self._Name
|
|
3180
3824
|
|
|
3181
3825
|
@Name.setter
|
|
@@ -3184,6 +3828,9 @@ class ModifyInvokerRequest(AbstractModel):
|
|
|
3184
3828
|
|
|
3185
3829
|
@property
|
|
3186
3830
|
def Type(self):
|
|
3831
|
+
"""Invoker type. It can only be `SCHEDULE` (recurring invokers).
|
|
3832
|
+
:rtype: str
|
|
3833
|
+
"""
|
|
3187
3834
|
return self._Type
|
|
3188
3835
|
|
|
3189
3836
|
@Type.setter
|
|
@@ -3192,6 +3839,9 @@ class ModifyInvokerRequest(AbstractModel):
|
|
|
3192
3839
|
|
|
3193
3840
|
@property
|
|
3194
3841
|
def CommandId(self):
|
|
3842
|
+
"""ID of the command to be modified.
|
|
3843
|
+
:rtype: str
|
|
3844
|
+
"""
|
|
3195
3845
|
return self._CommandId
|
|
3196
3846
|
|
|
3197
3847
|
@CommandId.setter
|
|
@@ -3200,6 +3850,9 @@ class ModifyInvokerRequest(AbstractModel):
|
|
|
3200
3850
|
|
|
3201
3851
|
@property
|
|
3202
3852
|
def Username(self):
|
|
3853
|
+
"""The username to be modified.
|
|
3854
|
+
:rtype: str
|
|
3855
|
+
"""
|
|
3203
3856
|
return self._Username
|
|
3204
3857
|
|
|
3205
3858
|
@Username.setter
|
|
@@ -3208,6 +3861,9 @@ class ModifyInvokerRequest(AbstractModel):
|
|
|
3208
3861
|
|
|
3209
3862
|
@property
|
|
3210
3863
|
def Parameters(self):
|
|
3864
|
+
"""Custom parameters to be modified.
|
|
3865
|
+
:rtype: str
|
|
3866
|
+
"""
|
|
3211
3867
|
return self._Parameters
|
|
3212
3868
|
|
|
3213
3869
|
@Parameters.setter
|
|
@@ -3216,6 +3872,9 @@ class ModifyInvokerRequest(AbstractModel):
|
|
|
3216
3872
|
|
|
3217
3873
|
@property
|
|
3218
3874
|
def InstanceIds(self):
|
|
3875
|
+
"""List of instance IDs to be modified. Up to 100 IDs are allowed.
|
|
3876
|
+
:rtype: list of str
|
|
3877
|
+
"""
|
|
3219
3878
|
return self._InstanceIds
|
|
3220
3879
|
|
|
3221
3880
|
@InstanceIds.setter
|
|
@@ -3224,6 +3883,9 @@ class ModifyInvokerRequest(AbstractModel):
|
|
|
3224
3883
|
|
|
3225
3884
|
@property
|
|
3226
3885
|
def ScheduleSettings(self):
|
|
3886
|
+
"""Scheduled invoker settings to be modified.
|
|
3887
|
+
:rtype: :class:`tencentcloud.tat.v20201028.models.ScheduleSettings`
|
|
3888
|
+
"""
|
|
3227
3889
|
return self._ScheduleSettings
|
|
3228
3890
|
|
|
3229
3891
|
@ScheduleSettings.setter
|
|
@@ -3266,6 +3928,9 @@ class ModifyInvokerResponse(AbstractModel):
|
|
|
3266
3928
|
|
|
3267
3929
|
@property
|
|
3268
3930
|
def RequestId(self):
|
|
3931
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
3932
|
+
:rtype: str
|
|
3933
|
+
"""
|
|
3269
3934
|
return self._RequestId
|
|
3270
3935
|
|
|
3271
3936
|
@RequestId.setter
|
|
@@ -3303,6 +3968,13 @@ CommandId or Content must be specified.
|
|
|
3303
3968
|
|
|
3304
3969
|
@property
|
|
3305
3970
|
def Parameters(self):
|
|
3971
|
+
"""Custom parameters for the preview. The field type is JSON encoded string. For example, {\"varA\": \"222\"}.
|
|
3972
|
+
`key` is the name of the custom parameter and "value" is its specified value. Both "key" and "value" are strings.
|
|
3973
|
+
At most 20 custom parameters are supported.
|
|
3974
|
+
The name of the custom parameter cannot exceed 64 characters and can only contain [a-z], [A-Z], [0-9], [-_].
|
|
3975
|
+
This parameter can be left empty if DefaultParameters is set for the previewed CommandId.
|
|
3976
|
+
:rtype: str
|
|
3977
|
+
"""
|
|
3306
3978
|
return self._Parameters
|
|
3307
3979
|
|
|
3308
3980
|
@Parameters.setter
|
|
@@ -3311,6 +3983,10 @@ CommandId or Content must be specified.
|
|
|
3311
3983
|
|
|
3312
3984
|
@property
|
|
3313
3985
|
def CommandId(self):
|
|
3986
|
+
"""The command to be previewed. If DefaultParameters is set, it is combined with Parameters and Parameters takes priority.
|
|
3987
|
+
`CommandId` or `Content` must be specified.
|
|
3988
|
+
:rtype: str
|
|
3989
|
+
"""
|
|
3314
3990
|
return self._CommandId
|
|
3315
3991
|
|
|
3316
3992
|
@CommandId.setter
|
|
@@ -3319,6 +3995,10 @@ CommandId or Content must be specified.
|
|
|
3319
3995
|
|
|
3320
3996
|
@property
|
|
3321
3997
|
def Content(self):
|
|
3998
|
+
"""Base64-encoded command to be previewed. The maximum length is 64 KB.
|
|
3999
|
+
CommandId or Content must be specified.
|
|
4000
|
+
:rtype: str
|
|
4001
|
+
"""
|
|
3322
4002
|
return self._Content
|
|
3323
4003
|
|
|
3324
4004
|
@Content.setter
|
|
@@ -3357,6 +4037,9 @@ class PreviewReplacedCommandContentResponse(AbstractModel):
|
|
|
3357
4037
|
|
|
3358
4038
|
@property
|
|
3359
4039
|
def ReplacedContent(self):
|
|
4040
|
+
"""Base64-encoded command with custom parameters.
|
|
4041
|
+
:rtype: str
|
|
4042
|
+
"""
|
|
3360
4043
|
return self._ReplacedContent
|
|
3361
4044
|
|
|
3362
4045
|
@ReplacedContent.setter
|
|
@@ -3365,6 +4048,9 @@ class PreviewReplacedCommandContentResponse(AbstractModel):
|
|
|
3365
4048
|
|
|
3366
4049
|
@property
|
|
3367
4050
|
def RequestId(self):
|
|
4051
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
4052
|
+
:rtype: str
|
|
4053
|
+
"""
|
|
3368
4054
|
return self._RequestId
|
|
3369
4055
|
|
|
3370
4056
|
@RequestId.setter
|
|
@@ -3397,6 +4083,9 @@ class RegionInfo(AbstractModel):
|
|
|
3397
4083
|
|
|
3398
4084
|
@property
|
|
3399
4085
|
def Region(self):
|
|
4086
|
+
"""Region name, such as `ap-guangzhou`
|
|
4087
|
+
:rtype: str
|
|
4088
|
+
"""
|
|
3400
4089
|
return self._Region
|
|
3401
4090
|
|
|
3402
4091
|
@Region.setter
|
|
@@ -3405,6 +4094,9 @@ class RegionInfo(AbstractModel):
|
|
|
3405
4094
|
|
|
3406
4095
|
@property
|
|
3407
4096
|
def RegionName(self):
|
|
4097
|
+
"""Region description, such as `Guangzhou`
|
|
4098
|
+
:rtype: str
|
|
4099
|
+
"""
|
|
3408
4100
|
return self._RegionName
|
|
3409
4101
|
|
|
3410
4102
|
@RegionName.setter
|
|
@@ -3413,6 +4105,9 @@ class RegionInfo(AbstractModel):
|
|
|
3413
4105
|
|
|
3414
4106
|
@property
|
|
3415
4107
|
def RegionState(self):
|
|
4108
|
+
"""Region status. `AVAILABLE` indicates the region is available.
|
|
4109
|
+
:rtype: str
|
|
4110
|
+
"""
|
|
3416
4111
|
return self._RegionState
|
|
3417
4112
|
|
|
3418
4113
|
@RegionState.setter
|
|
@@ -3509,6 +4204,9 @@ The principle of least privilege is the best practice for permission management.
|
|
|
3509
4204
|
|
|
3510
4205
|
@property
|
|
3511
4206
|
def Content(self):
|
|
4207
|
+
"""Base64-encoded command. The maximum length is 64 KB.
|
|
4208
|
+
:rtype: str
|
|
4209
|
+
"""
|
|
3512
4210
|
return self._Content
|
|
3513
4211
|
|
|
3514
4212
|
@Content.setter
|
|
@@ -3517,6 +4215,11 @@ The principle of least privilege is the best practice for permission management.
|
|
|
3517
4215
|
|
|
3518
4216
|
@property
|
|
3519
4217
|
def InstanceIds(self):
|
|
4218
|
+
"""IDs of instances about to execute commands. Up to 100 IDs are allowed. Supported instance types:
|
|
4219
|
+
<li> `CVM`
|
|
4220
|
+
<li> `LIGHTHOUSE`
|
|
4221
|
+
:rtype: list of str
|
|
4222
|
+
"""
|
|
3520
4223
|
return self._InstanceIds
|
|
3521
4224
|
|
|
3522
4225
|
@InstanceIds.setter
|
|
@@ -3525,6 +4228,9 @@ The principle of least privilege is the best practice for permission management.
|
|
|
3525
4228
|
|
|
3526
4229
|
@property
|
|
3527
4230
|
def CommandName(self):
|
|
4231
|
+
"""Command name. The name can be up to 60 bytes, and contain [a-z], [A-Z], [0-9] and [_-.].
|
|
4232
|
+
:rtype: str
|
|
4233
|
+
"""
|
|
3528
4234
|
return self._CommandName
|
|
3529
4235
|
|
|
3530
4236
|
@CommandName.setter
|
|
@@ -3533,6 +4239,9 @@ The principle of least privilege is the best practice for permission management.
|
|
|
3533
4239
|
|
|
3534
4240
|
@property
|
|
3535
4241
|
def Description(self):
|
|
4242
|
+
"""Command description. The maximum length is 120 characters.
|
|
4243
|
+
:rtype: str
|
|
4244
|
+
"""
|
|
3536
4245
|
return self._Description
|
|
3537
4246
|
|
|
3538
4247
|
@Description.setter
|
|
@@ -3541,6 +4250,9 @@ The principle of least privilege is the best practice for permission management.
|
|
|
3541
4250
|
|
|
3542
4251
|
@property
|
|
3543
4252
|
def CommandType(self):
|
|
4253
|
+
"""Command type. `SHELL` and `POWERSHELL` are supported. The default value is `SHELL`.
|
|
4254
|
+
:rtype: str
|
|
4255
|
+
"""
|
|
3544
4256
|
return self._CommandType
|
|
3545
4257
|
|
|
3546
4258
|
@CommandType.setter
|
|
@@ -3549,6 +4261,9 @@ The principle of least privilege is the best practice for permission management.
|
|
|
3549
4261
|
|
|
3550
4262
|
@property
|
|
3551
4263
|
def WorkingDirectory(self):
|
|
4264
|
+
"""Command execution path. The default value is /root for `SHELL` commands and C:\Program Files\qcloud\tat_agent\workdir for `POWERSHELL` commands.
|
|
4265
|
+
:rtype: str
|
|
4266
|
+
"""
|
|
3552
4267
|
return self._WorkingDirectory
|
|
3553
4268
|
|
|
3554
4269
|
@WorkingDirectory.setter
|
|
@@ -3557,6 +4272,9 @@ The principle of least privilege is the best practice for permission management.
|
|
|
3557
4272
|
|
|
3558
4273
|
@property
|
|
3559
4274
|
def Timeout(self):
|
|
4275
|
+
"""Command timeout period. Default value: 60 seconds. Value range: [1, 86400].
|
|
4276
|
+
:rtype: int
|
|
4277
|
+
"""
|
|
3560
4278
|
return self._Timeout
|
|
3561
4279
|
|
|
3562
4280
|
@Timeout.setter
|
|
@@ -3565,6 +4283,12 @@ The principle of least privilege is the best practice for permission management.
|
|
|
3565
4283
|
|
|
3566
4284
|
@property
|
|
3567
4285
|
def SaveCommand(self):
|
|
4286
|
+
"""Whether to save the command. Valid values:
|
|
4287
|
+
<li> `True`: Save
|
|
4288
|
+
<li> `False`: Do not save
|
|
4289
|
+
The default value is `False`.
|
|
4290
|
+
:rtype: bool
|
|
4291
|
+
"""
|
|
3568
4292
|
return self._SaveCommand
|
|
3569
4293
|
|
|
3570
4294
|
@SaveCommand.setter
|
|
@@ -3573,6 +4297,11 @@ The principle of least privilege is the best practice for permission management.
|
|
|
3573
4297
|
|
|
3574
4298
|
@property
|
|
3575
4299
|
def EnableParameter(self):
|
|
4300
|
+
"""Whether to enable the custom parameter feature.
|
|
4301
|
+
This cannot be modified once created.
|
|
4302
|
+
Default value: `false`.
|
|
4303
|
+
:rtype: bool
|
|
4304
|
+
"""
|
|
3576
4305
|
return self._EnableParameter
|
|
3577
4306
|
|
|
3578
4307
|
@EnableParameter.setter
|
|
@@ -3581,6 +4310,13 @@ The principle of least privilege is the best practice for permission management.
|
|
|
3581
4310
|
|
|
3582
4311
|
@property
|
|
3583
4312
|
def DefaultParameters(self):
|
|
4313
|
+
"""The default value of the custom parameter value when it is enabled. The field type is JSON encoded string. For example, {\"varA\": \"222\"}.
|
|
4314
|
+
`key` is the name of the custom parameter and `value` is the default value. Both `key` and `value` are strings.
|
|
4315
|
+
If Parameters is not provided, the default values specified here are used.
|
|
4316
|
+
Up to 20 custom parameters are supported.
|
|
4317
|
+
The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_].
|
|
4318
|
+
:rtype: str
|
|
4319
|
+
"""
|
|
3584
4320
|
return self._DefaultParameters
|
|
3585
4321
|
|
|
3586
4322
|
@DefaultParameters.setter
|
|
@@ -3589,6 +4325,13 @@ The principle of least privilege is the best practice for permission management.
|
|
|
3589
4325
|
|
|
3590
4326
|
@property
|
|
3591
4327
|
def Parameters(self):
|
|
4328
|
+
"""Custom parameters of `Command`. The field type is JSON encoded string. For example, {\"varA\": \"222\"}.
|
|
4329
|
+
`key` is the name of the custom parameter and `value` is the default value. Both `key` and `value` are strings.
|
|
4330
|
+
If no parameter value is provided, the `DefaultParameters` is used.
|
|
4331
|
+
Up to 20 custom parameters are supported.
|
|
4332
|
+
The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_].
|
|
4333
|
+
:rtype: str
|
|
4334
|
+
"""
|
|
3592
4335
|
return self._Parameters
|
|
3593
4336
|
|
|
3594
4337
|
@Parameters.setter
|
|
@@ -3597,6 +4340,9 @@ The principle of least privilege is the best practice for permission management.
|
|
|
3597
4340
|
|
|
3598
4341
|
@property
|
|
3599
4342
|
def Tags(self):
|
|
4343
|
+
"""The tags of the command. It is available when `SaveCommand` is `True`. A maximum of 10 tags are allowed.
|
|
4344
|
+
:rtype: list of Tag
|
|
4345
|
+
"""
|
|
3600
4346
|
return self._Tags
|
|
3601
4347
|
|
|
3602
4348
|
@Tags.setter
|
|
@@ -3605,6 +4351,10 @@ The principle of least privilege is the best practice for permission management.
|
|
|
3605
4351
|
|
|
3606
4352
|
@property
|
|
3607
4353
|
def Username(self):
|
|
4354
|
+
"""The username used to execute the command on the CVM or Lighthouse instance.
|
|
4355
|
+
The principle of least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. By default, the user `root` is used to execute commands on Linux and the user `System` is used on Windows.
|
|
4356
|
+
:rtype: str
|
|
4357
|
+
"""
|
|
3608
4358
|
return self._Username
|
|
3609
4359
|
|
|
3610
4360
|
@Username.setter
|
|
@@ -3613,6 +4363,9 @@ The principle of least privilege is the best practice for permission management.
|
|
|
3613
4363
|
|
|
3614
4364
|
@property
|
|
3615
4365
|
def OutputCOSBucketUrl(self):
|
|
4366
|
+
"""The COS bucket URL for uploading logs. The URL must start with `https`, such as `https://BucketName-123454321.cos.ap-beijing.myqcloud.com`.
|
|
4367
|
+
:rtype: str
|
|
4368
|
+
"""
|
|
3616
4369
|
return self._OutputCOSBucketUrl
|
|
3617
4370
|
|
|
3618
4371
|
@OutputCOSBucketUrl.setter
|
|
@@ -3621,6 +4374,12 @@ The principle of least privilege is the best practice for permission management.
|
|
|
3621
4374
|
|
|
3622
4375
|
@property
|
|
3623
4376
|
def OutputCOSKeyPrefix(self):
|
|
4377
|
+
"""The COS bucket directory where the logs are saved. Check below for the rules of the directory name.
|
|
4378
|
+
1. It must be a combination of number, letters, and visible characters. Up to 60 characters are allowed.
|
|
4379
|
+
2. Use a slash (/) to create a subdirectory.
|
|
4380
|
+
3. ".." can not be used as the folder name. It cannot start with a slash (/), and cannot contain consecutive slashes.
|
|
4381
|
+
:rtype: str
|
|
4382
|
+
"""
|
|
3624
4383
|
return self._OutputCOSKeyPrefix
|
|
3625
4384
|
|
|
3626
4385
|
@OutputCOSKeyPrefix.setter
|
|
@@ -3679,6 +4438,9 @@ class RunCommandResponse(AbstractModel):
|
|
|
3679
4438
|
|
|
3680
4439
|
@property
|
|
3681
4440
|
def CommandId(self):
|
|
4441
|
+
"""Command ID.
|
|
4442
|
+
:rtype: str
|
|
4443
|
+
"""
|
|
3682
4444
|
return self._CommandId
|
|
3683
4445
|
|
|
3684
4446
|
@CommandId.setter
|
|
@@ -3687,6 +4449,9 @@ class RunCommandResponse(AbstractModel):
|
|
|
3687
4449
|
|
|
3688
4450
|
@property
|
|
3689
4451
|
def InvocationId(self):
|
|
4452
|
+
"""Execution activity ID.
|
|
4453
|
+
:rtype: str
|
|
4454
|
+
"""
|
|
3690
4455
|
return self._InvocationId
|
|
3691
4456
|
|
|
3692
4457
|
@InvocationId.setter
|
|
@@ -3695,6 +4460,9 @@ class RunCommandResponse(AbstractModel):
|
|
|
3695
4460
|
|
|
3696
4461
|
@property
|
|
3697
4462
|
def RequestId(self):
|
|
4463
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
4464
|
+
:rtype: str
|
|
4465
|
+
"""
|
|
3698
4466
|
return self._RequestId
|
|
3699
4467
|
|
|
3700
4468
|
@RequestId.setter
|
|
@@ -3730,6 +4498,11 @@ class ScheduleSettings(AbstractModel):
|
|
|
3730
4498
|
|
|
3731
4499
|
@property
|
|
3732
4500
|
def Policy(self):
|
|
4501
|
+
"""Execution policy:
|
|
4502
|
+
<br><li>`ONCE`: Execute once
|
|
4503
|
+
<br><li>`RECURRENCE`: Execute repeatedly
|
|
4504
|
+
:rtype: str
|
|
4505
|
+
"""
|
|
3733
4506
|
return self._Policy
|
|
3734
4507
|
|
|
3735
4508
|
@Policy.setter
|
|
@@ -3738,6 +4511,9 @@ class ScheduleSettings(AbstractModel):
|
|
|
3738
4511
|
|
|
3739
4512
|
@property
|
|
3740
4513
|
def Recurrence(self):
|
|
4514
|
+
"""Trigger the crontab expression. This field is required if `Policy` is `RECURRENCE`. The crontab expression is parsed in UTC+8.
|
|
4515
|
+
:rtype: str
|
|
4516
|
+
"""
|
|
3741
4517
|
return self._Recurrence
|
|
3742
4518
|
|
|
3743
4519
|
@Recurrence.setter
|
|
@@ -3746,6 +4522,9 @@ class ScheduleSettings(AbstractModel):
|
|
|
3746
4522
|
|
|
3747
4523
|
@property
|
|
3748
4524
|
def InvokeTime(self):
|
|
4525
|
+
"""The next execution time of the invoker. This field is required if `Policy` is `ONCE`.
|
|
4526
|
+
:rtype: str
|
|
4527
|
+
"""
|
|
3749
4528
|
return self._InvokeTime
|
|
3750
4529
|
|
|
3751
4530
|
@InvokeTime.setter
|
|
@@ -3784,6 +4563,9 @@ class Tag(AbstractModel):
|
|
|
3784
4563
|
|
|
3785
4564
|
@property
|
|
3786
4565
|
def Key(self):
|
|
4566
|
+
"""Tag key.
|
|
4567
|
+
:rtype: str
|
|
4568
|
+
"""
|
|
3787
4569
|
return self._Key
|
|
3788
4570
|
|
|
3789
4571
|
@Key.setter
|
|
@@ -3792,6 +4574,9 @@ class Tag(AbstractModel):
|
|
|
3792
4574
|
|
|
3793
4575
|
@property
|
|
3794
4576
|
def Value(self):
|
|
4577
|
+
"""Tag value.
|
|
4578
|
+
:rtype: str
|
|
4579
|
+
"""
|
|
3795
4580
|
return self._Value
|
|
3796
4581
|
|
|
3797
4582
|
@Value.setter
|
|
@@ -3844,6 +4629,9 @@ class TaskResult(AbstractModel):
|
|
|
3844
4629
|
|
|
3845
4630
|
@property
|
|
3846
4631
|
def ExitCode(self):
|
|
4632
|
+
"""ExitCode of the execution.
|
|
4633
|
+
:rtype: int
|
|
4634
|
+
"""
|
|
3847
4635
|
return self._ExitCode
|
|
3848
4636
|
|
|
3849
4637
|
@ExitCode.setter
|
|
@@ -3852,6 +4640,9 @@ class TaskResult(AbstractModel):
|
|
|
3852
4640
|
|
|
3853
4641
|
@property
|
|
3854
4642
|
def Output(self):
|
|
4643
|
+
"""Base64-encoded command output. The maximum length is 24 KB.
|
|
4644
|
+
:rtype: str
|
|
4645
|
+
"""
|
|
3855
4646
|
return self._Output
|
|
3856
4647
|
|
|
3857
4648
|
@Output.setter
|
|
@@ -3860,6 +4651,9 @@ class TaskResult(AbstractModel):
|
|
|
3860
4651
|
|
|
3861
4652
|
@property
|
|
3862
4653
|
def ExecStartTime(self):
|
|
4654
|
+
"""Time when the execution is started.
|
|
4655
|
+
:rtype: str
|
|
4656
|
+
"""
|
|
3863
4657
|
return self._ExecStartTime
|
|
3864
4658
|
|
|
3865
4659
|
@ExecStartTime.setter
|
|
@@ -3868,6 +4662,9 @@ class TaskResult(AbstractModel):
|
|
|
3868
4662
|
|
|
3869
4663
|
@property
|
|
3870
4664
|
def ExecEndTime(self):
|
|
4665
|
+
"""Time when the execution is ended.
|
|
4666
|
+
:rtype: str
|
|
4667
|
+
"""
|
|
3871
4668
|
return self._ExecEndTime
|
|
3872
4669
|
|
|
3873
4670
|
@ExecEndTime.setter
|
|
@@ -3876,6 +4673,9 @@ class TaskResult(AbstractModel):
|
|
|
3876
4673
|
|
|
3877
4674
|
@property
|
|
3878
4675
|
def Dropped(self):
|
|
4676
|
+
"""Dropped bytes of the command output.
|
|
4677
|
+
:rtype: int
|
|
4678
|
+
"""
|
|
3879
4679
|
return self._Dropped
|
|
3880
4680
|
|
|
3881
4681
|
@Dropped.setter
|
|
@@ -3884,6 +4684,9 @@ class TaskResult(AbstractModel):
|
|
|
3884
4684
|
|
|
3885
4685
|
@property
|
|
3886
4686
|
def OutputUrl(self):
|
|
4687
|
+
"""COS URL of the logs.
|
|
4688
|
+
:rtype: str
|
|
4689
|
+
"""
|
|
3887
4690
|
return self._OutputUrl
|
|
3888
4691
|
|
|
3889
4692
|
@OutputUrl.setter
|
|
@@ -3892,6 +4695,9 @@ class TaskResult(AbstractModel):
|
|
|
3892
4695
|
|
|
3893
4696
|
@property
|
|
3894
4697
|
def OutputUploadCOSErrorInfo(self):
|
|
4698
|
+
"""Error message for uploading logs to COS.
|
|
4699
|
+
:rtype: str
|
|
4700
|
+
"""
|
|
3895
4701
|
return self._OutputUploadCOSErrorInfo
|
|
3896
4702
|
|
|
3897
4703
|
@OutputUploadCOSErrorInfo.setter
|