tencentcloud-sdk-python 3.0.1333__py2.py3-none-any.whl → 3.0.1335__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.
- tencentcloud/__init__.py +1 -1
- tencentcloud/acp/v20220105/models.py +0 -32
- tencentcloud/aiart/v20221229/models.py +2 -0
- tencentcloud/antiddos/v20200309/models.py +2 -2
- tencentcloud/apm/v20210622/models.py +63 -55
- tencentcloud/autoscaling/v20180419/autoscaling_client.py +3 -2
- tencentcloud/billing/v20180709/models.py +30 -474
- tencentcloud/cat/v20180409/models.py +2 -2
- tencentcloud/ciam/v20220331/models.py +0 -92
- tencentcloud/cls/v20201016/models.py +0 -2
- tencentcloud/common/abstract_client.py +3 -0
- tencentcloud/controlcenter/v20230110/controlcenter_client.py +92 -0
- tencentcloud/controlcenter/v20230110/errorcodes.py +9 -0
- tencentcloud/controlcenter/v20230110/models.py +947 -3
- tencentcloud/csip/v20221121/models.py +94 -4
- tencentcloud/cvm/v20170312/cvm_client.py +92 -0
- tencentcloud/cvm/v20170312/errorcodes.py +9 -0
- tencentcloud/cvm/v20170312/models.py +1627 -332
- tencentcloud/cynosdb/v20190107/models.py +17 -2
- tencentcloud/dbbrain/v20191016/models.py +0 -6
- tencentcloud/dbbrain/v20210527/models.py +0 -12
- tencentcloud/dlc/v20210125/models.py +32 -0
- tencentcloud/emr/v20190103/models.py +17 -0
- tencentcloud/es/v20180416/models.py +15 -0
- tencentcloud/goosefs/v20220519/models.py +0 -10
- tencentcloud/gwlb/v20240906/models.py +34 -2
- tencentcloud/ims/v20201229/ims_client.py +18 -12
- tencentcloud/iotcloud/v20210408/models.py +15 -15
- tencentcloud/keewidb/v20220308/models.py +0 -78
- tencentcloud/lcic/v20220817/models.py +75 -54
- tencentcloud/live/v20180801/models.py +8 -58
- tencentcloud/lke/v20231130/errorcodes.py +0 -12
- tencentcloud/lke/v20231130/lke_client.py +46 -50
- tencentcloud/lke/v20231130/models.py +385 -284
- tencentcloud/lowcode/v20210108/models.py +182 -2
- tencentcloud/mariadb/v20170312/models.py +10 -10
- tencentcloud/mongodb/v20190725/models.py +10 -4
- tencentcloud/mqtt/v20240516/models.py +238 -0
- tencentcloud/mqtt/v20240516/mqtt_client.py +46 -0
- tencentcloud/ocr/v20181119/errorcodes.py +3 -0
- tencentcloud/ocr/v20181119/models.py +32 -28
- tencentcloud/ocr/v20181119/ocr_client.py +1 -1
- tencentcloud/partners/v20180321/models.py +197 -0
- tencentcloud/partners/v20180321/partners_client.py +23 -0
- tencentcloud/pts/v20210728/models.py +68 -6
- tencentcloud/redis/v20180412/models.py +0 -66
- tencentcloud/rum/v20210622/models.py +150 -0
- tencentcloud/tag/v20180813/models.py +2 -2
- tencentcloud/tat/v20201028/models.py +494 -180
- tencentcloud/tat/v20201028/tat_client.py +2 -2
- tencentcloud/tdmq/v20200217/models.py +192 -0
- tencentcloud/tdmq/v20200217/tdmq_client.py +23 -0
- tencentcloud/teo/v20220901/models.py +14 -4
- tencentcloud/tke/v20180525/models.py +0 -312
- tencentcloud/tke/v20220501/models.py +0 -2
- tencentcloud/tms/v20201229/models.py +15 -0
- tencentcloud/tsf/v20180326/models.py +0 -880
- tencentcloud/vdb/v20230616/models.py +0 -12
- tencentcloud/vpc/v20170312/errorcodes.py +3 -0
- tencentcloud/waf/v20180125/models.py +0 -6
- tencentcloud/wedata/v20210820/models.py +173 -0
- {tencentcloud_sdk_python-3.0.1333.dist-info → tencentcloud_sdk_python-3.0.1335.dist-info}/METADATA +1 -1
- {tencentcloud_sdk_python-3.0.1333.dist-info → tencentcloud_sdk_python-3.0.1335.dist-info}/RECORD +66 -66
- {tencentcloud_sdk_python-3.0.1333.dist-info → tencentcloud_sdk_python-3.0.1335.dist-info}/LICENSE +0 -0
- {tencentcloud_sdk_python-3.0.1333.dist-info → tencentcloud_sdk_python-3.0.1335.dist-info}/WHEEL +0 -0
- {tencentcloud_sdk_python-3.0.1333.dist-info → tencentcloud_sdk_python-3.0.1335.dist-info}/top_level.txt +0 -0
@@ -140,11 +140,16 @@ class CancelInvocationRequest(AbstractModel):
|
|
140
140
|
|
141
141
|
def __init__(self):
|
142
142
|
r"""
|
143
|
-
:param _InvocationId: 执行活动ID
|
143
|
+
:param _InvocationId: 执行活动ID。
|
144
|
+
|
145
|
+
可通过 [DescribeInvocations(查询执行活动)](https://cloud.tencent.com/document/api/1340/52679) 接口获取。
|
144
146
|
:type InvocationId: str
|
145
|
-
:param _InstanceIds: 实例ID列表,上限100
|
146
|
-
|
147
|
-
|
147
|
+
:param _InstanceIds: 实例ID列表,上限100。
|
148
|
+
|
149
|
+
可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型:
|
150
|
+
- CVM
|
151
|
+
- Lighthouse
|
152
|
+
- TAT 托管实例
|
148
153
|
:type InstanceIds: list of str
|
149
154
|
"""
|
150
155
|
self._InvocationId = None
|
@@ -152,7 +157,9 @@ class CancelInvocationRequest(AbstractModel):
|
|
152
157
|
|
153
158
|
@property
|
154
159
|
def InvocationId(self):
|
155
|
-
"""执行活动ID
|
160
|
+
"""执行活动ID。
|
161
|
+
|
162
|
+
可通过 [DescribeInvocations(查询执行活动)](https://cloud.tencent.com/document/api/1340/52679) 接口获取。
|
156
163
|
:rtype: str
|
157
164
|
"""
|
158
165
|
return self._InvocationId
|
@@ -163,9 +170,12 @@ class CancelInvocationRequest(AbstractModel):
|
|
163
170
|
|
164
171
|
@property
|
165
172
|
def InstanceIds(self):
|
166
|
-
"""实例ID列表,上限100
|
167
|
-
|
168
|
-
|
173
|
+
"""实例ID列表,上限100。
|
174
|
+
|
175
|
+
可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型:
|
176
|
+
- CVM
|
177
|
+
- Lighthouse
|
178
|
+
- TAT 托管实例
|
169
179
|
:rtype: list of str
|
170
180
|
"""
|
171
181
|
return self._InstanceIds
|
@@ -231,15 +241,15 @@ class Command(AbstractModel):
|
|
231
241
|
:type Description: str
|
232
242
|
:param _Content: Base64编码后的命令内容。
|
233
243
|
:type Content: str
|
234
|
-
:param _CommandType:
|
244
|
+
:param _CommandType: 命令类型。取值为 SHELL、POWERSHELL、BAT 之一。
|
235
245
|
:type CommandType: str
|
236
246
|
:param _WorkingDirectory: 命令执行路径。
|
237
247
|
:type WorkingDirectory: str
|
238
248
|
:param _Timeout: 命令超时时间。
|
239
249
|
:type Timeout: int
|
240
|
-
:param _CreatedTime:
|
250
|
+
:param _CreatedTime: 命令创建时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
241
251
|
:type CreatedTime: str
|
242
|
-
:param _UpdatedTime:
|
252
|
+
:param _UpdatedTime: 命令更新时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
243
253
|
:type UpdatedTime: str
|
244
254
|
:param _EnableParameter: 是否启用自定义参数功能。
|
245
255
|
:type EnableParameter: bool
|
@@ -328,7 +338,7 @@ class Command(AbstractModel):
|
|
328
338
|
|
329
339
|
@property
|
330
340
|
def CommandType(self):
|
331
|
-
"""
|
341
|
+
"""命令类型。取值为 SHELL、POWERSHELL、BAT 之一。
|
332
342
|
:rtype: str
|
333
343
|
"""
|
334
344
|
return self._CommandType
|
@@ -361,7 +371,7 @@ class Command(AbstractModel):
|
|
361
371
|
|
362
372
|
@property
|
363
373
|
def CreatedTime(self):
|
364
|
-
"""
|
374
|
+
"""命令创建时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
365
375
|
:rtype: str
|
366
376
|
"""
|
367
377
|
return self._CreatedTime
|
@@ -372,7 +382,7 @@ class Command(AbstractModel):
|
|
372
382
|
|
373
383
|
@property
|
374
384
|
def UpdatedTime(self):
|
375
|
-
"""
|
385
|
+
"""命令更新时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
376
386
|
:rtype: str
|
377
387
|
"""
|
378
388
|
return self._UpdatedTime
|
@@ -541,9 +551,9 @@ class CommandDocument(AbstractModel):
|
|
541
551
|
r"""
|
542
552
|
:param _Content: Base64 编码后的执行命令。
|
543
553
|
:type Content: str
|
544
|
-
:param _CommandType:
|
554
|
+
:param _CommandType: 命令类型。取值为 SHELL、POWERSHELL、BAT 之一。
|
545
555
|
:type CommandType: str
|
546
|
-
:param _Timeout:
|
556
|
+
:param _Timeout: 超时时间。单位:秒。
|
547
557
|
:type Timeout: int
|
548
558
|
:param _WorkingDirectory: 执行路径。
|
549
559
|
:type WorkingDirectory: str
|
@@ -575,7 +585,7 @@ class CommandDocument(AbstractModel):
|
|
575
585
|
|
576
586
|
@property
|
577
587
|
def CommandType(self):
|
578
|
-
"""
|
588
|
+
"""命令类型。取值为 SHELL、POWERSHELL、BAT 之一。
|
579
589
|
:rtype: str
|
580
590
|
"""
|
581
591
|
return self._CommandType
|
@@ -586,7 +596,7 @@ class CommandDocument(AbstractModel):
|
|
586
596
|
|
587
597
|
@property
|
588
598
|
def Timeout(self):
|
589
|
-
"""
|
599
|
+
"""超时时间。单位:秒。
|
590
600
|
:rtype: int
|
591
601
|
"""
|
592
602
|
return self._Timeout
|
@@ -671,7 +681,7 @@ class CreateCommandRequest(AbstractModel):
|
|
671
681
|
:type Content: str
|
672
682
|
:param _Description: 命令描述。不超过120字符。
|
673
683
|
:type Description: str
|
674
|
-
:param _CommandType: 命令类型,目前支持取值:SHELL、POWERSHELL。默认:SHELL。
|
684
|
+
:param _CommandType: 命令类型,目前支持取值:SHELL、POWERSHELL、BAT。默认:SHELL。
|
675
685
|
:type CommandType: str
|
676
686
|
:param _WorkingDirectory: 命令执行路径,对于 SHELL 命令默认为 /root,对于 POWERSHELL 命令默认为 C:\Program Files\qcloud\tat_agent\workdir。
|
677
687
|
:type WorkingDirectory: str
|
@@ -684,11 +694,15 @@ class CreateCommandRequest(AbstractModel):
|
|
684
694
|
:param _DefaultParameters: 启用自定义参数功能时,自定义参数的默认取值。字段类型为json encoded string。如:{"varA": "222"}。
|
685
695
|
key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。
|
686
696
|
如果InvokeCommand时未提供参数取值,将使用这里的默认值进行替换。
|
697
|
+
参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。
|
698
|
+
仅在 EnableParameter 参数为 true 时,才允许设置此参数。
|
687
699
|
自定义参数最多20个。
|
688
700
|
自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。
|
689
701
|
:type DefaultParameters: str
|
690
702
|
:param _DefaultParameterConfs: 自定义参数数组。
|
691
703
|
如果InvokeCommand时未提供参数取值,将使用这里的默认值进行替换。
|
704
|
+
参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。
|
705
|
+
仅在 EnableParameter 参数为 true 时,才允许设置此参数。
|
692
706
|
自定义参数最多20个。
|
693
707
|
:type DefaultParameterConfs: list of DefaultParameterConf
|
694
708
|
:param _Tags: 为命令关联的标签,列表长度不超过10。
|
@@ -753,7 +767,7 @@ key为自定义参数名称,value为该参数的默认取值。kv均为字符
|
|
753
767
|
|
754
768
|
@property
|
755
769
|
def CommandType(self):
|
756
|
-
"""命令类型,目前支持取值:SHELL、POWERSHELL。默认:SHELL。
|
770
|
+
"""命令类型,目前支持取值:SHELL、POWERSHELL、BAT。默认:SHELL。
|
757
771
|
:rtype: str
|
758
772
|
"""
|
759
773
|
return self._CommandType
|
@@ -802,6 +816,8 @@ key为自定义参数名称,value为该参数的默认取值。kv均为字符
|
|
802
816
|
"""启用自定义参数功能时,自定义参数的默认取值。字段类型为json encoded string。如:{"varA": "222"}。
|
803
817
|
key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。
|
804
818
|
如果InvokeCommand时未提供参数取值,将使用这里的默认值进行替换。
|
819
|
+
参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。
|
820
|
+
仅在 EnableParameter 参数为 true 时,才允许设置此参数。
|
805
821
|
自定义参数最多20个。
|
806
822
|
自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。
|
807
823
|
:rtype: str
|
@@ -816,6 +832,8 @@ key为自定义参数名称,value为该参数的默认取值。kv均为字符
|
|
816
832
|
def DefaultParameterConfs(self):
|
817
833
|
"""自定义参数数组。
|
818
834
|
如果InvokeCommand时未提供参数取值,将使用这里的默认值进行替换。
|
835
|
+
参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。
|
836
|
+
仅在 EnableParameter 参数为 true 时,才允许设置此参数。
|
819
837
|
自定义参数最多20个。
|
820
838
|
:rtype: list of DefaultParameterConf
|
821
839
|
"""
|
@@ -963,14 +981,22 @@ class CreateInvokerRequest(AbstractModel):
|
|
963
981
|
:param _Type: 执行器类型,当前仅支持周期类型执行器,取值:`SCHEDULE` 。
|
964
982
|
:type Type: str
|
965
983
|
:param _CommandId: 远程命令ID。
|
984
|
+
|
985
|
+
可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。
|
966
986
|
:type CommandId: str
|
967
987
|
:param _InstanceIds: 触发器关联的实例ID。列表上限 100。
|
988
|
+
|
989
|
+
可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型:CVM、Lighthouse、TAT 托管实例。
|
990
|
+
|
991
|
+
实例需要安装 TAT 客户端, 且客户端为 Online 状态。可通过 [DescribeAutomationAgentStatus(查询客户端状态)](https://cloud.tencent.com/document/api/1340/52682) 接口查询客户端状态。
|
968
992
|
:type InstanceIds: list of str
|
969
993
|
:param _Username: 命令执行用户。
|
970
994
|
:type Username: str
|
971
995
|
:param _Parameters: 命令自定义参数。
|
996
|
+
|
997
|
+
仅在 CommandId 所指命令的 EnableParameter 为 true 时,才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。
|
972
998
|
:type Parameters: str
|
973
|
-
:param _ScheduleSettings:
|
999
|
+
:param _ScheduleSettings: 周期执行器设置。当创建周期执行器时,必须指定此参数。
|
974
1000
|
:type ScheduleSettings: :class:`tencentcloud.tat.v20201028.models.ScheduleSettings`
|
975
1001
|
"""
|
976
1002
|
self._Name = None
|
@@ -1006,6 +1032,8 @@ class CreateInvokerRequest(AbstractModel):
|
|
1006
1032
|
@property
|
1007
1033
|
def CommandId(self):
|
1008
1034
|
"""远程命令ID。
|
1035
|
+
|
1036
|
+
可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。
|
1009
1037
|
:rtype: str
|
1010
1038
|
"""
|
1011
1039
|
return self._CommandId
|
@@ -1017,6 +1045,10 @@ class CreateInvokerRequest(AbstractModel):
|
|
1017
1045
|
@property
|
1018
1046
|
def InstanceIds(self):
|
1019
1047
|
"""触发器关联的实例ID。列表上限 100。
|
1048
|
+
|
1049
|
+
可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型:CVM、Lighthouse、TAT 托管实例。
|
1050
|
+
|
1051
|
+
实例需要安装 TAT 客户端, 且客户端为 Online 状态。可通过 [DescribeAutomationAgentStatus(查询客户端状态)](https://cloud.tencent.com/document/api/1340/52682) 接口查询客户端状态。
|
1020
1052
|
:rtype: list of str
|
1021
1053
|
"""
|
1022
1054
|
return self._InstanceIds
|
@@ -1039,6 +1071,8 @@ class CreateInvokerRequest(AbstractModel):
|
|
1039
1071
|
@property
|
1040
1072
|
def Parameters(self):
|
1041
1073
|
"""命令自定义参数。
|
1074
|
+
|
1075
|
+
仅在 CommandId 所指命令的 EnableParameter 为 true 时,才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。
|
1042
1076
|
:rtype: str
|
1043
1077
|
"""
|
1044
1078
|
return self._Parameters
|
@@ -1049,7 +1083,7 @@ class CreateInvokerRequest(AbstractModel):
|
|
1049
1083
|
|
1050
1084
|
@property
|
1051
1085
|
def ScheduleSettings(self):
|
1052
|
-
"""
|
1086
|
+
"""周期执行器设置。当创建周期执行器时,必须指定此参数。
|
1053
1087
|
:rtype: :class:`tencentcloud.tat.v20201028.models.ScheduleSettings`
|
1054
1088
|
"""
|
1055
1089
|
return self._ScheduleSettings
|
@@ -1355,14 +1389,14 @@ class DeleteCommandRequest(AbstractModel):
|
|
1355
1389
|
|
1356
1390
|
def __init__(self):
|
1357
1391
|
r"""
|
1358
|
-
:param _CommandId: 待删除的命令ID
|
1392
|
+
:param _CommandId: 待删除的命令 ID。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。
|
1359
1393
|
:type CommandId: str
|
1360
1394
|
"""
|
1361
1395
|
self._CommandId = None
|
1362
1396
|
|
1363
1397
|
@property
|
1364
1398
|
def CommandId(self):
|
1365
|
-
"""待删除的命令ID
|
1399
|
+
"""待删除的命令 ID。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。
|
1366
1400
|
:rtype: str
|
1367
1401
|
"""
|
1368
1402
|
return self._CommandId
|
@@ -1419,14 +1453,14 @@ class DeleteCommandsRequest(AbstractModel):
|
|
1419
1453
|
|
1420
1454
|
def __init__(self):
|
1421
1455
|
r"""
|
1422
|
-
:param _CommandIds:
|
1456
|
+
:param _CommandIds: 待删除的命令 ID。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。
|
1423
1457
|
:type CommandIds: list of str
|
1424
1458
|
"""
|
1425
1459
|
self._CommandIds = None
|
1426
1460
|
|
1427
1461
|
@property
|
1428
1462
|
def CommandIds(self):
|
1429
|
-
"""
|
1463
|
+
"""待删除的命令 ID。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。
|
1430
1464
|
:rtype: list of str
|
1431
1465
|
"""
|
1432
1466
|
return self._CommandIds
|
@@ -1484,6 +1518,8 @@ class DeleteInvokerRequest(AbstractModel):
|
|
1484
1518
|
def __init__(self):
|
1485
1519
|
r"""
|
1486
1520
|
:param _InvokerId: 待删除的执行器ID。
|
1521
|
+
|
1522
|
+
可通过 [DescribeInvokers(查询执行器)](https://cloud.tencent.com/document/api/1340/61759) 接口获取。
|
1487
1523
|
:type InvokerId: str
|
1488
1524
|
"""
|
1489
1525
|
self._InvokerId = None
|
@@ -1491,6 +1527,8 @@ class DeleteInvokerRequest(AbstractModel):
|
|
1491
1527
|
@property
|
1492
1528
|
def InvokerId(self):
|
1493
1529
|
"""待删除的执行器ID。
|
1530
|
+
|
1531
|
+
可通过 [DescribeInvokers(查询执行器)](https://cloud.tencent.com/document/api/1340/61759) 接口获取。
|
1494
1532
|
:rtype: str
|
1495
1533
|
"""
|
1496
1534
|
return self._InvokerId
|
@@ -1548,6 +1586,8 @@ class DeleteRegisterCodesRequest(AbstractModel):
|
|
1548
1586
|
def __init__(self):
|
1549
1587
|
r"""
|
1550
1588
|
:param _RegisterCodeIds: 注册码ID列表。限制输入的注册码ID数量大于0小于100。
|
1589
|
+
|
1590
|
+
可通过 [DescribeRegisterCodes(查询注册码)](https://cloud.tencent.com/document/api/1340/96925) 接口获取。
|
1551
1591
|
:type RegisterCodeIds: list of str
|
1552
1592
|
"""
|
1553
1593
|
self._RegisterCodeIds = None
|
@@ -1555,6 +1595,8 @@ class DeleteRegisterCodesRequest(AbstractModel):
|
|
1555
1595
|
@property
|
1556
1596
|
def RegisterCodeIds(self):
|
1557
1597
|
"""注册码ID列表。限制输入的注册码ID数量大于0小于100。
|
1598
|
+
|
1599
|
+
可通过 [DescribeRegisterCodes(查询注册码)](https://cloud.tencent.com/document/api/1340/96925) 接口获取。
|
1558
1600
|
:rtype: list of str
|
1559
1601
|
"""
|
1560
1602
|
return self._RegisterCodeIds
|
@@ -1611,14 +1653,18 @@ class DeleteRegisterInstanceRequest(AbstractModel):
|
|
1611
1653
|
|
1612
1654
|
def __init__(self):
|
1613
1655
|
r"""
|
1614
|
-
:param _InstanceId:
|
1656
|
+
:param _InstanceId: 托管实例ID。
|
1657
|
+
|
1658
|
+
可通过 [DescribeRegisterInstances(查询托管实例)](https://cloud.tencent.com/document/api/1340/96924) 接口获取。
|
1615
1659
|
:type InstanceId: str
|
1616
1660
|
"""
|
1617
1661
|
self._InstanceId = None
|
1618
1662
|
|
1619
1663
|
@property
|
1620
1664
|
def InstanceId(self):
|
1621
|
-
"""
|
1665
|
+
"""托管实例ID。
|
1666
|
+
|
1667
|
+
可通过 [DescribeRegisterInstances(查询托管实例)](https://cloud.tencent.com/document/api/1340/96924) 接口获取。
|
1622
1668
|
:rtype: str
|
1623
1669
|
"""
|
1624
1670
|
return self._InstanceId
|
@@ -1676,8 +1722,16 @@ class DescribeAutomationAgentStatusRequest(AbstractModel):
|
|
1676
1722
|
def __init__(self):
|
1677
1723
|
r"""
|
1678
1724
|
:param _InstanceIds: 待查询的实例ID列表。
|
1725
|
+
|
1726
|
+
可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型:CVM、Lighthouse、TAT 托管实例。
|
1727
|
+
|
1728
|
+
参数不支持同时指定 `InstanceIds ` 和 `Filters ` 。
|
1679
1729
|
:type InstanceIds: list of str
|
1680
|
-
:param _Filters:
|
1730
|
+
:param _Filters: - agent-status - String - 是否必填:否 -(过滤条件)按照agent状态过滤,取值:Online 在线,Offline 离线。
|
1731
|
+
- environment - String - 是否必填:否 -(过滤条件)按照agent运行环境查询,取值:Linux, Windows。
|
1732
|
+
- instance-id - String - 是否必填:否 -(过滤条件)按照实例ID过滤。 可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型:CVM、Lighthouse、TAT 托管实例。
|
1733
|
+
|
1734
|
+
参数不支持同时指定 `InstanceIds ` 和 `Filters ` 。
|
1681
1735
|
:type Filters: list of Filter
|
1682
1736
|
:param _Limit: 返回数量,默认为20,最大值为100。关于 `Limit` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
|
1683
1737
|
:type Limit: int
|
@@ -1692,6 +1746,10 @@ class DescribeAutomationAgentStatusRequest(AbstractModel):
|
|
1692
1746
|
@property
|
1693
1747
|
def InstanceIds(self):
|
1694
1748
|
"""待查询的实例ID列表。
|
1749
|
+
|
1750
|
+
可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型:CVM、Lighthouse、TAT 托管实例。
|
1751
|
+
|
1752
|
+
参数不支持同时指定 `InstanceIds ` 和 `Filters ` 。
|
1695
1753
|
:rtype: list of str
|
1696
1754
|
"""
|
1697
1755
|
return self._InstanceIds
|
@@ -1702,7 +1760,11 @@ class DescribeAutomationAgentStatusRequest(AbstractModel):
|
|
1702
1760
|
|
1703
1761
|
@property
|
1704
1762
|
def Filters(self):
|
1705
|
-
"""
|
1763
|
+
"""- agent-status - String - 是否必填:否 -(过滤条件)按照agent状态过滤,取值:Online 在线,Offline 离线。
|
1764
|
+
- environment - String - 是否必填:否 -(过滤条件)按照agent运行环境查询,取值:Linux, Windows。
|
1765
|
+
- instance-id - String - 是否必填:否 -(过滤条件)按照实例ID过滤。 可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型:CVM、Lighthouse、TAT 托管实例。
|
1766
|
+
|
1767
|
+
参数不支持同时指定 `InstanceIds ` 和 `Filters ` 。
|
1706
1768
|
:rtype: list of Filter
|
1707
1769
|
"""
|
1708
1770
|
return self._Filters
|
@@ -1827,14 +1889,15 @@ class DescribeCommandsRequest(AbstractModel):
|
|
1827
1889
|
:param _CommandIds: 命令ID列表,每次请求的上限为100。参数不支持同时指定 `CommandIds` 和 `Filters` 。
|
1828
1890
|
:type CommandIds: list of str
|
1829
1891
|
:param _Filters: 过滤条件。
|
1830
|
-
|
1831
|
-
|
1832
|
-
|
1833
|
-
|
1834
|
-
|
1835
|
-
|
1836
|
-
|
1837
|
-
|
1892
|
+
|
1893
|
+
- command-id - String - 是否必填:否 -(过滤条件)按照命令ID过滤。
|
1894
|
+
- command-name - String - 是否必填:否 -(过滤条件)按照命令名称过滤。
|
1895
|
+
- command-type - String - 是否必填:否 -(过滤条件)按照命令类型过滤,取值为 SHELL、POWERSHELL、BAT。
|
1896
|
+
- scene-id - String - 是否必填:否 -(过滤条件)按照场景ID过滤。可通过 [DescribeScenes(查询场景)](https://cloud.tencent.com/document/api/1340/109968) 接口获取场景ID。
|
1897
|
+
- created-by - String - 是否必填:否 -(过滤条件)按照命令创建者过滤,取值为 TAT 或 USER。TAT 代表公共命令,USER 代表由用户创建的命令。
|
1898
|
+
- tag-key - String - 是否必填:否 -(过滤条件)按照标签键进行过滤。
|
1899
|
+
- tag-value - String - 是否必填:否 -(过滤条件)按照标签值进行过滤。
|
1900
|
+
- tag:tag-key - String - 是否必填:否 -(过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。使用请参考示例4
|
1838
1901
|
|
1839
1902
|
每次请求的 `Filters` 的上限为10, `Filter.Values` 的上限为5。参数不支持同时指定 `CommandIds` 和 `Filters` 。
|
1840
1903
|
:type Filters: list of Filter
|
@@ -1862,14 +1925,15 @@ class DescribeCommandsRequest(AbstractModel):
|
|
1862
1925
|
@property
|
1863
1926
|
def Filters(self):
|
1864
1927
|
"""过滤条件。
|
1865
|
-
|
1866
|
-
|
1867
|
-
|
1868
|
-
|
1869
|
-
|
1870
|
-
|
1871
|
-
|
1872
|
-
|
1928
|
+
|
1929
|
+
- command-id - String - 是否必填:否 -(过滤条件)按照命令ID过滤。
|
1930
|
+
- command-name - String - 是否必填:否 -(过滤条件)按照命令名称过滤。
|
1931
|
+
- command-type - String - 是否必填:否 -(过滤条件)按照命令类型过滤,取值为 SHELL、POWERSHELL、BAT。
|
1932
|
+
- scene-id - String - 是否必填:否 -(过滤条件)按照场景ID过滤。可通过 [DescribeScenes(查询场景)](https://cloud.tencent.com/document/api/1340/109968) 接口获取场景ID。
|
1933
|
+
- created-by - String - 是否必填:否 -(过滤条件)按照命令创建者过滤,取值为 TAT 或 USER。TAT 代表公共命令,USER 代表由用户创建的命令。
|
1934
|
+
- tag-key - String - 是否必填:否 -(过滤条件)按照标签键进行过滤。
|
1935
|
+
- tag-value - String - 是否必填:否 -(过滤条件)按照标签值进行过滤。
|
1936
|
+
- tag:tag-key - String - 是否必填:否 -(过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。使用请参考示例4
|
1873
1937
|
|
1874
1938
|
每次请求的 `Filters` 的上限为10, `Filter.Values` 的上限为5。参数不支持同时指定 `CommandIds` 和 `Filters` 。
|
1875
1939
|
:rtype: list of Filter
|
@@ -1997,15 +2061,23 @@ class DescribeInvocationTasksRequest(AbstractModel):
|
|
1997
2061
|
:type InvocationTaskIds: list of str
|
1998
2062
|
:param _Filters: 过滤条件。<br>
|
1999
2063
|
|
2000
|
-
|
2064
|
+
- invocation-task-id - String - 是否必填:否 -(过滤条件)按照执行任务ID过滤。
|
2065
|
+
- invocation-id - String - 是否必填:否 -(过滤条件)按照执行活动ID过滤。可通过 [DescribeInvocations(查询执行活动)](https://cloud.tencent.com/document/api/1340/52679) 接口获取。
|
2066
|
+
- instance-id - String - 是否必填:否 -(过滤条件)按照实例ID过滤。可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型: CVM、Lighthouse、TAT 托管实例
|
2067
|
+
- command-id - String - 是否必填:否 -(过滤条件)按照命令ID过滤。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。
|
2068
|
+
|
2069
|
+
每次请求的 `Filters` 的上限为10, `Filter.Values` 的上限为5。参数不支持同时指定 `InvocationTaskIds` 和 `Filters` 。
|
2001
2070
|
:type Filters: list of Filter
|
2002
2071
|
:param _Limit: 返回数量,默认为20,最大值为100。关于 `Limit` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
|
2003
2072
|
:type Limit: int
|
2004
2073
|
:param _Offset: 偏移量,默认为0。关于 `Offset` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
|
2005
2074
|
:type Offset: int
|
2006
|
-
:param _HideOutput:
|
2075
|
+
:param _HideOutput: 是否隐藏命令输出结果,取值范围:
|
2007
2076
|
|
2008
|
-
|
2077
|
+
- true:隐藏输出
|
2078
|
+
- false:不隐藏
|
2079
|
+
|
2080
|
+
默认为 true。
|
2009
2081
|
:type HideOutput: bool
|
2010
2082
|
"""
|
2011
2083
|
self._InvocationTaskIds = None
|
@@ -2029,7 +2101,12 @@ class DescribeInvocationTasksRequest(AbstractModel):
|
|
2029
2101
|
def Filters(self):
|
2030
2102
|
"""过滤条件。<br>
|
2031
2103
|
|
2032
|
-
|
2104
|
+
- invocation-task-id - String - 是否必填:否 -(过滤条件)按照执行任务ID过滤。
|
2105
|
+
- invocation-id - String - 是否必填:否 -(过滤条件)按照执行活动ID过滤。可通过 [DescribeInvocations(查询执行活动)](https://cloud.tencent.com/document/api/1340/52679) 接口获取。
|
2106
|
+
- instance-id - String - 是否必填:否 -(过滤条件)按照实例ID过滤。可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型: CVM、Lighthouse、TAT 托管实例
|
2107
|
+
- command-id - String - 是否必填:否 -(过滤条件)按照命令ID过滤。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。
|
2108
|
+
|
2109
|
+
每次请求的 `Filters` 的上限为10, `Filter.Values` 的上限为5。参数不支持同时指定 `InvocationTaskIds` 和 `Filters` 。
|
2033
2110
|
:rtype: list of Filter
|
2034
2111
|
"""
|
2035
2112
|
return self._Filters
|
@@ -2062,9 +2139,12 @@ class DescribeInvocationTasksRequest(AbstractModel):
|
|
2062
2139
|
|
2063
2140
|
@property
|
2064
2141
|
def HideOutput(self):
|
2065
|
-
"""
|
2142
|
+
"""是否隐藏命令输出结果,取值范围:
|
2066
2143
|
|
2067
|
-
|
2144
|
+
- true:隐藏输出
|
2145
|
+
- false:不隐藏
|
2146
|
+
|
2147
|
+
默认为 true。
|
2068
2148
|
:rtype: bool
|
2069
2149
|
"""
|
2070
2150
|
return self._HideOutput
|
@@ -2327,6 +2407,8 @@ class DescribeInvokerRecordsRequest(AbstractModel):
|
|
2327
2407
|
def __init__(self):
|
2328
2408
|
r"""
|
2329
2409
|
:param _InvokerIds: 执行器ID列表。列表上限 100。
|
2410
|
+
|
2411
|
+
可通过 [DescribeInvokers(查询执行器)](https://cloud.tencent.com/document/api/1340/61759) 接口获取。
|
2330
2412
|
:type InvokerIds: list of str
|
2331
2413
|
:param _Limit: 返回数量,默认为20,最大值为100。
|
2332
2414
|
:type Limit: int
|
@@ -2340,6 +2422,8 @@ class DescribeInvokerRecordsRequest(AbstractModel):
|
|
2340
2422
|
@property
|
2341
2423
|
def InvokerIds(self):
|
2342
2424
|
"""执行器ID列表。列表上限 100。
|
2425
|
+
|
2426
|
+
可通过 [DescribeInvokers(查询执行器)](https://cloud.tencent.com/document/api/1340/61759) 接口获取。
|
2343
2427
|
:rtype: list of str
|
2344
2428
|
"""
|
2345
2429
|
return self._InvokerIds
|
@@ -2456,8 +2540,17 @@ class DescribeInvokersRequest(AbstractModel):
|
|
2456
2540
|
def __init__(self):
|
2457
2541
|
r"""
|
2458
2542
|
:param _InvokerIds: 执行器ID列表。
|
2543
|
+
|
2544
|
+
参数不支持同时指定 `InvokerIds ` 和 `Filters ` 。
|
2545
|
+
|
2459
2546
|
:type InvokerIds: list of str
|
2460
|
-
:param _Filters:
|
2547
|
+
:param _Filters: 过滤条件:
|
2548
|
+
|
2549
|
+
- invoker-id - String - 是否必填:否 - (过滤条件)按执行器ID过滤。
|
2550
|
+
- command-id - String - 是否必填:否 - (过滤条件)按命令ID过滤。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。
|
2551
|
+
- type - String - 是否必填:否 - (过滤条件)按执行器类型过滤。目前仅支持 SCHEDULE 一种。
|
2552
|
+
|
2553
|
+
参数不支持同时指定 `InvokerIds ` 和 `Filters ` 。
|
2461
2554
|
:type Filters: list of Filter
|
2462
2555
|
:param _Limit: 返回数量,默认为20,最大值为100。
|
2463
2556
|
:type Limit: int
|
@@ -2472,6 +2565,9 @@ class DescribeInvokersRequest(AbstractModel):
|
|
2472
2565
|
@property
|
2473
2566
|
def InvokerIds(self):
|
2474
2567
|
"""执行器ID列表。
|
2568
|
+
|
2569
|
+
参数不支持同时指定 `InvokerIds ` 和 `Filters ` 。
|
2570
|
+
|
2475
2571
|
:rtype: list of str
|
2476
2572
|
"""
|
2477
2573
|
return self._InvokerIds
|
@@ -2482,7 +2578,13 @@ class DescribeInvokersRequest(AbstractModel):
|
|
2482
2578
|
|
2483
2579
|
@property
|
2484
2580
|
def Filters(self):
|
2485
|
-
"""
|
2581
|
+
"""过滤条件:
|
2582
|
+
|
2583
|
+
- invoker-id - String - 是否必填:否 - (过滤条件)按执行器ID过滤。
|
2584
|
+
- command-id - String - 是否必填:否 - (过滤条件)按命令ID过滤。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。
|
2585
|
+
- type - String - 是否必填:否 - (过滤条件)按执行器类型过滤。目前仅支持 SCHEDULE 一种。
|
2586
|
+
|
2587
|
+
参数不支持同时指定 `InvokerIds ` 和 `Filters ` 。
|
2486
2588
|
:rtype: list of Filter
|
2487
2589
|
"""
|
2488
2590
|
return self._Filters
|
@@ -2604,14 +2706,24 @@ class DescribeQuotasRequest(AbstractModel):
|
|
2604
2706
|
|
2605
2707
|
def __init__(self):
|
2606
2708
|
r"""
|
2607
|
-
:param _ResourceNames:
|
2709
|
+
:param _ResourceNames: 资源名称
|
2710
|
+
|
2711
|
+
取值为:
|
2712
|
+
|
2713
|
+
- COMMAND:命令
|
2714
|
+
- REGISTER_CODE:托管实例注册码
|
2608
2715
|
:type ResourceNames: list of str
|
2609
2716
|
"""
|
2610
2717
|
self._ResourceNames = None
|
2611
2718
|
|
2612
2719
|
@property
|
2613
2720
|
def ResourceNames(self):
|
2614
|
-
"""
|
2721
|
+
"""资源名称
|
2722
|
+
|
2723
|
+
取值为:
|
2724
|
+
|
2725
|
+
- COMMAND:命令
|
2726
|
+
- REGISTER_CODE:托管实例注册码
|
2615
2727
|
:rtype: list of str
|
2616
2728
|
"""
|
2617
2729
|
return self._ResourceNames
|
@@ -2888,25 +3000,29 @@ class DescribeRegisterInstancesRequest(AbstractModel):
|
|
2888
3000
|
|
2889
3001
|
def __init__(self):
|
2890
3002
|
r"""
|
2891
|
-
:param _InstanceIds:
|
3003
|
+
:param _InstanceIds: 托管实例 id。
|
3004
|
+
|
3005
|
+
参数不支持同时指定 `InstanceIds` 和 `Filters` 。
|
3006
|
+
|
2892
3007
|
:type InstanceIds: list of str
|
2893
|
-
:param _Filters:
|
3008
|
+
:param _Filters: 过滤器列表。参数不支持同时指定 `InstanceIds` 和 `Filters` 。
|
3009
|
+
|
2894
3010
|
|
2895
3011
|
- instance-name
|
2896
3012
|
|
2897
|
-
|
3013
|
+
按照【托管实例名称】进行过滤。
|
2898
3014
|
类型:String
|
2899
3015
|
必选:否
|
2900
3016
|
|
2901
3017
|
- instance-id
|
2902
3018
|
|
2903
|
-
|
3019
|
+
按照【托管实例ID】进行过滤。
|
2904
3020
|
类型:String
|
2905
3021
|
必选:否
|
2906
3022
|
|
2907
3023
|
- register-code-id
|
2908
3024
|
|
2909
|
-
|
3025
|
+
按照【托管实例注册码ID】进行过滤。可通过 [DescribeRegisterCodes(查询注册码)](https://cloud.tencent.com/document/api/1340/96925) 接口获取。
|
2910
3026
|
类型:String
|
2911
3027
|
必选:否
|
2912
3028
|
|
@@ -2930,7 +3046,10 @@ class DescribeRegisterInstancesRequest(AbstractModel):
|
|
2930
3046
|
|
2931
3047
|
@property
|
2932
3048
|
def InstanceIds(self):
|
2933
|
-
"""
|
3049
|
+
"""托管实例 id。
|
3050
|
+
|
3051
|
+
参数不支持同时指定 `InstanceIds` 和 `Filters` 。
|
3052
|
+
|
2934
3053
|
:rtype: list of str
|
2935
3054
|
"""
|
2936
3055
|
return self._InstanceIds
|
@@ -2941,23 +3060,24 @@ class DescribeRegisterInstancesRequest(AbstractModel):
|
|
2941
3060
|
|
2942
3061
|
@property
|
2943
3062
|
def Filters(self):
|
2944
|
-
"""
|
3063
|
+
"""过滤器列表。参数不支持同时指定 `InstanceIds` 和 `Filters` 。
|
3064
|
+
|
2945
3065
|
|
2946
3066
|
- instance-name
|
2947
3067
|
|
2948
|
-
|
3068
|
+
按照【托管实例名称】进行过滤。
|
2949
3069
|
类型:String
|
2950
3070
|
必选:否
|
2951
3071
|
|
2952
3072
|
- instance-id
|
2953
3073
|
|
2954
|
-
|
3074
|
+
按照【托管实例ID】进行过滤。
|
2955
3075
|
类型:String
|
2956
3076
|
必选:否
|
2957
3077
|
|
2958
3078
|
- register-code-id
|
2959
3079
|
|
2960
|
-
|
3080
|
+
按照【托管实例注册码ID】进行过滤。可通过 [DescribeRegisterCodes(查询注册码)](https://cloud.tencent.com/document/api/1340/96925) 接口获取。
|
2961
3081
|
类型:String
|
2962
3082
|
必选:否
|
2963
3083
|
|
@@ -3089,12 +3209,16 @@ class DescribeScenesRequest(AbstractModel):
|
|
3089
3209
|
|
3090
3210
|
def __init__(self):
|
3091
3211
|
r"""
|
3092
|
-
:param _SceneIds: 场景 ID
|
3212
|
+
:param _SceneIds: 场景 ID 数组。
|
3213
|
+
|
3214
|
+
参数不支持同时指定 `SceneIds ` 和 `Filters ` 。
|
3215
|
+
|
3093
3216
|
:type SceneIds: list of str
|
3094
3217
|
:param _Filters: 过滤条件。
|
3095
|
-
|
3096
|
-
|
3097
|
-
|
3218
|
+
|
3219
|
+
- scene-id - String - 是否必填:否 -(过滤条件)按照场景 ID 过滤。
|
3220
|
+
- scene-name - String - 是否必填:否 -(过滤条件)按照场景名称过滤。
|
3221
|
+
- created-by - String - 是否必填:否 -(过滤条件)按照场景创建者过滤,目前仅支持 TAT,代表公共场景。
|
3098
3222
|
|
3099
3223
|
每次请求的 `Filters` 的上限为10, `Filter.Values` 的上限为5。参数不支持同时指定 `SceneIds` 和 `Filters` 。
|
3100
3224
|
:type Filters: list of Filter
|
@@ -3110,7 +3234,10 @@ class DescribeScenesRequest(AbstractModel):
|
|
3110
3234
|
|
3111
3235
|
@property
|
3112
3236
|
def SceneIds(self):
|
3113
|
-
"""场景 ID
|
3237
|
+
"""场景 ID 数组。
|
3238
|
+
|
3239
|
+
参数不支持同时指定 `SceneIds ` 和 `Filters ` 。
|
3240
|
+
|
3114
3241
|
:rtype: list of str
|
3115
3242
|
"""
|
3116
3243
|
return self._SceneIds
|
@@ -3122,9 +3249,10 @@ class DescribeScenesRequest(AbstractModel):
|
|
3122
3249
|
@property
|
3123
3250
|
def Filters(self):
|
3124
3251
|
"""过滤条件。
|
3125
|
-
|
3126
|
-
|
3127
|
-
|
3252
|
+
|
3253
|
+
- scene-id - String - 是否必填:否 -(过滤条件)按照场景 ID 过滤。
|
3254
|
+
- scene-name - String - 是否必填:否 -(过滤条件)按照场景名称过滤。
|
3255
|
+
- created-by - String - 是否必填:否 -(过滤条件)按照场景创建者过滤,目前仅支持 TAT,代表公共场景。
|
3128
3256
|
|
3129
3257
|
每次请求的 `Filters` 的上限为10, `Filter.Values` 的上限为5。参数不支持同时指定 `SceneIds` 和 `Filters` 。
|
3130
3258
|
:rtype: list of Filter
|
@@ -3249,6 +3377,8 @@ class DisableInvokerRequest(AbstractModel):
|
|
3249
3377
|
def __init__(self):
|
3250
3378
|
r"""
|
3251
3379
|
:param _InvokerId: 待停止的执行器ID。
|
3380
|
+
|
3381
|
+
可通过 [DescribeInvokers(查询执行器)](https://cloud.tencent.com/document/api/1340/61759) 接口获取。
|
3252
3382
|
:type InvokerId: str
|
3253
3383
|
"""
|
3254
3384
|
self._InvokerId = None
|
@@ -3256,6 +3386,8 @@ class DisableInvokerRequest(AbstractModel):
|
|
3256
3386
|
@property
|
3257
3387
|
def InvokerId(self):
|
3258
3388
|
"""待停止的执行器ID。
|
3389
|
+
|
3390
|
+
可通过 [DescribeInvokers(查询执行器)](https://cloud.tencent.com/document/api/1340/61759) 接口获取。
|
3259
3391
|
:rtype: str
|
3260
3392
|
"""
|
3261
3393
|
return self._InvokerId
|
@@ -3313,6 +3445,8 @@ class DisableRegisterCodesRequest(AbstractModel):
|
|
3313
3445
|
def __init__(self):
|
3314
3446
|
r"""
|
3315
3447
|
:param _RegisterCodeIds: 注册码ID。
|
3448
|
+
|
3449
|
+
可通过 [DescribeRegisterCodes(查询注册码)](https://cloud.tencent.com/document/api/1340/96925) 接口获取。
|
3316
3450
|
:type RegisterCodeIds: list of str
|
3317
3451
|
"""
|
3318
3452
|
self._RegisterCodeIds = None
|
@@ -3320,6 +3454,8 @@ class DisableRegisterCodesRequest(AbstractModel):
|
|
3320
3454
|
@property
|
3321
3455
|
def RegisterCodeIds(self):
|
3322
3456
|
"""注册码ID。
|
3457
|
+
|
3458
|
+
可通过 [DescribeRegisterCodes(查询注册码)](https://cloud.tencent.com/document/api/1340/96925) 接口获取。
|
3323
3459
|
:rtype: list of str
|
3324
3460
|
"""
|
3325
3461
|
return self._RegisterCodeIds
|
@@ -3377,6 +3513,8 @@ class EnableInvokerRequest(AbstractModel):
|
|
3377
3513
|
def __init__(self):
|
3378
3514
|
r"""
|
3379
3515
|
:param _InvokerId: 待启用的执行器ID。
|
3516
|
+
|
3517
|
+
可通过 [DescribeInvokers(查询执行器)](https://cloud.tencent.com/document/api/1340/61759) 接口获取。
|
3380
3518
|
:type InvokerId: str
|
3381
3519
|
"""
|
3382
3520
|
self._InvokerId = None
|
@@ -3384,6 +3522,8 @@ class EnableInvokerRequest(AbstractModel):
|
|
3384
3522
|
@property
|
3385
3523
|
def InvokerId(self):
|
3386
3524
|
"""待启用的执行器ID。
|
3525
|
+
|
3526
|
+
可通过 [DescribeInvokers(查询执行器)](https://cloud.tencent.com/document/api/1340/61759) 接口获取。
|
3387
3527
|
:rtype: str
|
3388
3528
|
"""
|
3389
3529
|
return self._InvokerId
|
@@ -3504,6 +3644,11 @@ class GeneralResourceQuotaSet(AbstractModel):
|
|
3504
3644
|
def __init__(self):
|
3505
3645
|
r"""
|
3506
3646
|
:param _ResourceName: 资源名称
|
3647
|
+
|
3648
|
+
取值为:
|
3649
|
+
|
3650
|
+
- COMMAND:命令
|
3651
|
+
- REGISTER_CODE:托管实例注册码
|
3507
3652
|
:type ResourceName: str
|
3508
3653
|
:param _ResourceQuotaUsed: 已使用额度
|
3509
3654
|
:type ResourceQuotaUsed: int
|
@@ -3517,6 +3662,11 @@ class GeneralResourceQuotaSet(AbstractModel):
|
|
3517
3662
|
@property
|
3518
3663
|
def ResourceName(self):
|
3519
3664
|
"""资源名称
|
3665
|
+
|
3666
|
+
取值为:
|
3667
|
+
|
3668
|
+
- COMMAND:命令
|
3669
|
+
- REGISTER_CODE:托管实例注册码
|
3520
3670
|
:rtype: str
|
3521
3671
|
"""
|
3522
3672
|
return self._ResourceName
|
@@ -3575,20 +3725,27 @@ class Invocation(AbstractModel):
|
|
3575
3725
|
:type CommandId: str
|
3576
3726
|
:param _InvocationStatus: 执行任务状态。取值范围:
|
3577
3727
|
|
3578
|
-
|
3579
|
-
|
3728
|
+
- PENDING:等待下发
|
3729
|
+
- RUNNING:命令运行中
|
3730
|
+
- CANCELLING:取消中
|
3731
|
+
- SUCCESS:命令成功
|
3732
|
+
- TIMEOUT:命令超时
|
3733
|
+
- FAILED:命令失败
|
3734
|
+
- CANCELLED:命令全部取消
|
3735
|
+
- PARTIAL_FAILED:命令部分失败
|
3736
|
+
- PARTIAL_CANCELLED:命令部分取消
|
3580
3737
|
:type InvocationStatus: str
|
3581
3738
|
:param _InvocationTaskBasicInfoSet: 执行任务信息列表。
|
3582
3739
|
:type InvocationTaskBasicInfoSet: list of InvocationTaskBasicInfo
|
3583
3740
|
:param _Description: 执行活动描述。
|
3584
3741
|
:type Description: str
|
3585
|
-
:param _StartTime:
|
3742
|
+
:param _StartTime: 执行活动开始时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
3586
3743
|
:type StartTime: str
|
3587
|
-
:param _EndTime:
|
3744
|
+
:param _EndTime: 执行活动结束时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
3588
3745
|
:type EndTime: str
|
3589
|
-
:param _CreatedTime:
|
3746
|
+
:param _CreatedTime: 执行活动创建时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
3590
3747
|
:type CreatedTime: str
|
3591
|
-
:param _UpdatedTime:
|
3748
|
+
:param _UpdatedTime: 执行活动更新时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
3592
3749
|
:type UpdatedTime: str
|
3593
3750
|
:param _Parameters: 自定义参数取值。
|
3594
3751
|
:type Parameters: str
|
@@ -3599,6 +3756,9 @@ class Invocation(AbstractModel):
|
|
3599
3756
|
:param _Username: 在实例上执行命令时使用的用户名。
|
3600
3757
|
:type Username: str
|
3601
3758
|
:param _InvocationSource: 调用来源。
|
3759
|
+
|
3760
|
+
- USER:来源于用户调用。
|
3761
|
+
- INVOKER:来源于定时执行。
|
3602
3762
|
:type InvocationSource: str
|
3603
3763
|
:param _CommandContent: base64编码的命令内容
|
3604
3764
|
:type CommandContent: str
|
@@ -3660,8 +3820,15 @@ class Invocation(AbstractModel):
|
|
3660
3820
|
def InvocationStatus(self):
|
3661
3821
|
"""执行任务状态。取值范围:
|
3662
3822
|
|
3663
|
-
|
3664
|
-
|
3823
|
+
- PENDING:等待下发
|
3824
|
+
- RUNNING:命令运行中
|
3825
|
+
- CANCELLING:取消中
|
3826
|
+
- SUCCESS:命令成功
|
3827
|
+
- TIMEOUT:命令超时
|
3828
|
+
- FAILED:命令失败
|
3829
|
+
- CANCELLED:命令全部取消
|
3830
|
+
- PARTIAL_FAILED:命令部分失败
|
3831
|
+
- PARTIAL_CANCELLED:命令部分取消
|
3665
3832
|
:rtype: str
|
3666
3833
|
"""
|
3667
3834
|
return self._InvocationStatus
|
@@ -3694,7 +3861,7 @@ class Invocation(AbstractModel):
|
|
3694
3861
|
|
3695
3862
|
@property
|
3696
3863
|
def StartTime(self):
|
3697
|
-
"""
|
3864
|
+
"""执行活动开始时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
3698
3865
|
:rtype: str
|
3699
3866
|
"""
|
3700
3867
|
return self._StartTime
|
@@ -3705,7 +3872,7 @@ class Invocation(AbstractModel):
|
|
3705
3872
|
|
3706
3873
|
@property
|
3707
3874
|
def EndTime(self):
|
3708
|
-
"""
|
3875
|
+
"""执行活动结束时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
3709
3876
|
:rtype: str
|
3710
3877
|
"""
|
3711
3878
|
return self._EndTime
|
@@ -3716,7 +3883,7 @@ class Invocation(AbstractModel):
|
|
3716
3883
|
|
3717
3884
|
@property
|
3718
3885
|
def CreatedTime(self):
|
3719
|
-
"""
|
3886
|
+
"""执行活动创建时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
3720
3887
|
:rtype: str
|
3721
3888
|
"""
|
3722
3889
|
return self._CreatedTime
|
@@ -3727,7 +3894,7 @@ class Invocation(AbstractModel):
|
|
3727
3894
|
|
3728
3895
|
@property
|
3729
3896
|
def UpdatedTime(self):
|
3730
|
-
"""
|
3897
|
+
"""执行活动更新时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
3731
3898
|
:rtype: str
|
3732
3899
|
"""
|
3733
3900
|
return self._UpdatedTime
|
@@ -3783,6 +3950,9 @@ class Invocation(AbstractModel):
|
|
3783
3950
|
@property
|
3784
3951
|
def InvocationSource(self):
|
3785
3952
|
"""调用来源。
|
3953
|
+
|
3954
|
+
- USER:来源于用户调用。
|
3955
|
+
- INVOKER:来源于定时执行。
|
3786
3956
|
:rtype: str
|
3787
3957
|
"""
|
3788
3958
|
return self._InvocationSource
|
@@ -3909,21 +4079,33 @@ class InvocationTask(AbstractModel):
|
|
3909
4079
|
:type CommandId: str
|
3910
4080
|
:param _TaskStatus: 执行任务状态。取值范围:
|
3911
4081
|
|
3912
|
-
|
4082
|
+
- PENDING:等待下发
|
4083
|
+
- DELIVERING:下发中
|
4084
|
+
- DELIVER_DELAYED:延时下发
|
4085
|
+
- DELIVER_FAILED:下发失败
|
4086
|
+
- START_FAILED:命令启动失败
|
4087
|
+
- RUNNING:命令运行中
|
4088
|
+
- SUCCESS:命令成功
|
4089
|
+
- FAILED:命令执行失败,执行完退出码不为 0
|
4090
|
+
- TIMEOUT:命令超时
|
4091
|
+
- TASK_TIMEOUT:客户端无响应
|
4092
|
+
- CANCELLING:取消中
|
4093
|
+
- CANCELLED:已取消(命令启动前就被取消)
|
4094
|
+
- TERMINATED:已中止(命令执行期间被取消)
|
3913
4095
|
:type TaskStatus: str
|
3914
4096
|
:param _InstanceId: 实例ID。
|
3915
4097
|
:type InstanceId: str
|
3916
4098
|
:param _TaskResult: 执行结果。
|
3917
4099
|
:type TaskResult: :class:`tencentcloud.tat.v20201028.models.TaskResult`
|
3918
|
-
:param _StartTime:
|
4100
|
+
:param _StartTime: 执行任务开始时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
3919
4101
|
注意:此字段可能返回 null,表示取不到有效值。
|
3920
4102
|
:type StartTime: str
|
3921
|
-
:param _EndTime:
|
4103
|
+
:param _EndTime: 执行任务结束时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
3922
4104
|
注意:此字段可能返回 null,表示取不到有效值。
|
3923
4105
|
:type EndTime: str
|
3924
|
-
:param _CreatedTime:
|
4106
|
+
:param _CreatedTime: 创建时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
3925
4107
|
:type CreatedTime: str
|
3926
|
-
:param _UpdatedTime:
|
4108
|
+
:param _UpdatedTime: 更新时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
3927
4109
|
:type UpdatedTime: str
|
3928
4110
|
:param _CommandDocument: 执行任务所执行的命令详情。
|
3929
4111
|
:type CommandDocument: :class:`tencentcloud.tat.v20201028.models.CommandDocument`
|
@@ -3983,7 +4165,19 @@ class InvocationTask(AbstractModel):
|
|
3983
4165
|
def TaskStatus(self):
|
3984
4166
|
"""执行任务状态。取值范围:
|
3985
4167
|
|
3986
|
-
|
4168
|
+
- PENDING:等待下发
|
4169
|
+
- DELIVERING:下发中
|
4170
|
+
- DELIVER_DELAYED:延时下发
|
4171
|
+
- DELIVER_FAILED:下发失败
|
4172
|
+
- START_FAILED:命令启动失败
|
4173
|
+
- RUNNING:命令运行中
|
4174
|
+
- SUCCESS:命令成功
|
4175
|
+
- FAILED:命令执行失败,执行完退出码不为 0
|
4176
|
+
- TIMEOUT:命令超时
|
4177
|
+
- TASK_TIMEOUT:客户端无响应
|
4178
|
+
- CANCELLING:取消中
|
4179
|
+
- CANCELLED:已取消(命令启动前就被取消)
|
4180
|
+
- TERMINATED:已中止(命令执行期间被取消)
|
3987
4181
|
:rtype: str
|
3988
4182
|
"""
|
3989
4183
|
return self._TaskStatus
|
@@ -4016,7 +4210,7 @@ class InvocationTask(AbstractModel):
|
|
4016
4210
|
|
4017
4211
|
@property
|
4018
4212
|
def StartTime(self):
|
4019
|
-
"""
|
4213
|
+
"""执行任务开始时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
4020
4214
|
注意:此字段可能返回 null,表示取不到有效值。
|
4021
4215
|
:rtype: str
|
4022
4216
|
"""
|
@@ -4028,7 +4222,7 @@ class InvocationTask(AbstractModel):
|
|
4028
4222
|
|
4029
4223
|
@property
|
4030
4224
|
def EndTime(self):
|
4031
|
-
"""
|
4225
|
+
"""执行任务结束时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
4032
4226
|
注意:此字段可能返回 null,表示取不到有效值。
|
4033
4227
|
:rtype: str
|
4034
4228
|
"""
|
@@ -4040,7 +4234,7 @@ class InvocationTask(AbstractModel):
|
|
4040
4234
|
|
4041
4235
|
@property
|
4042
4236
|
def CreatedTime(self):
|
4043
|
-
"""
|
4237
|
+
"""创建时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
4044
4238
|
:rtype: str
|
4045
4239
|
"""
|
4046
4240
|
return self._CreatedTime
|
@@ -4051,7 +4245,7 @@ class InvocationTask(AbstractModel):
|
|
4051
4245
|
|
4052
4246
|
@property
|
4053
4247
|
def UpdatedTime(self):
|
4054
|
-
"""
|
4248
|
+
"""更新时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
4055
4249
|
:rtype: str
|
4056
4250
|
"""
|
4057
4251
|
return self._UpdatedTime
|
@@ -4132,19 +4326,20 @@ class InvocationTaskBasicInfo(AbstractModel):
|
|
4132
4326
|
:param _InvocationTaskId: 执行任务ID。
|
4133
4327
|
:type InvocationTaskId: str
|
4134
4328
|
:param _TaskStatus: 执行任务状态。取值范围:
|
4135
|
-
|
4136
|
-
|
4137
|
-
|
4138
|
-
|
4139
|
-
|
4140
|
-
|
4141
|
-
|
4142
|
-
|
4143
|
-
|
4144
|
-
|
4145
|
-
|
4146
|
-
|
4147
|
-
|
4329
|
+
|
4330
|
+
- PENDING:等待下发
|
4331
|
+
- DELIVERING:下发中
|
4332
|
+
- DELIVER_DELAYED:延时下发
|
4333
|
+
- DELIVER_FAILED:下发失败
|
4334
|
+
- START_FAILED:命令启动失败
|
4335
|
+
- RUNNING:命令运行中
|
4336
|
+
- SUCCESS:命令成功
|
4337
|
+
- FAILED:命令执行失败,执行完退出码不为 0
|
4338
|
+
- TIMEOUT:命令超时
|
4339
|
+
- TASK_TIMEOUT:客户端无响应
|
4340
|
+
- CANCELLING:取消中
|
4341
|
+
- CANCELLED:已取消(命令启动前就被取消)
|
4342
|
+
- TERMINATED:已中止(命令执行期间被取消)
|
4148
4343
|
:type TaskStatus: str
|
4149
4344
|
:param _InstanceId: 实例ID。
|
4150
4345
|
:type InstanceId: str
|
@@ -4167,19 +4362,20 @@ class InvocationTaskBasicInfo(AbstractModel):
|
|
4167
4362
|
@property
|
4168
4363
|
def TaskStatus(self):
|
4169
4364
|
"""执行任务状态。取值范围:
|
4170
|
-
|
4171
|
-
|
4172
|
-
|
4173
|
-
|
4174
|
-
|
4175
|
-
|
4176
|
-
|
4177
|
-
|
4178
|
-
|
4179
|
-
|
4180
|
-
|
4181
|
-
|
4182
|
-
|
4365
|
+
|
4366
|
+
- PENDING:等待下发
|
4367
|
+
- DELIVERING:下发中
|
4368
|
+
- DELIVER_DELAYED:延时下发
|
4369
|
+
- DELIVER_FAILED:下发失败
|
4370
|
+
- START_FAILED:命令启动失败
|
4371
|
+
- RUNNING:命令运行中
|
4372
|
+
- SUCCESS:命令成功
|
4373
|
+
- FAILED:命令执行失败,执行完退出码不为 0
|
4374
|
+
- TIMEOUT:命令超时
|
4375
|
+
- TASK_TIMEOUT:客户端无响应
|
4376
|
+
- CANCELLING:取消中
|
4377
|
+
- CANCELLED:已取消(命令启动前就被取消)
|
4378
|
+
- TERMINATED:已中止(命令执行期间被取消)
|
4183
4379
|
:rtype: str
|
4184
4380
|
"""
|
4185
4381
|
return self._TaskStatus
|
@@ -4221,13 +4417,19 @@ class InvokeCommandRequest(AbstractModel):
|
|
4221
4417
|
|
4222
4418
|
def __init__(self):
|
4223
4419
|
r"""
|
4224
|
-
:param _CommandId: 待触发的命令ID
|
4420
|
+
:param _CommandId: 待触发的命令ID。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。
|
4225
4421
|
:type CommandId: str
|
4226
4422
|
:param _InstanceIds: 待执行命令的实例ID列表,上限200。
|
4423
|
+
|
4424
|
+
可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型:
|
4425
|
+
- CVM
|
4426
|
+
- Lighthouse
|
4427
|
+
- TAT 托管实例
|
4227
4428
|
:type InstanceIds: list of str
|
4228
4429
|
:param _Parameters: Command 的自定义参数。字段类型为json encoded string。如:{"varA": "222"}。
|
4229
4430
|
key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。
|
4230
|
-
|
4431
|
+
仅在命令的 EnableParameter 为 true 时,才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。
|
4432
|
+
如果未提供该参数取值,将使用 Command 的 DefaultParameters 或 DefaultParameterConfs 进行替换。
|
4231
4433
|
自定义参数最多20个。
|
4232
4434
|
自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。
|
4233
4435
|
:type Parameters: str
|
@@ -4257,7 +4459,7 @@ key为自定义参数名称,value为该参数的默认取值。kv均为字符
|
|
4257
4459
|
|
4258
4460
|
@property
|
4259
4461
|
def CommandId(self):
|
4260
|
-
"""待触发的命令ID
|
4462
|
+
"""待触发的命令ID。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。
|
4261
4463
|
:rtype: str
|
4262
4464
|
"""
|
4263
4465
|
return self._CommandId
|
@@ -4269,6 +4471,11 @@ key为自定义参数名称,value为该参数的默认取值。kv均为字符
|
|
4269
4471
|
@property
|
4270
4472
|
def InstanceIds(self):
|
4271
4473
|
"""待执行命令的实例ID列表,上限200。
|
4474
|
+
|
4475
|
+
可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型:
|
4476
|
+
- CVM
|
4477
|
+
- Lighthouse
|
4478
|
+
- TAT 托管实例
|
4272
4479
|
:rtype: list of str
|
4273
4480
|
"""
|
4274
4481
|
return self._InstanceIds
|
@@ -4281,7 +4488,8 @@ key为自定义参数名称,value为该参数的默认取值。kv均为字符
|
|
4281
4488
|
def Parameters(self):
|
4282
4489
|
"""Command 的自定义参数。字段类型为json encoded string。如:{"varA": "222"}。
|
4283
4490
|
key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。
|
4284
|
-
|
4491
|
+
仅在命令的 EnableParameter 为 true 时,才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。
|
4492
|
+
如果未提供该参数取值,将使用 Command 的 DefaultParameters 或 DefaultParameterConfs 进行替换。
|
4285
4493
|
自定义参数最多20个。
|
4286
4494
|
自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。
|
4287
4495
|
:rtype: str
|
@@ -4425,7 +4633,7 @@ class Invoker(AbstractModel):
|
|
4425
4633
|
:type InvokerId: str
|
4426
4634
|
:param _Name: 执行器名称。
|
4427
4635
|
:type Name: str
|
4428
|
-
:param _Type:
|
4636
|
+
:param _Type: 执行器类型。目前仅支持 SCHEDULE 一种。
|
4429
4637
|
:type Type: str
|
4430
4638
|
:param _CommandId: 命令ID。
|
4431
4639
|
:type CommandId: str
|
@@ -4440,9 +4648,9 @@ class Invoker(AbstractModel):
|
|
4440
4648
|
:param _ScheduleSettings: 执行器周期计划。周期执行器会返回此字段。
|
4441
4649
|
注意:此字段可能返回 null,表示取不到有效值。
|
4442
4650
|
:type ScheduleSettings: :class:`tencentcloud.tat.v20201028.models.ScheduleSettings`
|
4443
|
-
:param _CreatedTime:
|
4651
|
+
:param _CreatedTime: 创建时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
4444
4652
|
:type CreatedTime: str
|
4445
|
-
:param _UpdatedTime:
|
4653
|
+
:param _UpdatedTime: 修改时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
4446
4654
|
:type UpdatedTime: str
|
4447
4655
|
"""
|
4448
4656
|
self._InvokerId = None
|
@@ -4481,7 +4689,7 @@ class Invoker(AbstractModel):
|
|
4481
4689
|
|
4482
4690
|
@property
|
4483
4691
|
def Type(self):
|
4484
|
-
"""
|
4692
|
+
"""执行器类型。目前仅支持 SCHEDULE 一种。
|
4485
4693
|
:rtype: str
|
4486
4694
|
"""
|
4487
4695
|
return self._Type
|
@@ -4559,7 +4767,7 @@ class Invoker(AbstractModel):
|
|
4559
4767
|
|
4560
4768
|
@property
|
4561
4769
|
def CreatedTime(self):
|
4562
|
-
"""
|
4770
|
+
"""创建时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
4563
4771
|
:rtype: str
|
4564
4772
|
"""
|
4565
4773
|
return self._CreatedTime
|
@@ -4570,7 +4778,7 @@ class Invoker(AbstractModel):
|
|
4570
4778
|
|
4571
4779
|
@property
|
4572
4780
|
def UpdatedTime(self):
|
4573
|
-
"""
|
4781
|
+
"""修改时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
4574
4782
|
:rtype: str
|
4575
4783
|
"""
|
4576
4784
|
return self._UpdatedTime
|
@@ -4613,13 +4821,23 @@ class InvokerRecord(AbstractModel):
|
|
4613
4821
|
r"""
|
4614
4822
|
:param _InvokerId: 执行器ID。
|
4615
4823
|
:type InvokerId: str
|
4616
|
-
:param _InvokeTime:
|
4824
|
+
:param _InvokeTime: 执行时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
4617
4825
|
:type InvokeTime: str
|
4618
4826
|
:param _Reason: 执行原因。
|
4619
4827
|
:type Reason: str
|
4620
4828
|
:param _InvocationId: 命令执行ID。
|
4621
4829
|
:type InvocationId: str
|
4622
4830
|
:param _Result: 触发结果。
|
4831
|
+
|
4832
|
+
- PENDING:等待下发
|
4833
|
+
- RUNNING:命令运行中
|
4834
|
+
- CANCELLING:取消中
|
4835
|
+
- SUCCESS:命令成功
|
4836
|
+
- TIMEOUT:命令超时
|
4837
|
+
- FAILED:命令失败
|
4838
|
+
- CANCELLED:命令全部取消
|
4839
|
+
- PARTIAL_FAILED:命令部分失败
|
4840
|
+
- PARTIAL_CANCELLED:命令部分取消
|
4623
4841
|
:type Result: str
|
4624
4842
|
"""
|
4625
4843
|
self._InvokerId = None
|
@@ -4641,7 +4859,7 @@ class InvokerRecord(AbstractModel):
|
|
4641
4859
|
|
4642
4860
|
@property
|
4643
4861
|
def InvokeTime(self):
|
4644
|
-
"""
|
4862
|
+
"""执行时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
4645
4863
|
:rtype: str
|
4646
4864
|
"""
|
4647
4865
|
return self._InvokeTime
|
@@ -4675,6 +4893,16 @@ class InvokerRecord(AbstractModel):
|
|
4675
4893
|
@property
|
4676
4894
|
def Result(self):
|
4677
4895
|
"""触发结果。
|
4896
|
+
|
4897
|
+
- PENDING:等待下发
|
4898
|
+
- RUNNING:命令运行中
|
4899
|
+
- CANCELLING:取消中
|
4900
|
+
- SUCCESS:命令成功
|
4901
|
+
- TIMEOUT:命令超时
|
4902
|
+
- FAILED:命令失败
|
4903
|
+
- CANCELLED:命令全部取消
|
4904
|
+
- PARTIAL_FAILED:命令部分失败
|
4905
|
+
- PARTIAL_CANCELLED:命令部分取消
|
4678
4906
|
:rtype: str
|
4679
4907
|
"""
|
4680
4908
|
return self._Result
|
@@ -4707,7 +4935,7 @@ class ModifyCommandRequest(AbstractModel):
|
|
4707
4935
|
|
4708
4936
|
def __init__(self):
|
4709
4937
|
r"""
|
4710
|
-
:param _CommandId: 命令ID
|
4938
|
+
:param _CommandId: 命令ID。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。
|
4711
4939
|
:type CommandId: str
|
4712
4940
|
:param _CommandName: 命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。
|
4713
4941
|
:type CommandName: str
|
@@ -4715,21 +4943,23 @@ class ModifyCommandRequest(AbstractModel):
|
|
4715
4943
|
:type Description: str
|
4716
4944
|
:param _Content: Base64编码后的命令内容,长度不可超过64KB。
|
4717
4945
|
:type Content: str
|
4718
|
-
:param _CommandType: 命令类型,目前支持取值:SHELL、POWERSHELL。
|
4946
|
+
:param _CommandType: 命令类型,目前支持取值:SHELL、POWERSHELL、BAT。
|
4719
4947
|
:type CommandType: str
|
4720
4948
|
:param _WorkingDirectory: 命令执行路径。
|
4721
4949
|
:type WorkingDirectory: str
|
4722
4950
|
:param _Timeout: 命令超时时间。取值范围[1, 86400]。
|
4723
4951
|
:type Timeout: int
|
4724
4952
|
:param _DefaultParameters: 启用自定义参数功能时,自定义参数的默认取值。字段类型为json encoded string。如:{"varA": "222"}。
|
4953
|
+
参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。
|
4725
4954
|
采取整体全覆盖式修改,即修改时必须提供所有新默认值。
|
4726
|
-
|
4955
|
+
仅在命令的 EnableParameter 为 true 时,才允许修改此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。
|
4727
4956
|
key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。
|
4728
4957
|
自定义参数最多20个。
|
4729
4958
|
自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。
|
4730
4959
|
:type DefaultParameters: str
|
4731
|
-
:param _DefaultParameterConfs:
|
4732
|
-
|
4960
|
+
:param _DefaultParameterConfs: 自定义参数数组。如果 InvokeCommand 时未提供参数取值,将使用这里的默认值进行替换。
|
4961
|
+
参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。
|
4962
|
+
仅在命令的 EnableParameter 为 true 时,才允许修改此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。
|
4733
4963
|
自定义参数最多20个。
|
4734
4964
|
:type DefaultParameterConfs: list of DefaultParameterConf
|
4735
4965
|
:param _Username: 在 CVM 或 Lighthouse 实例中执行命令的用户名称。
|
@@ -4758,7 +4988,7 @@ key为自定义参数名称,value为该参数的默认取值。kv均为字符
|
|
4758
4988
|
|
4759
4989
|
@property
|
4760
4990
|
def CommandId(self):
|
4761
|
-
"""命令ID
|
4991
|
+
"""命令ID。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。
|
4762
4992
|
:rtype: str
|
4763
4993
|
"""
|
4764
4994
|
return self._CommandId
|
@@ -4802,7 +5032,7 @@ key为自定义参数名称,value为该参数的默认取值。kv均为字符
|
|
4802
5032
|
|
4803
5033
|
@property
|
4804
5034
|
def CommandType(self):
|
4805
|
-
"""命令类型,目前支持取值:SHELL、POWERSHELL。
|
5035
|
+
"""命令类型,目前支持取值:SHELL、POWERSHELL、BAT。
|
4806
5036
|
:rtype: str
|
4807
5037
|
"""
|
4808
5038
|
return self._CommandType
|
@@ -4836,8 +5066,9 @@ key为自定义参数名称,value为该参数的默认取值。kv均为字符
|
|
4836
5066
|
@property
|
4837
5067
|
def DefaultParameters(self):
|
4838
5068
|
"""启用自定义参数功能时,自定义参数的默认取值。字段类型为json encoded string。如:{"varA": "222"}。
|
5069
|
+
参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。
|
4839
5070
|
采取整体全覆盖式修改,即修改时必须提供所有新默认值。
|
4840
|
-
|
5071
|
+
仅在命令的 EnableParameter 为 true 时,才允许修改此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。
|
4841
5072
|
key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。
|
4842
5073
|
自定义参数最多20个。
|
4843
5074
|
自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。
|
@@ -4851,8 +5082,9 @@ key为自定义参数名称,value为该参数的默认取值。kv均为字符
|
|
4851
5082
|
|
4852
5083
|
@property
|
4853
5084
|
def DefaultParameterConfs(self):
|
4854
|
-
"""
|
4855
|
-
|
5085
|
+
"""自定义参数数组。如果 InvokeCommand 时未提供参数取值,将使用这里的默认值进行替换。
|
5086
|
+
参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。
|
5087
|
+
仅在命令的 EnableParameter 为 true 时,才允许修改此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。
|
4856
5088
|
自定义参数最多20个。
|
4857
5089
|
:rtype: list of DefaultParameterConf
|
4858
5090
|
"""
|
@@ -4964,18 +5196,28 @@ class ModifyInvokerRequest(AbstractModel):
|
|
4964
5196
|
def __init__(self):
|
4965
5197
|
r"""
|
4966
5198
|
:param _InvokerId: 待修改的执行器ID。
|
5199
|
+
|
5200
|
+
可通过 [DescribeInvokers(查询执行器)](https://cloud.tencent.com/document/api/1340/61759) 接口获取。
|
4967
5201
|
:type InvokerId: str
|
4968
5202
|
:param _Name: 待修改的执行器名称。
|
4969
5203
|
:type Name: str
|
4970
5204
|
:param _Type: 执行器类型,当前仅支持周期类型执行器,取值:`SCHEDULE` 。
|
4971
5205
|
:type Type: str
|
4972
5206
|
:param _CommandId: 待修改的命令ID。
|
5207
|
+
|
5208
|
+
可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。
|
4973
5209
|
:type CommandId: str
|
4974
5210
|
:param _Username: 待修改的用户名。
|
4975
5211
|
:type Username: str
|
4976
5212
|
:param _Parameters: 待修改的自定义参数。
|
5213
|
+
|
5214
|
+
仅在 CommandId 所指命令的 EnableParameter 为 true 时,才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。
|
4977
5215
|
:type Parameters: str
|
4978
5216
|
:param _InstanceIds: 待修改的实例ID列表。列表长度上限100。
|
5217
|
+
|
5218
|
+
可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型:CVM、Lighthouse、TAT 托管实例。
|
5219
|
+
|
5220
|
+
实例需要安装 TAT 客户端, 且客户端为 Online 状态。可通过 [DescribeAutomationAgentStatus(查询客户端状态)](https://cloud.tencent.com/document/api/1340/52682) 接口查询客户端状态。
|
4979
5221
|
:type InstanceIds: list of str
|
4980
5222
|
:param _ScheduleSettings: 待修改的周期执行器设置。
|
4981
5223
|
:type ScheduleSettings: :class:`tencentcloud.tat.v20201028.models.ScheduleSettings`
|
@@ -4992,6 +5234,8 @@ class ModifyInvokerRequest(AbstractModel):
|
|
4992
5234
|
@property
|
4993
5235
|
def InvokerId(self):
|
4994
5236
|
"""待修改的执行器ID。
|
5237
|
+
|
5238
|
+
可通过 [DescribeInvokers(查询执行器)](https://cloud.tencent.com/document/api/1340/61759) 接口获取。
|
4995
5239
|
:rtype: str
|
4996
5240
|
"""
|
4997
5241
|
return self._InvokerId
|
@@ -5025,6 +5269,8 @@ class ModifyInvokerRequest(AbstractModel):
|
|
5025
5269
|
@property
|
5026
5270
|
def CommandId(self):
|
5027
5271
|
"""待修改的命令ID。
|
5272
|
+
|
5273
|
+
可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。
|
5028
5274
|
:rtype: str
|
5029
5275
|
"""
|
5030
5276
|
return self._CommandId
|
@@ -5047,6 +5293,8 @@ class ModifyInvokerRequest(AbstractModel):
|
|
5047
5293
|
@property
|
5048
5294
|
def Parameters(self):
|
5049
5295
|
"""待修改的自定义参数。
|
5296
|
+
|
5297
|
+
仅在 CommandId 所指命令的 EnableParameter 为 true 时,才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。
|
5050
5298
|
:rtype: str
|
5051
5299
|
"""
|
5052
5300
|
return self._Parameters
|
@@ -5058,6 +5306,10 @@ class ModifyInvokerRequest(AbstractModel):
|
|
5058
5306
|
@property
|
5059
5307
|
def InstanceIds(self):
|
5060
5308
|
"""待修改的实例ID列表。列表长度上限100。
|
5309
|
+
|
5310
|
+
可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型:CVM、Lighthouse、TAT 托管实例。
|
5311
|
+
|
5312
|
+
实例需要安装 TAT 客户端, 且客户端为 Online 状态。可通过 [DescribeAutomationAgentStatus(查询客户端状态)](https://cloud.tencent.com/document/api/1340/52682) 接口查询客户端状态。
|
5061
5313
|
:rtype: list of str
|
5062
5314
|
"""
|
5063
5315
|
return self._InstanceIds
|
@@ -5134,7 +5386,9 @@ class ModifyRegisterInstanceRequest(AbstractModel):
|
|
5134
5386
|
|
5135
5387
|
def __init__(self):
|
5136
5388
|
r"""
|
5137
|
-
:param _InstanceId:
|
5389
|
+
:param _InstanceId: 托管实例ID。
|
5390
|
+
|
5391
|
+
可通过 [DescribeRegisterInstances(查询托管实例)](https://cloud.tencent.com/document/api/1340/96924) 接口获取。
|
5138
5392
|
:type InstanceId: str
|
5139
5393
|
:param _InstanceName: 实例名称。有效长度为 1~60 字符。
|
5140
5394
|
:type InstanceName: str
|
@@ -5144,7 +5398,9 @@ class ModifyRegisterInstanceRequest(AbstractModel):
|
|
5144
5398
|
|
5145
5399
|
@property
|
5146
5400
|
def InstanceId(self):
|
5147
|
-
"""
|
5401
|
+
"""托管实例ID。
|
5402
|
+
|
5403
|
+
可通过 [DescribeRegisterInstances(查询托管实例)](https://cloud.tencent.com/document/api/1340/96924) 接口获取。
|
5148
5404
|
:rtype: str
|
5149
5405
|
"""
|
5150
5406
|
return self._InstanceId
|
@@ -5213,13 +5469,17 @@ class PreviewReplacedCommandContentRequest(AbstractModel):
|
|
5213
5469
|
|
5214
5470
|
def __init__(self):
|
5215
5471
|
r"""
|
5216
|
-
:param _Parameters: 本次预览采用的自定义参数。字段类型为 json encoded string,如:{
|
5472
|
+
:param _Parameters: 本次预览采用的自定义参数。字段类型为 json encoded string,如:{"varA": "222"}。
|
5473
|
+
仅在命令的 EnableParameter 为 true 时,才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。
|
5474
|
+
如果有设置过 DefaultParameters 或 DefaultParameterConfs,会与 Parameters 进行叠加,优先使用 Parameters 的值。
|
5475
|
+
|
5217
5476
|
key 为自定义参数名称,value 为该参数的取值。kv 均为字符串型。
|
5218
5477
|
自定义参数最多 20 个。
|
5219
5478
|
自定义参数名称需符合以下规范:字符数目上限 64,可选范围【a-zA-Z0-9-_】。
|
5220
5479
|
如果将预览的 CommandId 设置过 DefaultParameters,本参数可以为空。
|
5221
5480
|
:type Parameters: str
|
5222
|
-
:param _CommandId:
|
5481
|
+
:param _CommandId: 要进行替换预览的命令。
|
5482
|
+
可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。
|
5223
5483
|
CommandId 与 Content,必须且只能提供一个。
|
5224
5484
|
:type CommandId: str
|
5225
5485
|
:param _Content: 要预览的命令内容,经 Base64 编码,长度不可超过 64KB。
|
@@ -5232,7 +5492,10 @@ CommandId 与 Content,必须且只能提供一个。
|
|
5232
5492
|
|
5233
5493
|
@property
|
5234
5494
|
def Parameters(self):
|
5235
|
-
"""本次预览采用的自定义参数。字段类型为 json encoded string,如:{
|
5495
|
+
"""本次预览采用的自定义参数。字段类型为 json encoded string,如:{"varA": "222"}。
|
5496
|
+
仅在命令的 EnableParameter 为 true 时,才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。
|
5497
|
+
如果有设置过 DefaultParameters 或 DefaultParameterConfs,会与 Parameters 进行叠加,优先使用 Parameters 的值。
|
5498
|
+
|
5236
5499
|
key 为自定义参数名称,value 为该参数的取值。kv 均为字符串型。
|
5237
5500
|
自定义参数最多 20 个。
|
5238
5501
|
自定义参数名称需符合以下规范:字符数目上限 64,可选范围【a-zA-Z0-9-_】。
|
@@ -5247,7 +5510,8 @@ key 为自定义参数名称,value 为该参数的取值。kv 均为字符串
|
|
5247
5510
|
|
5248
5511
|
@property
|
5249
5512
|
def CommandId(self):
|
5250
|
-
"""
|
5513
|
+
"""要进行替换预览的命令。
|
5514
|
+
可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。
|
5251
5515
|
CommandId 与 Content,必须且只能提供一个。
|
5252
5516
|
:rtype: str
|
5253
5517
|
"""
|
@@ -5338,7 +5602,7 @@ class RegionInfo(AbstractModel):
|
|
5338
5602
|
:type Region: str
|
5339
5603
|
:param _RegionName: 地域描述,例如: 广州
|
5340
5604
|
:type RegionName: str
|
5341
|
-
:param _RegionState: 地域是否可用状态,AVAILABLE
|
5605
|
+
:param _RegionState: 地域是否可用状态,AVAILABLE 代表可用,UNAVAILABLE 代表不可用。
|
5342
5606
|
:type RegionState: str
|
5343
5607
|
"""
|
5344
5608
|
self._Region = None
|
@@ -5369,7 +5633,7 @@ class RegionInfo(AbstractModel):
|
|
5369
5633
|
|
5370
5634
|
@property
|
5371
5635
|
def RegionState(self):
|
5372
|
-
"""地域是否可用状态,AVAILABLE
|
5636
|
+
"""地域是否可用状态,AVAILABLE 代表可用,UNAVAILABLE 代表不可用。
|
5373
5637
|
:rtype: str
|
5374
5638
|
"""
|
5375
5639
|
return self._RegionState
|
@@ -5591,7 +5855,7 @@ class RegisterInstanceInfo(AbstractModel):
|
|
5591
5855
|
:type InstanceName: str
|
5592
5856
|
:param _MachineId: 机器ID。
|
5593
5857
|
:type MachineId: str
|
5594
|
-
:param _SystemName:
|
5858
|
+
:param _SystemName: 系统名。取值:Linux | Windows。
|
5595
5859
|
:type SystemName: str
|
5596
5860
|
:param _HostName: 主机名。
|
5597
5861
|
:type HostName: str
|
@@ -5602,10 +5866,12 @@ class RegisterInstanceInfo(AbstractModel):
|
|
5602
5866
|
:param _Status: 托管状态。
|
5603
5867
|
返回Online表示实例正在托管,返回Offline表示实例未托管。
|
5604
5868
|
:type Status: str
|
5605
|
-
:param _CreatedTime:
|
5869
|
+
:param _CreatedTime: 创建时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
5606
5870
|
:type CreatedTime: str
|
5607
|
-
:param _UpdatedTime:
|
5871
|
+
:param _UpdatedTime: 上次更新时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
5608
5872
|
:type UpdatedTime: str
|
5873
|
+
:param _Tags: 标签
|
5874
|
+
:type Tags: list of Tag
|
5609
5875
|
"""
|
5610
5876
|
self._RegisterCodeId = None
|
5611
5877
|
self._InstanceId = None
|
@@ -5618,6 +5884,7 @@ class RegisterInstanceInfo(AbstractModel):
|
|
5618
5884
|
self._Status = None
|
5619
5885
|
self._CreatedTime = None
|
5620
5886
|
self._UpdatedTime = None
|
5887
|
+
self._Tags = None
|
5621
5888
|
|
5622
5889
|
@property
|
5623
5890
|
def RegisterCodeId(self):
|
@@ -5665,7 +5932,7 @@ class RegisterInstanceInfo(AbstractModel):
|
|
5665
5932
|
|
5666
5933
|
@property
|
5667
5934
|
def SystemName(self):
|
5668
|
-
"""
|
5935
|
+
"""系统名。取值:Linux | Windows。
|
5669
5936
|
:rtype: str
|
5670
5937
|
"""
|
5671
5938
|
return self._SystemName
|
@@ -5721,7 +5988,7 @@ class RegisterInstanceInfo(AbstractModel):
|
|
5721
5988
|
|
5722
5989
|
@property
|
5723
5990
|
def CreatedTime(self):
|
5724
|
-
"""
|
5991
|
+
"""创建时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
5725
5992
|
:rtype: str
|
5726
5993
|
"""
|
5727
5994
|
return self._CreatedTime
|
@@ -5732,7 +5999,7 @@ class RegisterInstanceInfo(AbstractModel):
|
|
5732
5999
|
|
5733
6000
|
@property
|
5734
6001
|
def UpdatedTime(self):
|
5735
|
-
"""
|
6002
|
+
"""上次更新时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
5736
6003
|
:rtype: str
|
5737
6004
|
"""
|
5738
6005
|
return self._UpdatedTime
|
@@ -5741,6 +6008,17 @@ class RegisterInstanceInfo(AbstractModel):
|
|
5741
6008
|
def UpdatedTime(self, UpdatedTime):
|
5742
6009
|
self._UpdatedTime = UpdatedTime
|
5743
6010
|
|
6011
|
+
@property
|
6012
|
+
def Tags(self):
|
6013
|
+
"""标签
|
6014
|
+
:rtype: list of Tag
|
6015
|
+
"""
|
6016
|
+
return self._Tags
|
6017
|
+
|
6018
|
+
@Tags.setter
|
6019
|
+
def Tags(self, Tags):
|
6020
|
+
self._Tags = Tags
|
6021
|
+
|
5744
6022
|
|
5745
6023
|
def _deserialize(self, params):
|
5746
6024
|
self._RegisterCodeId = params.get("RegisterCodeId")
|
@@ -5754,6 +6032,12 @@ class RegisterInstanceInfo(AbstractModel):
|
|
5754
6032
|
self._Status = params.get("Status")
|
5755
6033
|
self._CreatedTime = params.get("CreatedTime")
|
5756
6034
|
self._UpdatedTime = params.get("UpdatedTime")
|
6035
|
+
if params.get("Tags") is not None:
|
6036
|
+
self._Tags = []
|
6037
|
+
for item in params.get("Tags"):
|
6038
|
+
obj = Tag()
|
6039
|
+
obj._deserialize(item)
|
6040
|
+
self._Tags.append(obj)
|
5757
6041
|
memeber_set = set(params.keys())
|
5758
6042
|
for name, value in vars(self).items():
|
5759
6043
|
property_name = name[1:]
|
@@ -5773,15 +6057,18 @@ class RunCommandRequest(AbstractModel):
|
|
5773
6057
|
r"""
|
5774
6058
|
:param _Content: Base64编码后的命令内容,长度不可超过64KB。
|
5775
6059
|
:type Content: str
|
5776
|
-
:param _InstanceIds: 待执行命令的实例ID列表,上限200
|
5777
|
-
|
5778
|
-
|
6060
|
+
:param _InstanceIds: 待执行命令的实例ID列表,上限200。
|
6061
|
+
|
6062
|
+
可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型:
|
6063
|
+
- CVM
|
6064
|
+
- Lighthouse
|
6065
|
+
- TAT 托管实例
|
5779
6066
|
:type InstanceIds: list of str
|
5780
6067
|
:param _CommandName: 命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。
|
5781
6068
|
:type CommandName: str
|
5782
6069
|
:param _Description: 命令描述。不超过120字符。
|
5783
6070
|
:type Description: str
|
5784
|
-
:param _CommandType: 命令类型,目前支持取值:SHELL、POWERSHELL。默认:SHELL。
|
6071
|
+
:param _CommandType: 命令类型,目前支持取值:SHELL、POWERSHELL、BAT。默认:SHELL。
|
5785
6072
|
:type CommandType: str
|
5786
6073
|
:param _WorkingDirectory: 命令执行路径,对于 SHELL 命令默认为 /root,对于 POWERSHELL 命令默认为 C:\Program Files\qcloud\tat_agent\workdir。
|
5787
6074
|
:type WorkingDirectory: str
|
@@ -5801,15 +6088,21 @@ class RunCommandRequest(AbstractModel):
|
|
5801
6088
|
:type EnableParameter: bool
|
5802
6089
|
:param _DefaultParameters: 启用自定义参数功能时,自定义参数的默认取值。字段类型为json encoded string。如:{"varA": "222"}。
|
5803
6090
|
key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。
|
6091
|
+
仅在命令的 EnableParameter 为 true 时,才允许设置此参数。
|
6092
|
+
参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。
|
5804
6093
|
如果 Parameters 未提供,将使用这里的默认值进行替换。
|
5805
6094
|
自定义参数最多20个。
|
5806
6095
|
自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。
|
5807
6096
|
:type DefaultParameters: str
|
5808
6097
|
:param _DefaultParameterConfs: 自定义参数数组。 如果 Parameters 未提供,将使用这里的默认值进行替换。 自定义参数最多20个。
|
6098
|
+
如果 Parameters 未提供,将使用这里的默认值进行替换。
|
6099
|
+
仅在命令的 EnableParameter 为 true 时,才允许设置此参数。
|
6100
|
+
参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。
|
5809
6101
|
:type DefaultParameterConfs: list of DefaultParameterConf
|
5810
6102
|
:param _Parameters: Command 的自定义参数。字段类型为json encoded string。如:{"varA": "222"}。
|
5811
6103
|
key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。
|
5812
|
-
|
6104
|
+
仅在命令的 EnableParameter 为 true 时,才允许设置此参数。
|
6105
|
+
如果未提供该参数取值,将使用 DefaultParameters 或 DefaultParameterConfs 进行替换。
|
5813
6106
|
自定义参数最多20个。
|
5814
6107
|
自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。
|
5815
6108
|
:type Parameters: str
|
@@ -5856,9 +6149,12 @@ key为自定义参数名称,value为该参数的默认取值。kv均为字符
|
|
5856
6149
|
|
5857
6150
|
@property
|
5858
6151
|
def InstanceIds(self):
|
5859
|
-
"""待执行命令的实例ID列表,上限200
|
5860
|
-
|
5861
|
-
|
6152
|
+
"""待执行命令的实例ID列表,上限200。
|
6153
|
+
|
6154
|
+
可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型:
|
6155
|
+
- CVM
|
6156
|
+
- Lighthouse
|
6157
|
+
- TAT 托管实例
|
5862
6158
|
:rtype: list of str
|
5863
6159
|
"""
|
5864
6160
|
return self._InstanceIds
|
@@ -5891,7 +6187,7 @@ key为自定义参数名称,value为该参数的默认取值。kv均为字符
|
|
5891
6187
|
|
5892
6188
|
@property
|
5893
6189
|
def CommandType(self):
|
5894
|
-
"""命令类型,目前支持取值:SHELL、POWERSHELL。默认:SHELL。
|
6190
|
+
"""命令类型,目前支持取值:SHELL、POWERSHELL、BAT。默认:SHELL。
|
5895
6191
|
:rtype: str
|
5896
6192
|
"""
|
5897
6193
|
return self._CommandType
|
@@ -5956,6 +6252,8 @@ key为自定义参数名称,value为该参数的默认取值。kv均为字符
|
|
5956
6252
|
def DefaultParameters(self):
|
5957
6253
|
"""启用自定义参数功能时,自定义参数的默认取值。字段类型为json encoded string。如:{"varA": "222"}。
|
5958
6254
|
key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。
|
6255
|
+
仅在命令的 EnableParameter 为 true 时,才允许设置此参数。
|
6256
|
+
参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。
|
5959
6257
|
如果 Parameters 未提供,将使用这里的默认值进行替换。
|
5960
6258
|
自定义参数最多20个。
|
5961
6259
|
自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。
|
@@ -5970,6 +6268,9 @@ key为自定义参数名称,value为该参数的默认取值。kv均为字符
|
|
5970
6268
|
@property
|
5971
6269
|
def DefaultParameterConfs(self):
|
5972
6270
|
"""自定义参数数组。 如果 Parameters 未提供,将使用这里的默认值进行替换。 自定义参数最多20个。
|
6271
|
+
如果 Parameters 未提供,将使用这里的默认值进行替换。
|
6272
|
+
仅在命令的 EnableParameter 为 true 时,才允许设置此参数。
|
6273
|
+
参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。
|
5973
6274
|
:rtype: list of DefaultParameterConf
|
5974
6275
|
"""
|
5975
6276
|
return self._DefaultParameterConfs
|
@@ -5982,7 +6283,8 @@ key为自定义参数名称,value为该参数的默认取值。kv均为字符
|
|
5982
6283
|
def Parameters(self):
|
5983
6284
|
"""Command 的自定义参数。字段类型为json encoded string。如:{"varA": "222"}。
|
5984
6285
|
key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。
|
5985
|
-
|
6286
|
+
仅在命令的 EnableParameter 为 true 时,才允许设置此参数。
|
6287
|
+
如果未提供该参数取值,将使用 DefaultParameters 或 DefaultParameterConfs 进行替换。
|
5986
6288
|
自定义参数最多20个。
|
5987
6289
|
自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。
|
5988
6290
|
:rtype: str
|
@@ -6149,10 +6451,12 @@ class Scene(AbstractModel):
|
|
6149
6451
|
:param _SceneName: 场景名称。
|
6150
6452
|
:type SceneName: str
|
6151
6453
|
:param _CreatedBy: 场景创建者。
|
6454
|
+
|
6455
|
+
- TAT:公共场景
|
6152
6456
|
:type CreatedBy: str
|
6153
|
-
:param _CreatedTime:
|
6457
|
+
:param _CreatedTime: 创建时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
6154
6458
|
:type CreatedTime: str
|
6155
|
-
:param _UpdatedTime:
|
6459
|
+
:param _UpdatedTime: 更新时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
6156
6460
|
:type UpdatedTime: str
|
6157
6461
|
"""
|
6158
6462
|
self._SceneId = None
|
@@ -6186,6 +6490,8 @@ class Scene(AbstractModel):
|
|
6186
6490
|
@property
|
6187
6491
|
def CreatedBy(self):
|
6188
6492
|
"""场景创建者。
|
6493
|
+
|
6494
|
+
- TAT:公共场景
|
6189
6495
|
:rtype: str
|
6190
6496
|
"""
|
6191
6497
|
return self._CreatedBy
|
@@ -6196,7 +6502,7 @@ class Scene(AbstractModel):
|
|
6196
6502
|
|
6197
6503
|
@property
|
6198
6504
|
def CreatedTime(self):
|
6199
|
-
"""
|
6505
|
+
"""创建时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
6200
6506
|
:rtype: str
|
6201
6507
|
"""
|
6202
6508
|
return self._CreatedTime
|
@@ -6207,7 +6513,7 @@ class Scene(AbstractModel):
|
|
6207
6513
|
|
6208
6514
|
@property
|
6209
6515
|
def UpdatedTime(self):
|
6210
|
-
"""
|
6516
|
+
"""更新时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
6211
6517
|
:rtype: str
|
6212
6518
|
"""
|
6213
6519
|
return self._UpdatedTime
|
@@ -6241,12 +6547,16 @@ class ScheduleSettings(AbstractModel):
|
|
6241
6547
|
def __init__(self):
|
6242
6548
|
r"""
|
6243
6549
|
:param _Policy: 执行策略:
|
6244
|
-
|
6245
|
-
|
6550
|
+
- ONCE:单次执行
|
6551
|
+
- RECURRENCE:周期执行
|
6552
|
+
|
6553
|
+
只有在 CreateInvoker 时才必填,ModifyInvoker 时为非必填
|
6246
6554
|
:type Policy: str
|
6247
6555
|
:param _Recurrence: 触发 Crontab 表达式。Policy 为 RECURRENCE 时,需要指定此字段。Crontab 按北京时间解析。
|
6248
6556
|
:type Recurrence: str
|
6249
6557
|
:param _InvokeTime: 执行器下次执行时间。Policy 为 ONCE 时,需要指定此字段。
|
6558
|
+
|
6559
|
+
时间格式为:YYYY-MM-DDThh:mm:ssZ
|
6250
6560
|
:type InvokeTime: str
|
6251
6561
|
"""
|
6252
6562
|
self._Policy = None
|
@@ -6256,8 +6566,10 @@ class ScheduleSettings(AbstractModel):
|
|
6256
6566
|
@property
|
6257
6567
|
def Policy(self):
|
6258
6568
|
"""执行策略:
|
6259
|
-
|
6260
|
-
|
6569
|
+
- ONCE:单次执行
|
6570
|
+
- RECURRENCE:周期执行
|
6571
|
+
|
6572
|
+
只有在 CreateInvoker 时才必填,ModifyInvoker 时为非必填
|
6261
6573
|
:rtype: str
|
6262
6574
|
"""
|
6263
6575
|
return self._Policy
|
@@ -6280,6 +6592,8 @@ class ScheduleSettings(AbstractModel):
|
|
6280
6592
|
@property
|
6281
6593
|
def InvokeTime(self):
|
6282
6594
|
"""执行器下次执行时间。Policy 为 ONCE 时,需要指定此字段。
|
6595
|
+
|
6596
|
+
时间格式为:YYYY-MM-DDThh:mm:ssZ
|
6283
6597
|
:rtype: str
|
6284
6598
|
"""
|
6285
6599
|
return self._InvokeTime
|
@@ -6365,10 +6679,10 @@ class TaskResult(AbstractModel):
|
|
6365
6679
|
:type ExitCode: int
|
6366
6680
|
:param _Output: Base64编码后的命令输出。最大长度24KB。
|
6367
6681
|
:type Output: str
|
6368
|
-
:param _ExecStartTime:
|
6682
|
+
:param _ExecStartTime: 命令执行开始时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
6369
6683
|
注意:此字段可能返回 null,表示取不到有效值。
|
6370
6684
|
:type ExecStartTime: str
|
6371
|
-
:param _ExecEndTime:
|
6685
|
+
:param _ExecEndTime: 命令执行结束时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
6372
6686
|
注意:此字段可能返回 null,表示取不到有效值。
|
6373
6687
|
:type ExecEndTime: str
|
6374
6688
|
:param _Dropped: 命令最终输出被截断的字节数。
|
@@ -6410,7 +6724,7 @@ class TaskResult(AbstractModel):
|
|
6410
6724
|
|
6411
6725
|
@property
|
6412
6726
|
def ExecStartTime(self):
|
6413
|
-
"""
|
6727
|
+
"""命令执行开始时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
6414
6728
|
注意:此字段可能返回 null,表示取不到有效值。
|
6415
6729
|
:rtype: str
|
6416
6730
|
"""
|
@@ -6422,7 +6736,7 @@ class TaskResult(AbstractModel):
|
|
6422
6736
|
|
6423
6737
|
@property
|
6424
6738
|
def ExecEndTime(self):
|
6425
|
-
"""
|
6739
|
+
"""命令执行结束时间。格式为:YYYY-MM-DDThh:mm:ssZ
|
6426
6740
|
注意:此字段可能返回 null,表示取不到有效值。
|
6427
6741
|
:rtype: str
|
6428
6742
|
"""
|