tccli-intl-en 3.0.1188.1__py2.py3-none-any.whl → 3.1.28.1__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 (292) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/argument.py +1 -1
  3. tccli/plugins/sso/__init__.py +14 -0
  4. tccli/plugins/sso/login.py +23 -6
  5. tccli/plugins/sso/texts.py +4 -0
  6. tccli/services/__init__.py +46 -2
  7. tccli/services/advisor/advisor_client.py +10 -4
  8. tccli/services/ai3d/__init__.py +4 -0
  9. tccli/services/ai3d/ai3d_client.py +266 -0
  10. tccli/services/ai3d/v20250513/api.json +264 -0
  11. tccli/services/ai3d/v20250513/examples.json +20 -0
  12. tccli/services/aiart/aiart_client.py +5 -2
  13. tccli/services/ams/ams_client.py +20 -8
  14. tccli/services/antiddos/antiddos_client.py +350 -140
  15. tccli/services/apigateway/apigateway_client.py +465 -186
  16. tccli/services/apm/apm_client.py +835 -68
  17. tccli/services/apm/v20210622/api.json +3936 -1145
  18. tccli/services/apm/v20210622/examples.json +133 -23
  19. tccli/services/asr/asr_client.py +10 -4
  20. tccli/services/autoscaling/autoscaling_client.py +341 -114
  21. tccli/services/autoscaling/v20180419/api.json +444 -272
  22. tccli/services/autoscaling/v20180419/examples.json +46 -38
  23. tccli/services/batch/batch_client.py +140 -56
  24. tccli/services/bi/__init__.py +4 -0
  25. tccli/services/bi/bi_client.py +1498 -0
  26. tccli/services/bi/v20220105/api.json +5769 -0
  27. tccli/services/bi/v20220105/examples.json +215 -0
  28. tccli/services/billing/billing_client.py +1007 -139
  29. tccli/services/billing/v20180709/api.json +1707 -429
  30. tccli/services/billing/v20180709/examples.json +161 -25
  31. tccli/services/cam/cam_client.py +405 -162
  32. tccli/services/captcha/captcha_client.py +5 -2
  33. tccli/services/captcha/v20190722/api.json +16 -6
  34. tccli/services/captcha/v20190722/examples.json +3 -3
  35. tccli/services/car/car_client.py +165 -66
  36. tccli/services/cbs/cbs_client.py +190 -76
  37. tccli/services/ccc/ccc_client.py +1167 -268
  38. tccli/services/ccc/v20200210/api.json +2263 -202
  39. tccli/services/ccc/v20200210/examples.json +116 -12
  40. tccli/services/cdb/cdb_client.py +665 -266
  41. tccli/services/cdb/v20170320/api.json +463 -208
  42. tccli/services/cdb/v20170320/examples.json +8 -8
  43. tccli/services/cdc/cdc_client.py +100 -40
  44. tccli/services/cdc/v20201214/api.json +2 -2
  45. tccli/services/cdc/v20201214/examples.json +4 -4
  46. tccli/services/cdn/cdn_client.py +220 -88
  47. tccli/services/cdn/v20180606/api.json +22 -22
  48. tccli/services/cdn/v20180606/examples.json +1 -1
  49. tccli/services/cdwdoris/cdwdoris_client.py +385 -154
  50. tccli/services/cdwpg/cdwpg_client.py +120 -48
  51. tccli/services/cdz/__init__.py +4 -0
  52. tccli/services/cdz/cdz_client.py +210 -0
  53. tccli/services/cdz/v20221123/api.json +233 -0
  54. tccli/services/cdz/v20221123/examples.json +12 -0
  55. tccli/services/cfg/cfg_client.py +80 -32
  56. tccli/services/cfg/v20210820/api.json +30 -10
  57. tccli/services/cfg/v20210820/examples.json +1 -1
  58. tccli/services/cfs/cfs_client.py +195 -78
  59. tccli/services/cfw/cfw_client.py +330 -132
  60. tccli/services/chdfs/chdfs_client.py +145 -58
  61. tccli/services/ciam/ciam_client.py +80 -32
  62. tccli/services/ckafka/ckafka_client.py +1149 -259
  63. tccli/services/ckafka/v20190819/api.json +3738 -1696
  64. tccli/services/ckafka/v20190819/examples.json +266 -162
  65. tccli/services/clb/clb_client.py +1054 -469
  66. tccli/services/clb/v20180317/api.json +2273 -1020
  67. tccli/services/clb/v20180317/examples.json +184 -124
  68. tccli/services/cloudaudit/cloudaudit_client.py +90 -36
  69. tccli/services/cls/cls_client.py +434 -173
  70. tccli/services/cmq/cmq_client.py +14 -803
  71. tccli/services/cmq/v20190304/api.json +173 -1367
  72. tccli/services/cmq/v20190304/examples.json +0 -120
  73. tccli/services/config/config_client.py +30 -12
  74. tccli/services/controlcenter/controlcenter_client.py +229 -2
  75. tccli/services/controlcenter/v20230110/api.json +528 -5
  76. tccli/services/controlcenter/v20230110/examples.json +32 -0
  77. tccli/services/csip/csip_client.py +339 -78
  78. tccli/services/csip/v20221121/api.json +1011 -38
  79. tccli/services/csip/v20221121/examples.json +24 -0
  80. tccli/services/ctsdb/__init__.py +4 -0
  81. tccli/services/ctsdb/ctsdb_client.py +266 -0
  82. tccli/services/ctsdb/v20230202/api.json +677 -0
  83. tccli/services/ctsdb/v20230202/examples.json +20 -0
  84. tccli/services/cvm/cvm_client.py +706 -189
  85. tccli/services/cvm/v20170312/api.json +1003 -453
  86. tccli/services/cvm/v20170312/examples.json +176 -130
  87. tccli/services/cwp/cwp_client.py +2325 -930
  88. tccli/services/cynosdb/cynosdb_client.py +2272 -591
  89. tccli/services/cynosdb/v20190107/api.json +12480 -7740
  90. tccli/services/cynosdb/v20190107/examples.json +193 -9
  91. tccli/services/dataintegration/dataintegration_client.py +5 -2
  92. tccli/services/dayu/dayu_client.py +515 -206
  93. tccli/services/dbbrain/dbbrain_client.py +210 -84
  94. tccli/services/dc/dc_client.py +90 -36
  95. tccli/services/dcdb/dcdb_client.py +310 -124
  96. tccli/services/dlc/dlc_client.py +859 -214
  97. tccli/services/dlc/v20210125/api.json +637 -13
  98. tccli/services/dlc/v20210125/examples.json +48 -0
  99. tccli/services/dms/dms_client.py +10 -4
  100. tccli/services/dnspod/dnspod_client.py +390 -111
  101. tccli/services/dnspod/v20210323/api.json +196 -0
  102. tccli/services/dnspod/v20210323/examples.json +24 -0
  103. tccli/services/domain/domain_client.py +120 -48
  104. tccli/services/dts/dts_client.py +415 -166
  105. tccli/services/eb/eb_client.py +130 -52
  106. tccli/services/ecdn/ecdn_client.py +75 -30
  107. tccli/services/ecm/ecm_client.py +620 -248
  108. tccli/services/eiam/eiam_client.py +200 -80
  109. tccli/services/emr/emr_client.py +3104 -117
  110. tccli/services/emr/v20190103/api.json +15311 -4361
  111. tccli/services/emr/v20190103/examples.json +452 -42
  112. tccli/services/es/es_client.py +105 -42
  113. tccli/services/facefusion/facefusion_client.py +15 -6
  114. tccli/services/faceid/faceid_client.py +95 -38
  115. tccli/services/faceid/v20180301/api.json +172 -45
  116. tccli/services/faceid/v20180301/examples.json +3 -3
  117. tccli/services/gaap/gaap_client.py +440 -176
  118. tccli/services/gme/gme_client.py +50 -20
  119. tccli/services/gpm/gpm_client.py +90 -36
  120. tccli/services/gse/gse_client.py +110 -44
  121. tccli/services/gwlb/gwlb_client.py +90 -36
  122. tccli/services/hunyuan/__init__.py +4 -0
  123. tccli/services/hunyuan/hunyuan_client.py +490 -0
  124. tccli/services/hunyuan/v20230901/api.json +566 -0
  125. tccli/services/hunyuan/v20230901/examples.json +52 -0
  126. tccli/services/iai/iai_client.py +145 -58
  127. tccli/services/iai/v20200303/api.json +187 -51
  128. tccli/services/iai/v20200303/examples.json +30 -12
  129. tccli/services/iap/iap_client.py +30 -12
  130. tccli/services/ims/ims_client.py +5 -2
  131. tccli/services/ims/v20201229/api.json +133 -141
  132. tccli/services/ims/v20201229/examples.json +3 -3
  133. tccli/services/intlpartnersmgt/intlpartnersmgt_client.py +363 -78
  134. tccli/services/intlpartnersmgt/v20220928/api.json +513 -22
  135. tccli/services/intlpartnersmgt/v20220928/examples.json +24 -0
  136. tccli/services/iotcloud/iotcloud_client.py +100 -40
  137. tccli/services/iotcloud/v20210408/api.json +216 -107
  138. tccli/services/iotcloud/v20210408/examples.json +9 -9
  139. tccli/services/ip/ip_client.py +30 -12
  140. tccli/services/kms/kms_client.py +1226 -227
  141. tccli/services/kms/v20190118/api.json +1465 -123
  142. tccli/services/kms/v20190118/examples.json +129 -3
  143. tccli/services/lcic/lcic_client.py +265 -106
  144. tccli/services/lighthouse/lighthouse_client.py +730 -172
  145. tccli/services/lighthouse/v20200324/api.json +502 -14
  146. tccli/services/lighthouse/v20200324/examples.json +59 -5
  147. tccli/services/live/live_client.py +804 -232
  148. tccli/services/live/v20180801/api.json +272 -0
  149. tccli/services/live/v20180801/examples.json +32 -0
  150. tccli/services/lke/__init__.py +4 -0
  151. tccli/services/lke/lke_client.py +5194 -0
  152. tccli/services/lke/v20231130/api.json +14803 -0
  153. tccli/services/lke/v20231130/examples.json +736 -0
  154. tccli/services/lkeap/__init__.py +4 -0
  155. tccli/services/lkeap/lkeap_client.py +602 -0
  156. tccli/services/lkeap/v20240522/api.json +989 -0
  157. tccli/services/lkeap/v20240522/examples.json +92 -0
  158. tccli/services/mariadb/mariadb_client.py +250 -100
  159. tccli/services/mdc/mdc_client.py +90 -36
  160. tccli/services/mdl/mdl_client.py +402 -82
  161. tccli/services/mdl/v20200326/api.json +1437 -100
  162. tccli/services/mdl/v20200326/examples.json +48 -16
  163. tccli/services/mdp/mdp_client.py +785 -122
  164. tccli/services/mdp/v20200527/api.json +1336 -49
  165. tccli/services/mdp/v20200527/examples.json +151 -79
  166. tccli/services/message/__init__.py +4 -0
  167. tccli/services/message/message_client.py +210 -0
  168. tccli/services/message/v20181225/api.json +72 -0
  169. tccli/services/message/v20181225/examples.json +13 -0
  170. tccli/services/mongodb/mongodb_client.py +1452 -136
  171. tccli/services/mongodb/v20190725/api.json +4393 -1462
  172. tccli/services/mongodb/v20190725/examples.json +265 -71
  173. tccli/services/monitor/monitor_client.py +1008 -296
  174. tccli/services/monitor/v20180724/api.json +664 -15
  175. tccli/services/monitor/v20180724/examples.json +152 -4
  176. tccli/services/mps/mps_client.py +1878 -379
  177. tccli/services/mps/v20190612/api.json +7473 -1626
  178. tccli/services/mps/v20190612/examples.json +276 -82
  179. tccli/services/mqtt/__init__.py +4 -0
  180. tccli/services/mqtt/mqtt_client.py +1610 -0
  181. tccli/services/mqtt/v20240516/api.json +3057 -0
  182. tccli/services/mqtt/v20240516/examples.json +213 -0
  183. tccli/services/msp/msp_client.py +35 -14
  184. tccli/services/ocr/ocr_client.py +515 -74
  185. tccli/services/ocr/v20181119/api.json +1991 -168
  186. tccli/services/ocr/v20181119/examples.json +58 -4
  187. tccli/services/omics/omics_client.py +100 -40
  188. tccli/services/organization/organization_client.py +580 -232
  189. tccli/services/postgres/postgres_client.py +455 -182
  190. tccli/services/postgres/v20170312/api.json +134 -109
  191. tccli/services/postgres/v20170312/examples.json +14 -14
  192. tccli/services/privatedns/privatedns_client.py +206 -60
  193. tccli/services/privatedns/v20201028/api.json +179 -0
  194. tccli/services/privatedns/v20201028/examples.json +8 -0
  195. tccli/services/pts/pts_client.py +240 -96
  196. tccli/services/quota/__init__.py +4 -0
  197. tccli/services/quota/quota_client.py +434 -0
  198. tccli/services/quota/v20241204/api.json +548 -0
  199. tccli/services/quota/v20241204/examples.json +51 -0
  200. tccli/services/rce/rce_client.py +5 -2
  201. tccli/services/redis/redis_client.py +698 -212
  202. tccli/services/redis/v20180412/api.json +968 -563
  203. tccli/services/redis/v20180412/examples.json +98 -56
  204. tccli/services/region/__init__.py +4 -0
  205. tccli/services/region/region_client.py +322 -0
  206. tccli/services/region/v20220627/api.json +399 -0
  207. tccli/services/region/v20220627/examples.json +29 -0
  208. tccli/services/rum/rum_client.py +300 -120
  209. tccli/services/scf/scf_client.py +210 -84
  210. tccli/services/ses/ses_client.py +368 -69
  211. tccli/services/ses/v20201002/api.json +240 -0
  212. tccli/services/ses/v20201002/examples.json +32 -0
  213. tccli/services/smh/__init__.py +4 -0
  214. tccli/services/smh/smh_client.py +714 -0
  215. tccli/services/smh/v20210712/api.json +1287 -0
  216. tccli/services/smh/v20210712/examples.json +85 -0
  217. tccli/services/sms/sms_client.py +90 -36
  218. tccli/services/sqlserver/sqlserver_client.py +3855 -470
  219. tccli/services/sqlserver/v20180328/api.json +9757 -3347
  220. tccli/services/sqlserver/v20180328/examples.json +480 -20
  221. tccli/services/ssl/ssl_client.py +504 -72
  222. tccli/services/ssl/v20191205/api.json +789 -21
  223. tccli/services/ssl/v20191205/examples.json +54 -0
  224. tccli/services/ssm/ssm_client.py +120 -48
  225. tccli/services/sts/sts_client.py +25 -10
  226. tccli/services/tag/tag_client.py +150 -60
  227. tccli/services/tat/tat_client.py +95 -38
  228. tccli/services/tbaas/tbaas_client.py +20 -8
  229. tccli/services/tcaplusdb/tcaplusdb_client.py +260 -104
  230. tccli/services/tcaplusdb/v20190823/api.json +836 -760
  231. tccli/services/tcaplusdb/v20190823/examples.json +3 -3
  232. tccli/services/tchd/tchd_client.py +5 -2
  233. tccli/services/tcmpp/tcmpp_client.py +520 -208
  234. tccli/services/tcr/tcr_client.py +380 -152
  235. tccli/services/tcsas/tcsas_client.py +295 -118
  236. tccli/services/tcsas/v20250106/api.json +1084 -980
  237. tccli/services/tcsas/v20250106/examples.json +15 -15
  238. tccli/services/tcss/tcss_client.py +1650 -660
  239. tccli/services/tdid/tdid_client.py +240 -96
  240. tccli/services/tdmq/tdmq_client.py +2876 -466
  241. tccli/services/tdmq/v20200217/api.json +11607 -3958
  242. tccli/services/tdmq/v20200217/examples.json +562 -264
  243. tccli/services/tem/tem_client.py +280 -112
  244. tccli/services/teo/teo_client.py +4507 -966
  245. tccli/services/teo/v20220901/api.json +7341 -1405
  246. tccli/services/teo/v20220901/examples.json +679 -99
  247. tccli/services/tione/__init__.py +4 -0
  248. tccli/services/tione/tione_client.py +210 -0
  249. tccli/services/tione/v20211111/api.json +3074 -0
  250. tccli/services/tione/v20211111/examples.json +12 -0
  251. tccli/services/tiw/tiw_client.py +255 -102
  252. tccli/services/tke/tke_client.py +858 -276
  253. tccli/services/tke/v20180525/api.json +227 -0
  254. tccli/services/tke/v20180525/examples.json +24 -0
  255. tccli/services/tms/tms_client.py +5 -2
  256. tccli/services/tms/v20201229/api.json +91 -100
  257. tccli/services/tmt/tmt_client.py +5 -2
  258. tccli/services/trabbit/trabbit_client.py +145 -58
  259. tccli/services/trocket/__init__.py +4 -0
  260. tccli/services/trocket/trocket_client.py +2450 -0
  261. tccli/services/trocket/v20230308/api.json +6062 -0
  262. tccli/services/trocket/v20230308/examples.json +339 -0
  263. tccli/services/trro/trro_client.py +95 -38
  264. tccli/services/trtc/trtc_client.py +928 -192
  265. tccli/services/trtc/v20190722/api.json +1810 -256
  266. tccli/services/trtc/v20190722/examples.json +100 -6
  267. tccli/services/tts/tts_client.py +5 -2
  268. tccli/services/vclm/vclm_client.py +10 -4
  269. tccli/services/vm/v20210922/api.json +61 -30
  270. tccli/services/vm/v20210922/examples.json +0 -12
  271. tccli/services/vm/vm_client.py +20 -8
  272. tccli/services/vod/v20180717/api.json +531 -54
  273. tccli/services/vod/v20180717/examples.json +25 -7
  274. tccli/services/vod/v20240718/api.json +1105 -0
  275. tccli/services/vod/v20240718/examples.json +97 -0
  276. tccli/services/vod/vod_client.py +1428 -350
  277. tccli/services/vpc/v20170312/api.json +1031 -133
  278. tccli/services/vpc/v20170312/examples.json +119 -23
  279. tccli/services/vpc/vpc_client.py +2159 -644
  280. tccli/services/waf/v20180125/api.json +1372 -194
  281. tccli/services/waf/v20180125/examples.json +89 -1
  282. tccli/services/waf/waf_client.py +1149 -245
  283. tccli/services/wedata/v20250806/api.json +13644 -0
  284. tccli/services/wedata/v20250806/examples.json +621 -0
  285. tccli/services/wedata/wedata_client.py +6067 -1263
  286. tccli/services/yunjing/yunjing_client.py +355 -142
  287. {tccli_intl_en-3.0.1188.1.dist-info → tccli_intl_en-3.1.28.1.dist-info}/METADATA +4 -7
  288. {tccli_intl_en-3.0.1188.1.dist-info → tccli_intl_en-3.1.28.1.dist-info}/RECORD +292 -232
  289. {tccli_intl_en-3.0.1188.1.dist-info → tccli_intl_en-3.1.28.1.dist-info}/WHEEL +1 -1
  290. {tccli_intl_en-3.0.1188.1.dist-info → tccli_intl_en-3.1.28.1.dist-info}/entry_points.txt +0 -1
  291. {tccli_intl_en-3.0.1188.1.dist-info → tccli_intl_en-3.1.28.1.dist-info}/LICENSE +0 -0
  292. {tccli_intl_en-3.0.1188.1.dist-info → tccli_intl_en-3.1.28.1.dist-info}/top_level.txt +0 -0
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "actions": {
3
3
  "AttachInstances": {
4
- "document": "This API is used to add CVM instances to an auto scaling group.\n* Only CVM instances in `RUNNING` or `STOPPED` status can be added.\n* The added CVM instances must in the same VPC as the scaling group.\n",
4
+ "document": "This interface (AttachInstances) is used to add CVM instances to a scaling group.\n* Only CVM instances in `RUNNING` or `STOPPED` status can be added.\nThis API is used to ensure added CVM instances match the VPC network of the scaling group.",
5
5
  "input": "AttachInstancesRequest",
6
6
  "name": "Adds CVM instances to an auto scaling group",
7
7
  "output": "AttachInstancesResponse",
@@ -15,7 +15,7 @@
15
15
  "status": "online"
16
16
  },
17
17
  "CancelInstanceRefresh": {
18
- "document": "This API is used to cancel the instance refresh activity of the scaling group.\n* The batches that have already been refreshed or are currently being refreshed remain unaffected, but the batches pending refresh will be canceled.\n* If a refresh fails, the affected instances will remain in the secondary status, and require manual intervention to exit the secondary status or terminate the instances.\n* Rollback operations are not allowed after cancellation, and recovery is also unsupported.\n* The instances temporarily scaled out due to the MaxSurge parameter are automatically terminated after cancellation.\n* During scale-in, all instances have already been updated and cannot be canceled.",
18
+ "document": "This API is used to cancel the instance refresh activity of the scaling group.\n* The batches that have already been refreshed remain unaffected, but the batches pending refresh will be canceled.\n* If a batch is currently refreshing, cancellation is not allowed. You can suspend the event and wait until the current batch finishes before canceling.\nThis API is used to refresh the failed instances. If a refresh fails, the affected instances will remain in standby status, and require manual intervention to exit the standby status or terminate the instances.\n* Rollback operations are not allowed after cancellation, and recovery is unsupported.\nTemporarily expanded instances due to the maxSurge parameter are automatically destroyed after cancellation.\n* During scale-in, all instances have already been updated and cannot be canceled.",
19
19
  "input": "CancelInstanceRefreshRequest",
20
20
  "name": "Cancels instance refresh",
21
21
  "output": "CancelInstanceRefreshResponse",
@@ -43,28 +43,28 @@
43
43
  "status": "online"
44
44
  },
45
45
  "CreateAutoScalingGroupFromInstance": {
46
- "document": "This API is used to create launch configurations and scaling groups based on an instance.\n\nNote: for a scaling group that is created based on a monthly-subscribed instance, the instances added for scale-out are pay-as-you-go instance.",
46
+ "document": "This API is used to create launch configurations and scaling groups based on an instance.",
47
47
  "input": "CreateAutoScalingGroupFromInstanceRequest",
48
- "name": "Creates launch configurations and scaling groups based on an instance",
48
+ "name": "Creates launch configuration and scaling group based on an instance",
49
49
  "output": "CreateAutoScalingGroupFromInstanceResponse",
50
50
  "status": "online"
51
51
  },
52
52
  "CreateLaunchConfiguration": {
53
- "document": "This API is used to create a launch configuration.\n\n* To modify a launch configuration, please use `ModifyLaunchConfigurationAttributes`.\n\n* Up to 20 launch configurations can be created for each project. For more information, see [Usage Limits](https://intl.cloud.tencent.com/document/product/377/3120?from_cn_redirect=1).",
53
+ "document": "This interface (CreateLaunchConfiguration) is used to create new launch configuration.\n\n* To modify a launch configuration, use [ModifyLaunchConfigurationAttributes](https://intl.cloud.tencent.com/document/api/377/31298?from_cn_redirect=1) to partially modify fields. If needed, create a new launch configuration.\n\nBy default, 50 launch configurations can be created per region. For details, see [Usage Limits](https://intl.cloud.tencent.com/document/product/377/3120?from_cn_redirect=1).",
54
54
  "input": "CreateLaunchConfigurationRequest",
55
55
  "name": "Creates a launch configuration",
56
56
  "output": "CreateLaunchConfigurationResponse",
57
57
  "status": "online"
58
58
  },
59
59
  "CreateLifecycleHook": {
60
- "document": "This API is used to create a lifecycle hook.\n\n* You can configure notifications or automation commands (TAT) for the lifecycle hook.\n\nIf you configured a notification, Auto Scaling will notify the TDMQ queue of the following information:\n\n```\n{\n\t\"Service\": \"Tencent Cloud Auto Scaling\",\n\t\"Time\": \"2019-03-14T10:15:11Z\",\n\t\"AppId\": \"1251783334\",\n\t\"ActivityId\": \"asa-fznnvrja\",\n\t\"AutoScalingGroupId\": \"asg-rrrrtttt\",\n\t\"LifecycleHookId\": \"ash-xxxxyyyy\",\n\t\"LifecycleHookName\": \"my-hook\",\n\t\"LifecycleActionToken\": \"3080e1c9-0efe-4dd7-ad3b-90cd6618298f\",\n\t\"InstanceId\": \"ins-aaaabbbb\",\n\t\"LifecycleTransition\": \"INSTANCE_LAUNCHING\",\n\t\"NotificationMetadata\": \"\"\n}\n```",
60
+ "document": "This interface (CreateLifecycleHook) is used for creating a lifecycle hook.\n\n* You can configure notifications or automation commands for the lifecycle hook.\n\nIf you configured a notification, Auto Scaling will notify the TDMQ Message Queue of the following information:.\n\n```\n{\n\t\"Service\": \"Tencent Cloud Auto Scaling\",\n\t\"Time\": \"2019-03-14T10:15:11Z\",\n\t\"AppId\": \"1251783334\",\n\t\"ActivityId\": \"asa-fznnvrja\",\n\t\"AutoScalingGroupId\": \"asg-ft6y7u8n\",\n\t\"LifecycleHookId\": \"ash-p9i7y6t5\",\n\t\"LifecycleHookName\": \"my-hook\",\n\t\"LifecycleActionToken\": \"3080e1c9-0efe-4dd7-ad3b-90cd6618298f\",\n\t\"InstanceId\": \"ins-y6dr5e43\",\n\t\"LifecycleTransition\": \"INSTANCE_LAUNCHING\",\n\t\"NotificationMetadata\": \"\"\n}\n```",
61
61
  "input": "CreateLifecycleHookRequest",
62
62
  "name": "Creating a Lifecycle Hook",
63
63
  "output": "CreateLifecycleHookResponse",
64
64
  "status": "online"
65
65
  },
66
66
  "CreateNotificationConfiguration": {
67
- "document": "This API is used to create a notification policy.\nWhen the notification is sent to a CMQ topic or queue, the following contents are included:\n```\n{\n \"Service\": \"Tencent Cloud Auto Scaling\",\n \"CreatedTime\": \"2021-10-11T10:15:11Z\", // Activity creation time\n \"AppId\": \"100000000\",\n \"ActivityId\": \"asa-fznnvrja\", // Scaling activity ID\n \"AutoScalingGroupId\": \"asg-pc2oqu2z\", // Scaling group ID\n \"ActivityType\": \"SCALE_OUT\", // Scaling activity type\n \"StatusCode\": \"SUCCESSFUL\", // Scaling activity result\n \"Description\": \"Activity was launched in response to a difference between desired capacity and actual capacity,\n scale out 1 instance(s).\", // Scaling activity description\n \"StartTime\": \"2021-10-11T10:15:11Z\", // Activity starting time\n \"EndTime\": \"2021-10-11T10:15:32Z\", // Activity ending time\n \"DetailedStatusMessageSet\": [ // A collection of failed attempts during the scaling process (Failed attempts are allowed in a successful scaling activity)\n {\n \"Code\": \"InvalidInstanceType\",\n \"Zone\": \"ap-guangzhou-2\",\n \"InstanceId\": \"\",\n \"InstanceChargeType\": \"POSTPAID_BY_HOUR\",\n \"SubnetId\": \"subnet-4t5mgeuu\",\n \"Message\": \"The specified instance type `S5.LARGE8` is invalid in `subnet-4t5mgeuu`, `ap-guangzhou-2`.\",\n \"InstanceType\": \"S5.LARGE8\",\n }\n ]\n}\n```",
67
+ "document": "This API is used to create a notification.\nThis API is used to send notifications to a CMQ topic or queue with the following message content:.\n```\n{\n \"Service\": \"Tencent Cloud Auto Scaling\",\n\"CreatedTime\": \"2021-10-11T10:15:11Z\", // Activity creation time.\n \"AppId\": \"100000000\",\n\"ActivityId\": \"asa-fznnvrja\", // scaling activity ID.\nThis API is used to specify the scaling group ID.\n\"ActivityType\": \"SCALE_OUT\", // scaling activity type.\n\"StatusCode\": \"SUCCESSFUL\".\n \"Description\": \"Activity was launched in response to a difference between desired capacity and actual capacity,\nThis API is used to scale out 1 instance.\nThis API is used to set the activity start time.\n\"EndTime\": \"2021-10-11T10:15:32Z\", // activity end time.\n\"DetailedStatusMessageSet\": [ // Collection of activity internal errors (non-empty does not mean activity failure).\n {\n \"Code\": \"InvalidInstanceType\",\n \"Zone\": \"ap-guangzhou-6\",\n \"InstanceId\": \"\",\n \"InstanceChargeType\": \"POSTPAID_BY_HOUR\",\n \"SubnetId\": \"subnet-4t5mgeuu\",\n \"Message\": \"The specified instance type `S5.LARGE8` is invalid in `subnet-4t5mgeuu`, `ap-guangzhou-6`.\",\n \"InstanceType\": \"S5.LARGE8\"\n }\n ]\n}\n```",
68
68
  "input": "CreateNotificationConfigurationRequest",
69
69
  "name": "Creates a notification",
70
70
  "output": "CreateNotificationConfigurationResponse",
@@ -92,7 +92,7 @@
92
92
  "status": "online"
93
93
  },
94
94
  "DeleteLaunchConfiguration": {
95
- "document": "This API (DeleteLaunchConfiguration) is used to delete a launch configuration.\n\n* If the launch configuration is active in an auto scaling group, it cannot be deleted.\n",
95
+ "document": "This API (DeleteLaunchConfiguration) is used to delete a launch configuration.\n\n* If the launch configuration is active in a scaling group, it cannot be deleted.",
96
96
  "input": "DeleteLaunchConfigurationRequest",
97
97
  "name": "Deletes a launch configuration",
98
98
  "output": "DeleteLaunchConfigurationResponse",
@@ -238,6 +238,13 @@
238
238
  "output": "EnableAutoScalingGroupResponse",
239
239
  "status": "online"
240
240
  },
241
+ "EnterStandby": {
242
+ "document": "This API is used to set instances within the scaling group to standby status.\nInstances in standby status have a CLB weight value of 0 and will not be selected for scaling in, unhealthy replacement, or refresh operation.\nThis API is used to call the Auto Scaling power-on/power-off API which may change the standby status, while the Cloud Virtual Machine server power on/off API will not affect it.\nThe instance enters standby status, and the scaling group attempts to lower the expected number of instances, which will not be less than the minimum value.",
243
+ "input": "EnterStandbyRequest",
244
+ "name": "Enter an instance into standby status",
245
+ "output": "EnterStandbyResponse",
246
+ "status": "online"
247
+ },
241
248
  "ExecuteScalingPolicy": {
242
249
  "document": "This API is used to execute a scaling policy.\n\n* The scaling policy can be executed based on the scaling policy ID.\n* The policy cannot be executed if there are ongoing scaling actions on the scaling group.\n* Executing a target tracking policy is not supported.",
243
250
  "input": "ExecuteScalingPolicyRequest",
@@ -246,7 +253,7 @@
246
253
  "status": "online"
247
254
  },
248
255
  "ExitStandby": {
249
- "document": "This API is used to exit instances from the standby status in the scaling group.\n* When an instance is in standby status, its load balancer weight is set to 0. Upon exiting the standby status, the weight value automatically gets restored.\n* Initiating power-on/power-off actions on instances that are in standby status also results in them exiting from the standby status.",
256
+ "document": "This API is used to exit instances from standby status in the scaling group.\n* After exiting standby status, the instance enters running state and the CLB weight value is restored to the default value.\nThis API is used to call the Auto Scaling power-on/power-off API which may change the standby status, while the Cloud Virtual Machine server power on/off API will not affect it.\nAfter instances exit standby status, the scaling group will raise the expected number of instances. The new expected number cannot exceed the maximum value.",
250
257
  "input": "ExitStandbyRequest",
251
258
  "name": "Exits instances from standby status",
252
259
  "output": "ExitStandbyResponse",
@@ -267,7 +274,7 @@
267
274
  "status": "online"
268
275
  },
269
276
  "ModifyLaunchConfigurationAttributes": {
270
- "document": "This API (ModifyLaunchConfigurationAttributes) is used to modify some attributes of a launch configuration.\n\n* The changes of launch configuration do not affect the existing instances. New instances will be created based on the modified configuration.\n* This API supports modifying certain simple types of attributes.",
277
+ "document": "This API (ModifyLaunchConfigurationAttributes) is used to modify part of a launch configuration's attributes.\n\nThis API is used to modify the startup configuration. Existing instances scaled out using this configuration will not change, while newly added instances using this launch configuration will scale out according to the new configuration.",
271
278
  "input": "ModifyLaunchConfigurationAttributesRequest",
272
279
  "name": "Modifies launch configuration attributes",
273
280
  "output": "ModifyLaunchConfigurationAttributesResponse",
@@ -407,7 +414,7 @@
407
414
  },
408
415
  "objects": {
409
416
  "Activity": {
410
- "document": "Information on eligible scaling activities.",
417
+ "document": "Information of auto scaling activity.",
411
418
  "members": [
412
419
  {
413
420
  "disabled": false,
@@ -431,7 +438,7 @@
431
438
  },
432
439
  {
433
440
  "disabled": false,
434
- "document": "Scaling activity type. Valid values:\n<li>SCALE_OUT: Scale out an instance.</li>\n<li>SCALE_IN: Scale in an instance.</li>\n<li>ATTACH_INSTANCES: Add an instance.</li>\n<li>REMOVE_INSTANCES: Terminate an instance.</li>\n<li>DETACH_INSTANCES: Remove an instance.</li>\n<li>TERMINATE_INSTANCES_UNEXPECTEDLY: Terminate an instance in the CVM console.</li>\n<li>REPLACE_UNHEALTHY_INSTANCE: Replace an unhealthy instance.</li>\n<li>START_INSTANCES: Start an instance.</li>\n<li>STOP_INSTANCES: Stop an instance.</li>\n<li>INVOKE_COMMAND: Execute a command.</li>",
441
+ "document": "Scaling activity type. Valid values:\n<li>SCALE_OUT: Scale out instance(s).</li>\n<li>SCALE_IN: Scale in instance(s).</li>\n<li>ATTACH_INSTANCES: Add instance(s).</li>\n<li>REMOVE_INSTANCES: Terminate instance(s).</li>\n<li>DETACH_INSTANCES: Remove instance(s).</li>\n<li>TERMINATE_INSTANCES_UNEXPECTEDLY: Instance(s) unexpectedly terminated in the CVM console.</li>\n<li>REPLACE_UNHEALTHY_INSTANCE: Replace unhealthy instance(s).</li>\n<li>START_INSTANCES: Start instance(s).</li>\n<li>STOP_INSTANCES: Stop instance(s).</li>\n<li>INVOKE_COMMAND: Execute a command in instance(s).</li>",
435
442
  "example": "SCALE_OUT",
436
443
  "member": "string",
437
444
  "name": "ActivityType",
@@ -481,7 +488,7 @@
481
488
  },
482
489
  {
483
490
  "disabled": false,
484
- "document": "Start time of the scaling activity.",
491
+ "document": "Start time of the auto scaling activity in UTC standard time.",
485
492
  "example": "2024-11-12T05:30:21Z",
486
493
  "member": "datetime_iso",
487
494
  "name": "StartTime",
@@ -491,7 +498,7 @@
491
498
  },
492
499
  {
493
500
  "disabled": false,
494
- "document": "End time of the scaling activity.",
501
+ "document": "End time of the scaling activity in UTC standard time.",
495
502
  "example": "2024-11-12T05:30:21Z",
496
503
  "member": "datetime_iso",
497
504
  "name": "EndTime",
@@ -501,7 +508,7 @@
501
508
  },
502
509
  {
503
510
  "disabled": false,
504
- "document": "Creation time of the scaling activity.",
511
+ "document": "Create time of the scaling activity in UTC standard time.",
505
512
  "example": "2024-11-12T05:30:21Z",
506
513
  "member": "datetime_iso",
507
514
  "name": "CreatedTime",
@@ -541,8 +548,8 @@
541
548
  },
542
549
  {
543
550
  "disabled": false,
544
- "document": "Detailed description of scaling activity status",
545
- "example": "[{\"Code\": \"CvmCreationFailed\", \"Zone\": \"ap-beijing-5\", \"InstanceId\": \"ins-qfcgbumb\", \"InstanceChargeType\": \"PREPAID\", \"SubnetId\": \"subnet-opywjlrx\", \"Message\": \"Failed to launch instance `ins-qfcgbumb`. Instance type: `GNV4.12XLARGE176`, Subnet: `subnet-opywjlrx`, Zone: `ap-beijing-5`, LatestOperationCode: `ResourceInsufficient`.\", \"InstanceType\": \"GNV4.12XLARGE176\"}]",
551
+ "document": "Detailed description of the scaling activity status",
552
+ "example": "",
546
553
  "member": "DetailedStatusMessage",
547
554
  "name": "DetailedStatusMessageSet",
548
555
  "output_required": true,
@@ -561,7 +568,7 @@
561
568
  },
562
569
  {
563
570
  "disabled": false,
564
- "document": "Information set of the instances related to the scaling activity.",
571
+ "document": "Related instance information set of the scaling activity.",
565
572
  "example": " [{\"InstanceId\": \"ins-qdve9yyr\", \"InstanceStatus\": \"SUCCESSFUL\"}]",
566
573
  "member": "RelatedInstance",
567
574
  "name": "RelatedInstanceSet",
@@ -649,7 +656,7 @@
649
656
  "members": [
650
657
  {
651
658
  "disabled": false,
652
- "document": "Auto scaling group ID",
659
+ "document": "Scaling group ID. obtain available scaling group ids in the following ways:.\n<li>Query the scaling group ID by logging in to the [console](https://console.cloud.tencent.com/autoscaling/group).</li>.\n<li>Specifies the scaling group ID obtained by calling the api [DescribeAutoScalingGroups](https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1) and retrieving the AutoScalingGroupId from the return information.</li>.",
653
660
  "example": "asg-boz1qhnk",
654
661
  "member": "string",
655
662
  "name": "AutoScalingGroupId",
@@ -658,7 +665,7 @@
658
665
  },
659
666
  {
660
667
  "disabled": false,
661
- "document": "List of CVM instance IDs",
668
+ "document": "CVM instance ID list. you can obtain available instance ID in the following ways:.\n<li>Query instance ID by logging in to the <a href=\"https://console.cloud.tencent.com/cvm/index\">console</a>.</li>.\n<li>Get the instance ID by calling the api [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1) and retrieving the `InstanceId` from the returned information.</li>.",
662
669
  "example": "[\"ins-cri8d02t\",\"ins-osckfnm7\"]",
663
670
  "member": "string",
664
671
  "name": "InstanceIds",
@@ -695,7 +702,7 @@
695
702
  "members": [
696
703
  {
697
704
  "disabled": false,
698
- "document": "Scaling group ID",
705
+ "document": "Scaling group ID. obtain the scaling group ID by logging in to the console (https://console.cloud.tencent.com/autoscaling/group) or calling the api DescribeAutoScalingGroups (https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1), and retrieve AutoScalingGroupId from the returned information.",
699
706
  "example": "asg-12wjuh0s",
700
707
  "member": "string",
701
708
  "name": "AutoScalingGroupId",
@@ -704,7 +711,7 @@
704
711
  },
705
712
  {
706
713
  "disabled": false,
707
- "document": "List of classic CLB IDs. Up to 20 classic CLBs can be bound to a security group. `LoadBalancerIds` and `ForwardLoadBalancers` cannot be specified at the same time.",
714
+ "document": "Specifies a list of classic clb ids. each scaling group can bind a maximum of 20 classic clbs. either LoadBalancerIds or ForwardLoadBalancers can be specified at the same time. can be obtained through the [DescribeLoadBalancers](https://intl.cloud.tencent.com/document/product/214/30685?from_cn_redirect=1) api.",
708
715
  "example": "[\"lb-crhgatrf\"]",
709
716
  "member": "string",
710
717
  "name": "LoadBalancerIds",
@@ -713,7 +720,7 @@
713
720
  },
714
721
  {
715
722
  "disabled": false,
716
- "document": "List of application CLBs. Up to 100 application CLBs can be bound to a scaling group. `LoadBalancerIds` and `ForwardLoadBalancers` cannot be specified at the same time.",
723
+ "document": "Specifies the list of load balancers. each scaling group can bind a maximum of 100 application clbs. either LoadBalancerIds or ForwardLoadBalancers can be specified at the same time. can be obtained through the [DescribeLoadBalancers](https://intl.cloud.tencent.com/document/product/214/30685?from_cn_redirect=1) api.",
717
724
  "example": "[{\"LoadBalancerId\": \"lb-af8li2kn\", \"ListenerId\": \"lbl-akw1lgo7\", \"TargetAttributes\": [{\"Port\": 80, \"Weight\": 10}]}]",
718
725
  "member": "ForwardLoadBalancer",
719
726
  "name": "ForwardLoadBalancers",
@@ -956,7 +963,7 @@
956
963
  },
957
964
  {
958
965
  "disabled": false,
959
- "document": "Termination policy",
966
+ "document": "Destruction policy. valid values are as follows:.\n<Li>OLDEST_INSTANCE: terminate the oldest instance in the scaling group first, default value.</li>.\n<Li>NEWEST_INSTANCE: terminate the newest instance in the scaling group first.</li>.",
960
967
  "example": "OLDEST_INSTANCE",
961
968
  "member": "string",
962
969
  "name": "TerminationPolicySet",
@@ -966,7 +973,7 @@
966
973
  },
967
974
  {
968
975
  "disabled": false,
969
- "document": "VPC ID",
976
+ "document": "VPC ID.",
970
977
  "example": "vpc-h3cd5td5",
971
978
  "member": "string",
972
979
  "name": "VpcId",
@@ -986,7 +993,7 @@
986
993
  },
987
994
  {
988
995
  "disabled": false,
989
- "document": "Retry policy",
996
+ "document": "Retry policy. a partially successful scaling operation is considered a failed activity. valid values are as follows:.\n<Li>IMMEDIATE_RETRY: default value, means retry immediately, attempting retries in rapid succession over a short period. cease further retries after a certain number of consecutive failures (5).</li>.\n<Li>INCREMENTAL_INTERVALS: specifies incremental interval retry. with the number of consecutive failures, the retry interval gradually increases. the first 10 retries are quick retry, and the follow-up retry interval gradually expands to 10 minutes, 30 minutes, 60 minutes, and one day.</li>.\n<Li>NO_RETRY: there will be no retry until another user call or Alarm information is received.</li>.",
990
997
  "example": "NO_RETRY",
991
998
  "member": "string",
992
999
  "name": "RetryPolicy",
@@ -1026,7 +1033,7 @@
1026
1033
  },
1027
1034
  {
1028
1035
  "disabled": false,
1029
- "document": "The number of IPv6 addresses that an instance has.",
1036
+ "document": "The number of IPv6 addresses that an instance has. valid values: 0 and 1. default value: 0, which means the instance does not allocate an IPv6 address. use a private network that supports ip and enable IPv6 CIDR in the subnet. for usage restrictions, see [IPv6 usage limits](https://intl.cloud.tencent.com/document/product/1142/38369?from_cn_redirect=1).",
1030
1037
  "example": "0",
1031
1038
  "member": "int64",
1032
1039
  "name": "Ipv6AddressCount",
@@ -1056,7 +1063,7 @@
1056
1063
  },
1057
1064
  {
1058
1065
  "disabled": false,
1059
- "document": "Grace period of the CLB health check",
1066
+ "document": "Grace period of the CLB health check. the scaled-out instances IN `IN_SERVICE` will not be marked as `CLB_UNHEALTHY` within the specified time range.\nDefault value: 0. value range: [0, 7200]. measurement unit: seconds.",
1060
1067
  "example": "300",
1061
1068
  "member": "uint64",
1062
1069
  "name": "LoadBalancerHealthCheckGracePeriod",
@@ -1096,7 +1103,7 @@
1096
1103
  },
1097
1104
  {
1098
1105
  "disabled": false,
1099
- "document": "Instance name sequencing settings.\nNote: This field may return null, indicating that no valid value can be obtained.",
1106
+ "document": "Instance name sequencing settings.",
1100
1107
  "example": "{\"BeginIndex\": 0, \"Enabled\": true}",
1101
1108
  "member": "InstanceNameIndexSettings",
1102
1109
  "name": "InstanceNameIndexSettings",
@@ -1142,7 +1149,7 @@
1142
1149
  "example": "asg-19kw47wk",
1143
1150
  "member": "string",
1144
1151
  "name": "AutoScalingGroupId",
1145
- "required": true,
1152
+ "output_required": true,
1146
1153
  "type": "string",
1147
1154
  "value_allowed_null": false
1148
1155
  },
@@ -1152,17 +1159,17 @@
1152
1159
  "example": "[\"12529\"]",
1153
1160
  "member": "string",
1154
1161
  "name": "NotificationUserGroupIds",
1155
- "required": true,
1162
+ "output_required": true,
1156
1163
  "type": "list",
1157
1164
  "value_allowed_null": false
1158
1165
  },
1159
1166
  {
1160
1167
  "disabled": false,
1161
- "document": "List of notification events.",
1168
+ "document": "Notification event list. valid values are as follows:.\n<Li>SCALE_OUT_SUCCESSFUL: scale-out succeeded</li>.\n<Li>SCALE_OUT_FAILED: scale-out failed</li>.\n<Li>SCALE_IN_SUCCESSFUL: scale-in succeeded</li>.\n<Li>SCALE_IN_FAILED: scale-in failed</li>.\n<Li>REPLACE_UNHEALTHY_INSTANCE_SUCCESSFUL: unhealthy instance replacement succeeded</li>.\n<Li>REPLACE_UNHEALTHY_INSTANCE_FAILED: unhealthy instance replacement failed</li>.",
1162
1169
  "example": "[\"SCALE_OUT_SUCCESSFUL\"]",
1163
1170
  "member": "string",
1164
1171
  "name": "NotificationTypes",
1165
- "required": true,
1172
+ "output_required": true,
1166
1173
  "type": "list",
1167
1174
  "value_allowed_null": false
1168
1175
  },
@@ -1172,37 +1179,37 @@
1172
1179
  "example": "asn-6r4waxc4",
1173
1180
  "member": "string",
1174
1181
  "name": "AutoScalingNotificationId",
1175
- "required": true,
1182
+ "output_required": true,
1176
1183
  "type": "string",
1177
1184
  "value_allowed_null": false
1178
1185
  },
1179
1186
  {
1180
1187
  "disabled": false,
1181
- "document": "Notification receiver type.",
1188
+ "document": "Notification receiver type. valid values:.\nUSER_GROUP: specifies the user group.\nTDMQ_CMQ_TOPIC: tdmq for cmq topic.\nTDMQ_CMQ_QUEUE: specifies the tdmq cmq queue.\n`CMQ_QUEUE`: cmq queue. [cmq API offline](https://intl.cloud.tencent.com/document/product/1496/83970?from_cn_redirect=1). unable to select.\nCMQ_TOPIC: cmq topic. [cmq API offline](https://intl.cloud.tencent.com/document/product/1496/83970?from_cn_redirect=1), unable to select.",
1182
1189
  "example": "USER_GROUP",
1183
1190
  "member": "string",
1184
1191
  "name": "TargetType",
1185
- "required": true,
1192
+ "output_required": true,
1186
1193
  "type": "string",
1187
1194
  "value_allowed_null": false
1188
1195
  },
1189
1196
  {
1190
1197
  "disabled": false,
1191
- "document": "CMQ queue name.",
1198
+ "document": "TDMQ CMQ queue name.",
1192
1199
  "example": "test-queue",
1193
1200
  "member": "string",
1194
1201
  "name": "QueueName",
1195
- "required": true,
1202
+ "output_required": true,
1196
1203
  "type": "string",
1197
1204
  "value_allowed_null": false
1198
1205
  },
1199
1206
  {
1200
1207
  "disabled": false,
1201
- "document": "CMQ topic name.",
1208
+ "document": "TDMQ CMQ topic name.",
1202
1209
  "example": "test-topic",
1203
1210
  "member": "string",
1204
1211
  "name": "TopicName",
1205
- "required": true,
1212
+ "output_required": true,
1206
1213
  "type": "string",
1207
1214
  "value_allowed_null": false
1208
1215
  }
@@ -1214,7 +1221,7 @@
1214
1221
  "members": [
1215
1222
  {
1216
1223
  "disabled": false,
1217
- "document": "Scaling group ID.",
1224
+ "document": "Scaling group ID. obtain available scaling group ids in the following ways:.\n<li>Query the scaling group ID by logging in to the [console](https://console.cloud.tencent.com/autoscaling/group).</li>.\n<li>Specifies the scaling group ID obtained by calling the api [DescribeAutoScalingGroups](https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1) and retrieving the AutoScalingGroupId from the return information.</li>.",
1218
1225
  "example": "asg-u7dy6t5r",
1219
1226
  "member": "string",
1220
1227
  "name": "AutoScalingGroupId",
@@ -1223,7 +1230,7 @@
1223
1230
  },
1224
1231
  {
1225
1232
  "disabled": false,
1226
- "document": "Refresh activity ID.",
1233
+ "document": "Refresh activity ID. you can obtain the instance refresh activity ID by calling the api [DescribeRefreshActivities](https://intl.cloud.tencent.com/document/api/377/99175?from_cn_redirect=1) and retrieving the RefreshActivityId from the returned information.",
1227
1234
  "example": "asr-dhwt6r54",
1228
1235
  "member": "string",
1229
1236
  "name": "RefreshActivityId",
@@ -1250,7 +1257,7 @@
1250
1257
  "members": [
1251
1258
  {
1252
1259
  "disabled": false,
1253
- "document": "Launch configuration ID",
1260
+ "document": "Launch configuration ID. obtain in the following ways:.\n<li>Queries the launch configuration ID by logging in to the [console](https://console.cloud.tencent.com/autoscaling/config).</li>.\n<li>Get the launch configuration ID by calling the api [DescribeLaunchConfigurations](https://intl.cloud.tencent.com/document/api/377/20445?from_cn_redirect=1) and retrieving the LaunchConfigurationId from the returned information.</li>.",
1254
1261
  "example": "asc-w37yt5r4",
1255
1262
  "member": "string",
1256
1263
  "name": "LaunchConfigurationId",
@@ -1331,7 +1338,7 @@
1331
1338
  "members": [
1332
1339
  {
1333
1340
  "disabled": false,
1334
- "document": "Lifecycle hook ID",
1341
+ "document": "Lifecycle hook ID. you can get the lifecycle hook ID by calling the api [DescribeLifecycleHooks](https://intl.cloud.tencent.com/document/api/377/34452?from_cn_redirect=1) and retrieving the `LifecycleHookId` from the returned information.",
1335
1342
  "example": "ash-fbjiexz7",
1336
1343
  "member": "string",
1337
1344
  "name": "LifecycleHookId",
@@ -1340,7 +1347,7 @@
1340
1347
  },
1341
1348
  {
1342
1349
  "disabled": false,
1343
- "document": "Result of the lifecycle action. Value range: \"CONTINUE\", \"ABANDON\"",
1350
+ "document": "Describes the result of the lifecycle action. valid values are as follows:.\n<Li>CONTINUE: default value, means continue execution of capacity expansion or reduction</li>.\n<li>ABANDON: for scale-out hooks, CVM instances with hook timeout or failed LifecycleCommand execution will be released directly or moved; for scale-in hooks, scale-in activities will continue.</li>.",
1344
1351
  "example": "CONTINUE",
1345
1352
  "member": "string",
1346
1353
  "name": "LifecycleActionResult",
@@ -1349,7 +1356,7 @@
1349
1356
  },
1350
1357
  {
1351
1358
  "disabled": false,
1352
- "document": "Instance ID. Either \"InstanceId\" or \"LifecycleActionToken\" must be specified",
1359
+ "document": "One of the parameters `InstanceId` or `LifecycleActionToken` is required. you can get the instance ID by logging in to the [console](https://console.cloud.tencent.com/cvm/index) or making an api call to [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1) and retrieving the `InstanceId` from the returned information.",
1353
1360
  "example": "ins-ni8bpmve",
1354
1361
  "member": "string",
1355
1362
  "name": "InstanceId",
@@ -1358,7 +1365,7 @@
1358
1365
  },
1359
1366
  {
1360
1367
  "disabled": false,
1361
- "document": "Either \"InstanceId\" or \"LifecycleActionToken\" must be specified",
1368
+ "document": "Lifecycle action token. specifies that one of `InstanceId` or `LifecycleActionToken` must be filled.\nThe method for accessing the parameter is as follows: when the hook of the `NotificationTarget` parameter is triggered, deliver a message containing the token to the message queue specified in the `NotificationTarget` parameter. the message queue consumer can obtain the token from the message.",
1362
1369
  "example": "34b59a82-6435-4516-90db-c98aeb46769b",
1363
1370
  "member": "string",
1364
1371
  "name": "LifecycleActionToken",
@@ -1385,7 +1392,7 @@
1385
1392
  "members": [
1386
1393
  {
1387
1394
  "disabled": false,
1388
- "document": "The scaling group name. It must be unique under your account. The name can only contain letters, numbers, underscore, hyphen “-” and periods. It cannot exceed 55 bytes.",
1395
+ "document": "The scaling group name. It must be unique under your account. The name can only contain letters, numbers, underscore, hyphen \"-\" and periods. It cannot exceed 55 bytes.",
1389
1396
  "example": "asgname",
1390
1397
  "member": "string",
1391
1398
  "name": "AutoScalingGroupName",
@@ -1394,7 +1401,7 @@
1394
1401
  },
1395
1402
  {
1396
1403
  "disabled": false,
1397
- "document": "The instance ID.",
1404
+ "document": "Instance ID. you can get the instance ID by logging in to the [console](https://console.cloud.tencent.com/cvm/index) or making an api call to [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1) and retrieving the `InstanceId` from the returned information.",
1398
1405
  "example": "ins-aaaabbbb",
1399
1406
  "member": "string",
1400
1407
  "name": "InstanceId",
@@ -1403,7 +1410,7 @@
1403
1410
  },
1404
1411
  {
1405
1412
  "disabled": false,
1406
- "document": "The minimum number of instances. Value range: 0-2000.",
1413
+ "document": "Minimum number of instances. value range: [0,2000]. to meet MaxSize >= DesiredCapacity >= MinSize at the same time.",
1407
1414
  "example": "1",
1408
1415
  "member": "int64",
1409
1416
  "name": "MinSize",
@@ -1412,7 +1419,7 @@
1412
1419
  },
1413
1420
  {
1414
1421
  "disabled": false,
1415
- "document": "The maximum number of instances. Value range: 0-2000.",
1422
+ "document": "Maximum instance count. value range [0,2000]. to meet MaxSize >= DesiredCapacity >= MinSize.",
1416
1423
  "example": "1",
1417
1424
  "member": "int64",
1418
1425
  "name": "MaxSize",
@@ -1421,7 +1428,7 @@
1421
1428
  },
1422
1429
  {
1423
1430
  "disabled": false,
1424
- "document": "The desired capacity. Its value must be greater than the minimum and smaller than the maximum.",
1431
+ "document": "Expected number of instances, value ranges from 0 to 2000, default value equals current MinSize, to meet MaxSize >= DesiredCapacity >= MinSize.",
1425
1432
  "example": "1",
1426
1433
  "member": "int64",
1427
1434
  "name": "DesiredCapacity",
@@ -1449,7 +1456,7 @@
1449
1456
  "example": "asg-aaaabbbb",
1450
1457
  "member": "string",
1451
1458
  "name": "AutoScalingGroupId",
1452
- "required": true,
1459
+ "output_required": true,
1453
1460
  "type": "string",
1454
1461
  "value_allowed_null": false
1455
1462
  },
@@ -1476,7 +1483,7 @@
1476
1483
  },
1477
1484
  {
1478
1485
  "disabled": false,
1479
- "document": "Launch configuration ID",
1486
+ "document": "Launch configuration ID. you can obtain the launch configuration ID by logging in to the [console](https://console.cloud.tencent.com/autoscaling/config) or making an api call to [DescribeLaunchConfigurations](https://intl.cloud.tencent.com/document/api/377/20445?from_cn_redirect=1) and retrieving the LaunchConfigurationId from the returned information.",
1480
1487
  "example": "asc-aaaabbbb",
1481
1488
  "member": "string",
1482
1489
  "name": "LaunchConfigurationId",
@@ -1485,7 +1492,7 @@
1485
1492
  },
1486
1493
  {
1487
1494
  "disabled": false,
1488
- "document": "Maximum number of instances. Value range: 0-2,000.",
1495
+ "document": "Maximum instance count. value range [0,2000]. to meet MaxSize >= DesiredCapacity >= MinSize.",
1489
1496
  "example": "1",
1490
1497
  "member": "uint64",
1491
1498
  "name": "MaxSize",
@@ -1494,7 +1501,7 @@
1494
1501
  },
1495
1502
  {
1496
1503
  "disabled": false,
1497
- "document": "Minimum number of instances. Value range: 0-2,000.",
1504
+ "document": "Minimum number of instances. value range: [0,2000]. to meet MaxSize >= DesiredCapacity >= MinSize at the same time.",
1498
1505
  "example": "1",
1499
1506
  "member": "uint64",
1500
1507
  "name": "MinSize",
@@ -1503,7 +1510,7 @@
1503
1510
  },
1504
1511
  {
1505
1512
  "disabled": false,
1506
- "document": "VPC ID; if on a basic network, enter an empty string",
1513
+ "document": "vpc ID. a valid vpc ID can be queried by logging in to the console (https://console.cloud.tencent.com/vpc/vpc). you can also call the api DescribeVpc (https://intl.cloud.tencent.com/document/api/215/15778?from_cn_redirect=1) and obtain it from the VpcId field in the api response.",
1507
1514
  "example": "vpc-uhygtf56",
1508
1515
  "member": "string",
1509
1516
  "name": "VpcId",
@@ -1512,7 +1519,7 @@
1512
1519
  },
1513
1520
  {
1514
1521
  "disabled": false,
1515
- "document": "Default cooldown period in seconds. Default value: 300",
1522
+ "document": "Default cooldown period in seconds. default value: 300. value range: [0,3600].",
1516
1523
  "example": "300",
1517
1524
  "member": "uint64",
1518
1525
  "name": "DefaultCooldown",
@@ -1521,7 +1528,7 @@
1521
1528
  },
1522
1529
  {
1523
1530
  "disabled": false,
1524
- "document": "Desired number of instances. The number should be no larger than the maximum and no smaller than minimum number of instances",
1531
+ "document": "The expected number of instances, in the range of [0,2000], default value equals current MinSize, and must meet MaxSize >= DesiredCapacity >= MinSize.",
1525
1532
  "example": "1",
1526
1533
  "member": "uint64",
1527
1534
  "name": "DesiredCapacity",
@@ -1530,7 +1537,7 @@
1530
1537
  },
1531
1538
  {
1532
1539
  "disabled": false,
1533
- "document": "List of classic CLB IDs. Currently, the maximum length is 20. You cannot specify LoadBalancerIds and ForwardLoadBalancers at the same time.",
1540
+ "document": "A list of classic load balancer ids with a current maximum length of 20. either LoadBalancerIds or ForwardLoadBalancers can be specified at the same time. can be obtained through the [DescribeLoadBalancers](https://intl.cloud.tencent.com/document/product/214/30685?from_cn_redirect=1) api.",
1534
1541
  "example": "[\"lb-uhygtf56\"]",
1535
1542
  "member": "string",
1536
1543
  "name": "LoadBalancerIds",
@@ -1539,7 +1546,7 @@
1539
1546
  },
1540
1547
  {
1541
1548
  "disabled": false,
1542
- "document": "Project ID of an instance in a scaling group. The default project is used if it’s left blank.",
1549
+ "document": "Project ID of the instance within the scaling group. default value is 0, indicates usage of the default project. obtain this parameter by calling [DescribeProject](https://intl.cloud.tencent.com/document/api/651/78725?from_cn_redirect=1), `projectId` field in the return value.",
1543
1550
  "example": "1",
1544
1551
  "member": "uint64",
1545
1552
  "name": "ProjectId",
@@ -1548,8 +1555,8 @@
1548
1555
  },
1549
1556
  {
1550
1557
  "disabled": false,
1551
- "document": "List of application CLBs. Up to 100 CLBs are allowed. `LoadBalancerIds` and `ForwardLoadBalancers` cannot be specified at the same time.",
1552
- "example": "[{\"LoadBalancerId\": \"lb-af8li2kn\", \"ListenerId\": \"lbl-akw1lgo7\", \"TargetAttributes\": [{\"Port\": 80, \"Weight\": 10}]}]",
1558
+ "document": "Specifies the list of load balancers with a current maximum length of 100. either LoadBalancerIds or ForwardLoadBalancers can be specified at the same time.",
1559
+ "example": "",
1553
1560
  "member": "ForwardLoadBalancer",
1554
1561
  "name": "ForwardLoadBalancers",
1555
1562
  "required": false,
@@ -1557,7 +1564,7 @@
1557
1564
  },
1558
1565
  {
1559
1566
  "disabled": false,
1560
- "document": "List of subnet IDs. A subnet must be specified in the VPC scenario. If multiple subnets are entered, their priority will be determined by the order in which they are entered, and they will be tried one by one until instances can be successfully created.",
1567
+ "document": "The subnet ID list must specify a subnet in VPC scenarios. multiple subnets are attempted sequentially based on the fill-in order as priority until successful instance creation. effective VPC subnet ids can be queried by logging in to the console (https://console.cloud.tencent.com/VPC/subnet) or obtained from the SubnetId field in the API response by calling the DescribeSubnets API (https://intl.cloud.tencent.com/document/product/215/15784?from_cn_redirect=1).",
1561
1568
  "example": "[\"subnet-uhygtf56\"]",
1562
1569
  "member": "string",
1563
1570
  "name": "SubnetIds",
@@ -1567,7 +1574,7 @@
1567
1574
  {
1568
1575
  "disabled": false,
1569
1576
  "document": "Termination policy, whose maximum length is currently 1. Valid values: OLDEST_INSTANCE and NEWEST_INSTANCE. Default value: OLDEST_INSTANCE.\n<li>OLDEST_INSTANCE: Terminate the oldest instance in the scaling group first.</li>\n<li>NEWEST_INSTANCE: Terminate the newest instance in the scaling group first.</li>",
1570
- "example": "OLDEST_INSTANCE",
1577
+ "example": "[\"OLDEST_INSTANCE\"]",
1571
1578
  "member": "string",
1572
1579
  "name": "TerminationPolicies",
1573
1580
  "required": false,
@@ -1602,8 +1609,8 @@
1602
1609
  },
1603
1610
  {
1604
1611
  "disabled": false,
1605
- "document": "List of tag descriptions. In this parameter, you can specify the tags to be bound with a scaling group as well as corresponding resource instances. Each scaling group can have up to 30 tags.",
1606
- "example": "[{\"Key\": \"Service_B\", \"Value\": \"pss3\", \"ResourceType\": \"auto-scaling-group\"}]",
1612
+ "document": "List of Tag descriptions. by specifying this parameter, you can bind tags to a scaling group and corresponding resource instances. each scaling group supports up to 30 tags. you can call the [GetTags](https://intl.cloud.tencent.com/document/product/651/72275?from_cn_redirect=1) API to retrieve existing Tag key-value pairs based on the response.",
1613
+ "example": "",
1607
1614
  "member": "Tag",
1608
1615
  "name": "Tags",
1609
1616
  "required": false,
@@ -1612,7 +1619,7 @@
1612
1619
  {
1613
1620
  "disabled": false,
1614
1621
  "document": "Service settings such as unhealthy instance replacement.",
1615
- "example": "{\"ScalingMode\": \"CLASSIC_SCALING\"}",
1622
+ "example": "",
1616
1623
  "member": "ServiceSettings",
1617
1624
  "name": "ServiceSettings",
1618
1625
  "required": false,
@@ -1620,7 +1627,7 @@
1620
1627
  },
1621
1628
  {
1622
1629
  "disabled": false,
1623
- "document": "The number of IPv6 addresses that an instance has. Valid values: 0 and 1. Default value: 0.",
1630
+ "document": "The number of IPv6 addresses that an instance has. valid values: 0 and 1. default value: 0, which means the instance does not allocate an IPv6 address. use a private network that supports IPv6 and enable IPv6 CIDR in the subnet. for other usage restrictions, see [IPv6 usage limits](https://intl.cloud.tencent.com/document/product/1142/38369?from_cn_redirect=1).",
1624
1631
  "example": "1",
1625
1632
  "member": "int64",
1626
1633
  "name": "Ipv6AddressCount",
@@ -1666,7 +1673,7 @@
1666
1673
  {
1667
1674
  "disabled": false,
1668
1675
  "document": "Specifies how to assign pay-as-you-go instances and spot instances.\nThis parameter is valid only when `InstanceAllocationPolicy ` is set to `SPOT_MIXED`.",
1669
- "example": "{\"BaseCapacity\": 1, \"CompensateWithBaseInstance\": true, \"OnDemandPercentageAboveBaseCapacity\": 50, \"SpotAllocationStrategy\": \"COST_OPTIMIZED\"}",
1676
+ "example": "",
1670
1677
  "member": "SpotMixedAllocationPolicy",
1671
1678
  "name": "SpotMixedAllocationPolicy",
1672
1679
  "required": false,
@@ -1684,7 +1691,7 @@
1684
1691
  {
1685
1692
  "disabled": false,
1686
1693
  "document": "Instance name sequencing settings. If this parameter is not specified, the default is not enabled. When enabled, an incremental numeric sequence will be appended to the names of instances automatically created within the scaling group.",
1687
- "example": "{\"BeginIndex\": 0, \"Enabled\": true}",
1694
+ "example": "",
1688
1695
  "member": "InstanceNameIndexSettings",
1689
1696
  "name": "InstanceNameIndexSettings",
1690
1697
  "required": false,
@@ -1738,7 +1745,7 @@
1738
1745
  },
1739
1746
  {
1740
1747
  "disabled": false,
1741
- "document": "Project ID of the launch configuration. The default project is used if it is left blank.\nNote that this project ID is not the same as the project ID of the scaling group. ",
1748
+ "document": "Project ID of the launch configuration. default value is 0, indicating usage of the default project. obtain this parameter by calling the projectId field in the return value of [DescribeProject](https://intl.cloud.tencent.com/document/api/651/78725?from_cn_redirect=1).\nNote: the instance's project ID within the scaling group takes the project ID of the scaling group, which is irrelevant here.",
1742
1749
  "example": "0",
1743
1750
  "member": "uint64",
1744
1751
  "name": "ProjectId",
@@ -1837,7 +1844,7 @@
1837
1844
  },
1838
1845
  {
1839
1846
  "disabled": false,
1840
- "document": "List of instance models. Different instance models specify different resource specifications. Up to 10 instance models can be supported.\n`InstanceType` and `InstanceTypes` are mutually exclusive, and one and only one of them must be entered.",
1847
+ "document": "Instance model list. different instance models specify different resource specifications. supports up to 10 instance models.\nThe `InstanceType` and `InstanceTypes` parameters are mutually exclusive. one and only one must be filled in. specific values can be obtained by calling the api [DescribeInstanceTypeConfigs](https://intl.cloud.tencent.com/document/api/213/15749?from_cn_redirect=1) to obtain the latest specification table or refer to [instance specifications](https://intl.cloud.tencent.com/document/product/213/11518?from_cn_redirect=1).",
1841
1848
  "example": "[\"S5.MEDIUM2\", \"S6.MEDIUM2\"]",
1842
1849
  "member": "string",
1843
1850
  "name": "InstanceTypes",
@@ -1846,7 +1853,7 @@
1846
1853
  },
1847
1854
  {
1848
1855
  "disabled": false,
1849
- "document": "CAM role name. This parameter can be obtained from the `roleName` field returned by DescribeRoleList API.",
1856
+ "document": "CAM role name. you can obtain it from the roleName in the return value from the API [DescribeRoleList](https://intl.cloud.tencent.com/document/product/598/36223?from_cn_redirect=1).",
1850
1857
  "example": "CVM_QcsRole",
1851
1858
  "member": "string",
1852
1859
  "name": "CamRoleName",
@@ -1855,7 +1862,7 @@
1855
1862
  },
1856
1863
  {
1857
1864
  "disabled": false,
1858
- "document": "InstanceType verification policy, whose valid values include ALL and ANY, with the default value being ANY.\n<li>ALL: Verification passes if all InstanceTypes are available; otherwise, a verification error will be reported.</li>\n<li>ANY: Verification passes if any InstanceType is available; otherwise, a verification error will be reported.</li>\n\nCommon reasons for unavailable InstanceTypes include the InstanceType being sold out, and the corresponding cloud disk being sold out.\nIf a model in InstanceTypes does not exist or has been abolished, a verification error will be reported regardless of the valid values set for InstanceTypesCheckPolicy.",
1865
+ "document": "Instance type validation policy. valid values include ALL and ANY. default value: ANY. this parameter is valid only when the InstanceTypes parameter contains multiple instance types.\n<li>ALL: verification passes if ALL instancetypes are available; otherwise, a verification error will be reported.</li>.\n<li>ANY: verification passes if ANY InstanceType is available; otherwise, a verification error will be reported.</li>.\n\nCommon reasons for unavailable instancetypes include the instancetype being sold out and the corresponding cloud disk being sold out.\nIf a model in InstanceTypes does not exist or has been abolished, a verification error will be reported regardless of the valid values set for InstanceTypesCheckPolicy.",
1859
1866
  "example": "ANY",
1860
1867
  "member": "string",
1861
1868
  "name": "InstanceTypesCheckPolicy",
@@ -1918,7 +1925,7 @@
1918
1925
  },
1919
1926
  {
1920
1927
  "disabled": false,
1921
- "document": "HPC ID<br>\nNote: This field is default to empty",
1928
+ "document": "High-Performance computing cluster ID. you can obtain this parameter by calling the [DescribeHpcClusters](https://intl.cloud.tencent.com/document/product/213/83220?from_cn_redirect=1) api.\nNote: this field is empty by default.",
1922
1929
  "example": "hpc-gt4es2q1",
1923
1930
  "member": "string",
1924
1931
  "name": "HpcClusterId",
@@ -1945,7 +1952,7 @@
1945
1952
  },
1946
1953
  {
1947
1954
  "disabled": false,
1948
- "document": "Image family name. Either image ID or image family name should be filled in, and only one of which can be filled.",
1955
+ "document": "Image family name. one and only one must be filled in between image Id and image family name. this parameter can be obtained by calling the [DescribeImages](https://intl.cloud.tencent.com/document/product/213/15715?from_cn_redirect=1) api.",
1949
1956
  "example": "test-family",
1950
1957
  "member": "string",
1951
1958
  "name": "ImageFamily",
@@ -1954,7 +1961,7 @@
1954
1961
  },
1955
1962
  {
1956
1963
  "disabled": false,
1957
- "document": "CDC ID.",
1964
+ "document": "Local exclusive cluster ID. this parameter can be obtained through the [DescribeDedicatedClusters](https://intl.cloud.tencent.com/document/product/1346/73758?from_cn_redirect=1) api.",
1958
1965
  "example": "cluster-gbo27yc4",
1959
1966
  "member": "string",
1960
1967
  "name": "DedicatedClusterId",
@@ -2000,7 +2007,7 @@
2000
2007
  "members": [
2001
2008
  {
2002
2009
  "disabled": false,
2003
- "document": "Auto scaling group ID",
2010
+ "document": "Scaling group ID. obtain available scaling group ids in the following ways:.\n<li>Query the scaling group ID by logging in to the [console](https://console.cloud.tencent.com/autoscaling/group).</li>.\n<li>Specifies the scaling group ID obtained by calling the api [DescribeAutoScalingGroups](https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1) and retrieving the AutoScalingGroupId from the return information.</li>.",
2004
2011
  "example": "asg-8fbozqja",
2005
2012
  "member": "string",
2006
2013
  "name": "AutoScalingGroupId",
@@ -2018,7 +2025,7 @@
2018
2025
  },
2019
2026
  {
2020
2027
  "disabled": false,
2021
- "document": "Scenario for the lifecycle hook. Valid values: \"INSTANCE_LAUNCHING\" and \"INSTANCE_TERMINATING\"",
2028
+ "document": "Scenario for performing the lifecycle hook. valid values:.\n<Li>`INSTANCE_LAUNCHING`: the lifecycle hook is being scaled out.</li>.\n<Li>`INSTANCE_TERMINATING`: scaling in lifecycle hook</li>.",
2022
2029
  "example": "INSTANCE_LAUNCHING",
2023
2030
  "member": "string",
2024
2031
  "name": "LifecycleTransition",
@@ -2027,7 +2034,7 @@
2027
2034
  },
2028
2035
  {
2029
2036
  "disabled": false,
2030
- "document": "Defined actions when lifecycle hook times out. Valid values: \"CONTINUE\" and \"ABANDON\". Default value: \"CONTINUE\"",
2037
+ "document": "Action to be taken by the scaling group in case of lifecycle hook timeout or LifecycleCommand execution failure. valid values:.\n<Li>CONTINUE: default value, means continue execution of capacity expansion or reduction</li>.\n<li>ABANDON: for scale-out hooks, CVM instances with hook timeout or failed LifecycleCommand execution will be released directly or removed. for scale-in hooks, scale-in activities will continue.</li>.",
2031
2038
  "example": "CONTINUE",
2032
2039
  "member": "string",
2033
2040
  "name": "DefaultResult",
@@ -2045,7 +2052,7 @@
2045
2052
  },
2046
2053
  {
2047
2054
  "disabled": false,
2048
- "document": "Additional information of a notification that Auto Scaling sends to targets. This parameter is set when you configure a notification (default value: \"\"). Up to 1024 characters are allowed.",
2055
+ "document": "Additional information of a notification that auto scaling sends to targets. this parameter is set when you configure a notification (default value: \"\"), with a maximum length of 1024 characters. NotificationMetadata and LifecycleCommand are mutually exclusive, and either can be specified.",
2049
2056
  "example": "addtional-info",
2050
2057
  "member": "string",
2051
2058
  "name": "NotificationMetadata",
@@ -2063,7 +2070,7 @@
2063
2070
  },
2064
2071
  {
2065
2072
  "disabled": false,
2066
- "document": "The scenario where the lifecycle hook is applied. `EXTENSION`: the lifecycle hook will be triggered when AttachInstances, DetachInstances or RemoveInstaces is called. `NORMAL`: the lifecycle hook is not triggered by the above APIs. ",
2073
+ "document": "Specifies the scenario type for performing the lifecycle hook. valid values: NORMAL and EXTENSION. default value: NORMAL.\n`EXTENSION`: the lifecycle hook will be triggered when calling [AttachInstances](https://intl.cloud.tencent.com/document/api/377/20441?from_cn_redirect=1), [DetachInstances](https://intl.cloud.tencent.com/document/api/377/20436?from_cn_redirect=1), [removeinstances](https://intl.cloud.tencent.com/document/api/377/20431?from_cn_redirect=1), [StopAutoScalingInstances](https://intl.cloud.tencent.com/document/api/377/40286?from_cn_redirect=1), [StartAutoScalingInstances](https://intl.cloud.tencent.com/document/api/377/40287?from_cn_redirect=1), or [StartInstanceRefresh](https://intl.cloud.tencent.com/document/api/377/99172?from_cn_redirect=1). `NORMAL`: the lifecycle hook is not triggered by these apis.",
2067
2074
  "example": "NORMAL",
2068
2075
  "member": "string",
2069
2076
  "name": "LifecycleTransitionType",
@@ -2072,7 +2079,7 @@
2072
2079
  },
2073
2080
  {
2074
2081
  "disabled": false,
2075
- "document": "Remote command execution object. `NotificationTarget` and `LifecycleCommand` cannot be specified at the same time.",
2082
+ "document": "Specifies the remote command execution object. NotificationTarget and NotificationMetadata are mutually exclusive with this parameter. either cannot be specified simultaneously.",
2076
2083
  "example": "{\"CommandId\": \"cmd-am4e3hd8\", \"Parameters\": \"{123: 222}\"}",
2077
2084
  "member": "LifecycleCommand",
2078
2085
  "name": "LifecycleCommand",
@@ -2109,7 +2116,7 @@
2109
2116
  "members": [
2110
2117
  {
2111
2118
  "disabled": false,
2112
- "document": "Auto scaling group ID.",
2119
+ "document": "Scaling group ID. obtain the scaling group ID by logging in to the console (https://console.cloud.tencent.com/autoscaling/group) or calling the api DescribeAutoScalingGroups (https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1), and retrieve AutoScalingGroupId from the returned information.",
2113
2120
  "example": "asg-12wjuh0s",
2114
2121
  "member": "string",
2115
2122
  "name": "AutoScalingGroupId",
@@ -2127,7 +2134,7 @@
2127
2134
  },
2128
2135
  {
2129
2136
  "disabled": false,
2130
- "document": "Notification group ID, which is the set of user group IDs. You can query the user group IDs through the [ListGroups](https://intl.cloud.tencent.com/document/product/598/34589?from_cn_redirect=1) API.",
2137
+ "document": "Notification GROUP ID, which is the USER GROUP ID collection. USER GROUP ID can be accessed through [ListGroups](https://intl.cloud.tencent.com/document/product/598/34589?from_cn_redirect=1). this parameter is valid only when TargetType is USER_GROUP.",
2131
2138
  "example": "[\"1678\"]",
2132
2139
  "member": "string",
2133
2140
  "name": "NotificationUserGroupIds",
@@ -2136,7 +2143,7 @@
2136
2143
  },
2137
2144
  {
2138
2145
  "disabled": false,
2139
- "document": "Notification receiver type. Valid values:\n<br><li>USER_GROUP:User group\n<br><li>CMQ_QUEUE:CMQ queue\n<br><li>CMQ_TOPIC:CMQ topic\n<br><li>TDMQ_CMQ_TOPIC:TDMQ CMQ topic\n<br><li>TDMQ_CMQ_QUEUE:TDMQ CMQ queue\n\nDefault value: `USER_GROUP`.",
2146
+ "document": "Notification receiver type. values as follows:.\n<Li>USER_GROUP: user group</li>.\n<Li>TDMQ_CMQ_TOPIC: tdmq cmq topic</li>.\n<Li>TDMQ_CMQ_QUEUE: tdmq cmq queue</li>.\n<li>CMQ_QUEUE: CMQ QUEUE. [CMQ is offline](https://intl.cloud.tencent.com/document/product/1496/83970?from_cn_redirect=1). currently, only TDMQ CMQ is recommended.</li>.\n<li>CMQ_TOPIC: specifies the CMQ TOPIC. [CMQ is offline](https://intl.cloud.tencent.com/document/product/1496/83970?from_cn_redirect=1). currently, TDMQ CMQ is recommended for use.</li>.\n\nDefault value: `USER_GROUP`.",
2140
2147
  "example": "USER_GROUP",
2141
2148
  "member": "string",
2142
2149
  "name": "TargetType",
@@ -2145,7 +2152,7 @@
2145
2152
  },
2146
2153
  {
2147
2154
  "disabled": false,
2148
- "document": "CMQ queue name. This parameter is required when `TargetType` is `CMQ_QUEUE` or `TDMQ_CMQ_QUEUE`.",
2155
+ "document": "TDMQ CMQ QUEUE name. this field is required if TargetType value is `TDMQ_CMQ_QUEUE`.",
2149
2156
  "example": "queue",
2150
2157
  "member": "string",
2151
2158
  "name": "QueueName",
@@ -2154,7 +2161,7 @@
2154
2161
  },
2155
2162
  {
2156
2163
  "disabled": false,
2157
- "document": "CMQ topic name. This parameter is required when `TargetType` is `CMQ_TOPIC` or `TDMQ_CMQ_TOPIC`.",
2164
+ "document": "TDMQ CMQ TOPIC name. this field is required when `TargetType` is `TDMQ_CMQ_TOPIC`.",
2158
2165
  "example": "topic",
2159
2166
  "member": "string",
2160
2167
  "name": "TopicName",
@@ -2173,7 +2180,7 @@
2173
2180
  "example": "asn-2sestqbr",
2174
2181
  "member": "string",
2175
2182
  "name": "AutoScalingNotificationId",
2176
- "required": true,
2183
+ "output_required": true,
2177
2184
  "type": "string",
2178
2185
  "value_allowed_null": false
2179
2186
  },
@@ -2191,7 +2198,7 @@
2191
2198
  "members": [
2192
2199
  {
2193
2200
  "disabled": false,
2194
- "document": "Auto scaling group ID.",
2201
+ "document": "Scaling group ID. obtain the scaling group ID by logging in to the console (https://console.cloud.tencent.com/autoscaling/group) or calling the api DescribeAutoScalingGroups (https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1), and retrieve AutoScalingGroupId from the returned information.",
2195
2202
  "example": "asg-12wjuh0s",
2196
2203
  "member": "string",
2197
2204
  "name": "AutoScalingGroupId",
@@ -2200,7 +2207,7 @@
2200
2207
  },
2201
2208
  {
2202
2209
  "disabled": false,
2203
- "document": "Alarm trigger policy name.",
2210
+ "document": "The Alarm policy name must be unique in your account. the name length cannot exceed 60 characters. the name only supports chinese, english, digits, underscores, hyphens, and decimal points.",
2204
2211
  "example": "cpu_policy_test",
2205
2212
  "member": "string",
2206
2213
  "name": "ScalingPolicyName",
@@ -2209,7 +2216,7 @@
2209
2216
  },
2210
2217
  {
2211
2218
  "disabled": false,
2212
- "document": "Scaling policy type. Valid values: <br><li>`SIMPLE` (default): A simple policy</li><li>`TARGET_TRACKING`: A target tracking policy</li>.",
2219
+ "document": "Alarm trigger policy type. default: SIMPLE. valid values:.\n<Li>`SIMPLE`: a simple policy.</li>.\n<Li>`TARGET_TRACKING`: a target tracking policy.</li>.",
2213
2220
  "example": "SIMPLE",
2214
2221
  "member": "string",
2215
2222
  "name": "ScalingPolicyType",
@@ -2218,7 +2225,7 @@
2218
2225
  },
2219
2226
  {
2220
2227
  "disabled": false,
2221
- "document": "The method to adjust the desired capacity after the alarm is triggered. It is only available when `ScalingPolicyType` is `Simple`. Valid values: <br><li>`CHANGE_IN_CAPACITY`: Increase or decrease the desired capacity </li><li>`EXACT_CAPACITY`: Adjust to the specified desired capacity </li> <li>`PERCENT_CHANGE_IN_CAPACITY`: Adjust the desired capacity by percentage </li>",
2228
+ "document": "After an Alarm is triggered, specifies the method for modifying the expected number of instances. required in the scenario of simple policies. valid values:.\n<Li>CHANGE_IN_CAPACITY: increase or decrease the expected number of instances</li>.\n<Li>EXACT_CAPACITY: adjust to the expected number of instances</li>.\n<Li>PERCENT_CHANGE_IN_CAPACITY: adjust expected instance number by percent</li>.",
2222
2229
  "example": "CHANGE_IN_CAPACITY",
2223
2230
  "member": "string",
2224
2231
  "name": "AdjustmentType",
@@ -2227,7 +2234,7 @@
2227
2234
  },
2228
2235
  {
2229
2236
  "disabled": false,
2230
- "document": "Adjustment value for the expected number of instances after an alarm is triggered, which is applicable only to simple policies.\n<li>When AdjustmentType is set to CHANGE_IN_CAPACITY, a positive value of AdjustmentValue indicates an increase in the number of instances after the alarm is triggered, while a negative value indicates a decrease in the number of instances after the alarm is triggered.</li>\n<li>When AdjustmentType is set to EXACT_CAPACITY, the value of AdjustmentValue indicates the new desired number of instances after the alarm is triggered. It should be greater than or equal to 0.</li>\n<li>When AdjustmentType is set to PERCENT_CHANGE_IN_CAPACITY, a positive value of AdjustmentValue indicates an increase in the number of instances by a percentage after the alarm is triggered, while a negative value indicates a decrease in the number of instances by a percentage after the alarm is triggered. Unit: %.</li>",
2237
+ "document": "Adjustment value for the expected number of instances after an Alarm is triggered, which is applicable only to simple policies and required in simple policy scenarios.\n<li>When AdjustmentType is CHANGE_IN_CAPACITY, a positive AdjustmentValue indicates an increase IN instances after Alarm trigger, while a negative value indicates a decrease IN instances after Alarm trigger.</li>. \n<li>When AdjustmentType is set to EXACT_CAPACITY, the value of AdjustmentValue indicates the new desired number of instances after the Alarm is triggered. it must be at least 0.</li>. \n<li>When AdjustmentType is set to PERCENT_CHANGE_IN_CAPACITY, a positive value of AdjustmentValue indicates an increase in the number of instances by a percentage after the alarm is triggered, while a negative value indicates a decrease in the number of instances by a percentage after the alarm is triggered. Unit: %.</li>",
2231
2238
  "example": "1",
2232
2239
  "member": "int64",
2233
2240
  "name": "AdjustmentValue",
@@ -2245,7 +2252,7 @@
2245
2252
  },
2246
2253
  {
2247
2254
  "disabled": false,
2248
- "document": "Alarm monitoring metric. It is only available when `ScalingPolicyType` is `Simple`.",
2255
+ "document": "Alarm monitoring metric, apply only to simple policies, required in the scenario of simple policy.",
2249
2256
  "example": "{\"ComparisonOperator\": \"GREATER_THAN\", \"ContinuousTime\": 1, \"MetricName\": \"CPU_UTILIZATION\", \"Period\": 60, \"Statistic\": \"AVERAGE\", \"Threshold\": 15}",
2250
2257
  "member": "MetricAlarm",
2251
2258
  "name": "MetricAlarm",
@@ -2254,7 +2261,7 @@
2254
2261
  },
2255
2262
  {
2256
2263
  "disabled": false,
2257
- "document": "Predefined monitoring item, applicable only to target tracking policies. Valid values:\n<li>ASG_AVG_CPU_UTILIZATION: average CPU utilization</li>\n<li>ASG_AVG_LAN_TRAFFIC_OUT: average outbound private network bandwidth</li>\n<li>ASG_AVG_LAN_TRAFFIC_IN: average inbound private network bandwidth</li>\n<li>ASG_AVG_WAN_TRAFFIC_OUT: average outbound public network bandwidth</li>\n<li>ASG_AVG_WAN_TRAFFIC_IN: average inbound public network bandwidth</li>",
2264
+ "document": "Predefined monitoring item, applicable only to target tracking policies. required in the scenario. value range:.\n<Li>ASG_AVG_CPU_UTILIZATION: average cpu utilization</li>.\n<Li>ASG_AVG_LAN_TRAFFIC_OUT: specifies the average outbound private network bandwidth.</li>.\n<Li>ASG_AVG_LAN_TRAFFIC_IN: average inbound private network bandwidth</li>.\n<Li>ASG_AVG_WAN_TRAFFIC_OUT: specifies the average outbound public network bandwidth.</li>.\n<li>ASG_AVG_WAN_TRAFFIC_IN: average inbound public network bandwidth</li>",
2258
2265
  "example": "ASG_AVG_CPU_UTILIZATION",
2259
2266
  "member": "string",
2260
2267
  "name": "PredefinedMetricType",
@@ -2263,7 +2270,7 @@
2263
2270
  },
2264
2271
  {
2265
2272
  "disabled": false,
2266
- "document": "Target value, which is applicable only to target tracking policies.\n<li>ASG_AVG_CPU_UTILIZATION: value range: [1, 100); unit: %.</li>\n<li>ASG_AVG_LAN_TRAFFIC_OUT: value range: > 0; unit: Mbps.</li>\n<li>ASG_AVG_LAN_TRAFFIC_IN: value range: > 0; unit: Mbps.</li>\n<li>ASG_AVG_WAN_TRAFFIC_OUT: value range: > 0; unit: Mbps.</li>\n<li>ASG_AVG_WAN_TRAFFIC_IN: value range: > 0; unit: Mbps.</li>",
2273
+ "document": "Target value, applicable only to the target tracking policy, required in the scenario.\n<Li>ASG_AVG_CPU_UTILIZATION: value range: [1, 100); unit: %.</li>.\n<li>ASG_AVG_LAN_TRAFFIC_OUT: value range: > 0; unit: Mbps.</li>.\n<li>ASG_AVG_LAN_TRAFFIC_IN: value range: > 0; unit: Mbps.</li>.\n<li>ASG_AVG_WAN_TRAFFIC_OUT: value range: > 0; unit: Mbps.</li>.\n<li>ASG_AVG_WAN_TRAFFIC_IN: value range: > 0; unit: Mbps.</li>",
2267
2274
  "example": "10",
2268
2275
  "member": "uint64",
2269
2276
  "name": "TargetValue",
@@ -2327,7 +2334,7 @@
2327
2334
  "members": [
2328
2335
  {
2329
2336
  "disabled": false,
2330
- "document": "Auto scaling group ID",
2337
+ "document": "Scaling group ID. obtain available scaling group ids in the following ways:.\n<li>Query the scaling group ID by logging in to the [console](https://console.cloud.tencent.com/autoscaling/group).</li>.\n<li>Specifies the scaling group ID obtained by calling the api [DescribeAutoScalingGroups](https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1) and retrieving the AutoScalingGroupId from the return information.</li>.",
2331
2338
  "example": "asg-2nr9xh8h",
2332
2339
  "member": "string",
2333
2340
  "name": "AutoScalingGroupId",
@@ -2345,21 +2352,21 @@
2345
2352
  },
2346
2353
  {
2347
2354
  "disabled": false,
2348
- "document": "The maximum number of instances set for the auto scaling group when the scheduled task is triggered.",
2349
- "example": "10",
2355
+ "document": "The minimum number of instances set for the auto scaling group when the scheduled task is triggered.",
2356
+ "example": "4",
2350
2357
  "member": "uint64",
2351
- "name": "MaxSize",
2358
+ "name": "MinSize",
2352
2359
  "required": true,
2353
2360
  "type": "int"
2354
2361
  },
2355
2362
  {
2356
2363
  "disabled": false,
2357
- "document": "The minimum number of instances set for the auto scaling group when the scheduled task is triggered.",
2358
- "example": "4",
2359
- "member": "uint64",
2360
- "name": "MinSize",
2364
+ "document": "Initial triggered time of the scheduled task. The value is in `Beijing time` (UTC+8) in the format of `YYYY-MM-DDThh:mm:ss+08:00` according to the `ISO8601` standard.",
2365
+ "example": "2018-08-28T23:00:00+08:00",
2366
+ "member": "datetime_iso",
2367
+ "name": "StartTime",
2361
2368
  "required": true,
2362
- "type": "int"
2369
+ "type": "string"
2363
2370
  },
2364
2371
  {
2365
2372
  "disabled": false,
@@ -2372,12 +2379,12 @@
2372
2379
  },
2373
2380
  {
2374
2381
  "disabled": false,
2375
- "document": "Initial triggered time of the scheduled task. The value is in `Beijing time` (UTC+8) in the format of `YYYY-MM-DDThh:mm:ss+08:00` according to the `ISO8601` standard.",
2376
- "example": "2018-08-28T23:00:00+08:00",
2377
- "member": "datetime_iso",
2378
- "name": "StartTime",
2382
+ "document": "The maximum number of instances set for the auto scaling group when the scheduled task is triggered.",
2383
+ "example": "10",
2384
+ "member": "uint64",
2385
+ "name": "MaxSize",
2379
2386
  "required": true,
2380
- "type": "string"
2387
+ "type": "int"
2381
2388
  },
2382
2389
  {
2383
2390
  "disabled": false,
@@ -2390,12 +2397,21 @@
2390
2397
  },
2391
2398
  {
2392
2399
  "disabled": false,
2393
- "document": "Repeating mode of the scheduled task, which is in standard cron format. <br><br>This parameter and `EndTime` need to be specified at the same time.",
2400
+ "document": "The repeating mode of a scheduled task follows the standard Cron format. the [Recurrence parameter limits](https://intl.cloud.tencent.com/document/product/377/88119?from_cn_redirect=1) in a scheduled task consist of 5 fields separated by spaces, with the structure: minute, hour, date, month, week. this parameter must be simultaneously specified with `EndTime`.",
2394
2401
  "example": "0 14 */1 * *",
2395
2402
  "member": "string",
2396
2403
  "name": "Recurrence",
2397
2404
  "required": false,
2398
2405
  "type": "string"
2406
+ },
2407
+ {
2408
+ "disabled": false,
2409
+ "document": "Disable update DesiredCapacity Indicates the DesiredCapacity is updated normally during scheduled task triggering.\n\nSpecifies whether the scheduled task triggers proactive modification of the DesiredCapacity when the value is True. DesiredCapacity may be modified by the minSize and maxSize mechanism.\nThe following cases assume that DisableUpdateDesiredCapacity is True:\n- When scheduled task triggered, the original DesiredCapacity is 5. The scheduled task changes the minSize to 10, the maxSize to 20, and the DesiredCapacity to 15. Since the DesiredCapacity update is disabled, 15 does not take effect. However, the original DesiredCapacity 5 is less than minSize 10, so the final new DesiredCapacity is 10.\n- When scheduled task triggered, the original DesiredCapacity is 25. The scheduled task changes the minSize to 10 and the maxSize to 20, and the DesiredCapacity to 15. Since the DesiredCapacity update is disabled, 15 does not take effect. However, the original DesiredCapacity 25 is greater than the maxSize 20, so the final new DesiredCapacity is 20.\n- When scheduled task triggered, the original DesiredCapacity is 13. The scheduled task changes the minSize to 10 and the maxSize to 20, and the DesiredCapacity to 15. Since the DesiredCapacity update is disabled, 15 does not take effect, and the DesiredCapacity is still 13.",
2410
+ "example": "false",
2411
+ "member": "bool",
2412
+ "name": "DisableUpdateDesiredCapacity",
2413
+ "required": false,
2414
+ "type": "bool"
2399
2415
  }
2400
2416
  ],
2401
2417
  "type": "object"
@@ -2427,7 +2443,7 @@
2427
2443
  "members": [
2428
2444
  {
2429
2445
  "disabled": false,
2430
- "document": "Data disk type. For restrictions on the data disk type, see [cloud block storage types](https://intl.cloud.tencent.com/document/product/362/2353?from_cn_redirect=1). Valid values:\n<li>LOCAL_BASIC: Local Disk.</li>\n<li>LOCAL_SSD: Local SSD.</li>\n<li>CLOUD_BASIC: Basic Cloud Disk.</li>\n<li>CLOUD_PREMIUM: Premium Disk.</li>\n<li>CLOUD_SSD: Cloud SSD.</li>\n<li>CLOUD_HSSD: Enhanced SSD.</li>\n<li>CLOUD_TSSD: Tremendous SSD.</li>\nThe default value is consistent with the system disk type (SystemDisk.DiskType).",
2446
+ "document": "Data disk type. for restrictions on data disk types, see [cloud block storage types](https://intl.cloud.tencent.com/document/product/362/2353?from_cn_redirect=1). valid values:.\n<Li>LOCAL_BASIC: local hard disk.</li>.\n<Li>LOCAL_SSD: local ssd.</li>.\n<Li>CLOUD_BASIC: general cloud disk.</li>.\n<Li>CLOUD_PREMIUM: high-performance cloud block storage</li>.\n<Li>CLOUD_SSD: cloud ssd</li>.\n<Li>CLOUD_HSSD: enhanced ssd cloud disk</li>.\n<Li>CLOUD_TSSD: ultra ssd.</li>.\n<Li>CLOUD_BSSD: universal ssd cloud disk</li>.\nThe default value is consistent with the system disk type (SystemDisk.DiskType).",
2431
2447
  "example": "CLOUD_PREMIUM",
2432
2448
  "member": "string",
2433
2449
  "name": "DiskType",
@@ -2438,7 +2454,7 @@
2438
2454
  },
2439
2455
  {
2440
2456
  "disabled": false,
2441
- "document": "Data disk size, in GB. The minimum adjustment step size is 10 GB. The value range varies according to the data disk type. For specific restrictions, see [CVM instance configuration](https://intl.cloud.tencent.com/document/product/213/2177?from_cn_redirect=1). Default value: 0, which means that no data disk is purchased. For more restrictions, see the product documentation.",
2457
+ "document": "Data disk size, in GB. the value range varies according to the data disk type. for specific restrictions, see [CVM instance configuration](https://intl.cloud.tencent.com/document/product/213/2177?from_cn_redirect=1). default value: 0, which means no data disk is purchased. for more restrictions, see the [product documentation](https://intl.cloud.tencent.com/document/product/362/5145?from_cn_redirect=1).",
2442
2458
  "example": "0",
2443
2459
  "member": "uint64",
2444
2460
  "name": "DiskSize",
@@ -2449,7 +2465,7 @@
2449
2465
  },
2450
2466
  {
2451
2467
  "disabled": false,
2452
- "document": "Data disk snapshot ID, such as `snap-l8psqwnt`.\nNote: This field may return null, indicating that no valid values can be obtained.",
2468
+ "document": "The data disk snapshot ID can be obtained through the [DescribeSnapshots](https://intl.cloud.tencent.com/document/product/362/15647?from_cn_redirect=1) api.\nNote: This field may return null, indicating that no valid values can be obtained.",
2453
2469
  "example": "snap-l8psqwnt",
2454
2470
  "member": "string",
2455
2471
  "name": "SnapshotId",
@@ -2493,7 +2509,7 @@
2493
2509
  },
2494
2510
  {
2495
2511
  "disabled": false,
2496
- "document": "Burst performance: Whether to enable burst performance. The default value is false.\n\nNote: This feature is in beta test and requires a ticket to be submitted for usage.\nNote: This field may return null, indicating that no valid values can be obtained.",
2512
+ "document": "Burst performance. specifies whether to enable burst performance. default value is false. this parameter only supports ultra-fast CLOUD disk (CLOUD_TSSD) and enhanced SSD CLOUD disk (CLOUD_HSSD) with capacity > 460GB.\nNote: this feature is in beta test and requires a ticket to be submitted for usage.\nNote: This field may return null, indicating that no valid values can be obtained.",
2497
2513
  "example": "false",
2498
2514
  "member": "bool",
2499
2515
  "name": "BurstPerformance",
@@ -2510,7 +2526,7 @@
2510
2526
  "members": [
2511
2527
  {
2512
2528
  "disabled": false,
2513
- "document": "Auto scaling group ID",
2529
+ "document": "Scaling group ID. obtain the scaling group ID by logging in to the console (https://console.cloud.tencent.com/autoscaling/group) or calling the api DescribeAutoScalingGroups (https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1), and retrieve AutoScalingGroupId from the returned information.",
2514
2530
  "example": "asg-nvnlpbb8",
2515
2531
  "member": "string",
2516
2532
  "name": "AutoScalingGroupId",
@@ -2537,8 +2553,8 @@
2537
2553
  "members": [
2538
2554
  {
2539
2555
  "disabled": false,
2540
- "document": "ID of the launch configuration to be deleted.",
2541
- "example": "asc-aaaabbbb",
2556
+ "document": "Specifies the launch configuration ID that needs to be deleted. you can obtain the launch configuration ID by logging in to the [console](https://console.cloud.tencent.com/autoscaling/config) or calling the api [DescribeLaunchConfigurations](https://intl.cloud.tencent.com/document/api/377/20445?from_cn_redirect=1) and retrieving the LaunchConfigurationId from the returned information.",
2557
+ "example": "asc-deuy6tre",
2542
2558
  "member": "string",
2543
2559
  "name": "LaunchConfigurationId",
2544
2560
  "required": true,
@@ -2564,7 +2580,7 @@
2564
2580
  "members": [
2565
2581
  {
2566
2582
  "disabled": false,
2567
- "document": "Lifecycle hook ID",
2583
+ "document": "Lifecycle hook ID. calling the api [DescribeLifecycleHooks](https://intl.cloud.tencent.com/document/api/377/34452?from_cn_redirect=1) and retrieving the LifecycleHookId from the returned information obtains the lifecycle hook ID.",
2568
2584
  "example": "ash-5rynk2n5",
2569
2585
  "member": "string",
2570
2586
  "name": "LifecycleHookId",
@@ -2591,7 +2607,7 @@
2591
2607
  "members": [
2592
2608
  {
2593
2609
  "disabled": false,
2594
- "document": "ID of the notification to be deleted.",
2610
+ "document": "The notification ID to be deleted. this is currently a required parameter. you can obtain the notification ID by logging in to the console (https://console.cloud.tencent.com/autoscaling/group) or calling the api [DescribeNotificationConfigurations](https://intl.cloud.tencent.com/document/api/377/33183?from_cn_redirect=1) and retrieving the AutoScalingNotificationId from the returned information.",
2595
2611
  "example": "asn-2sestqbr",
2596
2612
  "member": "string",
2597
2613
  "name": "AutoScalingNotificationId",
@@ -2618,7 +2634,7 @@
2618
2634
  "members": [
2619
2635
  {
2620
2636
  "disabled": false,
2621
- "document": "ID of the alarm policy to be deleted.",
2637
+ "document": "The Alarm policy ID to be deleted. you can obtain the Alarm policy ID by logging in to the console (https://console.cloud.tencent.com/autoscaling/group) or calling the api [DescribeScalingPolicies](https://intl.cloud.tencent.com/document/api/377/33178?from_cn_redirect=1) and retrieving the AutoScalingPolicyId from the returned information.",
2622
2638
  "example": "asp-lnfqbsoq",
2623
2639
  "member": "string",
2624
2640
  "name": "AutoScalingPolicyId",
@@ -2645,7 +2661,7 @@
2645
2661
  "members": [
2646
2662
  {
2647
2663
  "disabled": false,
2648
- "document": "ID of the scheduled task to be deleted.",
2664
+ "document": "Scheduled task ID to be deleted. obtain the scheduled task ID by calling the api [DescribeScheduledActions](https://intl.cloud.tencent.com/document/api/377/20450?from_cn_redirect=1) and retrieving the ScheduledActionId from the returned information.",
2649
2665
  "example": "asst-chwbkq4c",
2650
2666
  "member": "string",
2651
2667
  "name": "ScheduledActionId",
@@ -2738,7 +2754,7 @@
2738
2754
  },
2739
2755
  {
2740
2756
  "disabled": false,
2741
- "document": "Filter.\n<li> auto-scaling-group-id - String - Required: No - (Filter) Filter by auto scaling group ID.</li>\n<li> activity-status-code - String - Required: No - (Filter) Filter by scaling activity status . (INIT: initializing | RUNNING: running | SUCCESSFUL: succeeded | PARTIALLY_SUCCESSFUL: partially succeeded | FAILED: failed | CANCELLED: canceled)</li>\n<li> activity-type - String - Required: No - (Filter) Filter by scaling activity type. (SCALE_OUT: scale-out | SCALE_IN: scale-in | ATTACH_INSTANCES: adding an instance | REMOVE_INSTANCES: terminating an instance | DETACH_INSTANCES: removing an instance | TERMINATE_INSTANCES_UNEXPECTEDLY: terminating an instance in the CVM console | REPLACE_UNHEALTHY_INSTANCE: replacing an unhealthy instance | UPDATE_LOAD_BALANCERS: updating a load balancer)</li>\n<li> activity-id - String - Required: No - (Filter) Filter by scaling activity ID.</li>\nThe maximum number of `Filters` per request is 10. The upper limit for `Filter.Values` is 5. This parameter does not support specifying both `ActivityIds` and `Filters` at the same time.",
2757
+ "document": "Filter criteria. the filter field value ranges from...to.\n<ul>\n<li><strong>auto-scaling-group-id</strong><ul><li>Filter by [<strong>scaling group id</strong>]. you can log IN to the [console](https://console.cloud.tencent.com/autoscaling/group) or call the api [DescribeAutoScalingGroups](https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1) to obtain the scaling group id from the returned information.</li><li>type: String</li><li>required: no</li><li>example value: asg-kiju7yt5</li></ul></li> <li><strong>activity-status-code</strong><ul><li>filter by [<strong>scaling activity status</strong>]</li><li>type: String</li><li>required: no</li><li>options: </li><ul><li>INIT: initializing</li><li>RUNNING: RUNNING</li><li>SUCCESSFUL: SUCCESSFUL activity</li><li>PARTIALLY_SUCCESSFUL: PARTIALLY SUCCESSFUL activity</li><li>FAILED: activity FAILED</li><li>CANCELLED: activity CANCELLED</li></ul></ul></li> <li><strong>activity-type</strong><ul><li>filter by [<strong>scaling activity type</strong>]</li><li>type: String</li><li>required: no</li><li>options: </li><ul><li>SCALE_OUT: SCALE-OUT activity</li><li>SCALE_IN: SCALE-IN activity</li><li>ATTACH_INSTANCES: adding INSTANCES</li><li>REMOVE_INSTANCES: terminating INSTANCES</li><li>DETACH_INSTANCES: REMOVE INSTANCE</li><li>TERMINATE_INSTANCES_UNEXPECTEDLY: TERMINATE INSTANCE IN CVM console</li><li>REPLACE_UNHEALTHY_INSTANCE: REPLACE UNHEALTHY INSTANCES</li><li>START_INSTANCES: START INSTANCES</li><li>STOP_INSTANCES: shut down INSTANCE</li><li>INVOKE_COMMAND: execute COMMAND</li></ul></ul></li> <li><strong>activity-id</strong><ul><li>filter by [<strong>scaling activity id</strong>]. you can log IN to the [console](https://console.cloud.tencent.com/autoscaling/group) to obtain the scaling activity id.</li><li>type: String</li><li>required: no</li><li>example value: asa-hy6tr4ed</li></ul></li></ul>.\nThe maximum number of `Filters` per request is 10. the upper limit for `Filter.Values` is 5. parameters must not specify both `ActivityIds` and `Filters` simultaneously.",
2742
2758
  "example": "[{\"Name\": \"auto-scaling-group-id\", \"Values\": [\"asg-mgmeawez\"]}]",
2743
2759
  "member": "Filter",
2744
2760
  "name": "Filters",
@@ -2821,7 +2837,7 @@
2821
2837
  "members": [
2822
2838
  {
2823
2839
  "disabled": false,
2824
- "document": "List of scaling groups to be queried. Upper limit: 100.",
2840
+ "document": "The scaling group list to be queried, with an upper limit of 100. obtain the scaling group ID by logging in to the console (https://console.cloud.tencent.com/autoscaling/group) or calling the api [DescribeAutoScalingGroups](https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1) and retrieving the AutoScalingGroupId from the returned information.",
2825
2841
  "example": "[\"asg-2pvrsyog\", \"asg-4wtj6aeq\"]",
2826
2842
  "member": "string",
2827
2843
  "name": "AutoScalingGroupIds",
@@ -2858,7 +2874,7 @@
2858
2874
  "members": [
2859
2875
  {
2860
2876
  "disabled": false,
2861
- "document": "ID list of auto scaling groups.",
2877
+ "document": "Auto scaling group ID list. obtain the scaling group ID by logging in to the console (https://console.cloud.tencent.com/autoscaling/group) or calling the api DescribeAutoScalingGroups (https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1) and retrieving AutoScalingGroupId from the returned information.",
2862
2878
  "example": "[\"asg-2umy3jbd\"]",
2863
2879
  "member": "string",
2864
2880
  "name": "AutoScalingGroupIds",
@@ -2913,7 +2929,7 @@
2913
2929
  },
2914
2930
  {
2915
2931
  "disabled": false,
2916
- "document": "Filters.\n<li> auto-scaling-group-id - String - Required: No - (Filter) Filter by auto scaling group ID.</li>\n<li> auto-scaling-group-name - String - Required: No - (Filter) Filter by auto scaling group name.</li>\n<li> vague-auto-scaling-group-name - String - Required: No - (Filter) Fuzzy search by auto scaling group name.</li>\n<li> launch-configuration-id - String - Required: No - (Filter) Filter by launch configuration ID.</li>\n<li> tag-key - String - Required: No - (Filter) Filter by tag key.</li>\n<li> tag-value - String - Required: No - (Filter) Filter by tag value.</li>\n<li> tag:tag-key - String - Required: No - (Filter) Filter by tag key-value pair. The tag-key should be replaced with a specified tag key. For more information, see example 2.</li>\nThe maximum number of `Filters` in each request is 10. The upper limit for `Filter.Values` is 5. This parameter cannot specify `AutoScalingGroupIds` and `Filters` at the same time.",
2932
+ "document": "Filter criteria\n\n<li> auto-scaling-group-id - String - required: no - (filter) filter by auto scaling group id.</li>.\nSpecifies the scaling group ID obtained by logging in to the [console](https://console.cloud.tencent.com/autoscaling/group) or calling the api [DescribeAutoScalingGroups](https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1) and retrieving the AutoScalingGroupId from the return information.\n<li> auto-scaling-group-name - String - required: no - (filter) filter by auto scaling group name.</li>.\n<li> vague-auto-scaling-group-name - String - required: no - (filter) filter by scaling group name fuzzy search.</li>.\n<li>launch-configuration-id - String - required: no - (filter condition) filter by launch configuration id. you can obtain the launch configuration id by logging in to the console (https://console.cloud.tencent.com/autoscaling/config) or calling the api DescribeLaunchConfigurations (https://intl.cloud.tencent.com/document/api/377/20445?from_cn_redirect=1) and retrieving the LaunchConfigurationId from the returned information.</li>.\n<li> `tag-key` - String - optional - filter by the tag key. you can call the API [GetTags](https://intl.cloud.tencent.com/document/product/651/72275?from_cn_redirect=1) to obtain the tag key from the returned information.</li>.\n<li>tag-value - String - required: no - (filter condition) filter by tag value. you can obtain the tag value by calling the API [GetTags](https://intl.cloud.tencent.com/document/product/651/72275?from_cn_redirect=1) and retrieving the TagValue from the returned information.</li>.\n<li>tag:tag-key - String - required: no - (filter condition) filter by tag key-value pair. replace tag-key with a specific tag key. see example 2 for reference. call the API [GetTags](https://intl.cloud.tencent.com/document/product/651/72275?from_cn_redirect=1) to obtain the TagKey from the returned information.</li>.\nThe maximum number of `Filters` per request is 10, and that of `Filter.Values` is 5. the `AutoScalingGroupIds` and `Filters` parameters cannot be specified simultaneously.",
2917
2933
  "example": "[{\"Name\": \"auto-scaling-group-name\", \"Values\": [\"production-as\"]}]",
2918
2934
  "member": "Filter",
2919
2935
  "name": "Filters",
@@ -2947,7 +2963,7 @@
2947
2963
  {
2948
2964
  "disabled": false,
2949
2965
  "document": "List of auto scaling group details.",
2950
- "example": "[{\"InActivityStatus\": \"NOT_IN_ACTIVITY\", \"LoadBalancerIdSet\": [], \"RetryPolicy\": \"IMMEDIATE_RETRY\", \"InServiceInstanceCount\": 0, \"CreatedTime\": \"2022-03-19T04:39:52Z\", \"VpcId\": \"vpc-nqayns0m\", \"InstanceAllocationPolicy\": \"LAUNCH_CONFIGURATION\", \"Tags\": [], \"LaunchConfigurationId\": \"asc-rgrdh183\",\"MaxSize\": 500, \"MultiZoneSubnetPolicy\": \"EQUALITY\", \"SubnetIdSet\": [\"subnet-d9gneeoz\",], \"HealthCheckType\": \"CLB\", \"LoadBalancerHealthCheckGracePeriod\": 0, \"ForwardLoadBalancerSet\": [], \"ProjectId\": 0, \"AutoScalingGroupName\": \"tke-np-w\", \"MinSize\": 0, \"ServiceSettings\": {\"ReplaceMonitorUnhealthy\": false, \"ReplaceLoadBalancerUnhealthy\": false, \"ReplaceMode\": \"RECREATE\", \"ScalingMode\": \"CLASSIC_SCALING\"}, \"LaunchConfigurationName\": \"tke-np-ww\", \"CapacityRebalance\": false, \"TerminationPolicySet\": [\"OLDEST_INSTANCE\"], \"AutoScalingGroupStatus\": \"NORMAL\", \"InstanceCount\": 0, \"DesiredCapacity\": 0, \"AutoScalingGroupId\": \"asg-07tasrpr\", \"Ipv6AddressCount\": 0, \"DefaultCooldown\": 300, \"EnabledStatus\": \"ENABLED\", \"ZoneSet\": []}]",
2966
+ "example": "",
2951
2967
  "member": "AutoScalingGroup",
2952
2968
  "name": "AutoScalingGroupSet",
2953
2969
  "output_required": true,
@@ -2978,7 +2994,7 @@
2978
2994
  "members": [
2979
2995
  {
2980
2996
  "disabled": false,
2981
- "document": "IDs of the CVM instances to query. Up to 100 IDs can be queried at one time. `InstanceIds` and `Filters` can not be both specified.",
2997
+ "document": "IDs of the CVM instances to query. the instance ID list has a length limit of 100. `InstanceIds` and `Filters` cannot be specified simultaneously.\nYou can get available instance ids in the following ways:.\n<li>Query instance ID by logging in to the <a href=\"https://console.cloud.tencent.com/cvm/index\">console</a>.</li>.\n<li>Get the instance ID by calling the api [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1) and retrieving the `InstanceId` from the returned information.</li>.",
2982
2998
  "example": "[\"ins-1fswxz1m\"]",
2983
2999
  "member": "string",
2984
3000
  "name": "InstanceIds",
@@ -2987,7 +3003,7 @@
2987
3003
  },
2988
3004
  {
2989
3005
  "disabled": false,
2990
- "document": "Filter.\n<li> instance-id - String - Required: No - (Filter) Filter by instance ID.</li>\n<li> auto-scaling-group-id - String - Required: No - (Filter) Filter by auto scaling group ID.</li>\nThe maximum number of `Filters` per request is 10. The upper limit for `Filter.Values` is 5. This parameter does not support specifying both `InstanceIds` and `Filters` at the same time.",
3006
+ "document": "Filter criteria\n\n<li> instance-id - String - required: no - (filter condition) filter by instance id. get the instance id by logging in to the [console](https://console.cloud.tencent.com/cvm/index) or making an api call to [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1), and retrieve the `InstanceId` from the returned information.</li>.\n<li> auto-scaling-group-id - String - required: no - (filter) filter by auto scaling group id. you can obtain the scaling group id by logging in to the [console](https://console.cloud.tencent.com/autoscaling/group) or making an api call to [DescribeAutoScalingGroups](https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1) and retrieving the AutoScalingGroupId from the returned information.</li>.\nThe maximum number of `Filters` per request is 10, and the maximum number of `Filter.Values` is 5. parameters do not support specifying both `InstanceIds` and `Filters`.",
2991
3007
  "example": "[{\"Name\": \"auto-scaling-group-id\", \"Values\": [\"asg-ewdpp04x\"]}]",
2992
3008
  "member": "Filter",
2993
3009
  "name": "Filters",
@@ -3021,7 +3037,7 @@
3021
3037
  {
3022
3038
  "disabled": false,
3023
3039
  "document": "List of instance details.",
3024
- "example": "[{\"ProtectedFromScaleIn\": true, \"Zone\": \"sa-saopaulo-1\", \"CreationType\": \"AUTO_CREATION\", \"AutoScalingGroupId\": \"asg-f7rsts7d\", \"AddTime\": \"2024-07-25T13:16:42Z\", \"WarmupStatus\": \"NO_NEED_WARMUP\", \"LaunchConfigurationId\": \"asc-m4usv5o3\", \"AutoScalingGroupName\": \"tke-np-ss\", \"InstanceId\": \"ins-kajsxfzp\", \"VersionNumber\": 1, \"HealthStatus\": \"HEALTHY\", \"LifeCycleState\": \"IN_SERVICE\", \"LaunchConfigurationName\": \"tke-np-sd\", \"InstanceType\": \"S5.2XLARGE32\"}]",
3040
+ "example": "",
3025
3041
  "member": "Instance",
3026
3042
  "name": "AutoScalingInstanceSet",
3027
3043
  "output_required": true,
@@ -3200,7 +3216,7 @@
3200
3216
  "members": [
3201
3217
  {
3202
3218
  "disabled": false,
3203
- "document": "Queries by one or more notification IDs in the format of asn-2sestqbr. The maximum number of instances per request is 100. This parameter does not support specifying both `AutoScalingNotificationIds` and `Filters` at the same time.",
3219
+ "document": "Query by one or more notification ids. the list length limit is 100. you can obtain the notification ID by logging in to the console (https://console.cloud.tencent.com/autoscaling/group). parameters AutoScalingNotificationIds and Filters must not be specified simultaneously.",
3204
3220
  "example": "[\"asn-9bhwvxqh\"]",
3205
3221
  "member": "string",
3206
3222
  "name": "AutoScalingNotificationIds",
@@ -3209,7 +3225,7 @@
3209
3225
  },
3210
3226
  {
3211
3227
  "disabled": false,
3212
- "document": "Filter.\n<li> auto-scaling-notification-id - String - Required: No - (Filter) Filter by notification ID.</li>\n<li> auto-scaling-group-id - String - Required: No - (Filter) Filter by auto scaling group ID.</li>\nThe maximum number of `Filters` per request is 10. The upper limit for `Filter.Values` is 5. This parameter does not support specifying both `AutoScalingNotificationIds` and `Filters` at the same time.",
3228
+ "document": "Filter criteria\n\n<li> auto-scaling-notification-id - String - required: no - (filter) filter by notification id.</li>.\n<li> auto-scaling-group-id - String - required: no - (filter) filter by auto scaling group id. you can obtain the scaling group id by logging in to the console (https://console.cloud.tencent.com/autoscaling/group) or calling the api DescribeAutoScalingGroups (https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1) and retrieving the AutoScalingGroupId from the returned information.</li>.\nThe maximum number of `Filters` per request is 10, and that of `Filter.Values` is 5. the `AutoScalingNotificationIds` and `Filters` parameters cannot be specified simultaneously.",
3213
3229
  "example": "[{\"Name\": \"auto-scaling-group-id\", \"Values\": [\"asg-hyfg539t\"]}]",
3214
3230
  "member": "Filter",
3215
3231
  "name": "Filters",
@@ -3253,7 +3269,7 @@
3253
3269
  {
3254
3270
  "disabled": false,
3255
3271
  "document": "List of AS event notification details.",
3256
- "example": "[{\"TargetType\": \"USER_GROUP\", \"EnvironmentId\": \"\", \"AutoScalingGroupId\": \"asg-nimsv934\", \"ClusterId\": \"\", \"AutoScalingNotificationId\": \"asn-5wswisk2\", \"NotificationTypes\": [\"SCALE_OUT_FAILED\", \"SCALE_IN_SUCCESSFUL\", \"REPLACE_UNHEALTHY_INSTANCE_SUCCESSFUL\", \"REPLACE_UNHEALTHY_INSTANCE_FAILED\", \"SCALE_IN_FAILED\", \"SCALE_OUT_SUCCESSFUL\"], \"QueueName\": \"\", \"NotificationUserGroupIds\": [\"10000079\"], \"TopicName\": \"\"}]",
3272
+ "example": "",
3257
3273
  "member": "AutoScalingNotification",
3258
3274
  "name": "AutoScalingNotificationSet",
3259
3275
  "output_required": true,
@@ -3283,7 +3299,7 @@
3283
3299
  },
3284
3300
  {
3285
3301
  "disabled": false,
3286
- "document": "Filter criteria\n\n<li> auto-scaling-group-id - String - Required: No - (Filter) Filter by auto scaling group ID.</li>\n<li> refresh-activity-status-code - String - Required: No - (Filter)Filter based on refresh activity status. (INIT: Initialization | RUNNING:Running | SUCCESSFUL: Successful Activity | FAILED_PAUSE: Failed & Paused | AUTO_PAUSE: Auto Paused | MANUAL_PAUSE: Manually Paused | CANCELLED: Activity Cancelled | FAILED: Activity Failed)</li>\n<li> refresh-activity-type - String - Required: No - (Filter) Filter by refresh activity types. (NORMAL: Regular Refresh Activity | ROLLBACK: Rollback Refresh Activity)</li>\n<li> refresh-activity-id - String - Required: No - (Filter) Filter by refresh activity ID.</li>\n<li>The upper limit of Filters per request is 10, and that of Filter.Values is 5. The RefreshActivityIds and Filters parameters cannot be specified at the same time.</li>",
3302
+ "document": "Filter criteria\n\n<li> auto-scaling-group-id - String - required: no - (filter) filter by auto scaling group id. obtain the scaling group id by logging in to the [console](https://console.cloud.tencent.com/autoscaling/group) or calling the api [DescribeAutoScalingGroups](https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1) and retrieving the AutoScalingGroupId from the returned information.</li>.\n<li> refresh-activity-status-code - String - required: no - (filter criteria) filters by refresh activity status. (INIT: initializing | RUNNING: RUNNING | SUCCESSFUL: activity SUCCESSFUL | FAILED_PAUSE: PAUSE on failure | AUTO_PAUSE: AUTO PAUSE | MANUAL_PAUSE: manually PAUSE | CANCELLED: activity CANCELLED | FAILED: activity FAILED)</li>.\n<li> refresh-activity-type - String - required: no - (filter) filter by refresh activity types. (NORMAL: regular refresh activity | ROLLBACK: ROLLBACK refresh activity)</li>.\n<li> refresh-activity-id - String - required: no - (filter) filter by refresh activity id.</li>.\n<li>The upper limit of Filters per request is 10, and that of Filter.Values is 5. The RefreshActivityIds and Filters parameters cannot be specified at the same time.</li>",
3287
3303
  "example": "[{\"Name\": \"auto-scaling-group-id\", \"Values\": [\"asg-ewdpp04x\"]}]",
3288
3304
  "member": "Filter",
3289
3305
  "name": "Filters",
@@ -3327,7 +3343,7 @@
3327
3343
  {
3328
3344
  "disabled": false,
3329
3345
  "document": "A collection of information about refresh activities that meet the conditions.",
3330
- "example": "[{\"Status\": \"SUCCESSFUL\", \"RefreshBatchSet\": [{\"RefreshBatchNum\": 1, \"EndTime\": \"2024-11-06T19:01:08Z\", \"RefreshBatchRelatedInstanceSet\": [{\"InstanceId\": \"ins-me0846cu\", \"InstanceStatusMessage\": \"success\", \"LastActivityId\": \"asa-8ayecku8\", \"InstanceStatus\": \"SUCCESSFUL\"}], \"StartTime\": \"2024-11-06T19:00:14Z\", \"RefreshBatchStatus\": \"SUCCESSFUL\"}], \"RefreshMode\": \"ROLLING_UPDATE_RESET\", \"AutoScalingGroupId\": \"asg-7nfe25uy\", \"ActivityType\": \"NORMAL\", \"RefreshSettings\": {\"CheckInstanceTargetHealth\": true, \"RollingUpdateSettings\": {\"BatchNumber\": 1, \"MaxSurge\": 1, \"BatchPause\": \"AUTOMATIC\"}}, \"OriginRefreshActivityId\": \"\", \"CurrentRefreshBatchNum\": 1, \"RefreshActivityId\": \"asr-1pex1gkq\", \"StartTime\": \"2024-11-06T18:59:20Z\", \"CreatedTime\": \"2024-11-06T18:59:20Z\", \"EndTime\": \"2024-11-06T19:01:15Z\"}]",
3346
+ "example": "",
3331
3347
  "member": "RefreshActivity",
3332
3348
  "name": "RefreshActivitySet",
3333
3349
  "output_required": true,
@@ -3357,7 +3373,7 @@
3357
3373
  },
3358
3374
  {
3359
3375
  "disabled": false,
3360
- "document": "Filters.\n<li> `auto-scaling-policy-id` - String - Optional - Filter by the alarm policy ID.</li>\n<li> `auto-scaling-group-id` - String - Optional - Filter by the scaling group ID.</li>\n<li> `scaling-policy-name` - String - Optional - Filter by the alarm policy name.</li>\n<li> `scaling-policy-type` - String - Optional - Filter by the alarm policy type. Valid values: `SIMPLE`, `TARGET_TRACKING`.</li>\nThe maximum number of `Filters` per request is 10. The upper limit for `Filter.Values` is 5. You cannot specify `AutoScalingPolicyIds` and `Filters` at the same time.",
3376
+ "document": "Filter criteria\n\n<li> auto-scaling-policy-id - String - required: no - (filter) filter by alert policy id.</li>.\n<li> auto-scaling-group-id - String - required: no - (filter) filter by auto scaling group id. obtain the scaling group id by logging in to the [console](https://console.cloud.tencent.com/autoscaling/group) or calling the api [DescribeAutoScalingGroups](https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1) and retrieving the AutoScalingGroupId from the returned information.</li>.\n<li>scaling-policy-name - String - required: no - (filter condition) filters by Alarm policy name.</li>.\n<li>scaling-policy-type - String - required: no - (filter criteria) filters by Alarm policy type. valid values: SIMPLE, TARGET_TRACKING, representing SIMPLE policy and TARGET TRACKING policy respectively.</li>.\nThe maximum number of `Filters` per request is 10, and that of `Filter.Values` is 5. the `AutoScalingPolicyIds` and `Filters` parameters cannot be specified simultaneously.",
3361
3377
  "example": "[{\"Name\": \"auto-scaling-group-id\", \"Values\": [\"asg-ewdpp04x\"]}]",
3362
3378
  "member": "Filter",
3363
3379
  "name": "Filters",
@@ -3422,7 +3438,7 @@
3422
3438
  "members": [
3423
3439
  {
3424
3440
  "disabled": false,
3425
- "document": "Queries by one or more scheduled task IDs in the format of asst-am691zxo. The maximum number of instances per request is 100. This parameter does not support specifying both ScheduledActionIds` and `Filters` at the same time.",
3441
+ "document": "Query by one or more scheduled task ids. you can obtain the scheduled task ID by logging in to the console (https://console.cloud.tencent.com/autoscaling/group). the maximum number of instances per request is 100. parameters ScheduledActionIds and Filters must not be specified simultaneously.",
3426
3442
  "example": "[\"asst-caa5ha40\"]",
3427
3443
  "member": "string",
3428
3444
  "name": "ScheduledActionIds",
@@ -3431,7 +3447,7 @@
3431
3447
  },
3432
3448
  {
3433
3449
  "disabled": false,
3434
- "document": "Filter.\n<li> scheduled-action-id - String - Required: No - (Filter) Filter by scheduled task ID.</li>\n<li> scheduled-action-name - String - Required: No - (Filter) Filter by scheduled task name.</li>\n<li> auto-scaling-group-id - String - Required: No - (Filter) Filter by auto scaling group ID.</li>",
3450
+ "document": "Filter criteria. obtain the scheduled task ID, scheduled task name, and scaling group ID by logging in to the console (https://console.cloud.tencent.com/autoscaling/group).\n<li> scheduled-action-id - String - required: no - (filter) filter by scheduled task id.</li>.\n<li> scheduled-action-name - String - required: no - (filter criteria) filters by scheduled task name.</li>.\n<li> auto-scaling-group-id - String - required: no - (filter) filter by auto scaling group id.</li>.",
3435
3451
  "example": "[{\"Name\": \"auto-scaling-group-name\", \"Values\": [\"production-as\"]}]",
3436
3452
  "member": "Filter",
3437
3453
  "name": "Filters",
@@ -3496,7 +3512,7 @@
3496
3512
  "members": [
3497
3513
  {
3498
3514
  "disabled": false,
3499
- "document": "Auto scaling group ID",
3515
+ "document": "Auto scaling group ID. obtain available scaling group ids in the following ways:.\n<li>Query the scaling group ID by logging in to the [console](https://console.cloud.tencent.com/autoscaling/group).</li>.\n<li>Specifies the scaling group ID obtained by calling the api [DescribeAutoScalingGroups](https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1) and retrieving the AutoScalingGroupId from the return information.</li>.",
3500
3516
  "example": "asg-boz1qhnk",
3501
3517
  "member": "string",
3502
3518
  "name": "AutoScalingGroupId",
@@ -3505,7 +3521,7 @@
3505
3521
  },
3506
3522
  {
3507
3523
  "disabled": false,
3508
- "document": "List of CVM instance IDs",
3524
+ "document": "List of CVM instance ids. you can obtain available instance ids in the following ways:.\n<li>Query instance ID by logging in to the <a href=\"https://console.cloud.tencent.com/cvm/index\">console</a>.</li>.\n<li>Specifies the instance ID by calling the api [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1) and getting `InstanceId` from the return information.</li>.",
3509
3525
  "example": "[\"ins-cri8d02t\",\"ins-osckfnm7\"]",
3510
3526
  "member": "string",
3511
3527
  "name": "InstanceIds",
@@ -3542,7 +3558,7 @@
3542
3558
  "members": [
3543
3559
  {
3544
3560
  "disabled": false,
3545
- "document": "Scaling group ID",
3561
+ "document": "Scaling group ID. obtain the scaling group ID by logging in to the console (https://console.cloud.tencent.com/autoscaling/group) or calling the api DescribeAutoScalingGroups (https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1), and retrieve AutoScalingGroupId from the returned information.",
3546
3562
  "example": "asg-12wjuh0s",
3547
3563
  "member": "string",
3548
3564
  "name": "AutoScalingGroupId",
@@ -3551,7 +3567,7 @@
3551
3567
  },
3552
3568
  {
3553
3569
  "disabled": false,
3554
- "document": "List of classic CLB IDs. Up to 20 IDs are allowed. `LoadBalancerIds` and `ForwardLoadBalancerIdentifications` cannot be specified at the same time.",
3570
+ "document": "Specifies a list of classic load balancer ids with a maximum length of 20. either LoadBalancerIds or ForwardLoadBalancerIdentifications can be specified at the same time. can be obtained through the [DescribeLoadBalancers](https://intl.cloud.tencent.com/document/product/214/30685?from_cn_redirect=1) api.",
3555
3571
  "example": "[\"lb-crhgatrf\"]",
3556
3572
  "member": "string",
3557
3573
  "name": "LoadBalancerIds",
@@ -3560,7 +3576,7 @@
3560
3576
  },
3561
3577
  {
3562
3578
  "disabled": false,
3563
- "document": "List of application CLB IDs. Up to 100 IDs are allowed. `LoadBalancerIds` and `ForwardLoadBalancerIdentifications` cannot be specified at the same time.",
3579
+ "document": "Specifies the list of cloud load balancer identification information with a maximum length of 100. either LoadBalancerIds or ForwardLoadBalancerIdentifications can be specified at the same time. can be obtained through the [DescribeLoadBalancers](https://intl.cloud.tencent.com/document/product/214/30685?from_cn_redirect=1) api.",
3564
3580
  "example": "[{\"ListenerId\": \"lbl-mqnrswr0\", \"LoadBalancerId\": \"lb-k7cs98bu\", \"LocationId\": \"loc-ivbajssu\"}]",
3565
3581
  "member": "ForwardLoadBalancerIdentification",
3566
3582
  "name": "ForwardLoadBalancerIdentifications",
@@ -3673,7 +3689,7 @@
3673
3689
  "members": [
3674
3690
  {
3675
3691
  "disabled": false,
3676
- "document": "Scaling group ID",
3692
+ "document": "Scaling group ID. obtain the scaling group ID by logging in to the console (https://console.cloud.tencent.com/autoscaling/group) or calling the api DescribeAutoScalingGroups (https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1), and retrieve AutoScalingGroupId from the returned information.",
3677
3693
  "example": "asg-nvnlpbb8",
3678
3694
  "member": "string",
3679
3695
  "name": "AutoScalingGroupId",
@@ -3700,7 +3716,7 @@
3700
3716
  "members": [
3701
3717
  {
3702
3718
  "disabled": false,
3703
- "document": "Auto scaling group ID",
3719
+ "document": "Scaling group ID. you can obtain the scaling group ID by logging in to the [console](https://console.cloud.tencent.com/autoscaling/group) or making an api call to [DescribeAutoScalingGroups](https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1) and retrieving the AutoScalingGroupId from the returned information.",
3704
3720
  "example": "asg-nvnlpbb8",
3705
3721
  "member": "string",
3706
3722
  "name": "AutoScalingGroupId",
@@ -3768,12 +3784,58 @@
3768
3784
  ],
3769
3785
  "usage": "both"
3770
3786
  },
3787
+ "EnterStandbyRequest": {
3788
+ "document": "EnterStandby request structure.",
3789
+ "members": [
3790
+ {
3791
+ "disabled": false,
3792
+ "document": "Scaling group ID. obtain available scaling group ids in the following ways:.\n<li>Query the scaling group ID by logging in to the [console](https://console.cloud.tencent.com/autoscaling/group).</li>.\n<li>Specifies the scaling group ID obtained by calling the api [DescribeAutoScalingGroups](https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1) and retrieving the AutoScalingGroupId from the return information.</li>.",
3793
+ "example": "asg-boz1qhnk",
3794
+ "member": "string",
3795
+ "name": "AutoScalingGroupId",
3796
+ "required": true,
3797
+ "type": "string"
3798
+ },
3799
+ {
3800
+ "disabled": false,
3801
+ "document": "List of running instances. non-running instances are not supported. you can obtain available instance ids in the following ways:.\n<li>Query instance ID by logging in to the <a href=\"https://console.cloud.tencent.com/cvm/index\">console</a>.</li>.\n<li>Specifies the instance ID by calling the api [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1) and getting `InstanceId` from the return information.</li>.",
3802
+ "example": "[\"ins-cri8d02t\",\"ins-osckfnm7\"]",
3803
+ "member": "string",
3804
+ "name": "InstanceIds",
3805
+ "required": true,
3806
+ "type": "list"
3807
+ }
3808
+ ],
3809
+ "type": "object"
3810
+ },
3811
+ "EnterStandbyResponse": {
3812
+ "document": "EnterStandby response structure.",
3813
+ "members": [
3814
+ {
3815
+ "disabled": false,
3816
+ "document": "Scaling activity ID.",
3817
+ "example": "asa-q59zikez",
3818
+ "member": "string",
3819
+ "name": "ActivityId",
3820
+ "output_required": true,
3821
+ "type": "string",
3822
+ "value_allowed_null": false
3823
+ },
3824
+ {
3825
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
3826
+ "member": "string",
3827
+ "name": "RequestId",
3828
+ "type": "string"
3829
+ }
3830
+ ],
3831
+ "type": "object"
3832
+ },
3771
3833
  "ExecuteScalingPolicyRequest": {
3772
3834
  "document": "ExecuteScalingPolicy request structure.",
3773
3835
  "members": [
3774
3836
  {
3775
3837
  "disabled": false,
3776
- "document": "Auto-scaling policy ID. This parameter is not available to a target tracking policy.",
3838
+ "document": "Alarm scaling policy ID. target tracking policy is unsupported. the alert policy type can be obtained via the `ScalingPolicyType` parameter in the api response of [DescribeScalingPolicies](https://intl.cloud.tencent.com/document/api/377/33178?from_cn_redirect=1).",
3777
3839
  "example": "asp-f59pppuh",
3778
3840
  "member": "string",
3779
3841
  "name": "AutoScalingPolicyId",
@@ -3828,7 +3890,7 @@
3828
3890
  "members": [
3829
3891
  {
3830
3892
  "disabled": false,
3831
- "document": "Scaling group ID.",
3893
+ "document": "Auto scaling group ID. obtain available scaling group ids in the following ways:.\n<li>Query the scaling group ID by logging in to the [console](https://console.cloud.tencent.com/autoscaling/group).</li>.\n<li>Specifies the scaling group ID obtained by calling the api [DescribeAutoScalingGroups](https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1) and retrieving the AutoScalingGroupId from the return information.</li>.",
3832
3894
  "example": "asg-boz1qhnk",
3833
3895
  "member": "string",
3834
3896
  "name": "AutoScalingGroupId",
@@ -3837,7 +3899,7 @@
3837
3899
  },
3838
3900
  {
3839
3901
  "disabled": false,
3840
- "document": "List of CVM instances in standby status.",
3902
+ "document": "List of CVM instances in standby status. you can obtain available instance ID in the following ways:.\n<li>Query instance ID by logging in to the <a href=\"https://console.cloud.tencent.com/cvm/index\">console</a>.</li>.\n<li>Get the instance ID by calling the api [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1) and retrieving the `InstanceId` from the returned information.</li>.",
3841
3903
  "example": "[\"ins-cri8d02t\",\"ins-osckfnm7\"]",
3842
3904
  "member": "string",
3843
3905
  "name": "InstanceIds",
@@ -3852,7 +3914,7 @@
3852
3914
  "members": [
3853
3915
  {
3854
3916
  "disabled": false,
3855
- "document": "Scaling activity ID.\nNote: This field may return null, indicating that no valid value can be obtained.",
3917
+ "document": "Scaling activity ID.",
3856
3918
  "example": "asa-q59zikez",
3857
3919
  "member": "string",
3858
3920
  "name": "ActivityId",
@@ -3898,7 +3960,7 @@
3898
3960
  "members": [
3899
3961
  {
3900
3962
  "disabled": false,
3901
- "document": "Load balancer ID",
3963
+ "document": "ID of the load balancer. this parameter is required as an input parameter. you can obtain it through the [DescribeLoadBalancers](https://intl.cloud.tencent.com/document/product/214/30685?from_cn_redirect=1) api.",
3902
3964
  "example": "lb-fy6te4r5",
3903
3965
  "member": "string",
3904
3966
  "name": "LoadBalancerId",
@@ -3909,7 +3971,7 @@
3909
3971
  },
3910
3972
  {
3911
3973
  "disabled": false,
3912
- "document": "Application load balancer listener ID",
3974
+ "document": "CLB listener ID. as an input parameter, this parameter is required. you can obtain it through the [DescribeLoadBalancers](https://intl.cloud.tencent.com/document/product/214/30685?from_cn_redirect=1) api.",
3913
3975
  "example": "lbl-dhyt56rf",
3914
3976
  "member": "string",
3915
3977
  "name": "ListenerId",
@@ -3920,7 +3982,7 @@
3920
3982
  },
3921
3983
  {
3922
3984
  "disabled": false,
3923
- "document": "List of target rule attributes",
3985
+ "document": "Target rule attribute list. as an input parameter, this parameter is required.",
3924
3986
  "example": "[{\"Port\": 80, \"Weight\": 10}]",
3925
3987
  "member": "TargetAttribute",
3926
3988
  "name": "TargetAttributes",
@@ -3931,7 +3993,7 @@
3931
3993
  },
3932
3994
  {
3933
3995
  "disabled": false,
3934
- "document": "ID of a forwarding rule. This parameter is required for layer-7 listeners.",
3996
+ "document": "The forwarding rule ID. note: this parameter is required for layer-7 (http/https) listeners. it can be obtained through the [DescribeLoadBalancers](https://intl.cloud.tencent.com/document/product/214/30685?from_cn_redirect=1) api.",
3935
3997
  "example": "loc-sj8y6tr4",
3936
3998
  "member": "string",
3937
3999
  "name": "LocationId",
@@ -4110,7 +4172,7 @@
4110
4172
  },
4111
4173
  {
4112
4174
  "disabled": false,
4113
- "document": "Lifecycle status. Valid values:<br>\n<li>`IN_SERVICE`: The instance is running.\n<li>`CREATING`: The instance is being created.\n<li>`CREATION_FAILED`: The instance fails to be created.\n<li>`TERMINATING`: The instance is being terminated.\n<li>`TERMINATION_FAILED`: The instance fails to be terminated.\n<li>`ATTACHING`: The instance is being bound.\n<li>`ATTACH_FAILED`: The instance fails to be bound.\n<li>`DETACHING`: The instance is being unbound.\n<li>`DETACH_FAILED`: The instance fails to be unbound.\n<li>`ATTACHING_LB`: The LB is being bound.\n<li>DETACHING_LB: The LB is being unbound.\n<li>`MODIFYING_LB`: The LB is being modified.\n<li>`STARTING`: The instance is being started up.\n<li>`START_FAILED`: The instance fails to be started up.\n<li>`STOPPING`: The instance is being shut down.\n<li>`STOP_FAILED`: The instance fails to be shut down.\n<li>`STOPPED`: The instance is shut down.\n<li>`IN_LAUNCHING_HOOK`: The lifecycle hook is being scaled out.\n<li>`IN_TERMINATING_HOOK`: The lifecycle hook is being scaled in.",
4175
+ "document": "Lifecycle status. valid values are as follows:.\n<Li>IN_SERVICE: running</li>.\n<Li>CREATING: specifies the instance is being created.</li>.\n<Li>CREATION_FAILED: creation failed.</li>.\n<Li>`TERMINATING`: the instance is being terminated.</li>.\n<Li>`TERMINATION_FAILED`: the instance fails to be terminated.</li>.\n<Li>ATTACHING: binding</li>.\n<Li>`ATTACH_FAILED`: the instance fails to be bound.</li>.\n<Li>DETACHING: specifies the unbinding is in progress.</li>.\n<Li>`DETACH_FAILED`: the instance fails to be unbound.</li>.\n<Li>`ATTACHING_LB`: binding to lb</li>.\n<Li>DETACHING_LB: the lb is being unbound.</li>.\n<Li>`MODIFYING_LB`: the lb is being modified.</li>.\n<Li>`STARTING`: the instance is being started up.</li>.\n<Li>`START_FAILED`: the instance fails to be started up.</li>.\n<Li>`STOPPING`: the instance is being shut down.</li>.\n<Li>`STOP_FAILED`: the instance fails to be shut down.</li>.\n<Li>`STOPPED`: the instance is shut down.</li>.\n<Li>`IN_LAUNCHING_HOOK`: the lifecycle hook is being scaled out.</li>.\n<Li>`IN_TERMINATING_HOOK`: the lifecycle hook is being scaled in.</li>.",
4114
4176
  "example": "IN_SERVICE",
4115
4177
  "member": "string",
4116
4178
  "name": "LifeCycleState",
@@ -4120,7 +4182,7 @@
4120
4182
  },
4121
4183
  {
4122
4184
  "disabled": false,
4123
- "document": "Health status. Value range: HEALTHY, UNHEALTHY",
4185
+ "document": "Health status. valid values are as follows:.\n<Li>HEALTHY: the instance is in Healthy status.</li>.\n<Li>UNHEALTHY: instance ping unreachable</li>.\n<Li>CLB_UNHEALTHY: the instance port listened by clb is unhealthy</li>.",
4124
4186
  "example": "HEALTHY",
4125
4187
  "member": "string",
4126
4188
  "name": "HealthStatus",
@@ -4160,7 +4222,7 @@
4160
4222
  },
4161
4223
  {
4162
4224
  "disabled": false,
4163
- "document": "Instance addition time",
4225
+ "document": "Instance join time is displayed in a format that conforms to the ISO8601 standard and uses UTC time.",
4164
4226
  "example": "2023-01-13T03:06:25Z",
4165
4227
  "member": "datetime_iso",
4166
4228
  "name": "AddTime",
@@ -4200,7 +4262,7 @@
4200
4262
  },
4201
4263
  {
4202
4264
  "disabled": false,
4203
- "document": "Warming up status. Valid values:\n<li>`WAITING_ENTER_WARMUP`: The instance is waiting to be warmed up.\n<li>`NO_NEED_WARMUP`: Warming up is not required.\n<li>`IN_WARMUP`: The instance is being warmed up.\n<li>`AFTER_WARMUP`: Warming up is completed.",
4265
+ "document": "Preheat status. valid values are as follows:.\n<Li>WAITING_ENTER_WARMUP: specifies the instance is waiting to enter preheating.</li>.\n<Li>`NO_NEED_WARMUP`: warming up is not required.</li>.\n<Li>IN_WARMUP: preheating.</li>.\n<Li>AFTER_WARMUP: indicates the preheating is completed.</li>.",
4204
4266
  "example": "IN_WARMUP",
4205
4267
  "member": "string",
4206
4268
  "name": "WarmupStatus",
@@ -4210,7 +4272,7 @@
4210
4272
  },
4211
4273
  {
4212
4274
  "disabled": false,
4213
- "document": "Placement group ID. Only one is allowed.\nNote: This field may return `null`, indicating that no valid values can be obtained.",
4275
+ "document": "Placement group ID. Only one can be specified.",
4214
4276
  "example": "[\"ps-uf8j6y3t\"]",
4215
4277
  "member": "string",
4216
4278
  "name": "DisasterRecoverGroupIds",
@@ -4278,12 +4340,12 @@
4278
4340
  "usage": "both"
4279
4341
  },
4280
4342
  "InstanceNameIndexSettings": {
4281
- "document": "Instance name sequencing settings.",
4343
+ "document": "Instance name index settings.",
4282
4344
  "members": [
4283
4345
  {
4284
4346
  "disabled": false,
4285
- "document": "Whether to enable instance creation sequencing, which is disabled by default. Valid values: <li>TRUE: Indicates that instance creation sequencing is enabled. <li>FALSE: Indicates that instance creation sequencing is disabled.\nNote: This field may return null, indicating that no valid value can be obtained.",
4286
- "example": "FALSE",
4347
+ "document": "Whether to enable instance name index. Default value: false. Value range:.\n\n**true**: indicates that instance name index is enabled.\n**false**: indicates that instance name index is disabled.\nNote: This field may return null, indicating that no valid values can be obtained.",
4348
+ "example": "false",
4287
4349
  "member": "bool",
4288
4350
  "name": "Enabled",
4289
4351
  "output_required": false,
@@ -4293,7 +4355,7 @@
4293
4355
  },
4294
4356
  {
4295
4357
  "disabled": false,
4296
- "document": "Initial sequence number, with a value range of [0, 99,999,999]. When the sequence number exceeds this range after incrementing, scale-out activities will fail. <li>Upon the first enabling of instance name sequencing: The default value is 0. <li>Upon the enabling of instance name sequencing (not for the first time): If this parameter is not specified, the historical sequence number will be carried forward. Lowering the initial sequence number may result in duplicate instance name sequences within the scaling group.\nNote: This field may return null, indicating that no valid value can be obtained.",
4358
+ "document": "Begin index number. Value range: [0, 99999999].\n\nIndicates that the scale out activity will be failed when the index out of range. \nIf not specified, carries forward historical index number or 0.\nLowering the index sequence number may lead to instance name duplication within the group.\nNote: This field may return null, indicating that no valid values can be obtained.",
4297
4359
  "example": "0",
4298
4360
  "member": "int64",
4299
4361
  "name": "BeginIndex",
@@ -4301,6 +4363,17 @@
4301
4363
  "required": false,
4302
4364
  "type": "int",
4303
4365
  "value_allowed_null": true
4366
+ },
4367
+ {
4368
+ "disabled": false,
4369
+ "document": "Instance name index number digits, defaults to 0, means no specified digit count. Value range: 0-8, maximum is integer 8. when using values 1-8, the system checks whether the index number exceeds the maximum digit for this digit count.\n\nIf set to 3, index number is in the format: 000, 001, 002 ... 010, 011 ... 100 ... 999. The maximum is 999. \nAssuming set to 0, the index number is 0, 1, 2 ... 10, 11 ... 100 ... 1000 ...10000 ... 99999999. Max number is 99999999.",
4370
+ "example": "0",
4371
+ "member": "uint64",
4372
+ "name": "IndexLength",
4373
+ "output_required": false,
4374
+ "required": false,
4375
+ "type": "int",
4376
+ "value_allowed_null": false
4304
4377
  }
4305
4378
  ],
4306
4379
  "usage": "both"
@@ -4418,6 +4491,50 @@
4418
4491
  "required": false,
4419
4492
  "type": "string",
4420
4493
  "value_allowed_null": true
4494
+ },
4495
+ {
4496
+ "disabled": false,
4497
+ "document": "Describes the line type. For details, refer to [EIP Product Overview](https://www.tencentcloud.com/document/product/213/5733). default value: `BGP`.\n\n<Li>BGP: general bgp line.</li>\nFor a user who has enabled the static single-line IP allowlist, valid values include:\n <li>CMCC: China Mobile</li> <li>CTCC: China Telecom</li> <li>CUCC: China Unicom</li>\nNote: Only certain regions support static single-line IP addresses.\n",
4498
+ "example": "BGP",
4499
+ "member": "string",
4500
+ "name": "InternetServiceProvider",
4501
+ "output_required": false,
4502
+ "required": false,
4503
+ "type": "string",
4504
+ "value_allowed_null": false
4505
+ },
4506
+ {
4507
+ "disabled": false,
4508
+ "document": "Type of public IP address.\n\n<li> WanIP: Ordinary public IP address. </li> <li> HighQualityEIP: High Quality EIP is supported only in Singapore and Hong Kong. </li> <li> AntiDDoSEIP: Anti-DDoS IP is supported only in specific regions. For details, see [EIP Product Overview](https://www.tencentcloud.com/document/product/213/5733). </li> \nSpecify the type of public IPv4 address to assign a public IPv4 address to the resource. HighQualityEIP and AntiDDoSEIP features are gradually released in select regions. For usage, [submit a ticket for consultation](https://console.tencentcloud.com/workorder).",
4509
+ "example": "WanIP",
4510
+ "member": "string",
4511
+ "name": "IPv4AddressType",
4512
+ "output_required": false,
4513
+ "required": false,
4514
+ "type": "string",
4515
+ "value_allowed_null": false
4516
+ },
4517
+ {
4518
+ "disabled": false,
4519
+ "document": "Anti-DDoS service package ID. This is required when you want to request an Anti-DDoS IP.",
4520
+ "example": "bgp-00000000",
4521
+ "member": "string",
4522
+ "name": "AntiDDoSPackageId",
4523
+ "output_required": false,
4524
+ "required": false,
4525
+ "type": "string",
4526
+ "value_allowed_null": false
4527
+ },
4528
+ {
4529
+ "disabled": false,
4530
+ "document": "Whether to delete the bound EIP(HighQualityEIP and AntiDDoSEIP) when the instance is destroyed.\n\nRange of values:\n\n<li>TRUE: retain the EIP</li> <li>FALSE: not retain the EIP</li>Note that when the IPv4AddressType field specifies the EIP type, the default behavior is not to retain the EIP. \nWanIP is unaffected by this field and will always be deleted with the instance. \nChanging this field configuration will take effect immediately for resources already bound to a scaling group.",
4531
+ "example": "false",
4532
+ "member": "bool",
4533
+ "name": "IsKeepEIP",
4534
+ "output_required": false,
4535
+ "required": false,
4536
+ "type": "bool",
4537
+ "value_allowed_null": false
4421
4538
  }
4422
4539
  ],
4423
4540
  "usage": "both"
@@ -4603,7 +4720,7 @@
4603
4720
  },
4604
4721
  {
4605
4722
  "disabled": false,
4606
- "document": "Creation time of the launch configuration.",
4723
+ "document": "Specifies the startup configuration creation time. uses UTC standard time.",
4607
4724
  "example": "2021-05-31T12:38:35Z",
4608
4725
  "member": "datetime_iso",
4609
4726
  "name": "CreatedTime",
@@ -4643,7 +4760,7 @@
4643
4760
  },
4644
4761
  {
4645
4762
  "disabled": false,
4646
- "document": "Instance billing type, with the CVM default value processed as POSTPAID_BY_HOUR. <li>POSTPAID_BY_HOUR: Hourly postpaid billing.</li> <li>SPOTPAID: Spot billing.</li>",
4763
+ "document": "Instance billing type. valid values:.\n<Li>POSTPAID_BY_HOUR: pay-as-you-go hourly</li>.\n<Li>SPOTPAID: spot payment</li>.\n<Li>PREPAID: prepaid, i.e., monthly subscription</li>.\n<Li>CDCPAID: dedicated cluster payment</li>.",
4647
4764
  "example": "POSTPAID_BY_HOUR",
4648
4765
  "member": "string",
4649
4766
  "name": "InstanceChargeType",
@@ -4683,7 +4800,7 @@
4683
4800
  },
4684
4801
  {
4685
4802
  "disabled": false,
4686
- "document": "Tag list.\nNote: This field may return null, indicating that no valid values can be obtained.",
4803
+ "document": "Tag list. this parameter specifies tags only used for binding the launch configuration and will not be passed to CVM instances scaled out based on it.",
4687
4804
  "example": "[{\"Key\": \"CCode\", \"Value\": \"ASTENCENT\", \"ResourceType\": \"launch-configuration\"}]",
4688
4805
  "member": "Tag",
4689
4806
  "name": "Tags",
@@ -4703,7 +4820,7 @@
4703
4820
  },
4704
4821
  {
4705
4822
  "disabled": false,
4706
- "document": "Update time",
4823
+ "document": "Last update time is in standard UTC time.",
4707
4824
  "example": "2023-09-04T11:42:46Z",
4708
4825
  "member": "datetime_iso",
4709
4826
  "name": "UpdatedTime",
@@ -4713,7 +4830,7 @@
4713
4830
  },
4714
4831
  {
4715
4832
  "disabled": false,
4716
- "document": "CAM role name. This parameter can be obtained from the `roleName` field returned by DescribeRoleList API.",
4833
+ "document": "Role name of the CAM role. can be obtained from roleName in the return value from the DescribeRoleList API (https://intl.cloud.tencent.com/document/product/598/36223?from_cn_redirect=1).",
4717
4834
  "example": "TestRole",
4718
4835
  "member": "string",
4719
4836
  "name": "CamRoleName",
@@ -4803,7 +4920,7 @@
4803
4920
  },
4804
4921
  {
4805
4922
  "disabled": false,
4806
- "document": "Image family name.\nNote: This field may return null, indicating that no valid values can be obtained.",
4923
+ "document": "Image family name.",
4807
4924
  "example": "testfamily",
4808
4925
  "member": "string",
4809
4926
  "name": "ImageFamily",
@@ -4905,7 +5022,7 @@
4905
5022
  "members": [
4906
5023
  {
4907
5024
  "disabled": false,
4908
- "document": "Remote command ID. It’s required to execute a command.\nNote: This field may return null, indicating that no valid values can be obtained.",
5025
+ "document": "Remote command ID. this item is required if you select to execute command.",
4909
5026
  "example": "cmd-gt5dre32",
4910
5027
  "member": "string",
4911
5028
  "name": "CommandId",
@@ -4916,7 +5033,7 @@
4916
5033
  },
4917
5034
  {
4918
5035
  "disabled": false,
4919
- "document": "Custom parameter. The field type is JSON encoded string. For example, {\"varA\": \"222\"}.\n`key` is the name of the custom parameter and `value` is the default value. Both `key` and `value` are strings.\nIf this parameter is not specified, the `DefaultParameters` of `Command` is used.\nUp to 20 customer parameters allowed. The parameter name can contain up to 64 characters, including [a-z], [A-Z], [0-9] and [-_].\nNote: This field may return null, indicating that no valid values can be obtained.",
5036
+ "document": "Custom parameter. field type is json encoded string, for example: {\"varA\": \"222\"}.\nkey specifies the custom parameter name, and value specifies the default. both are string type.\nIf the parameter value is not provided, the DefaultParameters of Command will be used to replace it.\nCustom parameters support a maximum of 20 entries. the custom parameter name must meet the following standard: number of characters has a cap of 64, value range [a-zA-Z0-9-_].",
4920
5037
  "example": "{\"varA\": \"222\"}",
4921
5038
  "member": "string",
4922
5039
  "name": "Parameters",
@@ -4963,7 +5080,7 @@
4963
5080
  },
4964
5081
  {
4965
5082
  "disabled": false,
4966
- "document": "Default result of the lifecycle hook",
5083
+ "document": "Action to be taken by the scaling group in case of lifecycle hook timeout or LifecycleCommand execution failure. valid values:.\n-CONTINUE execution by default means capacity expansion or reduction.\n-For scale-out hooks, cvms with hook timeout or failed LifecycleCommand execution will be released directly or removed; for scale-in hooks, scale-in activities will continue.",
4967
5084
  "example": "CONTINUE",
4968
5085
  "member": "string",
4969
5086
  "name": "DefaultResult",
@@ -4973,7 +5090,7 @@
4973
5090
  },
4974
5091
  {
4975
5092
  "disabled": false,
4976
- "document": "Wait timeout period of the lifecycle hook",
5093
+ "document": "Specifies the timeout waiting time of the lifecycle hook in seconds. value range: 30 to 7200.",
4977
5094
  "example": "300",
4978
5095
  "member": "int64",
4979
5096
  "name": "HeartbeatTimeout",
@@ -4983,7 +5100,7 @@
4983
5100
  },
4984
5101
  {
4985
5102
  "disabled": false,
4986
- "document": "Applicable scenario of the lifecycle hook",
5103
+ "document": "Scenario for entering the lifecycle hook. valid values:.\n-`INSTANCE_LAUNCHING`: the lifecycle hook is being scaled out.\n-INSTANCE_TERMINATING: scale-in lifecycle hook.",
4987
5104
  "example": "INSTANCE_TERMINATING",
4988
5105
  "member": "string",
4989
5106
  "name": "LifecycleTransition",
@@ -5003,7 +5120,7 @@
5003
5120
  },
5004
5121
  {
5005
5122
  "disabled": false,
5006
- "document": "Creation time",
5123
+ "document": "Creation time. uses UTC for timing.",
5007
5124
  "example": "2024-11-11T15:29:59Z",
5008
5125
  "member": "datetime_iso",
5009
5126
  "name": "CreatedTime",
@@ -5023,7 +5140,7 @@
5023
5140
  },
5024
5141
  {
5025
5142
  "disabled": false,
5026
- "document": "Applicable scenario of the lifecycle hook",
5143
+ "document": "Specifies the scenario type for performing the lifecycle hook. valid values: NORMAL and EXTENSION. default value: NORMAL.\nDescription: when set to `EXTENSION`, the lifecycle hook will be triggered during `AttachInstances`, `DetachInstances`, or `RemoveInstances` API calls. if set to `NORMAL`, the lifecycle hook will not be triggered by these apis.",
5027
5144
  "example": "NORMAL",
5028
5145
  "member": "string",
5029
5146
  "name": "LifecycleTransitionType",
@@ -5033,7 +5150,7 @@
5033
5150
  },
5034
5151
  {
5035
5152
  "disabled": false,
5036
- "document": "Remote command execution object.\nNote: This field may return null, indicating that no valid values can be obtained.",
5153
+ "document": "Remote command execution object.",
5037
5154
  "example": "{\"CommandId\": \"cmd-am4e3hd8\", \"Parameters\": \"{123: 222}\"}",
5038
5155
  "member": "LifecycleCommand",
5039
5156
  "name": "LifecycleCommand",
@@ -5074,7 +5191,7 @@
5074
5191
  },
5075
5192
  {
5076
5193
  "disabled": false,
5077
- "document": "List of key IDs. After an instance is associated with a key, you can access the instance with the private key in the key pair. You can call `DescribeKeyPairs` to obtain `KeyId`. Key and password cannot be specified at the same time. Windows instances do not support keys. Currently, you can only specify one key when purchasing an instance.",
5194
+ "document": "List of key ids. after associating a key, you can access the instance through the corresponding private key. KeyId can be obtained by calling the api [DescribeKeyPairs](https://intl.cloud.tencent.com/document/api/213/15699?from_cn_redirect=1). key and password cannot be specified simultaneously. the Windows operating system does not support specifying a key. currently, only one key can be specified during purchase.",
5078
5195
  "example": "[\"skey-ju7fy6t5\"]",
5079
5196
  "member": "string",
5080
5197
  "name": "KeyIds",
@@ -5226,8 +5343,8 @@
5226
5343
  "members": [
5227
5344
  {
5228
5345
  "disabled": false,
5229
- "document": "Auto scaling group ID",
5230
- "example": "asg-aaaabbbb",
5346
+ "document": "Scaling group ID. obtain available scaling group ids in the following ways:.\n<li>Query the scaling group ID by logging in to the [console](https://console.cloud.tencent.com/autoscaling/group).</li>.\n<li>Specifies the scaling group ID obtained by calling the api [DescribeAutoScalingGroups](https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1) and retrieving the AutoScalingGroupId from the return information.</li>.",
5347
+ "example": "asg-gf5r6t7u",
5231
5348
  "member": "string",
5232
5349
  "name": "AutoScalingGroupId",
5233
5350
  "required": true,
@@ -5244,7 +5361,7 @@
5244
5361
  },
5245
5362
  {
5246
5363
  "disabled": false,
5247
- "document": "Default cooldown period in seconds. Default value: 300",
5364
+ "document": "Default cooldown period in seconds. value ranges from 0 to 3600. default value: 300.",
5248
5365
  "example": "300",
5249
5366
  "member": "uint64",
5250
5367
  "name": "DefaultCooldown",
@@ -5253,7 +5370,7 @@
5253
5370
  },
5254
5371
  {
5255
5372
  "disabled": false,
5256
- "document": "Desired number of instances. The number should be no larger than the maximum and no smaller than minimum number of instances",
5373
+ "document": "Expected number of instances, value ranges from 0 to 2000. to meet maximum value greater than or equal to expected value, expected value greater than or equal to minimum value.",
5257
5374
  "example": "1",
5258
5375
  "member": "uint64",
5259
5376
  "name": "DesiredCapacity",
@@ -5262,8 +5379,8 @@
5262
5379
  },
5263
5380
  {
5264
5381
  "disabled": false,
5265
- "document": "Launch configuration ID",
5266
- "example": "asc-aaaabbbb",
5382
+ "document": "Launch configuration ID. obtain available launch configuration ids in the following ways:.\n<li>Queries the launch configuration ID by logging in to the [console](https://console.cloud.tencent.com/autoscaling/config).</li>.\n<li>Specifies the launch configuration ID obtained by calling the api [DescribeLaunchConfigurations](https://intl.cloud.tencent.com/document/api/377/20445?from_cn_redirect=1) and retrieving the LaunchConfigurationId from the return information.</li>.",
5383
+ "example": "asc-gf5r6t7u",
5267
5384
  "member": "string",
5268
5385
  "name": "LaunchConfigurationId",
5269
5386
  "required": false,
@@ -5271,7 +5388,7 @@
5271
5388
  },
5272
5389
  {
5273
5390
  "disabled": false,
5274
- "document": "Maximum number of instances. Value range: 0-2,000.",
5391
+ "document": "Maximum number of instances, value range from 0 to 2000. to meet maximum value greater than or equal to expected value, expected value greater than or equal to minimum value.",
5275
5392
  "example": "1",
5276
5393
  "member": "uint64",
5277
5394
  "name": "MaxSize",
@@ -5280,7 +5397,7 @@
5280
5397
  },
5281
5398
  {
5282
5399
  "disabled": false,
5283
- "document": "Minimum number of instances. Value range: 0-2,000.",
5400
+ "document": "Minimum number of instances. value range [0,2000]. to meet maximum value equal to or greater than expected value, expected value equal to or greater than minimum value.",
5284
5401
  "example": "1",
5285
5402
  "member": "uint64",
5286
5403
  "name": "MinSize",
@@ -5289,7 +5406,7 @@
5289
5406
  },
5290
5407
  {
5291
5408
  "disabled": false,
5292
- "document": "Project ID",
5409
+ "document": "Project ID. obtain this parameter by calling [DescribeProject](https://intl.cloud.tencent.com/document/api/651/78725?from_cn_redirect=1), `ProjectId` field in the return value. default value is 0, indicates usage of the default project.",
5293
5410
  "example": "1",
5294
5411
  "member": "uint64",
5295
5412
  "name": "ProjectId",
@@ -5298,8 +5415,8 @@
5298
5415
  },
5299
5416
  {
5300
5417
  "disabled": false,
5301
- "document": "List of subnet IDs",
5302
- "example": "[\"subnet-aaaabbbb\"]",
5418
+ "document": "subnet ID list. you can obtain a valid vpc subnet ID by logging in to the [console](https://console.cloud.tencent.com/vpc/subnet). you can also call the API [DescribeSubnets](https://intl.cloud.tencent.com/document/product/215/15784?from_cn_redirect=1) and retrieve the valid vpc subnet ID from the SubnetId field in the API response.",
5419
+ "example": "[\"subnet-gf5r6t7u\"]",
5303
5420
  "member": "string",
5304
5421
  "name": "SubnetIds",
5305
5422
  "required": false,
@@ -5316,8 +5433,8 @@
5316
5433
  },
5317
5434
  {
5318
5435
  "disabled": false,
5319
- "document": "VPC ID. This field is left empty for basic networks. You need to specify SubnetIds when modifying the network of the auto scaling group to a VPC with a specified VPC ID. Specify Zones when modifying the network to a basic network.",
5320
- "example": "vpc-aaaabbbb",
5436
+ "document": "vpc ID. when modifying the vpc, you need to change the SubnetIds parameter to the subnet of this vpc. effective VpcId can be queried by logging in to the console (https://console.cloud.tencent.com/vpc/vpc) or obtained from the VpcId field in the api response by calling the DescribeVpc api (https://intl.cloud.tencent.com/document/api/215/15778?from_cn_redirect=1).",
5437
+ "example": "vpc-gf5r6t7u",
5321
5438
  "member": "string",
5322
5439
  "name": "VpcId",
5323
5440
  "required": false,
@@ -5361,7 +5478,7 @@
5361
5478
  },
5362
5479
  {
5363
5480
  "disabled": false,
5364
- "document": "The number of IPv6 addresses that an instance has. Valid values: 0 and 1.",
5481
+ "document": "The number of IPv6 addresses that an instance has. valid values: 0 and 1. default value: 0, which means the instance does not allocate an IPv6 address. use a private network that supports IPv6 and enable IPv6 CIDR in the subnet. for usage restrictions, see [IPv6 usage limits](https://intl.cloud.tencent.com/document/product/1142/38369?from_cn_redirect=1).",
5365
5482
  "example": "1",
5366
5483
  "member": "int64",
5367
5484
  "name": "Ipv6AddressCount",
@@ -5451,7 +5568,7 @@
5451
5568
  "members": [
5452
5569
  {
5453
5570
  "disabled": false,
5454
- "document": "Auto scaling group ID",
5571
+ "document": "Scaling group ID. obtain the scaling group ID by logging in to the console (https://console.cloud.tencent.com/autoscaling/group) or calling the api DescribeAutoScalingGroups (https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1), and retrieve AutoScalingGroupId from the returned information.",
5455
5572
  "example": "asg-nvnlpbb8",
5456
5573
  "member": "string",
5457
5574
  "name": "AutoScalingGroupId",
@@ -5460,7 +5577,7 @@
5460
5577
  },
5461
5578
  {
5462
5579
  "disabled": false,
5463
- "document": "Desired capacity",
5580
+ "document": "Expected number of instances, value ranges from 0 to 2000, to meet MaxSize >= DesiredCapacity >= MinSize.",
5464
5581
  "example": "2",
5465
5582
  "member": "uint64",
5466
5583
  "name": "DesiredCapacity",
@@ -5469,7 +5586,7 @@
5469
5586
  },
5470
5587
  {
5471
5588
  "disabled": false,
5472
- "document": "Minimum number of instances. Value range: 0-2000.",
5589
+ "document": "Minimum number of instances. value range: [0,2000]. to meet MaxSize >= DesiredCapacity >= MinSize at the same time.",
5473
5590
  "example": "0",
5474
5591
  "member": "uint64",
5475
5592
  "name": "MinSize",
@@ -5478,7 +5595,7 @@
5478
5595
  },
5479
5596
  {
5480
5597
  "disabled": false,
5481
- "document": "Maximum number of instances. Value range: 0-2000.",
5598
+ "document": "Maximum instance count. value range [0,2000]. to meet MaxSize >= DesiredCapacity >= MinSize.",
5482
5599
  "example": "20",
5483
5600
  "member": "uint64",
5484
5601
  "name": "MaxSize",
@@ -5505,7 +5622,7 @@
5505
5622
  "members": [
5506
5623
  {
5507
5624
  "disabled": false,
5508
- "document": "Launch configuration ID",
5625
+ "document": "Launch configuration ID. obtain the launch configuration ID by logging in to the console (https://console.cloud.tencent.com/autoscaling/config) or calling the api DescribeLaunchConfigurations (https://intl.cloud.tencent.com/document/api/377/20445?from_cn_redirect=1) and retrieving the LaunchConfigurationId from the return information.",
5509
5626
  "example": "asc-aaaabbbb",
5510
5627
  "member": "string",
5511
5628
  "name": "LaunchConfigurationId",
@@ -5523,7 +5640,7 @@
5523
5640
  },
5524
5641
  {
5525
5642
  "disabled": false,
5526
- "document": "List of instance types. Each type specifies different resource specifications. This list contains up to 10 instance types.\nThe launch configuration uses `InstanceType` to indicate one single instance type and `InstanceTypes` to indicate multiple instance types. Specifying the `InstanceTypes` field will invalidate the original `InstanceType`.",
5643
+ "document": "Types of cvm instances. different instance models specify different resource specifications. supports up to 10 instance models.\nThe launch configuration uses `InstanceType` to indicate one single instance type and `InstanceTypes` to indicate multiple instance types. specifying the `InstanceTypes` field will invalidate the original `InstanceType`. specific values can be obtained by calling the api [DescribeInstanceTypeConfigs](https://intl.cloud.tencent.com/document/api/213/15749?from_cn_redirect=1) to obtain the latest specification table or refer to [instance specifications](https://intl.cloud.tencent.com/document/product/213/11518?from_cn_redirect=1).",
5527
5644
  "example": "S5.SMALL2",
5528
5645
  "member": "string",
5529
5646
  "name": "InstanceTypes",
@@ -5658,7 +5775,7 @@
5658
5775
  },
5659
5776
  {
5660
5777
  "disabled": false,
5661
- "document": "CAM role name. This parameter can be obtained from the `roleName` field returned by DescribeRoleList API.",
5778
+ "document": "Role name of the CAM role. can be obtained from roleName in the return value from the DescribeRoleList API (https://intl.cloud.tencent.com/document/product/598/36223?from_cn_redirect=1).",
5662
5779
  "example": "TestRole",
5663
5780
  "member": "string",
5664
5781
  "name": "CamRoleName",
@@ -5667,7 +5784,7 @@
5667
5784
  },
5668
5785
  {
5669
5786
  "disabled": false,
5670
- "document": "HPC ID<br>\nNote: This field is default to empty",
5787
+ "document": "High-Performance computing cluster ID. you can obtain this parameter by calling the [DescribeHpcClusters](https://intl.cloud.tencent.com/document/product/213/83220?from_cn_redirect=1) api.\nNote: this field is empty by default.",
5671
5788
  "example": "hpc-abcd1234",
5672
5789
  "member": "string",
5673
5790
  "name": "HpcClusterId",
@@ -5685,7 +5802,7 @@
5685
5802
  },
5686
5803
  {
5687
5804
  "disabled": false,
5688
- "document": "Placement group ID. Only one is allowed.",
5805
+ "document": "Placement group id. only one can be specified. obtain through the API [DescribeDisasterRecoverGroups](https://intl.cloud.tencent.com/document/product/213/17810?from_cn_redirect=1).",
5689
5806
  "example": "[\"ps-fy7e0ml0\"]",
5690
5807
  "member": "string",
5691
5808
  "name": "DisasterRecoverGroupIds",
@@ -5712,7 +5829,7 @@
5712
5829
  },
5713
5830
  {
5714
5831
  "disabled": false,
5715
- "document": "Image family name.",
5832
+ "document": "Image family name. this parameter can be obtained by calling the [DescribeImages](https://intl.cloud.tencent.com/document/product/213/15715?from_cn_redirect=1) api.",
5716
5833
  "example": "test-family",
5717
5834
  "member": "string",
5718
5835
  "name": "ImageFamily",
@@ -5757,7 +5874,7 @@
5757
5874
  "members": [
5758
5875
  {
5759
5876
  "disabled": false,
5760
- "document": "Lifecycle hook ID.",
5877
+ "document": "Lifecycle hook ID. you can get the lifecycle hook ID by calling the api [DescribeLifecycleHooks](https://intl.cloud.tencent.com/document/api/377/34452?from_cn_redirect=1) and retrieving the LifecycleHookId from the returned information.",
5761
5878
  "example": "ash-je1esoo9",
5762
5879
  "member": "string",
5763
5880
  "name": "LifecycleHookId",
@@ -5766,7 +5883,7 @@
5766
5883
  },
5767
5884
  {
5768
5885
  "disabled": false,
5769
- "document": "Lifecycle hook name.",
5886
+ "document": "Lifecycle hook name. Name only supports chinese, english, digits, underscore (_), hyphen (-), decimal point (.), maximum length cannot exceed 128.",
5770
5887
  "example": "hook-test",
5771
5888
  "member": "string",
5772
5889
  "name": "LifecycleHookName",
@@ -5775,7 +5892,7 @@
5775
5892
  },
5776
5893
  {
5777
5894
  "disabled": false,
5778
- "document": "Scenario for entering the lifecycle hook. Valid values:\n<li>INSTANCE_LAUNCHING: after the instance is launched.</li>\n<li>INSTANCE_TERMINATING: before the instance is terminated.</li>",
5895
+ "document": "Scenario for entering the lifecycle hook. valid values:.\n`INSTANCE_LAUNCHING`: the lifecycle hook is being scaled out.\n`INSTANCE_TERMINATING`: the lifecycle hook is being scaled in.",
5779
5896
  "example": "INSTANCE_LAUNCHING",
5780
5897
  "member": "string",
5781
5898
  "name": "LifecycleTransition",
@@ -5784,7 +5901,7 @@
5784
5901
  },
5785
5902
  {
5786
5903
  "disabled": false,
5787
- "document": "Action to be taken by the scaling group in case of lifecycle hook timeout. Valid values:\n<li>CONTINUE: Continue the scaling activity after timeout.</li>\n<li>ABANDON: Terminate the scaling activity after timeout.</li>",
5904
+ "document": "Action to be taken by the scaling group in case of lifecycle hook timeout or LifecycleCommand execution failure. valid values:.\nDefault value means CONTINUE to execute capacity expansion or reduction.\n* ABANDON: for scale-out hooks, cvms that time out or fail to execute LifecycleCommand are released directly or removed. for scale-in hooks, scale-in activities continue.",
5788
5905
  "example": "CONTINUE",
5789
5906
  "member": "string",
5790
5907
  "name": "DefaultResult",
@@ -5802,7 +5919,7 @@
5802
5919
  },
5803
5920
  {
5804
5921
  "disabled": false,
5805
- "document": "Additional information sent by AS to the notification target.",
5922
+ "document": "Specifies the additional information sent by auto scaling to the notification target. NotificationMetadata and LifecycleCommand are mutually exclusive. the two cannot be specified simultaneously.",
5806
5923
  "example": "addtional-info",
5807
5924
  "member": "string",
5808
5925
  "name": "NotificationMetadata",
@@ -5820,7 +5937,7 @@
5820
5937
  },
5821
5938
  {
5822
5939
  "disabled": false,
5823
- "document": "Information of the notification target.",
5940
+ "document": "Notify the target information. NotificationTarget and LifecycleCommand are mutually exclusive. the two cannot be specified simultaneously.",
5824
5941
  "example": "{\"QueueName\": \"as-pool\", \"TargetType\": \"TDMQ_CMQ_QUEUE\"}",
5825
5942
  "member": "NotificationTarget",
5826
5943
  "name": "NotificationTarget",
@@ -5829,7 +5946,7 @@
5829
5946
  },
5830
5947
  {
5831
5948
  "disabled": false,
5832
- "document": "Remote command execution object.",
5949
+ "document": "Remote command execution object. `NotificationMetadata`, `NotificationTarget`, and `LifecycleCommand` cannot be specified at the same time.",
5833
5950
  "example": "{\"CommandId\": \"cmd-am4e3hd8\", \"Parameters\": \"{123: 222}\"}",
5834
5951
  "member": "LifecycleCommand",
5835
5952
  "name": "LifecycleCommand",
@@ -5856,7 +5973,7 @@
5856
5973
  "members": [
5857
5974
  {
5858
5975
  "disabled": false,
5859
- "document": "Scaling group ID",
5976
+ "document": "Scaling group ID. obtain the scaling group ID by logging in to the console (https://console.cloud.tencent.com/autoscaling/group) or calling the api DescribeAutoScalingGroups (https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1), and retrieve AutoScalingGroupId from the returned information.",
5860
5977
  "example": "asg-12wjuh0s",
5861
5978
  "member": "string",
5862
5979
  "name": "AutoScalingGroupId",
@@ -5865,7 +5982,7 @@
5865
5982
  },
5866
5983
  {
5867
5984
  "disabled": false,
5868
- "document": "List of application CLBs to modify. Up to 100 CLBs allowed.",
5985
+ "document": "Specifies the list of load balancers whose target rule attributes need modification, with a list length limit of 100. can be obtained through the [DescribeLoadBalancers](https://intl.cloud.tencent.com/document/product/214/30685?from_cn_redirect=1) api.",
5869
5986
  "example": "无",
5870
5987
  "member": "ForwardLoadBalancer",
5871
5988
  "name": "ForwardLoadBalancers",
@@ -5884,7 +6001,7 @@
5884
6001
  "example": "asa-67izy66g",
5885
6002
  "member": "string",
5886
6003
  "name": "ActivityId",
5887
- "required": true,
6004
+ "output_required": true,
5888
6005
  "type": "string",
5889
6006
  "value_allowed_null": false
5890
6007
  },
@@ -5902,7 +6019,7 @@
5902
6019
  "members": [
5903
6020
  {
5904
6021
  "disabled": false,
5905
- "document": "Auto scaling group ID",
6022
+ "document": "Scaling group ID. you can obtain the scaling group ID by logging in to the [console](https://console.cloud.tencent.com/autoscaling/group) or calling the api [DescribeAutoScalingGroups](https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1) and retrieving the AutoScalingGroupId from the returned information.",
5906
6023
  "example": "asg-12wjuh0s",
5907
6024
  "member": "string",
5908
6025
  "name": "AutoScalingGroupId",
@@ -5911,7 +6028,7 @@
5911
6028
  },
5912
6029
  {
5913
6030
  "disabled": false,
5914
- "document": "List of classic CLB IDs. Currently, the maximum length is 20. You cannot specify LoadBalancerIds and ForwardLoadBalancers at the same time.",
6031
+ "document": "List of classic clb ids. currently, the maximum length is 20. you cannot specify LoadBalancerIds and ForwardLoadBalancers at the same time. it can be obtained through the [DescribeLoadBalancers](https://intl.cloud.tencent.com/document/product/214/30685?from_cn_redirect=1) api.",
5915
6032
  "example": "[\"lb-crhgatrf\"]",
5916
6033
  "member": "string",
5917
6034
  "name": "LoadBalancerIds",
@@ -5920,7 +6037,7 @@
5920
6037
  },
5921
6038
  {
5922
6039
  "disabled": false,
5923
- "document": "List of application CLBs. Up to 100 CLBs are allowed. `LoadBalancerIds` and `ForwardLoadBalancers` cannot be specified at the same time.",
6040
+ "document": "Specifies the list of load balancers with a current maximum length of 100. either LoadBalancerIds or ForwardLoadBalancers can be specified at the same time. can be obtained through the [DescribeLoadBalancers](https://intl.cloud.tencent.com/document/product/214/30685?from_cn_redirect=1) api.",
5924
6041
  "example": "[{\"LoadBalancerId\": \"lb-af8li2kn\", \"ListenerId\": \"lbl-akw1lgo7\", \"TargetAttributes\": [{\"Port\": 80, \"Weight\": 10}]}]",
5925
6042
  "member": "ForwardLoadBalancer",
5926
6043
  "name": "ForwardLoadBalancers",
@@ -5966,7 +6083,7 @@
5966
6083
  "members": [
5967
6084
  {
5968
6085
  "disabled": false,
5969
- "document": "ID of the notification to be modified.",
6086
+ "document": "Specifies the notification ID that needs modification. get the notification ID by logging in to the [console](https://console.cloud.tencent.com/autoscaling/group) or calling the api [DescribeNotificationConfigurations](https://intl.cloud.tencent.com/document/api/377/33183?from_cn_redirect=1) and getting `AutoScalingNotificationId` from the returned information.",
5970
6087
  "example": "asn-2sestqbr",
5971
6088
  "member": "string",
5972
6089
  "name": "AutoScalingNotificationId",
@@ -5984,7 +6101,7 @@
5984
6101
  },
5985
6102
  {
5986
6103
  "disabled": false,
5987
- "document": "Notification group ID, which is the set of user group IDs. You can query the user group IDs through the [ListGroups](https://intl.cloud.tencent.com/document/product/598/34589?from_cn_redirect=1) API.",
6104
+ "document": "Notification GROUP ID, which is the USER GROUP ID collection. USER GROUP ID can be accessed through [ListGroups](https://intl.cloud.tencent.com/document/product/598/34589?from_cn_redirect=1). this parameter is valid only when `TargetType` is `USER_GROUP`.",
5988
6105
  "example": "[\"1678\"]",
5989
6106
  "member": "string",
5990
6107
  "name": "NotificationUserGroupIds",
@@ -5993,7 +6110,7 @@
5993
6110
  },
5994
6111
  {
5995
6112
  "disabled": false,
5996
- "document": "CMQ or TDMQ CMQ queue name.",
6113
+ "document": "The TDMQ CMQ QUEUE name. [the original CMQ is offline](https://intl.cloud.tencent.com/document/product/1496/83970?from_cn_redirect=1). currently, only TDMQ CMQ is recommended for use. this parameter is valid only when `TargetType` is `TDMQ_CMQ_QUEUE`.",
5997
6114
  "example": "queue",
5998
6115
  "member": "string",
5999
6116
  "name": "QueueName",
@@ -6002,7 +6119,7 @@
6002
6119
  },
6003
6120
  {
6004
6121
  "disabled": false,
6005
- "document": "CMQ or TDMQ CMQ toipc name.",
6122
+ "document": "The TDMQ CMQ TOPIC name. [original CMQ is offline](https://intl.cloud.tencent.com/document/product/1496/83970?from_cn_redirect=1). currently, only TDMQ CMQ is recommended for use. this parameter is valid only when `TargetType` is `TDMQ_CMQ_TOPIC`.",
6006
6123
  "example": "topic",
6007
6124
  "member": "string",
6008
6125
  "name": "TopicName",
@@ -6029,7 +6146,7 @@
6029
6146
  "members": [
6030
6147
  {
6031
6148
  "disabled": false,
6032
- "document": "Alarm policy ID.",
6149
+ "document": "Specifies the alert policy ID. obtain the alert policy ID by logging in to the console (https://console.cloud.tencent.com/autoscaling/group) or calling the api DescribeScalingPolicies (https://intl.cloud.tencent.com/document/api/377/33178?from_cn_redirect=1), and retrieve the AutoScalingPolicyId from the returned information.",
6033
6150
  "example": "asp-iir70sxv",
6034
6151
  "member": "string",
6035
6152
  "name": "AutoScalingPolicyId",
@@ -6038,7 +6155,7 @@
6038
6155
  },
6039
6156
  {
6040
6157
  "disabled": false,
6041
- "document": "Alarm policy name.",
6158
+ "document": "The Alarm policy name must be unique in your account. the name length cannot exceed 60 characters. the name only supports chinese, english, digits, underscores, hyphens, and decimal separators.",
6042
6159
  "example": "cpu_policy_test",
6043
6160
  "member": "string",
6044
6161
  "name": "ScalingPolicyName",
@@ -6146,7 +6263,7 @@
6146
6263
  "members": [
6147
6264
  {
6148
6265
  "disabled": false,
6149
- "document": "ID of the scheduled task to be edited",
6266
+ "document": "Scheduled task ID that needs modification. obtain the scheduled task ID by calling the api [DescribeScheduledActions](https://intl.cloud.tencent.com/document/api/377/20450?from_cn_redirect=1) and retrieving the ScheduledActionId from the returned information.",
6150
6267
  "example": "asst-chwbkq4c",
6151
6268
  "member": "string",
6152
6269
  "name": "ScheduledActionId",
@@ -6209,12 +6326,21 @@
6209
6326
  },
6210
6327
  {
6211
6328
  "disabled": false,
6212
- "document": "Repeating mode of the scheduled task, which is in standard cron format. <br>This parameter and `EndTime` need to be specified at the same time.",
6329
+ "document": "The repeating mode of the scheduled task. follows the standard Cron format. the Recurrence parameter limits (https://intl.cloud.tencent.com/document/product/377/88119?from_cn_redirect=1) consist of 5 fields separated by space, with the structure: minute, hr, date, month, week. this parameter must be simultaneously specified with `EndTime`.",
6213
6330
  "example": "0 18 * * 1,2,3,4,5",
6214
6331
  "member": "string",
6215
6332
  "name": "Recurrence",
6216
6333
  "required": false,
6217
6334
  "type": "string"
6335
+ },
6336
+ {
6337
+ "disabled": false,
6338
+ "document": "Disable update DesiredCapacity Indicates the DesiredCapacity is updated normally during scheduled task triggering.\n\nSpecifies whether the scheduled task triggers proactive modification of the DesiredCapacity when the value is True. DesiredCapacity may be modified by the minSize and maxSize mechanism.\nThe following cases assume that DisableUpdateDesiredCapacity is True:\n- When scheduled task triggered, the original DesiredCapacity is 5. The scheduled task changes the minSize to 10, the maxSize to 20, and the DesiredCapacity to 15. Since the DesiredCapacity update is disabled, 15 does not take effect. However, the original DesiredCapacity 5 is less than minSize 10, so the final new DesiredCapacity is 10.\n- When scheduled task triggered, the original DesiredCapacity is 25. The scheduled task changes the minSize to 10 and the maxSize to 20, and the DesiredCapacity to 15. Since the DesiredCapacity update is disabled, 15 does not take effect. However, the original DesiredCapacity 25 is greater than the maxSize 20, so the final new DesiredCapacity is 20.\n- When scheduled task triggered, the original DesiredCapacity is 13. The scheduled task changes the minSize to 10 and the maxSize to 20, and the DesiredCapacity to 15. Since the DesiredCapacity update is disabled, 15 does not take effect, and the DesiredCapacity is still 13.",
6339
+ "example": "false",
6340
+ "member": "bool",
6341
+ "name": "DisableUpdateDesiredCapacity",
6342
+ "required": false,
6343
+ "type": "bool"
6218
6344
  }
6219
6345
  ],
6220
6346
  "type": "object"
@@ -6236,10 +6362,11 @@
6236
6362
  "members": [
6237
6363
  {
6238
6364
  "disabled": false,
6239
- "document": "Target type. Valid values: `CMQ_QUEUE`, `CMQ_TOPIC`, `TDMQ_CMQ_QUEUE` and `TDMQ_CMQ_TOPIC`.\n<li> CMQ_QUEUE: Tencent Cloud message queue - queue model.</li>\n<li> CMQ_TOPIC: Tencent Cloud message queue - topic model.</li>\n<li> TDMQ_CMQ_QUEUE: Tencent Cloud TDMQ message queue - queue model.</li>\n<li> TDMQ_CMQ_TOPIC: Tencent Cloud TDMQ message queue - topic model.</li>",
6365
+ "document": "Target type. valid values include `CMQ_QUEUE`, `CMQ_TOPIC`, `TDMQ_CMQ_QUEUE`, `TDMQ_CMQ_TOPIC`.\n<li>CMQ_QUEUE, specifies tencent cloud message QUEUE - queueing model. the corresponding product is offline. it is recommended to switch to TDMQ_CMQ_QUEUE (https://intl.cloud.tencent.com/document/product/1496/83970?from_cn_redirect=1).</li>.\n<li>CMQ_TOPIC, specifies tencent cloud message queue - TOPIC model. the corresponding product is offline. it is recommended to switch to TDMQ_CMQ_TOPIC (https://intl.cloud.tencent.com/document/product/1496/83970?from_cn_redirect=1).</li>.\n<li> TDMQ_CMQ_QUEUE. specifies the tencent cloud TDMQ message QUEUE - queueing model.</li>.\n<Li>TDMQ_CMQ_TOPIC. specifies tencent cloud tdmq message queue - topic model.</li>.",
6240
6366
  "example": "TDMQ_CMQ_QUEUE",
6241
6367
  "member": "string",
6242
6368
  "name": "TargetType",
6369
+ "output_required": true,
6243
6370
  "required": true,
6244
6371
  "type": "string",
6245
6372
  "value_allowed_null": false
@@ -6250,6 +6377,7 @@
6250
6377
  "example": "test-queue",
6251
6378
  "member": "string",
6252
6379
  "name": "QueueName",
6380
+ "output_required": true,
6253
6381
  "required": false,
6254
6382
  "type": "string",
6255
6383
  "value_allowed_null": false
@@ -6260,6 +6388,7 @@
6260
6388
  "example": "test-topic",
6261
6389
  "member": "string",
6262
6390
  "name": "TopicName",
6391
+ "output_required": true,
6263
6392
  "required": false,
6264
6393
  "type": "string",
6265
6394
  "value_allowed_null": false
@@ -6292,7 +6421,7 @@
6292
6421
  },
6293
6422
  {
6294
6423
  "disabled": false,
6295
- "document": "Original refresh activity ID, which exists only in the rollback refresh activity.\nNote: This field may return null, indicating that no valid value can be obtained.",
6424
+ "document": "Original refresh activity ID. exists only in rollback refresh activity.",
6296
6425
  "example": "asr-v8dd7er6",
6297
6426
  "member": "string",
6298
6427
  "name": "OriginRefreshActivityId",
@@ -6312,8 +6441,8 @@
6312
6441
  },
6313
6442
  {
6314
6443
  "disabled": false,
6315
- "document": "Refresh mode.",
6316
- "example": "ROLLING_UPDATE",
6444
+ "document": "Refresh mode. valid values as follows:.\n<Li>ROLLING_UPDATE_RESET: reinstall the system for rolling updates.</li>.\n<li>ROLLING_UPDATE_REPLACE: Create an instance and replace the old instance with it for rolling updates. This mode does not support the rollback API currently.</li>",
6445
+ "example": "ROLLING_UPDATE_RESET",
6317
6446
  "member": "string",
6318
6447
  "name": "RefreshMode",
6319
6448
  "output_required": true,
@@ -6352,7 +6481,7 @@
6352
6481
  },
6353
6482
  {
6354
6483
  "disabled": false,
6355
- "document": "Current refresh batch number. For example, a value of 2 indicates that the current activity is refreshing the second batch of instances.\nNote: This field may return null, indicating that no valid value can be obtained.",
6484
+ "document": "Current refresh batch number. for example, 2 indicates the second batch of instances is being refreshed by the current activity.",
6356
6485
  "example": "2",
6357
6486
  "member": "uint64",
6358
6487
  "name": "CurrentRefreshBatchNum",
@@ -6362,7 +6491,7 @@
6362
6491
  },
6363
6492
  {
6364
6493
  "disabled": false,
6365
- "document": "Refresh activity start time.\nNote: This field may return null, indicating that no valid value can be obtained.",
6494
+ "document": "The activity start time is refreshed in standard `UTC` time, in the format `YYYY-MM-DDTHH:MM:ssZ`.\nNote: This field may return null, indicating that no valid values can be obtained.",
6366
6495
  "example": "2023-09-04T11:42:46Z",
6367
6496
  "member": "datetime_iso",
6368
6497
  "name": "StartTime",
@@ -6372,7 +6501,7 @@
6372
6501
  },
6373
6502
  {
6374
6503
  "disabled": false,
6375
- "document": "Refresh activity end time.\nNote: This field may return null, indicating that no valid value can be obtained.",
6504
+ "document": "Refresh activity end time, in standard UTC time, in the format YYYY-MM-DDTHH:MM:ssZ.\nNote: This field may return null, indicating that no valid values can be obtained.",
6376
6505
  "example": "2023-09-04T11:42:46Z",
6377
6506
  "member": "datetime_iso",
6378
6507
  "name": "EndTime",
@@ -6382,7 +6511,7 @@
6382
6511
  },
6383
6512
  {
6384
6513
  "disabled": false,
6385
- "document": "Refresh activity creation time.\nNote: This field may return null, indicating that no valid value can be obtained.",
6514
+ "document": "Refresh activity creation time, in standard UTC time, in the format YYYY-MM-DDTHH:MM:ssZ.",
6386
6515
  "example": "2023-09-04T11:42:46Z",
6387
6516
  "member": "datetime_iso",
6388
6517
  "name": "CreatedTime",
@@ -6464,7 +6593,7 @@
6464
6593
  },
6465
6594
  {
6466
6595
  "disabled": false,
6467
- "document": "Refresh instance status. If an instance is removed or destroyed during the refresh process, its status will be updated to NOT_FOUND. Valid values: <br><li>WAITING: pending refresh.</li> <li>INIT: Initializing.</li> <li>RUNNING: Refreshing in progress.</li> <li>FAILED: Refresh failed.</li> <li>CANCELLED: Canceled.</li> <li>SUCCESSFUL: Refreshed.</li> <li>NOT_FOUND: Instance not found.",
6596
+ "document": "Refresh instance status. if the instance is removed or terminated during refresh, the status will be updated to NOT_FOUND. valid values: <li>WAITING: pending refresh;</li> <li>INIT: initializing;</li> <li>RUNNING: refreshing;</li> <li>FAILED: refresh FAILED;</li> <li>CANCELLED: CANCELLED;</li> <li>SUCCESSFUL: refresh SUCCESSFUL;</li> <li>NOT_FOUND: instance does NOT exist.</li>.",
6468
6597
  "example": "WAITING",
6469
6598
  "member": "string",
6470
6599
  "name": "InstanceStatus",
@@ -6474,7 +6603,7 @@
6474
6603
  },
6475
6604
  {
6476
6605
  "disabled": false,
6477
- "document": "The most recent scaling activity ID during instance refresh can be queried via the DescribeAutoScalingActivities API.\nPlease note that scaling activities differ from instance refresh activities; a single instance refresh activity may involve multiple scaling activities.\nNote: This field may return null, indicating that no valid value can be obtained.",
6606
+ "document": "The most recent scaling activity ID during instance refresh can be queried via the DescribeAutoScalingActivities api.\nPlease note that scaling activities differ from instance refresh activities; a single instance refresh activity may involve multiple scaling activities.",
6478
6607
  "example": "asa-7y5rey56",
6479
6608
  "member": "string",
6480
6609
  "name": "LastActivityId",
@@ -6484,7 +6613,7 @@
6484
6613
  },
6485
6614
  {
6486
6615
  "disabled": false,
6487
- "document": "Instance refresh status information.\nNote: This field may return null, indicating that no valid value can be obtained.",
6616
+ "document": "Describes the instance refresh status.",
6488
6617
  "example": "success",
6489
6618
  "member": "string",
6490
6619
  "name": "InstanceStatusMessage",
@@ -6500,7 +6629,7 @@
6500
6629
  "members": [
6501
6630
  {
6502
6631
  "disabled": false,
6503
- "document": "Rolling update settings parameters. RefreshMode is the rolling update. This parameter must be filled in.Note: This field may return null, indicating that no valid value can be obtained.",
6632
+ "document": "Rolling update settings parameters. RefreshMode is rolling update. this parameter must be filled in.",
6504
6633
  "example": "{\"BatchNumber\": 1, \"MaxSurge\": 1, \"BatchPause\": \"AUTOMATIC\"}",
6505
6634
  "member": "RollingUpdateSettings",
6506
6635
  "name": "RollingUpdateSettings",
@@ -6554,7 +6683,7 @@
6554
6683
  "members": [
6555
6684
  {
6556
6685
  "disabled": false,
6557
- "document": "Auto scaling group ID",
6686
+ "document": "Scaling group ID. obtain available scaling group ids in the following ways:.\n<li>Query the scaling group ID by logging in to the [console](https://console.cloud.tencent.com/autoscaling/group).</li>.\n<li>Specifies the scaling group ID obtained by calling the api [DescribeAutoScalingGroups](https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1) and retrieving the AutoScalingGroupId from the return information.</li>.",
6558
6687
  "example": "asg-boz1qhnk",
6559
6688
  "member": "string",
6560
6689
  "name": "AutoScalingGroupId",
@@ -6563,7 +6692,7 @@
6563
6692
  },
6564
6693
  {
6565
6694
  "disabled": false,
6566
- "document": "List of CVM instance IDs",
6695
+ "document": "CVM instance ID list. you can obtain available instance ID in the following ways:.\n<li>Query instance ID by logging in to the <a href=\"https://console.cloud.tencent.com/cvm/index\">console</a>.</li>.\n<li>Specifies the instance ID by calling the api [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1) and getting `InstanceId` from the return information.</li>.",
6567
6696
  "example": "[\"ins-cri8d02t\",\"ins-osckfnm7\"]",
6568
6697
  "member": "string",
6569
6698
  "name": "InstanceIds",
@@ -6600,7 +6729,7 @@
6600
6729
  "members": [
6601
6730
  {
6602
6731
  "disabled": false,
6603
- "document": "Scaling group ID.",
6732
+ "document": "Scaling group ID. obtain in the following ways:.\n<li>Query the scaling group ID by logging in to the [console](https://console.cloud.tencent.com/autoscaling/group).</li>.\n<li>Specifies the scaling group ID obtained by calling the api [DescribeAutoScalingGroups](https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1) and retrieving the AutoScalingGroupId from the return information.</li>.",
6604
6733
  "example": "asg-u7dy6t5r",
6605
6734
  "member": "string",
6606
6735
  "name": "AutoScalingGroupId",
@@ -6609,7 +6738,7 @@
6609
6738
  },
6610
6739
  {
6611
6740
  "disabled": false,
6612
- "document": "Refresh activity ID.",
6741
+ "document": "Refresh activity ID. you can get the instance refresh activity ID by calling the api [DescribeRefreshActivities](https://intl.cloud.tencent.com/document/api/377/99175?from_cn_redirect=1) and retrieving the RefreshActivityId from the returned information.",
6613
6742
  "example": "asr-dhwt6r54",
6614
6743
  "member": "string",
6615
6744
  "name": "RefreshActivityId",
@@ -6645,7 +6774,7 @@
6645
6774
  "members": [
6646
6775
  {
6647
6776
  "disabled": false,
6648
- "document": "Scaling group ID.",
6777
+ "document": "Scaling group ID. you can obtain available scaling group ids in the following ways. \n<li>Query the scaling group ID by logging in to the <a href=\"https://console.cloud.tencent.com/autoscaling/group\">console</a>.</li>.\n<li>Obtain the scaling group ID by calling the api [DescribeAutoScalingGroups](https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1) and retrieving the AutoScalingGroupId from the returned information.</li>.",
6649
6778
  "example": "asg-12yqet78",
6650
6779
  "member": "string",
6651
6780
  "name": "AutoScalingGroupId",
@@ -6663,7 +6792,7 @@
6663
6792
  },
6664
6793
  {
6665
6794
  "disabled": false,
6666
- "document": "Original refresh activity ID.",
6795
+ "document": "The original refresh activity ID. you can obtain the original refresh activity ID by calling the api [DescribeRefreshActivities](https://intl.cloud.tencent.com/document/api/377/99175?from_cn_redirect=1) and retrieving the OriginRefreshActivityId from the returned information.",
6667
6796
  "example": "asr-fdsf8u6b",
6668
6797
  "member": "string",
6669
6798
  "name": "OriginRefreshActivityId",
@@ -6721,7 +6850,7 @@
6721
6850
  {
6722
6851
  "disabled": false,
6723
6852
  "document": "Pause policy between batches. Default value: Automatic. Valid values:\n<li>FIRST_BATCH_PAUSE: Pause after the first batch of updates is completed.</li>\n<li>BATCH_INTERVAL_PAUSE: Pause between batches.</li>\n<li>AUTOMATIC: Do not pause.</li>",
6724
- "example": "Automatic",
6853
+ "example": "AUTOMATIC",
6725
6854
  "member": "string",
6726
6855
  "name": "BatchPause",
6727
6856
  "output_required": true,
@@ -6739,6 +6868,17 @@
6739
6868
  "required": false,
6740
6869
  "type": "int",
6741
6870
  "value_allowed_null": false
6871
+ },
6872
+ {
6873
+ "disabled": false,
6874
+ "document": "Failure handling strategy. default value: AUTO_PAUSE. valid values:.\n<Li>AUTO_PAUSE: suspended after refresh fails</li>.\n<li>AUTO_ROLLBACK: roll back after a refresh fails. each batch rolls back one instance during ROLLBACK, and the CheckInstanceTargetHealth parameter value matches the original refresh activity. no need to roll back if the shrinkage process introduced by the MaxSurge parameter fails. a cancel action will replace the ROLLBACK.</li>.\n<Li>AUTO_CANCEL: cancel after refresh fails</li>.",
6875
+ "example": "AUTO_PAUSE",
6876
+ "member": "string",
6877
+ "name": "FailProcess",
6878
+ "output_required": false,
6879
+ "required": false,
6880
+ "type": "string",
6881
+ "value_allowed_null": false
6742
6882
  }
6743
6883
  ],
6744
6884
  "usage": "both"
@@ -6798,7 +6938,7 @@
6798
6938
  "members": [
6799
6939
  {
6800
6940
  "disabled": false,
6801
- "document": "Scaling group ID",
6941
+ "document": "Scaling group ID. obtain available scaling group ids in the following ways:.\n<li>Query the scaling group ID by logging in to the [console](https://console.cloud.tencent.com/autoscaling/group).</li>.\n<li>Specifies the scaling group ID obtained by calling the api [DescribeAutoScalingGroups](https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1) and retrieving the AutoScalingGroupId from the return information.</li>.",
6802
6942
  "example": "asg-12yqet78",
6803
6943
  "member": "string",
6804
6944
  "name": "AutoScalingGroupId",
@@ -6807,7 +6947,7 @@
6807
6947
  },
6808
6948
  {
6809
6949
  "disabled": false,
6810
- "document": "Number of instances to be reduced",
6950
+ "document": "Number of resource instances to scale in. this parameter has a static value range of [1,2000] and must not be larger than the difference between the desired number and the minimum value. for example, if the scaling group desired number is 100 and the minimum value is 20, the permissible range is [1,80].",
6811
6951
  "example": "1",
6812
6952
  "member": "uint64",
6813
6953
  "name": "ScaleInNumber",
@@ -6949,7 +7089,7 @@
6949
7089
  },
6950
7090
  {
6951
7091
  "disabled": false,
6952
- "document": "Cooldown period. This parameter is only applicable to a simple policy.",
7092
+ "document": "Cooldown duration in seconds, applies only to simple policies. value range [0,3600]. default cooldown: 300 seconds.",
6953
7093
  "example": "60",
6954
7094
  "member": "uint64",
6955
7095
  "name": "Cooldown",
@@ -7075,7 +7215,7 @@
7075
7215
  },
7076
7216
  {
7077
7217
  "disabled": false,
7078
- "document": "Repeating mode of the scheduled task.",
7218
+ "document": "Specifies the repeating mode of the scheduled task. the Recurrence parameter limits (https://intl.cloud.tencent.com/document/product/377/88119?from_cn_redirect=1) consist of 5 fields separated by space, with the structure: minute, hour, date, month, week.",
7079
7219
  "example": "0 23 */1 * *",
7080
7220
  "member": "string",
7081
7221
  "name": "Recurrence",
@@ -7125,7 +7265,7 @@
7125
7265
  },
7126
7266
  {
7127
7267
  "disabled": false,
7128
- "document": "Creation time of the scheduled task. The value is in `UTC time` in the format of `YYYY-MM-DDThh:mm:ssZ` according to the `ISO8601` standard.",
7268
+ "document": "The creation time of the scheduled task. value is in standard `UTC` time, formatted as `YYYY-MM-DDThh:MM:ssZ` according to the `ISO8601` standard.",
7129
7269
  "example": "2022-02-21T02:19:52Z",
7130
7270
  "member": "datetime_iso",
7131
7271
  "name": "CreatedTime",
@@ -7142,6 +7282,16 @@
7142
7282
  "output_required": true,
7143
7283
  "type": "string",
7144
7284
  "value_allowed_null": false
7285
+ },
7286
+ {
7287
+ "disabled": false,
7288
+ "document": "Disable update DesiredCapacity Indicates the DesiredCapacity is updated normally during scheduled task triggering.\n\nSpecifies whether the scheduled task triggers proactive modification of the DesiredCapacity when the value is True. DesiredCapacity may be modified by the minSize and maxSize mechanism.\nThe following cases assume that DisableUpdateDesiredCapacity is True:\n- When scheduled task triggered, the original DesiredCapacity is 5. The scheduled task changes the minSize to 10, the maxSize to 20, and the DesiredCapacity to 15. Since the DesiredCapacity update is disabled, 15 does not take effect. However, the original DesiredCapacity 5 is less than minSize 10, so the final new DesiredCapacity is 10.\n- When scheduled task triggered, the original DesiredCapacity is 25. The scheduled task changes the minSize to 10 and the maxSize to 20, and the DesiredCapacity to 15. Since the DesiredCapacity update is disabled, 15 does not take effect. However, the original DesiredCapacity 25 is greater than the maxSize 20, so the final new DesiredCapacity is 20.\n- When scheduled task triggered, the original DesiredCapacity is 13. The scheduled task changes the minSize to 10 and the maxSize to 20, and the DesiredCapacity to 15. Since the DesiredCapacity update is disabled, 15 does not take effect, and the DesiredCapacity is still 13.",
7289
+ "example": "false",
7290
+ "member": "bool",
7291
+ "name": "DisableUpdateDesiredCapacity",
7292
+ "output_required": false,
7293
+ "type": "bool",
7294
+ "value_allowed_null": false
7145
7295
  }
7146
7296
  ],
7147
7297
  "usage": "out"
@@ -7152,7 +7302,7 @@
7152
7302
  {
7153
7303
  "disabled": false,
7154
7304
  "document": "Enables unhealthy instance replacement. If this feature is enabled, AS will replace instances that are flagged as unhealthy by Cloud Monitor. If this parameter is not specified, the value will be False by default.",
7155
- "example": "False",
7305
+ "example": "false",
7156
7306
  "member": "bool",
7157
7307
  "name": "ReplaceMonitorUnhealthy",
7158
7308
  "output_required": true,
@@ -7174,7 +7324,7 @@
7174
7324
  {
7175
7325
  "disabled": false,
7176
7326
  "document": "Enable unhealthy instance replacement. If this feature is enabled, AS will replace instances that are found unhealthy in the CLB health check. If this parameter is not specified, the default value `False` will be used.",
7177
- "example": "False",
7327
+ "example": "false",
7178
7328
  "member": "bool",
7179
7329
  "name": "ReplaceLoadBalancerUnhealthy",
7180
7330
  "output_required": true,
@@ -7184,7 +7334,7 @@
7184
7334
  },
7185
7335
  {
7186
7336
  "disabled": false,
7187
- "document": "Replace mode of unhealthy replacement service. Valid values:\nRECREATE: Rebuild an instance to replace the original unhealthy instance.\nRESET: Performing a system reinstallation on unhealthy instances to keep information such as data disks, private IP addresses, and instance IDs unchanged. The instance login settings, HostName, enhanced services, and UserData will remain consistent with the current launch configuration.\nDefault value: RECREATE.\nNote: This field may return null, indicating that no valid values can be obtained.",
7337
+ "document": "Replacement mode of the unhealthy replacement service. valid values:.\nRECREATE: rebuild an instance to replace the unhealthy instance.\nRESET: performs a system reinstallation on unhealthy instances while keeping the data disk, private IP address, instance id, and other information unchanged. the instance login settings, hostname, enhanced services, and UserData remain consistent with the current launch configuration.\nDefault value: RECREATE.",
7188
7338
  "example": "RECREATE",
7189
7339
  "member": "string",
7190
7340
  "name": "ReplaceMode",
@@ -7195,14 +7345,36 @@
7195
7345
  },
7196
7346
  {
7197
7347
  "disabled": false,
7198
- "document": "Automatic instance tag update. The default value is false. If this feature is enabled, tags of running instances in a scaling group will be updated as well if the scaling group tags are updated. (This feature takes effect for tag creation and editing but not tag deletion.) The update does not take effect immediately due to certain latency.",
7199
- "example": "False",
7348
+ "document": "Automatic instance Tag update. the default value is False. if this feature is enabled, tags of running instances in a scaling group will be updated as well if the scaling group tags are updated. (this feature takes effect for Tag creation and editing but not Tag deletion.) the update does not take effect immediately due to certain latency.",
7349
+ "example": "false",
7200
7350
  "member": "bool",
7201
7351
  "name": "AutoUpdateInstanceTags",
7202
7352
  "output_required": false,
7203
7353
  "required": false,
7204
7354
  "type": "bool",
7205
7355
  "value_allowed_null": false
7356
+ },
7357
+ {
7358
+ "disabled": false,
7359
+ "document": "Expected number of instances sync minimum and maximum value. default value is False. this parameter only takes effect in scenarios where the expected number is not passed in to modify scaling group api.\n<Li>True: when modifying the maximum or minimum value, if a conflict exists with the current expected value, synchronously adjust the expected value. for example, if the input minimum value is 2 while the current expected value is 1, the expected value will be synchronously adjusted to 2.</li>.\n<Li>False: if a conflict exists between the current expected value when modifying the maximum or minimum value, an error message indicates it is not allowed to be modified.</li>.",
7360
+ "example": "false",
7361
+ "member": "bool",
7362
+ "name": "DesiredCapacitySyncWithMaxMinSize",
7363
+ "output_required": true,
7364
+ "required": false,
7365
+ "type": "bool",
7366
+ "value_allowed_null": false
7367
+ },
7368
+ {
7369
+ "disabled": false,
7370
+ "document": "Scaling in unhealthy instances first. If enabled, preferentially selects unhealthy instances during scale in. Default value: False.",
7371
+ "example": "false",
7372
+ "member": "bool",
7373
+ "name": "PriorityScaleInUnhealthy",
7374
+ "output_required": false,
7375
+ "required": false,
7376
+ "type": "bool",
7377
+ "value_allowed_null": false
7206
7378
  }
7207
7379
  ],
7208
7380
  "usage": "both"
@@ -7212,7 +7384,7 @@
7212
7384
  "members": [
7213
7385
  {
7214
7386
  "disabled": false,
7215
- "document": "Auto scaling group ID.",
7387
+ "document": "Auto scaling group ID. obtain available scaling group ids in the following ways:.\n<li>Query the scaling group ID by logging in to the [console](https://console.cloud.tencent.com/autoscaling/group).</li>.\n<li>Specifies the scaling group ID obtained by calling the api [DescribeAutoScalingGroups](https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1) and retrieving the AutoScalingGroupId from the return information.</li>.",
7216
7388
  "example": "asg-2umy3jbd",
7217
7389
  "member": "string",
7218
7390
  "name": "AutoScalingGroupId",
@@ -7221,7 +7393,7 @@
7221
7393
  },
7222
7394
  {
7223
7395
  "disabled": false,
7224
- "document": "Instance ID.",
7396
+ "document": "Instance ID. you can obtain available instance ID in the following ways:.\n<li>Query instance ID by logging in to the <a href=\"https://console.cloud.tencent.com/cvm/index\">console</a>.</li>.\n<li>Specifies the instance ID by calling the api [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1) and getting `InstanceId` from the return information.</li>.",
7225
7397
  "example": "[\"ins-b2d33ywt\"]",
7226
7398
  "member": "string",
7227
7399
  "name": "InstanceIds",
@@ -7331,7 +7503,7 @@
7331
7503
  "members": [
7332
7504
  {
7333
7505
  "disabled": false,
7334
- "document": "The scaling group ID.",
7506
+ "document": "Scaling group ID. obtain available scaling group ids in the following ways:.\n<li>Query the scaling group ID by logging in to the [console](https://console.cloud.tencent.com/autoscaling/group).</li>.\n<li>Specifies the scaling group ID obtained by calling the api [DescribeAutoScalingGroups](https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1) and retrieving the AutoScalingGroupId from the return information.</li>.",
7335
7507
  "example": "asg-boz1qhnk",
7336
7508
  "member": "string",
7337
7509
  "name": "AutoScalingGroupId",
@@ -7340,7 +7512,7 @@
7340
7512
  },
7341
7513
  {
7342
7514
  "disabled": false,
7343
- "document": "The list of the CVM instances you want to start up.",
7515
+ "document": "Specifies the instance ID list of CVM to enable. you can obtain available instance ID in the following ways.\n<li>Query instance ID by logging in to the <a href=\"https://console.cloud.tencent.com/cvm/index\">console</a>.</li>.\n<li>Get the instance ID by calling the api [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1) and retrieving the `InstanceId` from the returned information.</li>.",
7344
7516
  "example": "[\"ins-cri8d02t\",\"ins-osckfnm7\"]",
7345
7517
  "member": "string",
7346
7518
  "name": "InstanceIds",
@@ -7395,7 +7567,7 @@
7395
7567
  },
7396
7568
  {
7397
7569
  "disabled": false,
7398
- "document": "Refresh mode. Valid values:\n<li>ROLLING_UPDATE_RESET: Reinstall the system for rolling updates.</li>\n<li>ROLLING_UPDATE_REPLACE: Create an instance and replace the old instance with it for rolling updates. This mode does not support the rollback API currently.</li>",
7570
+ "document": "Refresh mode. default value: ROLLING_UPDATE_RESET. valid values:.\n<Li>ROLLING_UPDATE_RESET: reinstall the system for rolling updates.</li>.\n<li>ROLLING_UPDATE_REPLACE: Create an instance and replace the old instance with it for rolling updates. This mode does not support the rollback API currently.</li>",
7399
7571
  "example": "ROLLING_UPDATE_RESET",
7400
7572
  "member": "string",
7401
7573
  "name": "RefreshMode",
@@ -7432,7 +7604,7 @@
7432
7604
  "members": [
7433
7605
  {
7434
7606
  "disabled": false,
7435
- "document": "The scaling group ID.",
7607
+ "document": "Auto scaling group ID. obtain available scaling group ids in the following ways:.\n<li>Query the scaling group ID by logging in to the [console](https://console.cloud.tencent.com/autoscaling/group).</li>.\n<li>Specifies the scaling group ID obtained by calling the api [DescribeAutoScalingGroups](https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1) and retrieving the AutoScalingGroupId from the return information.</li>.",
7436
7608
  "example": "asg-boz1qhnk",
7437
7609
  "member": "string",
7438
7610
  "name": "AutoScalingGroupId",
@@ -7441,7 +7613,7 @@
7441
7613
  },
7442
7614
  {
7443
7615
  "disabled": false,
7444
- "document": "The list of the CVM instances you want to shut down.",
7616
+ "document": "List of CVM instance ids to be closed. you can obtain available instance ids in the following ways:.\n<li>Query instance ID by logging in to the <a href=\"https://console.cloud.tencent.com/cvm/index\">console</a>.</li>.\n<li>Specifies the instance ID by calling the api [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1) and getting `InstanceId` from the return information.</li>.",
7445
7617
  "example": "[\"ins-cri8d02t\",\"ins-osckfnm7\"]",
7446
7618
  "member": "string",
7447
7619
  "name": "InstanceIds",
@@ -7487,7 +7659,7 @@
7487
7659
  "members": [
7488
7660
  {
7489
7661
  "disabled": false,
7490
- "document": "Scaling group ID.",
7662
+ "document": "Scaling group ID. you can obtain available scaling group ids in the following ways.\n<li>Query the scaling group ID by logging in to the [console](https://console.cloud.tencent.com/autoscaling/group).</li>.\n<li>Get the scaling group ID by calling the api [DescribeAutoScalingGroups](https://intl.cloud.tencent.com/document/api/377/20438?from_cn_redirect=1) and retrieving the AutoScalingGroupId from the returned information.</li>.",
7491
7663
  "example": "asg-u7dy6t5r",
7492
7664
  "member": "string",
7493
7665
  "name": "AutoScalingGroupId",
@@ -7496,7 +7668,7 @@
7496
7668
  },
7497
7669
  {
7498
7670
  "disabled": false,
7499
- "document": "Refresh activity ID.",
7671
+ "document": "Refresh activity ID. you can call the api [DescribeRefreshActivities](https://intl.cloud.tencent.com/document/api/377/99175?from_cn_redirect=1) and obtain the instance refresh activity ID from the returned information.",
7500
7672
  "example": "asr-dhwt6r54",
7501
7673
  "member": "string",
7502
7674
  "name": "RefreshActivityId",
@@ -7523,7 +7695,7 @@
7523
7695
  "members": [
7524
7696
  {
7525
7697
  "disabled": false,
7526
- "document": "System disk type. For restrictions on the system disk type, see [cloud block storage types](https://intl.cloud.tencent.com/document/product/362/2353?from_cn_redirect=1). Valid values:\n<li>LOCAL_BASIC: Local Disk.</li>\n<li>LOCAL_SSD: Local SSD.</li>\n<li>CLOUD_BASIC: Basic Cloud Disk.</li>\n<li>CLOUD_PREMIUM: Premium Disk.</li>\n<li>CLOUD_SSD: Cloud SSD.</li>\n<li>Default value: CLOUD_PREMIUM.</li>",
7698
+ "document": "System disk type. for restrictions on the system disk type, see [cloud block storage types](https://intl.cloud.tencent.com/document/product/362/2353?from_cn_redirect=1). valid values:.\n<Li>LOCAL_BASIC: local hard disk.</li>.\n<Li>LOCAL_SSD: local ssd.</li>.\n<Li>CLOUD_BASIC: general cloud disk.</li>.\n<Li>CLOUD_PREMIUM: high-performance cloud block storage</li>.\n<Li>CLOUD_SSD: cloud ssd</li>.\n<Li>CLOUD_BSSD: universal ssd cloud disk</li>.\n<Li>CLOUD_HSSD: enhanced ssd cloud disk</li>.\n<Li>CLOUD_TSSD: ultra ssd.</li>.\n<li>Default value: CLOUD_PREMIUM.</li>",
7527
7699
  "example": "CLOUD_PREMIUM",
7528
7700
  "member": "string",
7529
7701
  "name": "DiskType",
@@ -7573,7 +7745,7 @@
7573
7745
  },
7574
7746
  {
7575
7747
  "disabled": false,
7576
- "document": "Resource type bound with tags. Valid values: auto-scaling-group and launch-configuration.\nNote: This field may return null, indicating that no valid values can be obtained.",
7748
+ "document": "Specifies the resource type bound to the tag. type currently supported: \"auto-scaling-group\", \"launch-configuration\". valid values: scaling group resources and launch configuration resources respectively.",
7577
7749
  "example": "auto-scaling-group",
7578
7750
  "member": "string",
7579
7751
  "name": "ResourceType",
@@ -7590,7 +7762,7 @@
7590
7762
  "members": [
7591
7763
  {
7592
7764
  "disabled": false,
7593
- "document": "Port",
7765
+ "document": "Port. value range: [1,65535]. as an input parameter, this parameter is required.",
7594
7766
  "example": "80",
7595
7767
  "member": "uint64",
7596
7768
  "name": "Port",
@@ -7601,7 +7773,7 @@
7601
7773
  },
7602
7774
  {
7603
7775
  "disabled": false,
7604
- "document": "Weight",
7776
+ "document": "Weight. value range: [0,100]. this parameter is required as an input parameter.",
7605
7777
  "example": "10",
7606
7778
  "member": "uint64",
7607
7779
  "name": "Weight",
@@ -7834,7 +8006,7 @@
7834
8006
  "members": [
7835
8007
  {
7836
8008
  "disabled": false,
7837
- "document": "Lifecycle hook ID",
8009
+ "document": "Lifecycle hook ID. you can call the api [DescribeLifecycleHooks](https://intl.cloud.tencent.com/document/api/377/34452?from_cn_redirect=1) and retrieve the LifecycleHookId from the returned information to obtain the lifecycle hook ID.",
7838
8010
  "example": "ash-8azjzxj9",
7839
8011
  "member": "string",
7840
8012
  "name": "LifecycleHookId",
@@ -7843,7 +8015,7 @@
7843
8015
  },
7844
8016
  {
7845
8017
  "disabled": false,
7846
- "document": "Lifecycle hook name",
8018
+ "document": "Lifecycle hook name, which can contain chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) with a maximum length of 128 characters.",
7847
8019
  "example": "hook-updated",
7848
8020
  "member": "string",
7849
8021
  "name": "LifecycleHookName",
@@ -7852,7 +8024,7 @@
7852
8024
  },
7853
8025
  {
7854
8026
  "disabled": false,
7855
- "document": "Scenario for the lifecycle hook. Value range: \"INSTANCE_LAUNCHING\", \"INSTANCE_TERMINATING\"",
8027
+ "document": "Scenario for performing the lifecycle hook. valid values:.\n`INSTANCE_LAUNCHING`: the lifecycle hook is being scaled out.\n`INSTANCE_TERMINATING`: the lifecycle hook is being scaled in.",
7856
8028
  "example": "INSTANCE_LAUNCHING",
7857
8029
  "member": "string",
7858
8030
  "name": "LifecycleTransition",
@@ -7861,7 +8033,7 @@
7861
8033
  },
7862
8034
  {
7863
8035
  "disabled": false,
7864
- "document": "Defines the action to be taken by the auto scaling group upon lifecycle hook timeout. Value range: \"CONTINUE\", \"ABANDON\". Default value: \"CONTINUE\"",
8036
+ "document": "Action to be taken by the scaling group in case of lifecycle hook timeout or LifecycleCommand execution failure. valid values are as follows:.\nDefault value, means CONTINUE to execute capacity expansion or reduction.\n* ABANDON: for scale-out hooks, cvms that time out or fail to execute LifecycleCommand will be released directly or removed. for scale-in hooks, scale-in activities will continue.",
7865
8037
  "example": "CONTINUE",
7866
8038
  "member": "string",
7867
8039
  "name": "DefaultResult",
@@ -7879,7 +8051,7 @@
7879
8051
  },
7880
8052
  {
7881
8053
  "disabled": false,
7882
- "document": "Additional information of a notification that Auto Scaling sends to targets. This parameter is set when you configure a notification (default value: \"\").",
8054
+ "document": "Additional information sent by auto scaling to notification targets, used when configuring a notification (default value: \"\"). NotificationMetadata and LifecycleCommand are mutually exclusive parameters and cannot be specified simultaneously.",
7883
8055
  "example": "as-meta-0",
7884
8056
  "member": "string",
7885
8057
  "name": "NotificationMetadata",
@@ -7906,7 +8078,7 @@
7906
8078
  },
7907
8079
  {
7908
8080
  "disabled": false,
7909
- "document": "Remote command execution object. `NotificationTarget` and `LifecycleCommand` cannot be specified at the same time.",
8081
+ "document": "Remote command execution object. `NotificationMetadata`, `NotificationTarget`, and `LifecycleCommand` are mutually exclusive and cannot be specified simultaneously.",
7910
8082
  "example": "{\"CommandId\": \"cmd-am4e3hd8\", \"Parameters\": \"{123: 222}\"}",
7911
8083
  "member": "LifecycleCommand",
7912
8084
  "name": "LifecycleCommand",