tencentcloud-sdk-python 3.0.1367__py2.py3-none-any.whl → 3.0.1369__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.
Files changed (36) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/autoscaling/v20180419/autoscaling_client.py +2 -1
  3. tencentcloud/autoscaling/v20180419/models.py +198 -102
  4. tencentcloud/cbs/v20170312/cbs_client.py +1 -1
  5. tencentcloud/cbs/v20170312/models.py +41 -44
  6. tencentcloud/ccc/v20200210/models.py +15 -0
  7. tencentcloud/cdn/v20180606/cdn_client.py +45 -15
  8. tencentcloud/cfs/v20190719/models.py +15 -0
  9. tencentcloud/cvm/v20170312/cvm_client.py +1 -1
  10. tencentcloud/cvm/v20170312/errorcodes.py +1 -1
  11. tencentcloud/cvm/v20170312/models.py +83 -40
  12. tencentcloud/domain/v20180808/domain_client.py +4 -2
  13. tencentcloud/domain/v20180808/errorcodes.py +3 -0
  14. tencentcloud/domain/v20180808/models.py +254 -124
  15. tencentcloud/ioa/v20220601/models.py +19 -4
  16. tencentcloud/iotexplorer/v20190423/models.py +94 -4
  17. tencentcloud/iotvideoindustry/v20201201/models.py +15 -0
  18. tencentcloud/lcic/v20220817/errorcodes.py +1 -1
  19. tencentcloud/lke/v20231130/models.py +10 -2
  20. tencentcloud/mps/v20190612/models.py +2 -2
  21. tencentcloud/ocr/v20181119/models.py +23 -2
  22. tencentcloud/redis/v20180412/models.py +159 -6
  23. tencentcloud/tat/v20201028/errorcodes.py +6 -0
  24. tencentcloud/tat/v20201028/models.py +78 -32
  25. tencentcloud/tcss/v20201101/models.py +45 -0
  26. tencentcloud/teo/v20220901/models.py +35 -10
  27. tencentcloud/trtc/v20190722/models.py +2 -2
  28. tencentcloud/vod/v20180717/models.py +6 -6
  29. tencentcloud/vpc/v20170312/models.py +30 -74
  30. tencentcloud/wedata/v20210820/models.py +322 -0
  31. tencentcloud/wedata/v20210820/wedata_client.py +23 -0
  32. {tencentcloud_sdk_python-3.0.1367.dist-info → tencentcloud_sdk_python-3.0.1369.dist-info}/METADATA +1 -1
  33. {tencentcloud_sdk_python-3.0.1367.dist-info → tencentcloud_sdk_python-3.0.1369.dist-info}/RECORD +36 -36
  34. {tencentcloud_sdk_python-3.0.1367.dist-info → tencentcloud_sdk_python-3.0.1369.dist-info}/LICENSE +0 -0
  35. {tencentcloud_sdk_python-3.0.1367.dist-info → tencentcloud_sdk_python-3.0.1369.dist-info}/WHEEL +0 -0
  36. {tencentcloud_sdk_python-3.0.1367.dist-info → tencentcloud_sdk_python-3.0.1369.dist-info}/top_level.txt +0 -0
@@ -483,9 +483,13 @@ class AttachInstancesRequest(AbstractModel):
483
483
 
484
484
  def __init__(self):
485
485
  r"""
486
- :param _AutoScalingGroupId: 伸缩组ID
486
+ :param _AutoScalingGroupId: 伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
487
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。</li>
488
+ <li>通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。</li>
487
489
  :type AutoScalingGroupId: str
488
- :param _InstanceIds: CVM实例ID列表
490
+ :param _InstanceIds: CVM实例ID列表。可以通过以下方式获取可用的实例ID:
491
+ <li>通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。</li>
492
+ <li>通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `InstanceId` 获取实例ID。</li>
489
493
  :type InstanceIds: list of str
490
494
  """
491
495
  self._AutoScalingGroupId = None
@@ -493,7 +497,9 @@ class AttachInstancesRequest(AbstractModel):
493
497
 
494
498
  @property
495
499
  def AutoScalingGroupId(self):
496
- """伸缩组ID
500
+ """伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
501
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。</li>
502
+ <li>通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。</li>
497
503
  :rtype: str
498
504
  """
499
505
  return self._AutoScalingGroupId
@@ -504,7 +510,9 @@ class AttachInstancesRequest(AbstractModel):
504
510
 
505
511
  @property
506
512
  def InstanceIds(self):
507
- """CVM实例ID列表
513
+ """CVM实例ID列表。可以通过以下方式获取可用的实例ID:
514
+ <li>通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。</li>
515
+ <li>通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `InstanceId` 获取实例ID。</li>
508
516
  :rtype: list of str
509
517
  """
510
518
  return self._InstanceIds
@@ -1500,9 +1508,11 @@ class CancelInstanceRefreshRequest(AbstractModel):
1500
1508
 
1501
1509
  def __init__(self):
1502
1510
  r"""
1503
- :param _AutoScalingGroupId: 伸缩组ID
1511
+ :param _AutoScalingGroupId: 伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
1512
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。</li>
1513
+ <li>通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。</li>
1504
1514
  :type AutoScalingGroupId: str
1505
- :param _RefreshActivityId: 刷新活动ID。
1515
+ :param _RefreshActivityId: 刷新活动ID。可以通过调用接口 [DescribeRefreshActivities](https://cloud.tencent.com/document/api/377/99175) ,取返回信息中的 RefreshActivityId 获取实例刷新活动ID
1506
1516
  :type RefreshActivityId: str
1507
1517
  """
1508
1518
  self._AutoScalingGroupId = None
@@ -1510,7 +1520,9 @@ class CancelInstanceRefreshRequest(AbstractModel):
1510
1520
 
1511
1521
  @property
1512
1522
  def AutoScalingGroupId(self):
1513
- """伸缩组ID
1523
+ """伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
1524
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。</li>
1525
+ <li>通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。</li>
1514
1526
  :rtype: str
1515
1527
  """
1516
1528
  return self._AutoScalingGroupId
@@ -1521,7 +1533,7 @@ class CancelInstanceRefreshRequest(AbstractModel):
1521
1533
 
1522
1534
  @property
1523
1535
  def RefreshActivityId(self):
1524
- """刷新活动ID。
1536
+ """刷新活动ID。可以通过调用接口 [DescribeRefreshActivities](https://cloud.tencent.com/document/api/377/99175) ,取返回信息中的 RefreshActivityId 获取实例刷新活动ID
1525
1537
  :rtype: str
1526
1538
  """
1527
1539
  return self._RefreshActivityId
@@ -1579,7 +1591,9 @@ class ClearLaunchConfigurationAttributesRequest(AbstractModel):
1579
1591
 
1580
1592
  def __init__(self):
1581
1593
  r"""
1582
- :param _LaunchConfigurationId: 启动配置ID
1594
+ :param _LaunchConfigurationId: 启动配置ID。可通过如下方式获取:
1595
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/config) 查询启动配置ID。</li>
1596
+ <li>通过调用接口 [DescribeLaunchConfigurations](https://cloud.tencent.com/document/api/377/20445) ,取返回信息中的 LaunchConfigurationId 获取启动配置ID。</li>
1583
1597
  :type LaunchConfigurationId: str
1584
1598
  :param _ClearDataDisks: 是否清空数据盘信息,非必填,默认为 false。
1585
1599
  填 true 代表清空“数据盘”信息,清空后基于此新创建的云主机将不含有任何数据盘。
@@ -1609,7 +1623,9 @@ class ClearLaunchConfigurationAttributesRequest(AbstractModel):
1609
1623
 
1610
1624
  @property
1611
1625
  def LaunchConfigurationId(self):
1612
- """启动配置ID
1626
+ """启动配置ID。可通过如下方式获取:
1627
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/config) 查询启动配置ID。</li>
1628
+ <li>通过调用接口 [DescribeLaunchConfigurations](https://cloud.tencent.com/document/api/377/20445) ,取返回信息中的 LaunchConfigurationId 获取启动配置ID。</li>
1613
1629
  :rtype: str
1614
1630
  """
1615
1631
  return self._LaunchConfigurationId
@@ -3725,7 +3741,9 @@ class CreateScheduledActionRequest(AbstractModel):
3725
3741
 
3726
3742
  def __init__(self):
3727
3743
  r"""
3728
- :param _AutoScalingGroupId: 伸缩组ID
3744
+ :param _AutoScalingGroupId: 伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
3745
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。</li>
3746
+ <li>通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。</li>
3729
3747
  :type AutoScalingGroupId: str
3730
3748
  :param _ScheduledActionName: 定时任务名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。同一伸缩组下必须唯一。
3731
3749
  :type ScheduledActionName: str
@@ -3739,7 +3757,7 @@ class CreateScheduledActionRequest(AbstractModel):
3739
3757
  :type StartTime: str
3740
3758
  :param _EndTime: 定时任务的结束时间,取值为`北京时间`(UTC+8),按照`ISO8601`标准,格式:`YYYY-MM-DDThh:mm:ss+08:00`。<br><br>此参数与`Recurrence`需要同时指定,到达结束时间之后,定时任务将不再生效。
3741
3759
  :type EndTime: str
3742
- :param _Recurrence: 定时任务的重复方式。为标准 Cron 格式<br><br>此参数与`EndTime`需要同时指定。
3760
+ :param _Recurrence: 定时任务的重复方式。为标准 Cron 格式。定时任务中的 [Recurrence参数限制](https://cloud.tencent.com/document/product/377/88119) 为5个字段,由空格分开,结构为:分,小时,日期,月份,星期。此参数与`EndTime`需要同时指定。
3743
3761
  :type Recurrence: str
3744
3762
  """
3745
3763
  self._AutoScalingGroupId = None
@@ -3753,7 +3771,9 @@ class CreateScheduledActionRequest(AbstractModel):
3753
3771
 
3754
3772
  @property
3755
3773
  def AutoScalingGroupId(self):
3756
- """伸缩组ID
3774
+ """伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
3775
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。</li>
3776
+ <li>通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。</li>
3757
3777
  :rtype: str
3758
3778
  """
3759
3779
  return self._AutoScalingGroupId
@@ -3830,7 +3850,7 @@ class CreateScheduledActionRequest(AbstractModel):
3830
3850
 
3831
3851
  @property
3832
3852
  def Recurrence(self):
3833
- """定时任务的重复方式。为标准 Cron 格式<br><br>此参数与`EndTime`需要同时指定。
3853
+ """定时任务的重复方式。为标准 Cron 格式。定时任务中的 [Recurrence参数限制](https://cloud.tencent.com/document/product/377/88119) 为5个字段,由空格分开,结构为:分,小时,日期,月份,星期。此参数与`EndTime`需要同时指定。
3834
3854
  :rtype: str
3835
3855
  """
3836
3856
  return self._Recurrence
@@ -4395,14 +4415,14 @@ class DeleteScheduledActionRequest(AbstractModel):
4395
4415
 
4396
4416
  def __init__(self):
4397
4417
  r"""
4398
- :param _ScheduledActionId: 待删除的定时任务ID。
4418
+ :param _ScheduledActionId: 待删除的定时任务ID。可以通过调用接口 [DescribeScheduledActions](https://cloud.tencent.com/document/api/377/20450) ,取返回信息中的 ScheduledActionId 获取定时任务ID
4399
4419
  :type ScheduledActionId: str
4400
4420
  """
4401
4421
  self._ScheduledActionId = None
4402
4422
 
4403
4423
  @property
4404
4424
  def ScheduledActionId(self):
4405
- """待删除的定时任务ID。
4425
+ """待删除的定时任务ID。可以通过调用接口 [DescribeScheduledActions](https://cloud.tencent.com/document/api/377/20450) ,取返回信息中的 ScheduledActionId 获取定时任务ID
4406
4426
  :rtype: str
4407
4427
  """
4408
4428
  return self._ScheduledActionId
@@ -6023,9 +6043,9 @@ class DescribeScheduledActionsRequest(AbstractModel):
6023
6043
 
6024
6044
  def __init__(self):
6025
6045
  r"""
6026
- :param _ScheduledActionIds: 按照一个或者多个定时任务ID查询。实例ID形如:asst-am691zxo。每次请求的实例的上限为100。参数不支持同时指定ScheduledActionIds和Filters。
6046
+ :param _ScheduledActionIds: 按照一个或者多个定时任务ID查询。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 获取定时任务 ID。每次请求的实例的上限为100。参数不支持同时指定ScheduledActionIds和Filters。
6027
6047
  :type ScheduledActionIds: list of str
6028
- :param _Filters: 过滤条件。
6048
+ :param _Filters: 过滤条件。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 获取定时任务 ID,定时任务名称,伸缩组 ID。
6029
6049
  <li> scheduled-action-id - String - 是否必填:否 -(过滤条件)按照定时任务ID过滤。</li>
6030
6050
  <li> scheduled-action-name - String - 是否必填:否 - (过滤条件) 按照定时任务名称过滤。</li>
6031
6051
  <li> auto-scaling-group-id - String - 是否必填:否 - (过滤条件) 按照伸缩组ID过滤。</li>
@@ -6042,7 +6062,7 @@ class DescribeScheduledActionsRequest(AbstractModel):
6042
6062
 
6043
6063
  @property
6044
6064
  def ScheduledActionIds(self):
6045
- """按照一个或者多个定时任务ID查询。实例ID形如:asst-am691zxo。每次请求的实例的上限为100。参数不支持同时指定ScheduledActionIds和Filters。
6065
+ """按照一个或者多个定时任务ID查询。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 获取定时任务 ID。每次请求的实例的上限为100。参数不支持同时指定ScheduledActionIds和Filters。
6046
6066
  :rtype: list of str
6047
6067
  """
6048
6068
  return self._ScheduledActionIds
@@ -6053,7 +6073,7 @@ class DescribeScheduledActionsRequest(AbstractModel):
6053
6073
 
6054
6074
  @property
6055
6075
  def Filters(self):
6056
- """过滤条件。
6076
+ """过滤条件。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 获取定时任务 ID,定时任务名称,伸缩组 ID。
6057
6077
  <li> scheduled-action-id - String - 是否必填:否 -(过滤条件)按照定时任务ID过滤。</li>
6058
6078
  <li> scheduled-action-name - String - 是否必填:否 - (过滤条件) 按照定时任务名称过滤。</li>
6059
6079
  <li> auto-scaling-group-id - String - 是否必填:否 - (过滤条件) 按照伸缩组ID过滤。</li>
@@ -6178,9 +6198,13 @@ class DetachInstancesRequest(AbstractModel):
6178
6198
 
6179
6199
  def __init__(self):
6180
6200
  r"""
6181
- :param _AutoScalingGroupId: 伸缩组ID
6201
+ :param _AutoScalingGroupId: 伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
6202
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。</li>
6203
+ <li>通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。</li>
6182
6204
  :type AutoScalingGroupId: str
6183
- :param _InstanceIds: CVM实例ID列表
6205
+ :param _InstanceIds: CVM实例ID列表。可以通过以下方式获取可用的实例ID:
6206
+ <li>通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。</li>
6207
+ <li>通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `InstanceId` 获取实例ID。</li>
6184
6208
  :type InstanceIds: list of str
6185
6209
  """
6186
6210
  self._AutoScalingGroupId = None
@@ -6188,7 +6212,9 @@ class DetachInstancesRequest(AbstractModel):
6188
6212
 
6189
6213
  @property
6190
6214
  def AutoScalingGroupId(self):
6191
- """伸缩组ID
6215
+ """伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
6216
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。</li>
6217
+ <li>通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。</li>
6192
6218
  :rtype: str
6193
6219
  """
6194
6220
  return self._AutoScalingGroupId
@@ -6199,7 +6225,9 @@ class DetachInstancesRequest(AbstractModel):
6199
6225
 
6200
6226
  @property
6201
6227
  def InstanceIds(self):
6202
- """CVM实例ID列表
6228
+ """CVM实例ID列表。可以通过以下方式获取可用的实例ID:
6229
+ <li>通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。</li>
6230
+ <li>通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `InstanceId` 获取实例ID。</li>
6203
6231
  :rtype: list of str
6204
6232
  """
6205
6233
  return self._InstanceIds
@@ -6736,9 +6764,13 @@ class EnterStandbyRequest(AbstractModel):
6736
6764
 
6737
6765
  def __init__(self):
6738
6766
  r"""
6739
- :param _AutoScalingGroupId: 伸缩组 ID
6767
+ :param _AutoScalingGroupId: 伸缩组 ID。可以通过如下方式获取可用的伸缩组ID:
6768
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。</li>
6769
+ <li>通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。</li>
6740
6770
  :type AutoScalingGroupId: str
6741
- :param _InstanceIds: 运行中状态实例列表,不支持传入非运行中状态实例。
6771
+ :param _InstanceIds: 运行中状态实例列表,不支持传入非运行中状态实例。可以通过以下方式获取可用的实例ID:
6772
+ <li>通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。</li>
6773
+ <li>通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `InstanceId` 获取实例ID。</li>
6742
6774
  :type InstanceIds: list of str
6743
6775
  """
6744
6776
  self._AutoScalingGroupId = None
@@ -6746,7 +6778,9 @@ class EnterStandbyRequest(AbstractModel):
6746
6778
 
6747
6779
  @property
6748
6780
  def AutoScalingGroupId(self):
6749
- """伸缩组 ID
6781
+ """伸缩组 ID。可以通过如下方式获取可用的伸缩组ID:
6782
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。</li>
6783
+ <li>通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。</li>
6750
6784
  :rtype: str
6751
6785
  """
6752
6786
  return self._AutoScalingGroupId
@@ -6757,7 +6791,9 @@ class EnterStandbyRequest(AbstractModel):
6757
6791
 
6758
6792
  @property
6759
6793
  def InstanceIds(self):
6760
- """运行中状态实例列表,不支持传入非运行中状态实例。
6794
+ """运行中状态实例列表,不支持传入非运行中状态实例。可以通过以下方式获取可用的实例ID:
6795
+ <li>通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。</li>
6796
+ <li>通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `InstanceId` 获取实例ID。</li>
6761
6797
  :rtype: list of str
6762
6798
  """
6763
6799
  return self._InstanceIds
@@ -6939,9 +6975,13 @@ class ExitStandbyRequest(AbstractModel):
6939
6975
 
6940
6976
  def __init__(self):
6941
6977
  r"""
6942
- :param _AutoScalingGroupId: 伸缩组 ID
6978
+ :param _AutoScalingGroupId: 伸缩组 ID。可以通过如下方式获取可用的伸缩组ID:
6979
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。</li>
6980
+ <li>通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。</li>
6943
6981
  :type AutoScalingGroupId: str
6944
- :param _InstanceIds: 备用中状态 CVM 实例列表。
6982
+ :param _InstanceIds: 备用中状态 CVM 实例列表。可以通过以下方式获取可用的实例ID:
6983
+ <li>通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。</li>
6984
+ <li>通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `InstanceId` 获取实例ID。</li>
6945
6985
  :type InstanceIds: list of str
6946
6986
  """
6947
6987
  self._AutoScalingGroupId = None
@@ -6949,7 +6989,9 @@ class ExitStandbyRequest(AbstractModel):
6949
6989
 
6950
6990
  @property
6951
6991
  def AutoScalingGroupId(self):
6952
- """伸缩组 ID
6992
+ """伸缩组 ID。可以通过如下方式获取可用的伸缩组ID:
6993
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。</li>
6994
+ <li>通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。</li>
6953
6995
  :rtype: str
6954
6996
  """
6955
6997
  return self._AutoScalingGroupId
@@ -6960,7 +7002,9 @@ class ExitStandbyRequest(AbstractModel):
6960
7002
 
6961
7003
  @property
6962
7004
  def InstanceIds(self):
6963
- """备用中状态 CVM 实例列表。
7005
+ """备用中状态 CVM 实例列表。可以通过以下方式获取可用的实例ID:
7006
+ <li>通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。</li>
7007
+ <li>通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `InstanceId` 获取实例ID。</li>
6964
7008
  :rtype: list of str
6965
7009
  """
6966
7010
  return self._InstanceIds
@@ -10583,27 +10627,27 @@ class ModifyLifecycleHookRequest(AbstractModel):
10583
10627
 
10584
10628
  def __init__(self):
10585
10629
  r"""
10586
- :param _LifecycleHookId: 生命周期挂钩ID。
10630
+ :param _LifecycleHookId: 生命周期挂钩ID。可以通过调用接口 [DescribeLifecycleHooks](https://cloud.tencent.com/document/api/377/34452) ,取返回信息中的 LifecycleHookId 获取生命周期挂钩ID
10587
10631
  :type LifecycleHookId: str
10588
- :param _LifecycleHookName: 生命周期挂钩名称。
10632
+ :param _LifecycleHookName: 生命周期挂钩名称。名称仅支持中文、英文、数字、下划线(_)、短横线(-)、小数点(.),最大长度不能超128。
10589
10633
  :type LifecycleHookName: str
10590
- :param _LifecycleTransition: 进入生命周期挂钩场景,取值包括:
10591
- <li> INSTANCE_LAUNCHING:实例启动后</li>
10592
- <li> INSTANCE_TERMINATING:实例销毁前</li>
10634
+ :param _LifecycleTransition: 进入生命周期挂钩场景,取值范围如下:
10635
+ * INSTANCE_LAUNCHING: 扩容生命周期挂钩
10636
+ * INSTANCE_TERMINATING: 缩容生命周期挂钩
10593
10637
  :type LifecycleTransition: str
10594
- :param _DefaultResult: 定义伸缩组在生命周期挂钩超时的情况下应采取的操作,取值包括:
10595
- <li> CONTINUE 超时后继续伸缩活动</li>
10596
- <li> ABANDON:超时后终止伸缩活动</li>
10638
+ :param _DefaultResult: 定义伸缩组在生命周期挂钩超时或 LifecycleCommand 执行失败时应采取的操作,取值范围如下:
10639
+ * CONTINUE: 默认值,表示继续执行扩缩容活动
10640
+ * ABANDON: 针对扩容挂钩,挂钩超时或 LifecycleCommand 执行失败的 CVM 实例会直接释放或移出;而针对缩容挂钩,会继续执行缩容活动。
10597
10641
  :type DefaultResult: str
10598
10642
  :param _HeartbeatTimeout: 生命周期挂钩超时之前可以经过的最长时间(以秒为单位),范围从 30 到 7200 秒。
10599
10643
  :type HeartbeatTimeout: int
10600
- :param _NotificationMetadata: 弹性伸缩向通知目标发送的附加信息。
10644
+ :param _NotificationMetadata: 弹性伸缩向通知目标发送的附加信息。NotificationMetadata 与 LifecycleCommand互斥,二者不可同时指定。
10601
10645
  :type NotificationMetadata: str
10602
10646
  :param _LifecycleTransitionType: 进行生命周期挂钩的场景类型,取值范围包括`NORMAL`和 `EXTENSION`。说明:设置为`EXTENSION`值,在AttachInstances、DetachInstances、RemoveInstances 接口时会触发生命周期挂钩操作,值为`NORMAL`则不会在这些接口中触发生命周期挂钩。
10603
10647
  :type LifecycleTransitionType: str
10604
- :param _NotificationTarget: 通知目标信息。
10648
+ :param _NotificationTarget: 通知目标信息。NotificationTarget 与 LifecycleCommand互斥,二者不可同时指定。
10605
10649
  :type NotificationTarget: :class:`tencentcloud.autoscaling.v20180419.models.NotificationTarget`
10606
- :param _LifecycleCommand: 远程命令执行对象。
10650
+ :param _LifecycleCommand: 远程命令执行对象。通知参数 NotificationMetadata、NotificationTarget 与 LifecycleCommand互斥,不可同时指定。
10607
10651
  :type LifecycleCommand: :class:`tencentcloud.autoscaling.v20180419.models.LifecycleCommand`
10608
10652
  """
10609
10653
  self._LifecycleHookId = None
@@ -10618,7 +10662,7 @@ class ModifyLifecycleHookRequest(AbstractModel):
10618
10662
 
10619
10663
  @property
10620
10664
  def LifecycleHookId(self):
10621
- """生命周期挂钩ID。
10665
+ """生命周期挂钩ID。可以通过调用接口 [DescribeLifecycleHooks](https://cloud.tencent.com/document/api/377/34452) ,取返回信息中的 LifecycleHookId 获取生命周期挂钩ID
10622
10666
  :rtype: str
10623
10667
  """
10624
10668
  return self._LifecycleHookId
@@ -10629,7 +10673,7 @@ class ModifyLifecycleHookRequest(AbstractModel):
10629
10673
 
10630
10674
  @property
10631
10675
  def LifecycleHookName(self):
10632
- """生命周期挂钩名称。
10676
+ """生命周期挂钩名称。名称仅支持中文、英文、数字、下划线(_)、短横线(-)、小数点(.),最大长度不能超128。
10633
10677
  :rtype: str
10634
10678
  """
10635
10679
  return self._LifecycleHookName
@@ -10640,9 +10684,9 @@ class ModifyLifecycleHookRequest(AbstractModel):
10640
10684
 
10641
10685
  @property
10642
10686
  def LifecycleTransition(self):
10643
- """进入生命周期挂钩场景,取值包括:
10644
- <li> INSTANCE_LAUNCHING:实例启动后</li>
10645
- <li> INSTANCE_TERMINATING:实例销毁前</li>
10687
+ """进入生命周期挂钩场景,取值范围如下:
10688
+ * INSTANCE_LAUNCHING: 扩容生命周期挂钩
10689
+ * INSTANCE_TERMINATING: 缩容生命周期挂钩
10646
10690
  :rtype: str
10647
10691
  """
10648
10692
  return self._LifecycleTransition
@@ -10653,9 +10697,9 @@ class ModifyLifecycleHookRequest(AbstractModel):
10653
10697
 
10654
10698
  @property
10655
10699
  def DefaultResult(self):
10656
- """定义伸缩组在生命周期挂钩超时的情况下应采取的操作,取值包括:
10657
- <li> CONTINUE 超时后继续伸缩活动</li>
10658
- <li> ABANDON:超时后终止伸缩活动</li>
10700
+ """定义伸缩组在生命周期挂钩超时或 LifecycleCommand 执行失败时应采取的操作,取值范围如下:
10701
+ * CONTINUE: 默认值,表示继续执行扩缩容活动
10702
+ * ABANDON: 针对扩容挂钩,挂钩超时或 LifecycleCommand 执行失败的 CVM 实例会直接释放或移出;而针对缩容挂钩,会继续执行缩容活动。
10659
10703
  :rtype: str
10660
10704
  """
10661
10705
  return self._DefaultResult
@@ -10677,7 +10721,7 @@ class ModifyLifecycleHookRequest(AbstractModel):
10677
10721
 
10678
10722
  @property
10679
10723
  def NotificationMetadata(self):
10680
- """弹性伸缩向通知目标发送的附加信息。
10724
+ """弹性伸缩向通知目标发送的附加信息。NotificationMetadata 与 LifecycleCommand互斥,二者不可同时指定。
10681
10725
  :rtype: str
10682
10726
  """
10683
10727
  return self._NotificationMetadata
@@ -10699,7 +10743,7 @@ class ModifyLifecycleHookRequest(AbstractModel):
10699
10743
 
10700
10744
  @property
10701
10745
  def NotificationTarget(self):
10702
- """通知目标信息。
10746
+ """通知目标信息。NotificationTarget 与 LifecycleCommand互斥,二者不可同时指定。
10703
10747
  :rtype: :class:`tencentcloud.autoscaling.v20180419.models.NotificationTarget`
10704
10748
  """
10705
10749
  return self._NotificationTarget
@@ -10710,7 +10754,7 @@ class ModifyLifecycleHookRequest(AbstractModel):
10710
10754
 
10711
10755
  @property
10712
10756
  def LifecycleCommand(self):
10713
- """远程命令执行对象。
10757
+ """远程命令执行对象。通知参数 NotificationMetadata、NotificationTarget 与 LifecycleCommand互斥,不可同时指定。
10714
10758
  :rtype: :class:`tencentcloud.autoscaling.v20180419.models.LifecycleCommand`
10715
10759
  """
10716
10760
  return self._LifecycleCommand
@@ -11365,7 +11409,7 @@ class ModifyScheduledActionRequest(AbstractModel):
11365
11409
 
11366
11410
  def __init__(self):
11367
11411
  r"""
11368
- :param _ScheduledActionId: 待修改的定时任务ID
11412
+ :param _ScheduledActionId: 待修改的定时任务ID。可以通过调用接口 [DescribeScheduledActions](https://cloud.tencent.com/document/api/377/20450) ,取返回信息中的 ScheduledActionId 获取定时任务ID。
11369
11413
  :type ScheduledActionId: str
11370
11414
  :param _ScheduledActionName: 定时任务名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。同一伸缩组下必须唯一。
11371
11415
  :type ScheduledActionName: str
@@ -11379,7 +11423,7 @@ class ModifyScheduledActionRequest(AbstractModel):
11379
11423
  :type StartTime: str
11380
11424
  :param _EndTime: 定时任务的结束时间,取值为`北京时间`(UTC+8),按照`ISO8601`标准,格式:`YYYY-MM-DDThh:mm:ss+08:00`。<br>此参数与`Recurrence`需要同时指定,到达结束时间之后,定时任务将不再生效。
11381
11425
  :type EndTime: str
11382
- :param _Recurrence: 定时任务的重复方式。为标准 Cron 格式<br>此参数与`EndTime`需要同时指定。
11426
+ :param _Recurrence: 定时任务的重复方式。为标准 Cron 格式,[Recurrence参数限制](https://cloud.tencent.com/document/product/377/88119)为5个字段,由空格分开,结构为:分,小时,日期,月份,星期。此参数与`EndTime`需要同时指定。
11383
11427
  :type Recurrence: str
11384
11428
  """
11385
11429
  self._ScheduledActionId = None
@@ -11393,7 +11437,7 @@ class ModifyScheduledActionRequest(AbstractModel):
11393
11437
 
11394
11438
  @property
11395
11439
  def ScheduledActionId(self):
11396
- """待修改的定时任务ID
11440
+ """待修改的定时任务ID。可以通过调用接口 [DescribeScheduledActions](https://cloud.tencent.com/document/api/377/20450) ,取返回信息中的 ScheduledActionId 获取定时任务ID。
11397
11441
  :rtype: str
11398
11442
  """
11399
11443
  return self._ScheduledActionId
@@ -11470,7 +11514,7 @@ class ModifyScheduledActionRequest(AbstractModel):
11470
11514
 
11471
11515
  @property
11472
11516
  def Recurrence(self):
11473
- """定时任务的重复方式。为标准 Cron 格式<br>此参数与`EndTime`需要同时指定。
11517
+ """定时任务的重复方式。为标准 Cron 格式,[Recurrence参数限制](https://cloud.tencent.com/document/product/377/88119)为5个字段,由空格分开,结构为:分,小时,日期,月份,星期。此参数与`EndTime`需要同时指定。
11474
11518
  :rtype: str
11475
11519
  """
11476
11520
  return self._Recurrence
@@ -12140,9 +12184,13 @@ class RemoveInstancesRequest(AbstractModel):
12140
12184
 
12141
12185
  def __init__(self):
12142
12186
  r"""
12143
- :param _AutoScalingGroupId: 伸缩组ID
12187
+ :param _AutoScalingGroupId: 伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
12188
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。</li>
12189
+ <li>通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。</li>
12144
12190
  :type AutoScalingGroupId: str
12145
- :param _InstanceIds: CVM实例ID列表
12191
+ :param _InstanceIds: CVM实例ID列表。可以通过以下方式获取可用的实例ID:
12192
+ <li>通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。</li>
12193
+ <li>通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `InstanceId` 获取实例ID。</li>
12146
12194
  :type InstanceIds: list of str
12147
12195
  """
12148
12196
  self._AutoScalingGroupId = None
@@ -12150,7 +12198,9 @@ class RemoveInstancesRequest(AbstractModel):
12150
12198
 
12151
12199
  @property
12152
12200
  def AutoScalingGroupId(self):
12153
- """伸缩组ID
12201
+ """伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
12202
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。</li>
12203
+ <li>通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。</li>
12154
12204
  :rtype: str
12155
12205
  """
12156
12206
  return self._AutoScalingGroupId
@@ -12161,7 +12211,9 @@ class RemoveInstancesRequest(AbstractModel):
12161
12211
 
12162
12212
  @property
12163
12213
  def InstanceIds(self):
12164
- """CVM实例ID列表
12214
+ """CVM实例ID列表。可以通过以下方式获取可用的实例ID:
12215
+ <li>通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。</li>
12216
+ <li>通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `InstanceId` 获取实例ID。</li>
12165
12217
  :rtype: list of str
12166
12218
  """
12167
12219
  return self._InstanceIds
@@ -12234,9 +12286,11 @@ class ResumeInstanceRefreshRequest(AbstractModel):
12234
12286
 
12235
12287
  def __init__(self):
12236
12288
  r"""
12237
- :param _AutoScalingGroupId: 伸缩组ID
12289
+ :param _AutoScalingGroupId: 伸缩组ID。可通过如下方式获取:
12290
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。</li>
12291
+ <li>通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。</li>
12238
12292
  :type AutoScalingGroupId: str
12239
- :param _RefreshActivityId: 刷新活动ID。
12293
+ :param _RefreshActivityId: 刷新活动ID。可以通过调用接口 [DescribeRefreshActivities](https://cloud.tencent.com/document/api/377/99175) ,取返回信息中的 RefreshActivityId 获取实例刷新活动ID
12240
12294
  :type RefreshActivityId: str
12241
12295
  :param _ResumeMode: 当前批次刷新失败实例的恢复方式,如不存在失败实例,该参数无效。默认值为RETRY,取值范围如下:<li>RETRY: 重试当前批次刷新失败实例</li><li>CONTINUE: 跳过当前批次刷新失败实例</li>
12242
12296
  :type ResumeMode: str
@@ -12247,7 +12301,9 @@ class ResumeInstanceRefreshRequest(AbstractModel):
12247
12301
 
12248
12302
  @property
12249
12303
  def AutoScalingGroupId(self):
12250
- """伸缩组ID
12304
+ """伸缩组ID。可通过如下方式获取:
12305
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。</li>
12306
+ <li>通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。</li>
12251
12307
  :rtype: str
12252
12308
  """
12253
12309
  return self._AutoScalingGroupId
@@ -12258,7 +12314,7 @@ class ResumeInstanceRefreshRequest(AbstractModel):
12258
12314
 
12259
12315
  @property
12260
12316
  def RefreshActivityId(self):
12261
- """刷新活动ID。
12317
+ """刷新活动ID。可以通过调用接口 [DescribeRefreshActivities](https://cloud.tencent.com/document/api/377/99175) ,取返回信息中的 RefreshActivityId 获取实例刷新活动ID
12262
12318
  :rtype: str
12263
12319
  """
12264
12320
  return self._RefreshActivityId
@@ -12328,11 +12384,13 @@ class RollbackInstanceRefreshRequest(AbstractModel):
12328
12384
 
12329
12385
  def __init__(self):
12330
12386
  r"""
12331
- :param _AutoScalingGroupId: 伸缩组ID
12387
+ :param _AutoScalingGroupId: 伸缩组ID。可以通过以下方式获取可用的伸缩组ID:
12388
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。</li>
12389
+ <li>通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。</li>
12332
12390
  :type AutoScalingGroupId: str
12333
12391
  :param _RefreshSettings: 刷新设置。
12334
12392
  :type RefreshSettings: :class:`tencentcloud.autoscaling.v20180419.models.RefreshSettings`
12335
- :param _OriginRefreshActivityId: 原始刷新活动 ID。
12393
+ :param _OriginRefreshActivityId: 原始刷新活动 ID。可以通过调用接口 [DescribeRefreshActivities](https://cloud.tencent.com/document/api/377/99175) ,取返回信息中的 OriginRefreshActivityId 获取原始刷新活动ID
12336
12394
  :type OriginRefreshActivityId: str
12337
12395
  :param _RefreshMode: 刷新模式,目前仅支持滚动更新,默认值为 ROLLING_UPDATE_RESET。
12338
12396
  :type RefreshMode: str
@@ -12344,7 +12402,9 @@ class RollbackInstanceRefreshRequest(AbstractModel):
12344
12402
 
12345
12403
  @property
12346
12404
  def AutoScalingGroupId(self):
12347
- """伸缩组ID
12405
+ """伸缩组ID。可以通过以下方式获取可用的伸缩组ID:
12406
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。</li>
12407
+ <li>通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。</li>
12348
12408
  :rtype: str
12349
12409
  """
12350
12410
  return self._AutoScalingGroupId
@@ -12366,7 +12426,7 @@ class RollbackInstanceRefreshRequest(AbstractModel):
12366
12426
 
12367
12427
  @property
12368
12428
  def OriginRefreshActivityId(self):
12369
- """原始刷新活动 ID。
12429
+ """原始刷新活动 ID。可以通过调用接口 [DescribeRefreshActivities](https://cloud.tencent.com/document/api/377/99175) ,取返回信息中的 OriginRefreshActivityId 获取原始刷新活动ID
12370
12430
  :rtype: str
12371
12431
  """
12372
12432
  return self._OriginRefreshActivityId
@@ -13119,7 +13179,7 @@ class ScheduledAction(AbstractModel):
13119
13179
  :type AutoScalingGroupId: str
13120
13180
  :param _StartTime: 定时任务的开始时间。取值为`北京时间`(UTC+8),按照`ISO8601`标准,格式:`YYYY-MM-DDThh:mm:ss+08:00`。
13121
13181
  :type StartTime: str
13122
- :param _Recurrence: 定时任务的重复方式。
13182
+ :param _Recurrence: 定时任务的重复方式。定时任务中的[Recurrence参数限制](https://cloud.tencent.com/document/product/377/88119)为5个字段,由空格分开,结构为:分,小时,日期,月份,星期。
13123
13183
  :type Recurrence: str
13124
13184
  :param _EndTime: 定时任务的结束时间。取值为`北京时间`(UTC+8),按照`ISO8601`标准,格式:`YYYY-MM-DDThh:mm:ss+08:00`。
13125
13185
  :type EndTime: str
@@ -13129,7 +13189,7 @@ class ScheduledAction(AbstractModel):
13129
13189
  :type DesiredCapacity: int
13130
13190
  :param _MinSize: 定时任务设置的最小实例数。
13131
13191
  :type MinSize: int
13132
- :param _CreatedTime: 定时任务的创建时间。取值为`UTC`时间,按照`ISO8601`标准,格式:`YYYY-MM-DDThh:mm:ssZ`。
13192
+ :param _CreatedTime: 定时任务的创建时间。取值为标准`UTC`时间,按照`ISO8601`标准,格式:`YYYY-MM-DDThh:mm:ssZ`。
13133
13193
  :type CreatedTime: str
13134
13194
  :param _ScheduledType: 定时任务的执行类型。取值范围:
13135
13195
  <li>CRONTAB:代表定时任务为重复执行。</li>
@@ -13194,7 +13254,7 @@ class ScheduledAction(AbstractModel):
13194
13254
 
13195
13255
  @property
13196
13256
  def Recurrence(self):
13197
- """定时任务的重复方式。
13257
+ """定时任务的重复方式。定时任务中的[Recurrence参数限制](https://cloud.tencent.com/document/product/377/88119)为5个字段,由空格分开,结构为:分,小时,日期,月份,星期。
13198
13258
  :rtype: str
13199
13259
  """
13200
13260
  return self._Recurrence
@@ -13249,7 +13309,7 @@ class ScheduledAction(AbstractModel):
13249
13309
 
13250
13310
  @property
13251
13311
  def CreatedTime(self):
13252
- """定时任务的创建时间。取值为`UTC`时间,按照`ISO8601`标准,格式:`YYYY-MM-DDThh:mm:ssZ`。
13312
+ """定时任务的创建时间。取值为标准`UTC`时间,按照`ISO8601`标准,格式:`YYYY-MM-DDThh:mm:ssZ`。
13253
13313
  :rtype: str
13254
13314
  """
13255
13315
  return self._CreatedTime
@@ -13428,9 +13488,13 @@ class SetInstancesProtectionRequest(AbstractModel):
13428
13488
 
13429
13489
  def __init__(self):
13430
13490
  r"""
13431
- :param _AutoScalingGroupId: 伸缩组ID
13491
+ :param _AutoScalingGroupId: 伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
13492
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。</li>
13493
+ <li>通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。</li>
13432
13494
  :type AutoScalingGroupId: str
13433
- :param _InstanceIds: 实例ID
13495
+ :param _InstanceIds: 实例ID。可以通过以下方式获取可用的实例ID:
13496
+ <li>通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。</li>
13497
+ <li>通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `InstanceId` 获取实例ID。</li>
13434
13498
  :type InstanceIds: list of str
13435
13499
  :param _ProtectedFromScaleIn: 实例是否需要设置保护。
13436
13500
  :type ProtectedFromScaleIn: bool
@@ -13441,7 +13505,9 @@ class SetInstancesProtectionRequest(AbstractModel):
13441
13505
 
13442
13506
  @property
13443
13507
  def AutoScalingGroupId(self):
13444
- """伸缩组ID
13508
+ """伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
13509
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。</li>
13510
+ <li>通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。</li>
13445
13511
  :rtype: str
13446
13512
  """
13447
13513
  return self._AutoScalingGroupId
@@ -13452,7 +13518,9 @@ class SetInstancesProtectionRequest(AbstractModel):
13452
13518
 
13453
13519
  @property
13454
13520
  def InstanceIds(self):
13455
- """实例ID
13521
+ """实例ID。可以通过以下方式获取可用的实例ID:
13522
+ <li>通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。</li>
13523
+ <li>通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `InstanceId` 获取实例ID。</li>
13456
13524
  :rtype: list of str
13457
13525
  """
13458
13526
  return self._InstanceIds
@@ -13676,9 +13744,13 @@ class StartAutoScalingInstancesRequest(AbstractModel):
13676
13744
 
13677
13745
  def __init__(self):
13678
13746
  r"""
13679
- :param _AutoScalingGroupId: 伸缩组ID
13747
+ :param _AutoScalingGroupId: 伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
13748
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。</li>
13749
+ <li>通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。</li>
13680
13750
  :type AutoScalingGroupId: str
13681
- :param _InstanceIds: 待开启的CVM实例ID列表
13751
+ :param _InstanceIds: 待开启的CVM实例ID列表。可以通过以下方式获取可用的实例ID:
13752
+ <li>通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。</li>
13753
+ <li>通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `InstanceId` 获取实例ID。</li>
13682
13754
  :type InstanceIds: list of str
13683
13755
  """
13684
13756
  self._AutoScalingGroupId = None
@@ -13686,7 +13758,9 @@ class StartAutoScalingInstancesRequest(AbstractModel):
13686
13758
 
13687
13759
  @property
13688
13760
  def AutoScalingGroupId(self):
13689
- """伸缩组ID
13761
+ """伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
13762
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。</li>
13763
+ <li>通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。</li>
13690
13764
  :rtype: str
13691
13765
  """
13692
13766
  return self._AutoScalingGroupId
@@ -13697,7 +13771,9 @@ class StartAutoScalingInstancesRequest(AbstractModel):
13697
13771
 
13698
13772
  @property
13699
13773
  def InstanceIds(self):
13700
- """待开启的CVM实例ID列表
13774
+ """待开启的CVM实例ID列表。可以通过以下方式获取可用的实例ID:
13775
+ <li>通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。</li>
13776
+ <li>通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `InstanceId` 获取实例ID。</li>
13701
13777
  :rtype: list of str
13702
13778
  """
13703
13779
  return self._InstanceIds
@@ -13885,9 +13961,13 @@ class StopAutoScalingInstancesRequest(AbstractModel):
13885
13961
 
13886
13962
  def __init__(self):
13887
13963
  r"""
13888
- :param _AutoScalingGroupId: 伸缩组ID
13964
+ :param _AutoScalingGroupId: 伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
13965
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。</li>
13966
+ <li>通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。</li>
13889
13967
  :type AutoScalingGroupId: str
13890
- :param _InstanceIds: 待关闭的CVM实例ID列表
13968
+ :param _InstanceIds: 待关闭的CVM实例ID列表。可以通过以下方式获取可用的实例ID:
13969
+ <li>通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。</li>
13970
+ <li>通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `InstanceId` 获取实例ID。</li>
13891
13971
  :type InstanceIds: list of str
13892
13972
  :param _StoppedMode: 关闭的实例是否收费,取值为:
13893
13973
  KEEP_CHARGING:关机继续收费
@@ -13901,7 +13981,9 @@ STOP_CHARGING:关机停止收费
13901
13981
 
13902
13982
  @property
13903
13983
  def AutoScalingGroupId(self):
13904
- """伸缩组ID
13984
+ """伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
13985
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。</li>
13986
+ <li>通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。</li>
13905
13987
  :rtype: str
13906
13988
  """
13907
13989
  return self._AutoScalingGroupId
@@ -13912,7 +13994,9 @@ STOP_CHARGING:关机停止收费
13912
13994
 
13913
13995
  @property
13914
13996
  def InstanceIds(self):
13915
- """待关闭的CVM实例ID列表
13997
+ """待关闭的CVM实例ID列表。可以通过以下方式获取可用的实例ID:
13998
+ <li>通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。</li>
13999
+ <li>通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `InstanceId` 获取实例ID。</li>
13916
14000
  :rtype: list of str
13917
14001
  """
13918
14002
  return self._InstanceIds
@@ -14000,9 +14084,11 @@ class StopInstanceRefreshRequest(AbstractModel):
14000
14084
 
14001
14085
  def __init__(self):
14002
14086
  r"""
14003
- :param _AutoScalingGroupId: 伸缩组ID
14087
+ :param _AutoScalingGroupId: 伸缩组ID。可以通过以下方式获取可用的伸缩组ID:
14088
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。</li>
14089
+ <li>通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。</li>
14004
14090
  :type AutoScalingGroupId: str
14005
- :param _RefreshActivityId: 刷新活动ID。
14091
+ :param _RefreshActivityId: 刷新活动ID。可以通过调用接口 [DescribeRefreshActivities](https://cloud.tencent.com/document/api/377/99175) ,取返回信息中的 RefreshActivityId 获取实例刷新活动ID
14006
14092
  :type RefreshActivityId: str
14007
14093
  """
14008
14094
  self._AutoScalingGroupId = None
@@ -14010,7 +14096,9 @@ class StopInstanceRefreshRequest(AbstractModel):
14010
14096
 
14011
14097
  @property
14012
14098
  def AutoScalingGroupId(self):
14013
- """伸缩组ID
14099
+ """伸缩组ID。可以通过以下方式获取可用的伸缩组ID:
14100
+ <li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。</li>
14101
+ <li>通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。</li>
14014
14102
  :rtype: str
14015
14103
  """
14016
14104
  return self._AutoScalingGroupId
@@ -14021,7 +14109,7 @@ class StopInstanceRefreshRequest(AbstractModel):
14021
14109
 
14022
14110
  @property
14023
14111
  def RefreshActivityId(self):
14024
- """刷新活动ID。
14112
+ """刷新活动ID。可以通过调用接口 [DescribeRefreshActivities](https://cloud.tencent.com/document/api/377/99175) ,取返回信息中的 RefreshActivityId 获取实例刷新活动ID
14025
14113
  :rtype: str
14026
14114
  """
14027
14115
  return self._RefreshActivityId
@@ -14686,23 +14774,27 @@ class UpgradeLifecycleHookRequest(AbstractModel):
14686
14774
 
14687
14775
  def __init__(self):
14688
14776
  r"""
14689
- :param _LifecycleHookId: 生命周期挂钩ID
14777
+ :param _LifecycleHookId: 生命周期挂钩ID。可以通过调用接口 [DescribeLifecycleHooks](https://cloud.tencent.com/document/api/377/34452) ,取返回信息中的 LifecycleHookId 获取生命周期挂钩ID。
14690
14778
  :type LifecycleHookId: str
14691
- :param _LifecycleHookName: 生命周期挂钩名称
14779
+ :param _LifecycleHookName: 生命周期挂钩名称。名称仅支持中文、英文、数字、下划线(_)、短横线(-)、小数点(.),最大长度不能超128个字符。
14692
14780
  :type LifecycleHookName: str
14693
- :param _LifecycleTransition: 进行生命周期挂钩的场景,取值范围包括“INSTANCE_LAUNCHING”和“INSTANCE_TERMINATING”
14781
+ :param _LifecycleTransition: 进行生命周期挂钩的场景,取值范围如下:
14782
+ * INSTANCE_LAUNCHING: 扩容生命周期挂钩
14783
+ * INSTANCE_TERMINATING: 缩容生命周期挂钩
14694
14784
  :type LifecycleTransition: str
14695
- :param _DefaultResult: 定义伸缩组在生命周期挂钩超时的情况下应采取的操作,取值范围是“CONTINUE”或“ABANDON”,默认值为“CONTINUE”
14785
+ :param _DefaultResult: 定义伸缩组在生命周期挂钩超时或 LifecycleCommand 执行失败时应采取的操作,取值范围是如下:
14786
+ * CONTINUE: 默认值,表示继续执行扩缩容活动
14787
+ * ABANDON: 针对扩容挂钩,挂钩超时或 LifecycleCommand 执行失败的 CVM 实例会直接释放或移出;而针对缩容挂钩,会继续执行缩容活动。
14696
14788
  :type DefaultResult: str
14697
14789
  :param _HeartbeatTimeout: 生命周期挂钩超时之前可以经过的最长时间(以秒为单位),范围从30到7200秒,默认值为300秒
14698
14790
  :type HeartbeatTimeout: int
14699
- :param _NotificationMetadata: 弹性伸缩向通知目标发送的附加信息,配置通知时使用,默认值为空字符串""
14791
+ :param _NotificationMetadata: 弹性伸缩向通知目标发送的附加信息,配置通知时使用,默认值为空字符串。NotificationMetadata 和 LifecycleCommand参数互斥,二者不可同时指定。
14700
14792
  :type NotificationMetadata: str
14701
14793
  :param _NotificationTarget: 通知目标。NotificationTarget和LifecycleCommand参数互斥,二者不可同时指定。
14702
14794
  :type NotificationTarget: :class:`tencentcloud.autoscaling.v20180419.models.NotificationTarget`
14703
14795
  :param _LifecycleTransitionType: 进行生命周期挂钩的场景类型,取值范围包括NORMAL 和 EXTENSION。说明:设置为EXTENSION值,在AttachInstances、DetachInstances、RemoveInstaces接口时会触发生命周期挂钩操作,值为NORMAL则不会在这些接口中触发生命周期挂钩。
14704
14796
  :type LifecycleTransitionType: str
14705
- :param _LifecycleCommand: 远程命令执行对象。NotificationTargetLifecycleCommand参数互斥,二者不可同时指定。
14797
+ :param _LifecycleCommand: 远程命令执行对象。通知参数 NotificationMetadata、NotificationTargetLifecycleCommand 互斥,不可同时指定。
14706
14798
  :type LifecycleCommand: :class:`tencentcloud.autoscaling.v20180419.models.LifecycleCommand`
14707
14799
  """
14708
14800
  self._LifecycleHookId = None
@@ -14717,7 +14809,7 @@ class UpgradeLifecycleHookRequest(AbstractModel):
14717
14809
 
14718
14810
  @property
14719
14811
  def LifecycleHookId(self):
14720
- """生命周期挂钩ID
14812
+ """生命周期挂钩ID。可以通过调用接口 [DescribeLifecycleHooks](https://cloud.tencent.com/document/api/377/34452) ,取返回信息中的 LifecycleHookId 获取生命周期挂钩ID。
14721
14813
  :rtype: str
14722
14814
  """
14723
14815
  return self._LifecycleHookId
@@ -14728,7 +14820,7 @@ class UpgradeLifecycleHookRequest(AbstractModel):
14728
14820
 
14729
14821
  @property
14730
14822
  def LifecycleHookName(self):
14731
- """生命周期挂钩名称
14823
+ """生命周期挂钩名称。名称仅支持中文、英文、数字、下划线(_)、短横线(-)、小数点(.),最大长度不能超128个字符。
14732
14824
  :rtype: str
14733
14825
  """
14734
14826
  return self._LifecycleHookName
@@ -14739,7 +14831,9 @@ class UpgradeLifecycleHookRequest(AbstractModel):
14739
14831
 
14740
14832
  @property
14741
14833
  def LifecycleTransition(self):
14742
- """进行生命周期挂钩的场景,取值范围包括“INSTANCE_LAUNCHING”和“INSTANCE_TERMINATING”
14834
+ """进行生命周期挂钩的场景,取值范围如下:
14835
+ * INSTANCE_LAUNCHING: 扩容生命周期挂钩
14836
+ * INSTANCE_TERMINATING: 缩容生命周期挂钩
14743
14837
  :rtype: str
14744
14838
  """
14745
14839
  return self._LifecycleTransition
@@ -14750,7 +14844,9 @@ class UpgradeLifecycleHookRequest(AbstractModel):
14750
14844
 
14751
14845
  @property
14752
14846
  def DefaultResult(self):
14753
- """定义伸缩组在生命周期挂钩超时的情况下应采取的操作,取值范围是“CONTINUE”或“ABANDON”,默认值为“CONTINUE”
14847
+ """定义伸缩组在生命周期挂钩超时或 LifecycleCommand 执行失败时应采取的操作,取值范围是如下:
14848
+ * CONTINUE: 默认值,表示继续执行扩缩容活动
14849
+ * ABANDON: 针对扩容挂钩,挂钩超时或 LifecycleCommand 执行失败的 CVM 实例会直接释放或移出;而针对缩容挂钩,会继续执行缩容活动。
14754
14850
  :rtype: str
14755
14851
  """
14756
14852
  return self._DefaultResult
@@ -14772,7 +14868,7 @@ class UpgradeLifecycleHookRequest(AbstractModel):
14772
14868
 
14773
14869
  @property
14774
14870
  def NotificationMetadata(self):
14775
- """弹性伸缩向通知目标发送的附加信息,配置通知时使用,默认值为空字符串""
14871
+ """弹性伸缩向通知目标发送的附加信息,配置通知时使用,默认值为空字符串。NotificationMetadata 和 LifecycleCommand参数互斥,二者不可同时指定。
14776
14872
  :rtype: str
14777
14873
  """
14778
14874
  return self._NotificationMetadata
@@ -14805,7 +14901,7 @@ class UpgradeLifecycleHookRequest(AbstractModel):
14805
14901
 
14806
14902
  @property
14807
14903
  def LifecycleCommand(self):
14808
- """远程命令执行对象。NotificationTargetLifecycleCommand参数互斥,二者不可同时指定。
14904
+ """远程命令执行对象。通知参数 NotificationMetadata、NotificationTargetLifecycleCommand 互斥,不可同时指定。
14809
14905
  :rtype: :class:`tencentcloud.autoscaling.v20180419.models.LifecycleCommand`
14810
14906
  """
14811
14907
  return self._LifecycleCommand