tccli-intl-en 3.0.1248.1__py2.py3-none-any.whl → 3.0.1282.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.
- tccli/__init__.py +1 -1
- tccli/services/__init__.py +17 -1
- tccli/services/advisor/advisor_client.py +8 -2
- tccli/services/aiart/aiart_client.py +4 -1
- tccli/services/ams/ams_client.py +16 -4
- tccli/services/antiddos/antiddos_client.py +280 -70
- tccli/services/apigateway/apigateway_client.py +372 -93
- tccli/services/apm/apm_client.py +52 -13
- tccli/services/asr/asr_client.py +8 -2
- tccli/services/autoscaling/autoscaling_client.py +232 -58
- tccli/services/autoscaling/v20180419/api.json +1 -1
- tccli/services/batch/batch_client.py +112 -28
- tccli/services/bi/bi_client.py +96 -24
- tccli/services/billing/billing_client.py +168 -42
- tccli/services/cam/cam_client.py +324 -81
- tccli/services/captcha/captcha_client.py +4 -1
- tccli/services/car/car_client.py +132 -33
- tccli/services/cbs/cbs_client.py +152 -38
- tccli/services/ccc/ccc_client.py +732 -98
- tccli/services/ccc/v20200210/api.json +1727 -196
- tccli/services/ccc/v20200210/examples.json +64 -0
- tccli/services/cdb/cdb_client.py +532 -133
- tccli/services/cdc/cdc_client.py +80 -20
- tccli/services/cdc/v20201214/api.json +2 -2
- tccli/services/cdc/v20201214/examples.json +4 -4
- tccli/services/cdn/cdn_client.py +176 -44
- tccli/services/cdwdoris/cdwdoris_client.py +308 -77
- tccli/services/cdwpg/cdwpg_client.py +96 -24
- tccli/services/cdz/__init__.py +4 -0
- tccli/services/cdz/cdz_client.py +210 -0
- tccli/services/cdz/v20221123/api.json +233 -0
- tccli/services/cdz/v20221123/examples.json +12 -0
- tccli/services/cfg/cfg_client.py +64 -16
- tccli/services/cfs/cfs_client.py +156 -39
- tccli/services/cfw/cfw_client.py +264 -66
- tccli/services/chdfs/chdfs_client.py +116 -29
- tccli/services/ciam/ciam_client.py +64 -16
- tccli/services/ckafka/ckafka_client.py +575 -77
- tccli/services/ckafka/v20190819/api.json +2749 -1470
- tccli/services/ckafka/v20190819/examples.json +209 -155
- tccli/services/clb/clb_client.py +332 -83
- tccli/services/clb/v20180317/api.json +29 -14
- tccli/services/cloudaudit/cloudaudit_client.py +72 -18
- tccli/services/cls/cls_client.py +348 -87
- tccli/services/cmq/cmq_client.py +12 -801
- tccli/services/cmq/v20190304/api.json +173 -1367
- tccli/services/cmq/v20190304/examples.json +0 -120
- tccli/services/config/config_client.py +24 -6
- tccli/services/controlcenter/controlcenter_client.py +4 -1
- tccli/services/csip/csip_client.py +136 -34
- tccli/services/ctsdb/ctsdb_client.py +8 -2
- tccli/services/cvm/cvm_client.py +627 -110
- tccli/services/cvm/v20170312/api.json +435 -81
- tccli/services/cvm/v20170312/examples.json +100 -54
- tccli/services/cwp/cwp_client.py +1860 -465
- tccli/services/cynosdb/cynosdb_client.py +1749 -439
- tccli/services/cynosdb/v20190107/api.json +11763 -7697
- tccli/services/cynosdb/v20190107/examples.json +132 -4
- tccli/services/dataintegration/dataintegration_client.py +4 -1
- tccli/services/dayu/dayu_client.py +412 -103
- tccli/services/dbbrain/dbbrain_client.py +168 -42
- tccli/services/dc/dc_client.py +72 -18
- tccli/services/dcdb/dcdb_client.py +248 -62
- tccli/services/dlc/dlc_client.py +756 -111
- tccli/services/dlc/v20210125/api.json +637 -13
- tccli/services/dlc/v20210125/examples.json +48 -0
- tccli/services/dms/dms_client.py +8 -2
- tccli/services/dnspod/dnspod_client.py +264 -38
- tccli/services/dnspod/v20210323/api.json +153 -0
- tccli/services/dnspod/v20210323/examples.json +16 -0
- tccli/services/domain/domain_client.py +96 -24
- tccli/services/dts/dts_client.py +332 -83
- tccli/services/eb/eb_client.py +104 -26
- tccli/services/ecdn/ecdn_client.py +60 -15
- tccli/services/ecm/ecm_client.py +496 -124
- tccli/services/eiam/eiam_client.py +160 -40
- tccli/services/emr/emr_client.py +2784 -115
- tccli/services/emr/v20190103/api.json +14527 -4841
- tccli/services/emr/v20190103/examples.json +404 -36
- tccli/services/es/es_client.py +84 -21
- tccli/services/facefusion/facefusion_client.py +12 -3
- tccli/services/faceid/faceid_client.py +76 -19
- tccli/services/faceid/v20180301/api.json +79 -14
- tccli/services/faceid/v20180301/examples.json +3 -3
- tccli/services/gaap/gaap_client.py +352 -88
- tccli/services/gme/gme_client.py +40 -10
- tccli/services/gpm/gpm_client.py +72 -18
- tccli/services/gse/gse_client.py +88 -22
- tccli/services/gwlb/gwlb_client.py +72 -18
- tccli/services/iai/iai_client.py +116 -29
- tccli/services/iap/iap_client.py +24 -6
- tccli/services/ims/ims_client.py +4 -1
- tccli/services/intlpartnersmgt/intlpartnersmgt_client.py +168 -42
- tccli/services/iotcloud/iotcloud_client.py +80 -20
- tccli/services/ip/ip_client.py +24 -6
- tccli/services/kms/kms_client.py +272 -68
- tccli/services/lcic/lcic_client.py +212 -53
- tccli/services/lighthouse/lighthouse_client.py +296 -74
- tccli/services/lighthouse/v20200324/api.json +14 -14
- tccli/services/lighthouse/v20200324/examples.json +5 -5
- tccli/services/live/live_client.py +480 -120
- tccli/services/lke/lke_client.py +360 -90
- tccli/services/lkeap/__init__.py +4 -0
- tccli/services/lkeap/lkeap_client.py +546 -0
- tccli/services/lkeap/v20240522/api.json +855 -0
- tccli/services/lkeap/v20240522/examples.json +72 -0
- tccli/services/mariadb/mariadb_client.py +200 -50
- tccli/services/mdc/mdc_client.py +72 -18
- tccli/services/mdl/mdl_client.py +132 -33
- tccli/services/mdl/v20200326/api.json +186 -12
- tccli/services/mdl/v20200326/examples.json +16 -16
- tccli/services/mdp/mdp_client.py +356 -64
- tccli/services/mdp/v20200527/api.json +146 -14
- tccli/services/mdp/v20200527/examples.json +95 -79
- tccli/services/message/__init__.py +4 -0
- tccli/services/message/message_client.py +210 -0
- tccli/services/message/v20181225/api.json +72 -0
- tccli/services/message/v20181225/examples.json +13 -0
- tccli/services/mongodb/mongodb_client.py +340 -29
- tccli/services/mongodb/v20190725/api.json +811 -226
- tccli/services/mongodb/v20190725/examples.json +54 -22
- tccli/services/monitor/monitor_client.py +864 -152
- tccli/services/monitor/v20180724/api.json +657 -8
- tccli/services/monitor/v20180724/examples.json +152 -4
- tccli/services/mps/mps_client.py +592 -92
- tccli/services/mps/v20190612/api.json +2719 -375
- tccli/services/mps/v20190612/examples.json +63 -13
- tccli/services/msp/msp_client.py +28 -7
- tccli/services/ocr/ocr_client.py +152 -38
- tccli/services/ocr/v20181119/api.json +15 -15
- tccli/services/ocr/v20181119/examples.json +4 -4
- tccli/services/omics/omics_client.py +80 -20
- tccli/services/organization/organization_client.py +464 -116
- tccli/services/postgres/postgres_client.py +364 -91
- tccli/services/privatedns/privatedns_client.py +124 -31
- tccli/services/pts/pts_client.py +192 -48
- tccli/services/quota/__init__.py +4 -0
- tccli/services/quota/quota_client.py +434 -0
- tccli/services/quota/v20241204/api.json +548 -0
- tccli/services/quota/v20241204/examples.json +51 -0
- tccli/services/rce/rce_client.py +4 -1
- tccli/services/redis/redis_client.py +436 -109
- tccli/services/redis/v20180412/api.json +225 -113
- tccli/services/redis/v20180412/examples.json +19 -19
- tccli/services/region/region_client.py +12 -3
- tccli/services/rum/rum_client.py +240 -60
- tccli/services/scf/scf_client.py +168 -42
- tccli/services/ses/ses_client.py +116 -29
- tccli/services/sms/sms_client.py +72 -18
- tccli/services/sqlserver/sqlserver_client.py +3674 -395
- tccli/services/sqlserver/v20180328/api.json +8909 -2941
- tccli/services/sqlserver/v20180328/examples.json +447 -3
- tccli/services/ssl/ssl_client.py +152 -38
- tccli/services/ssm/ssm_client.py +96 -24
- tccli/services/sts/sts_client.py +20 -5
- tccli/services/tag/tag_client.py +120 -30
- tccli/services/tat/tat_client.py +76 -19
- tccli/services/tbaas/tbaas_client.py +16 -4
- tccli/services/tcaplusdb/tcaplusdb_client.py +208 -52
- tccli/services/tcaplusdb/v20190823/api.json +836 -760
- tccli/services/tcaplusdb/v20190823/examples.json +3 -3
- tccli/services/tchd/tchd_client.py +4 -1
- tccli/services/tcmpp/tcmpp_client.py +416 -104
- tccli/services/tcr/tcr_client.py +304 -76
- tccli/services/tcsas/tcsas_client.py +236 -59
- tccli/services/tcsas/v20250106/api.json +155 -79
- tccli/services/tcsas/v20250106/examples.json +3 -3
- tccli/services/tcss/tcss_client.py +1320 -330
- tccli/services/tdid/tdid_client.py +192 -48
- tccli/services/tdmq/tdmq_client.py +376 -94
- tccli/services/tem/tem_client.py +224 -56
- tccli/services/teo/teo_client.py +1127 -245
- tccli/services/teo/v20220901/api.json +381 -57
- tccli/services/teo/v20220901/examples.json +24 -0
- tccli/services/tione/__init__.py +4 -0
- tccli/services/tione/tione_client.py +210 -0
- tccli/services/tione/v20211111/api.json +3074 -0
- tccli/services/tione/v20211111/examples.json +12 -0
- tccli/services/tiw/tiw_client.py +204 -51
- tccli/services/tke/tke_client.py +552 -138
- tccli/services/tms/tms_client.py +4 -1
- tccli/services/tmt/tmt_client.py +4 -1
- tccli/services/trabbit/trabbit_client.py +116 -29
- tccli/services/trro/trro_client.py +76 -19
- tccli/services/trtc/trtc_client.py +204 -51
- tccli/services/trtc/v20190722/api.json +120 -16
- tccli/services/trtc/v20190722/examples.json +7 -7
- tccli/services/tts/tts_client.py +4 -1
- tccli/services/vclm/vclm_client.py +8 -2
- tccli/services/vm/vm_client.py +16 -4
- tccli/services/vod/vod_client.py +716 -179
- tccli/services/vpc/v20170312/api.json +970 -75
- tccli/services/vpc/v20170312/examples.json +106 -10
- tccli/services/vpc/vpc_client.py +1876 -361
- tccli/services/waf/v20180125/api.json +1372 -194
- tccli/services/waf/v20180125/examples.json +89 -1
- tccli/services/waf/waf_client.py +1051 -147
- tccli/services/wedata/v20250806/api.json +13644 -0
- tccli/services/wedata/v20250806/examples.json +621 -0
- tccli/services/wedata/wedata_client.py +5830 -1026
- tccli/services/yunjing/yunjing_client.py +284 -71
- {tccli_intl_en-3.0.1248.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/METADATA +4 -7
- {tccli_intl_en-3.0.1248.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/RECORD +207 -185
- {tccli_intl_en-3.0.1248.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/WHEEL +1 -1
- {tccli_intl_en-3.0.1248.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/entry_points.txt +0 -1
- {tccli_intl_en-3.0.1248.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/LICENSE +0 -0
- {tccli_intl_en-3.0.1248.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/top_level.txt +0 -0
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"actions": {
|
|
3
3
|
"AllocateHosts": {
|
|
4
|
-
"document": "This API is used to create CDH instances with specified configuration
|
|
4
|
+
"document": "This API is used to create CDH instances with specified configuration.",
|
|
5
5
|
"input": "AllocateHostsRequest",
|
|
6
6
|
"name": "Creates CDH instances",
|
|
7
7
|
"output": "AllocateHostsResponse",
|
|
@@ -343,6 +343,20 @@
|
|
|
343
343
|
"output": "InquirePricePurchaseReservedInstancesOfferingResponse",
|
|
344
344
|
"status": "online"
|
|
345
345
|
},
|
|
346
|
+
"InquiryPriceModifyInstancesChargeType": {
|
|
347
|
+
"document": "This API is used to inquire about the price for switching billing modes of instance.\n\n\nThis API is used to indicate that instances with no charge when shut down, instances of the model families Batch Computing BC1 and Batch Computing BS1, instances of scheduled termination, and spot instances do not support this operation.",
|
|
348
|
+
"input": "InquiryPriceModifyInstancesChargeTypeRequest",
|
|
349
|
+
"name": "Modify the instance billing mode price inquiry",
|
|
350
|
+
"output": "InquiryPriceModifyInstancesChargeTypeResponse",
|
|
351
|
+
"status": "online"
|
|
352
|
+
},
|
|
353
|
+
"InquiryPriceRenewInstances": {
|
|
354
|
+
"document": "This API is used to inquire about the price for renewing a monthly subscription instance.\n\nThis API is used to query the renewal price of monthly subscription instances.",
|
|
355
|
+
"input": "InquiryPriceRenewInstancesRequest",
|
|
356
|
+
"name": "Renewal instance inquiry",
|
|
357
|
+
"output": "InquiryPriceRenewInstancesResponse",
|
|
358
|
+
"status": "online"
|
|
359
|
+
},
|
|
346
360
|
"InquiryPriceResetInstance": {
|
|
347
361
|
"document": "This API is used to inquire about the price for reinstalling an instance.\n\n* If you have specified the parameter `ImageId`, inquire about the price for reinstallation by using the specified image. Otherwise, inquire about the price for reinstallation based on the image currently used by the instance.\n* Currently, only instances with a [system disk type](https://intl.cloud.tencent.com/document/api/213/15753?from_cn_redirect=1#SystemDisk) of `CLOUD_BSSD`, `CLOUD_PREMIUM`, or `CLOUD_SSD` are supported for inquiring about the price for reinstallation caused by switching between `Linux` and `Windows` operating systems through this API.\n* Currently, instances in regions outside the Chinese mainland are not supported for inquiring about the price for reinstallation caused by switching between `Linux` and `Windows` operating systems through this API.",
|
|
348
362
|
"input": "InquiryPriceResetInstanceRequest",
|
|
@@ -414,12 +428,26 @@
|
|
|
414
428
|
"status": "online"
|
|
415
429
|
},
|
|
416
430
|
"ModifyInstancesAttribute": {
|
|
417
|
-
"document": "
|
|
431
|
+
"document": "This API is used to modify instance attributes.\n\nThis API is used to modify one attribute of the instance per request. The attribute must be specified.\nThe instance name is only for user convenience in management. Tencent Cloud does not use this name as the basis for online support or to perform instance management operations.\nThis API is used to support batch operations. The maximum of 100 batch instances per request is supported.\nThis API is used to modify the security group association. The originally associated security group of the instance will be unbound.\n* You can query the result of the instance operation by calling the API [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5). If the latest operation status (LatestOperationState) of the instance is **SUCCESS**, the operation is successful.\nThis API is used to modify the hostname. The instance restarts immediately after hostname modification, and the new hostname takes effect after restart.",
|
|
418
432
|
"input": "ModifyInstancesAttributeRequest",
|
|
419
433
|
"name": "Modifies instance attributes",
|
|
420
434
|
"output": "ModifyInstancesAttributeResponse",
|
|
421
435
|
"status": "online"
|
|
422
436
|
},
|
|
437
|
+
"ModifyInstancesChargeType": {
|
|
438
|
+
"document": "This API is used to switch the billing mode of an instance.\n\nThis API is used to perform operations that do not support instances with no charge when shut down, instances of the model families Batch Compute BC1 and Batch Compute BS1, or instances of scheduled termination.\n* You can query the result of the instance operation by calling the API [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5). If the latest operation status (LatestOperationState) of the instance is **SUCCESS**, the operation is successful.",
|
|
439
|
+
"input": "ModifyInstancesChargeTypeRequest",
|
|
440
|
+
"name": "Modify the instance billing mode",
|
|
441
|
+
"output": "ModifyInstancesChargeTypeResponse",
|
|
442
|
+
"status": "online"
|
|
443
|
+
},
|
|
444
|
+
"ModifyInstancesDisasterRecoverGroup": {
|
|
445
|
+
"document": "This API is used to adjust the placement group of an instance.\n* Currently only basic networks or Virtual Private Cloud (VPC) instances are supported.",
|
|
446
|
+
"input": "ModifyInstancesDisasterRecoverGroupRequest",
|
|
447
|
+
"name": "Adjust the distributed placement group of an instance",
|
|
448
|
+
"output": "ModifyInstancesDisasterRecoverGroupResponse",
|
|
449
|
+
"status": "online"
|
|
450
|
+
},
|
|
423
451
|
"ModifyInstancesProject": {
|
|
424
452
|
"document": "This API is used to change the project to which an instance is assigned.\n\n* Project is a virtual concept. You can create multiple projects under one account, manage different resources in each project, and assign different instances to different projects. You may use the [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1) API to query instances and use the project ID to filter the results.\n* You cannot modify the project of an instance that is bound to a load balancer. You need to unbind the load balancer from the instance by using the [DeregisterInstancesFromLoadBalancer](https://intl.cloud.tencent.com/document/api/214/1258?from_cn_redirect=1) API before using this API.\n* Batch operations are supported. Up to 100 instances per request is allowed.\n* You can use the API [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) to query the operation result. If the `LatestOperationState` in the response is `SUCCESS`, the operation is successful.",
|
|
425
453
|
"input": "ModifyInstancesProjectRequest",
|
|
@@ -483,6 +511,13 @@
|
|
|
483
511
|
"output": "RemoveChcDeployVpcResponse",
|
|
484
512
|
"status": "online"
|
|
485
513
|
},
|
|
514
|
+
"RenewInstances": {
|
|
515
|
+
"document": "This API is used to renew annual and monthly subscription instances.\n\nThis API is used to operate on monthly subscription instances only.\nThis API is used to ensure your account balance is sufficient for renewal. You can check the balance via the DescribeAccountBalance API (https://www.tencentcloud.comom/document/product/555/20253?from_cn_redirect=1).\n* You can query the result of the instance operation by calling the API [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5). If the latest operation status (LatestOperationState) of the instance is **SUCCESS**, the operation is successful.",
|
|
516
|
+
"input": "RenewInstancesRequest",
|
|
517
|
+
"name": "Renew an instance",
|
|
518
|
+
"output": "RenewInstancesResponse",
|
|
519
|
+
"status": "online"
|
|
520
|
+
},
|
|
486
521
|
"ResetInstance": {
|
|
487
522
|
"document": "This API (ResetInstance) is used to reinstall the operating system on a specified instance.\n\n\n\n* If you have specified the parameter `ImageId`, use the specified image for reinstallation. Otherwise, perform reinstallation based on the image currently used by the instance.\n* The system disk will be formatted and reset. Ensure that there are no important files in the system disk.\n* If you do not specify a password, a random password will be sent via Message Center.\n* Currently, only instances with a [system disk type](https://intl.cloud.tencent.com/document/api/213/9452?from_cn_redirect=1#SystemDisk) of `CLOUD_BASIC`, `CLOUD_PREMIUM`, `CLOUD_SSD`, or `CLOUD_BSSD` are supported for implementing operating system switching through this API.\n* You can query the result of the instance operation by calling the API [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5). If the latest operation status (LatestOperationState) of the instance is **SUCCESS**, the operation is successful.",
|
|
488
523
|
"input": "ResetInstanceRequest",
|
|
@@ -655,7 +690,7 @@
|
|
|
655
690
|
},
|
|
656
691
|
{
|
|
657
692
|
"disabled": false,
|
|
658
|
-
"document": "Configuration of prepaid instances. You can use the parameter to specify the attributes of prepaid instances, such as the subscription period and the auto-renewal plan. This parameter is required for prepaid instances.",
|
|
693
|
+
"document": "Not supported. Configuration of prepaid instances. You can use the parameter to specify the attributes of prepaid instances, such as the subscription period and the auto-renewal plan. This parameter is required for prepaid instances.",
|
|
659
694
|
"example": "无",
|
|
660
695
|
"member": "ChargePrepaid",
|
|
661
696
|
"name": "HostChargePrepaid",
|
|
@@ -664,7 +699,7 @@
|
|
|
664
699
|
},
|
|
665
700
|
{
|
|
666
701
|
"disabled": false,
|
|
667
|
-
"document": "Instance billing
|
|
702
|
+
"document": "Instance [billing type](https://intl.cloud.tencent.com/document/product/213/2180?from_cn_redirect=1). <br><li>`POSTPAID_BY_HOUR`: Hourly-based pay-as-you-go <br>",
|
|
668
703
|
"example": "PREPAID",
|
|
669
704
|
"member": "string",
|
|
670
705
|
"name": "HostChargeType",
|
|
@@ -2280,7 +2315,7 @@
|
|
|
2280
2315
|
},
|
|
2281
2316
|
{
|
|
2282
2317
|
"disabled": false,
|
|
2283
|
-
"document": "
|
|
2318
|
+
"document": "Specifies the data disk type. for restrictions on data disk types, refer to [storage overview](https://www.tencentcloud.com/document/product/213/4952?from_cn_redirect=1). valid values: <br /><li>LOCAL_BASIC: LOCAL disk</li> <li>LOCAL_SSD: LOCAL SSD</li><li>LOCAL_NVME: LOCAL NVME disk, which is closely related to InstanceType and cannot be specified</li><li>LOCAL_PRO: LOCAL HDD, which is closely related to InstanceType and cannot be specified</li><li>cloud_BASIC: BASIC cloud disk</li><li>cloud_PREMIUM: high-performance cloud block storage</li><li>cloud_SSD: SSD cloud disk</li><li>cloud_HSSD: enhanced SSD cloud disk</li> <li>cloud_TSSD: ultra-fast SSD cbs</li><li>cloud_BSSD: universal SSD cloud disk</li><br />default: LOCAL_BASIC.<br/><br />this parameter is invalid for the `ResizeInstanceDisk` api.",
|
|
2284
2319
|
"example": "CLOUD_SSD",
|
|
2285
2320
|
"member": "string",
|
|
2286
2321
|
"name": "DiskType",
|
|
@@ -2335,7 +2370,7 @@
|
|
|
2335
2370
|
},
|
|
2336
2371
|
{
|
|
2337
2372
|
"disabled": false,
|
|
2338
|
-
"document": "Custom CMK
|
|
2373
|
+
"document": "Custom CMK ID, value is UUID or similar to kms-abcd1234. used for encrypted cloud disk.\n\nThis parameter is currently only used for the `RunInstances` api.\nNote: This field may return null, indicating that no valid value is found.",
|
|
2339
2374
|
"example": "kms-abcd1234",
|
|
2340
2375
|
"member": "string",
|
|
2341
2376
|
"name": "KmsKeyId",
|
|
@@ -2346,7 +2381,7 @@
|
|
|
2346
2381
|
},
|
|
2347
2382
|
{
|
|
2348
2383
|
"disabled": false,
|
|
2349
|
-
"document": "
|
|
2384
|
+
"document": "Cloud disk performance (unit: MiB/s). specifies additional performance for cloud disks.\nCurrently only supports extreme cbs (CLOUD_TSSD) and enhanced SSD CLOUD disk (CLOUD_HSSD).\nNote: This field may return null, indicating that no valid value is found.",
|
|
2350
2385
|
"example": "20",
|
|
2351
2386
|
"member": "int64",
|
|
2352
2387
|
"name": "ThroughputPerformance",
|
|
@@ -2357,7 +2392,7 @@
|
|
|
2357
2392
|
},
|
|
2358
2393
|
{
|
|
2359
2394
|
"disabled": false,
|
|
2360
|
-
"document": "Specifies the
|
|
2395
|
+
"document": "Specifies the dedicated cluster ID belonging to.\nNote: This field may return null, indicating that no valid value is found.",
|
|
2361
2396
|
"example": "cdc-1648zauv",
|
|
2362
2397
|
"member": "string",
|
|
2363
2398
|
"name": "CdcId",
|
|
@@ -2368,7 +2403,7 @@
|
|
|
2368
2403
|
},
|
|
2369
2404
|
{
|
|
2370
2405
|
"disabled": false,
|
|
2371
|
-
"document": "
|
|
2406
|
+
"document": "Burstable performance.\n\n<B>Note: this field is in beta test.</b>.",
|
|
2372
2407
|
"example": "false",
|
|
2373
2408
|
"member": "bool",
|
|
2374
2409
|
"name": "BurstPerformance",
|
|
@@ -3104,9 +3139,10 @@
|
|
|
3104
3139
|
{
|
|
3105
3140
|
"disabled": false,
|
|
3106
3141
|
"document": "List of instance model families",
|
|
3107
|
-
"example": "",
|
|
3142
|
+
"example": "无",
|
|
3108
3143
|
"member": "InstanceFamilyConfig",
|
|
3109
3144
|
"name": "InstanceFamilyConfigSet",
|
|
3145
|
+
"output_required": true,
|
|
3110
3146
|
"type": "list",
|
|
3111
3147
|
"value_allowed_null": false
|
|
3112
3148
|
},
|
|
@@ -3195,7 +3231,7 @@
|
|
|
3195
3231
|
{
|
|
3196
3232
|
"disabled": false,
|
|
3197
3233
|
"document": "The maximum number of times you can modify the instance configurations (degrading the configurations)",
|
|
3198
|
-
"example": "
|
|
3234
|
+
"example": "无",
|
|
3199
3235
|
"member": "OperationCountLimit",
|
|
3200
3236
|
"name": "InstanceOperationLimitSet",
|
|
3201
3237
|
"output_required": true,
|
|
@@ -4151,7 +4187,7 @@
|
|
|
4151
4187
|
{
|
|
4152
4188
|
"disabled": false,
|
|
4153
4189
|
"document": "Instance ID Needs to Enter Rescue Mode",
|
|
4154
|
-
"example": "
|
|
4190
|
+
"example": "ins-abcdefg",
|
|
4155
4191
|
"member": "string",
|
|
4156
4192
|
"name": "InstanceId",
|
|
4157
4193
|
"required": true,
|
|
@@ -4160,7 +4196,7 @@
|
|
|
4160
4196
|
{
|
|
4161
4197
|
"disabled": false,
|
|
4162
4198
|
"document": "System Password in Rescue Mode",
|
|
4163
|
-
"example": "
|
|
4199
|
+
"example": "hello123456789",
|
|
4164
4200
|
"member": "string",
|
|
4165
4201
|
"name": "Password",
|
|
4166
4202
|
"required": true,
|
|
@@ -4169,20 +4205,29 @@
|
|
|
4169
4205
|
{
|
|
4170
4206
|
"disabled": false,
|
|
4171
4207
|
"document": "System Username in Rescue Mode",
|
|
4172
|
-
"example": "
|
|
4208
|
+
"example": "root",
|
|
4173
4209
|
"member": "string",
|
|
4174
4210
|
"name": "Username",
|
|
4175
4211
|
"required": false,
|
|
4176
4212
|
"type": "string"
|
|
4177
4213
|
},
|
|
4178
4214
|
{
|
|
4179
|
-
"disabled":
|
|
4215
|
+
"disabled": true,
|
|
4180
4216
|
"document": "Whether to perform forced shutdown.",
|
|
4181
|
-
"example": "
|
|
4217
|
+
"example": "false",
|
|
4182
4218
|
"member": "bool",
|
|
4183
4219
|
"name": "ForceStop",
|
|
4184
4220
|
"required": false,
|
|
4185
4221
|
"type": "bool"
|
|
4222
|
+
},
|
|
4223
|
+
{
|
|
4224
|
+
"disabled": false,
|
|
4225
|
+
"document": "",
|
|
4226
|
+
"example": "HARD",
|
|
4227
|
+
"member": "string",
|
|
4228
|
+
"name": "StopType",
|
|
4229
|
+
"required": false,
|
|
4230
|
+
"type": "string"
|
|
4186
4231
|
}
|
|
4187
4232
|
],
|
|
4188
4233
|
"type": "object"
|
|
@@ -4205,7 +4250,7 @@
|
|
|
4205
4250
|
{
|
|
4206
4251
|
"disabled": false,
|
|
4207
4252
|
"document": "Instance ID Exiting Rescue Mode",
|
|
4208
|
-
"example": "
|
|
4253
|
+
"example": "ins-axzc12s",
|
|
4209
4254
|
"member": "string",
|
|
4210
4255
|
"name": "InstanceId",
|
|
4211
4256
|
"required": true,
|
|
@@ -4395,7 +4440,7 @@
|
|
|
4395
4440
|
"members": [
|
|
4396
4441
|
{
|
|
4397
4442
|
"disabled": false,
|
|
4398
|
-
"document": "
|
|
4443
|
+
"document": "Specifies the GPU count of the instance. a value less than 1 indicates VGPU type, and a value larger than 1 indicates GPU passthrough type.",
|
|
4399
4444
|
"example": "1",
|
|
4400
4445
|
"member": "float",
|
|
4401
4446
|
"name": "GPUCount",
|
|
@@ -4405,7 +4450,7 @@
|
|
|
4405
4450
|
},
|
|
4406
4451
|
{
|
|
4407
4452
|
"disabled": false,
|
|
4408
|
-
"document": "GPU address
|
|
4453
|
+
"document": "Specifies the GPU address of the instance.",
|
|
4409
4454
|
"example": "['0000:18:00.0','0000:18:00.1']",
|
|
4410
4455
|
"member": "string",
|
|
4411
4456
|
"name": "GPUId",
|
|
@@ -4415,7 +4460,7 @@
|
|
|
4415
4460
|
},
|
|
4416
4461
|
{
|
|
4417
4462
|
"disabled": false,
|
|
4418
|
-
"document": "GPU type of the instance
|
|
4463
|
+
"document": "Specifies the GPU type of the instance.",
|
|
4419
4464
|
"example": "NVIDIA T4",
|
|
4420
4465
|
"member": "string",
|
|
4421
4466
|
"name": "GPUType",
|
|
@@ -5143,6 +5188,134 @@
|
|
|
5143
5188
|
],
|
|
5144
5189
|
"type": "object"
|
|
5145
5190
|
},
|
|
5191
|
+
"InquiryPriceModifyInstancesChargeTypeRequest": {
|
|
5192
|
+
"document": "InquiryPriceModifyInstancesChargeType request structure.",
|
|
5193
|
+
"members": [
|
|
5194
|
+
{
|
|
5195
|
+
"disabled": false,
|
|
5196
|
+
"document": "One or more instance IDs to be operated. You can obtain the instance ID through the `InstanceId` in the return value from the API [DescribeInstances](https://www.tencentcloud.com/document/api/213/15728?from_cn_redirect=1). The maximum number of instances per request is 100.",
|
|
5197
|
+
"example": "[\"ins-r8hr2upy\"]",
|
|
5198
|
+
"member": "string",
|
|
5199
|
+
"name": "InstanceIds",
|
|
5200
|
+
"required": true,
|
|
5201
|
+
"type": "list"
|
|
5202
|
+
},
|
|
5203
|
+
{
|
|
5204
|
+
"disabled": false,
|
|
5205
|
+
"document": "Modified instance [billing type](https://www.tencentcloud.com/document/product/213/2180?from_cn_redirect=1). <br><li>`PREPAID`: monthly subscription.</li>\n\n**Note:** Only supports converting pay-as-you-go instances to annual and monthly subscription instances.\n\ndefault value: `PREPAID`",
|
|
5206
|
+
"example": "PREPAID",
|
|
5207
|
+
"member": "string",
|
|
5208
|
+
"name": "InstanceChargeType",
|
|
5209
|
+
"required": true,
|
|
5210
|
+
"type": "string"
|
|
5211
|
+
},
|
|
5212
|
+
{
|
|
5213
|
+
"disabled": false,
|
|
5214
|
+
"document": "Prepaid mode, parameter settings related to monthly/annual subscription. through this parameter, specify the purchase duration of annual and monthly subscription instances, whether to enable auto-renewal, and other attributes. ",
|
|
5215
|
+
"example": "无",
|
|
5216
|
+
"member": "InstanceChargePrepaid",
|
|
5217
|
+
"name": "InstanceChargePrepaid",
|
|
5218
|
+
"required": false,
|
|
5219
|
+
"type": "object"
|
|
5220
|
+
},
|
|
5221
|
+
{
|
|
5222
|
+
"disabled": false,
|
|
5223
|
+
"document": "Whether to switch the billing mode of elastic data cloud disks simultaneously. valid values: <br><li>true: means switching the billing mode of elastic data cloud disks</li><li>false: means not switching the billing mode of elastic data cloud disks</li><br>default value: false.",
|
|
5224
|
+
"example": "false",
|
|
5225
|
+
"member": "bool",
|
|
5226
|
+
"name": "ModifyPortableDataDisk",
|
|
5227
|
+
"required": false,
|
|
5228
|
+
"type": "bool"
|
|
5229
|
+
}
|
|
5230
|
+
],
|
|
5231
|
+
"type": "object"
|
|
5232
|
+
},
|
|
5233
|
+
"InquiryPriceModifyInstancesChargeTypeResponse": {
|
|
5234
|
+
"document": "InquiryPriceModifyInstancesChargeType response structure.",
|
|
5235
|
+
"members": [
|
|
5236
|
+
{
|
|
5237
|
+
"disabled": false,
|
|
5238
|
+
"document": "This parameter indicates the price for switching the billing mode of the corresponding configuration instance.",
|
|
5239
|
+
"example": "无",
|
|
5240
|
+
"member": "Price",
|
|
5241
|
+
"name": "Price",
|
|
5242
|
+
"output_required": true,
|
|
5243
|
+
"type": "object",
|
|
5244
|
+
"value_allowed_null": false
|
|
5245
|
+
},
|
|
5246
|
+
{
|
|
5247
|
+
"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.",
|
|
5248
|
+
"member": "string",
|
|
5249
|
+
"name": "RequestId",
|
|
5250
|
+
"type": "string"
|
|
5251
|
+
}
|
|
5252
|
+
],
|
|
5253
|
+
"type": "object"
|
|
5254
|
+
},
|
|
5255
|
+
"InquiryPriceRenewInstancesRequest": {
|
|
5256
|
+
"document": "InquiryPriceRenewInstances request structure.",
|
|
5257
|
+
"members": [
|
|
5258
|
+
{
|
|
5259
|
+
"disabled": false,
|
|
5260
|
+
"document": "One or more instance IDs to be operated. You can obtain the instance ID through the `InstanceId` in the return value from the API [DescribeInstances](https://www.tencentcloud.comom/document/api/213/15728?from_cn_redirect=1). The maximum number of instances per request is 100.",
|
|
5261
|
+
"example": "[\"ins-2zvpghhc\"]",
|
|
5262
|
+
"member": "string",
|
|
5263
|
+
"name": "InstanceIds",
|
|
5264
|
+
"required": true,
|
|
5265
|
+
"type": "list"
|
|
5266
|
+
},
|
|
5267
|
+
{
|
|
5268
|
+
"disabled": false,
|
|
5269
|
+
"document": "Prepaid mode, that is, monthly subscription-related parameter settings. You can specify attributes of a monthly subscription instance, such as purchase duration and whether to set auto-renewal, through this parameter.",
|
|
5270
|
+
"example": "无",
|
|
5271
|
+
"member": "InstanceChargePrepaid",
|
|
5272
|
+
"name": "InstanceChargePrepaid",
|
|
5273
|
+
"required": true,
|
|
5274
|
+
"type": "object"
|
|
5275
|
+
},
|
|
5276
|
+
{
|
|
5277
|
+
"disabled": false,
|
|
5278
|
+
"document": "Trial run, for testing purposes, does not execute specific logic. valid values: <li>`true`: skip execution logic</li> <li>`false`: execute logic</li> default value: `false`.",
|
|
5279
|
+
"example": "false",
|
|
5280
|
+
"member": "bool",
|
|
5281
|
+
"name": "DryRun",
|
|
5282
|
+
"required": false,
|
|
5283
|
+
"type": "bool"
|
|
5284
|
+
},
|
|
5285
|
+
{
|
|
5286
|
+
"disabled": false,
|
|
5287
|
+
"document": "Whether to renew the elastic data disk. valid values:<br><li>true: indicates renewing the annual and monthly subscription instance and its mounted elastic data disk simultaneously</li><li>false: indicates renewing the annual and monthly subscription instance while no longer renewing its mounted elastic data disk</li><br>default value: true.",
|
|
5288
|
+
"example": "false",
|
|
5289
|
+
"member": "bool",
|
|
5290
|
+
"name": "RenewPortableDataDisk",
|
|
5291
|
+
"required": false,
|
|
5292
|
+
"type": "bool"
|
|
5293
|
+
}
|
|
5294
|
+
],
|
|
5295
|
+
"type": "object"
|
|
5296
|
+
},
|
|
5297
|
+
"InquiryPriceRenewInstancesResponse": {
|
|
5298
|
+
"document": "InquiryPriceRenewInstances response structure.",
|
|
5299
|
+
"members": [
|
|
5300
|
+
{
|
|
5301
|
+
"disabled": false,
|
|
5302
|
+
"document": "This parameter indicates the price for the corresponding configuration instance.",
|
|
5303
|
+
"example": "无",
|
|
5304
|
+
"member": "Price",
|
|
5305
|
+
"name": "Price",
|
|
5306
|
+
"output_required": true,
|
|
5307
|
+
"type": "object",
|
|
5308
|
+
"value_allowed_null": false
|
|
5309
|
+
},
|
|
5310
|
+
{
|
|
5311
|
+
"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.",
|
|
5312
|
+
"member": "string",
|
|
5313
|
+
"name": "RequestId",
|
|
5314
|
+
"type": "string"
|
|
5315
|
+
}
|
|
5316
|
+
],
|
|
5317
|
+
"type": "object"
|
|
5318
|
+
},
|
|
5146
5319
|
"InquiryPriceResetInstanceRequest": {
|
|
5147
5320
|
"document": "InquiryPriceResetInstance request structure.",
|
|
5148
5321
|
"members": [
|
|
@@ -5190,6 +5363,15 @@
|
|
|
5190
5363
|
"name": "EnhancedService",
|
|
5191
5364
|
"required": false,
|
|
5192
5365
|
"type": "object"
|
|
5366
|
+
},
|
|
5367
|
+
{
|
|
5368
|
+
"disabled": false,
|
|
5369
|
+
"document": "",
|
|
5370
|
+
"example": "TXlVc2VyRGF0YQo",
|
|
5371
|
+
"member": "string",
|
|
5372
|
+
"name": "UserData",
|
|
5373
|
+
"required": false,
|
|
5374
|
+
"type": "string"
|
|
5193
5375
|
}
|
|
5194
5376
|
],
|
|
5195
5377
|
"type": "object"
|
|
@@ -5422,7 +5604,7 @@
|
|
|
5422
5604
|
},
|
|
5423
5605
|
{
|
|
5424
5606
|
"disabled": false,
|
|
5425
|
-
"document": "
|
|
5607
|
+
"document": "Instance model. Different instance models specify different resource specifications.\n<br><li>For instances created with the payment modes PREPAID or POSTPAID_BY_HOUR, specifies the specific values obtained BY calling the [DescribeInstanceTypeConfigs](https://www.tencentcloud.comom/document/api/213/15749?from_cn_redirect=1) api for the latest specification table or referring to [instance specifications](https://www.tencentcloud.comom/document/product/213/11518?from_cn_redirect=1). if not specified, the system will dynamically assign a default model based on the current resource sales situation in a region.</li><br><li>for instances created with the payment mode CDHPAID, indicates this parameter uses the prefix \"CDH_\" and is generated based on CPU and memory configuration. the specific format is: CDH_XCXG. for example, for creating a CDH instance with 1 CPU core and 1 gb memory, this parameter should be CDH_1C1G.</li>.",
|
|
5426
5608
|
"example": "S5.MEDIUM2",
|
|
5427
5609
|
"member": "string",
|
|
5428
5610
|
"name": "InstanceType",
|
|
@@ -5476,7 +5658,7 @@
|
|
|
5476
5658
|
},
|
|
5477
5659
|
{
|
|
5478
5660
|
"disabled": false,
|
|
5479
|
-
"document": "Instance name
|
|
5661
|
+
"document": "Instance display name. <li>if no instance display name is specified, it will display 'unnamed' by default.</li> <li>when purchasing multiple instances, if the pattern string `{R:x}` is specified, it means generating numbers `[x, x+n-1]`, where `n` represents the number of purchased instances. for example, `server_{R:3}`: when purchasing 1 instance, the instance display name is `server_3`; when purchasing 2 instances, the instance display names are `server_3` and `server_4` respectively. supports specifying multiple pattern strings `{R:x}`.</li> <li>when purchasing multiple instances without specifying a pattern string, suffixes `1, 2...n` will be added to the instance display name, where `n` represents the number of purchased instances. for example, `server_`: when purchasing 2 instances, the instance display names are `server_1` and `server_2` respectively.</li> <li>supports up to 128 characters (including pattern strings).</li>.",
|
|
5480
5662
|
"example": "myInstance",
|
|
5481
5663
|
"member": "string",
|
|
5482
5664
|
"name": "InstanceName",
|
|
@@ -5494,7 +5676,7 @@
|
|
|
5494
5676
|
},
|
|
5495
5677
|
{
|
|
5496
5678
|
"disabled": false,
|
|
5497
|
-
"document": "Security
|
|
5679
|
+
"document": "Security group to which an instance belongs. obtain this parameter by calling the `SecurityGroupId` field in the return value of [DescribeSecurityGroups](https://www.tencentcloud.comom/document/api/215/15808?from_cn_redirect=1). if not specified, bind the default security group under the designated project. if the default security group does not exist, automatically create it.\n",
|
|
5498
5680
|
"example": "[\"sg-efil73jd\"]",
|
|
5499
5681
|
"member": "string",
|
|
5500
5682
|
"name": "SecurityGroupIds",
|
|
@@ -5513,7 +5695,7 @@
|
|
|
5513
5695
|
{
|
|
5514
5696
|
"disabled": false,
|
|
5515
5697
|
"document": "A unique string supplied by the client to ensure that the request is idempotent. Its maximum length is 64 ASCII characters. If this parameter is not specified, the idempotency of the request cannot be guaranteed.<br>For more information, see Ensuring Idempotency.",
|
|
5516
|
-
"example": "
|
|
5698
|
+
"example": "a521b4e4-c903-4d37-9de6-8096e3ad8eb7",
|
|
5517
5699
|
"member": "string",
|
|
5518
5700
|
"name": "ClientToken",
|
|
5519
5701
|
"required": false,
|
|
@@ -5546,6 +5728,15 @@
|
|
|
5546
5728
|
"required": false,
|
|
5547
5729
|
"type": "object"
|
|
5548
5730
|
},
|
|
5731
|
+
{
|
|
5732
|
+
"disabled": false,
|
|
5733
|
+
"document": "Custom metadata, supports creating key-value pairs of custom metadata when creating a CVM.\n\n**Note: this field is in beta test.**.",
|
|
5734
|
+
"example": "无",
|
|
5735
|
+
"member": "Metadata",
|
|
5736
|
+
"name": "Metadata",
|
|
5737
|
+
"required": false,
|
|
5738
|
+
"type": "object"
|
|
5739
|
+
},
|
|
5549
5740
|
{
|
|
5550
5741
|
"disabled": false,
|
|
5551
5742
|
"document": "HPC cluster ID.",
|
|
@@ -5643,7 +5834,7 @@
|
|
|
5643
5834
|
},
|
|
5644
5835
|
{
|
|
5645
5836
|
"disabled": false,
|
|
5646
|
-
"document": "
|
|
5837
|
+
"document": "Instance memory capacity. unit: GiB.",
|
|
5647
5838
|
"example": "1",
|
|
5648
5839
|
"member": "int64",
|
|
5649
5840
|
"name": "Memory",
|
|
@@ -5653,7 +5844,7 @@
|
|
|
5653
5844
|
},
|
|
5654
5845
|
{
|
|
5655
5846
|
"disabled": false,
|
|
5656
|
-
"document": "Instance status.
|
|
5847
|
+
"document": "Instance business status. valid values:<br><li>NORMAL: indicates an instance in the NORMAL state</li><li>EXPIRED: indicates an EXPIRED instance</li><li>PROTECTIVELY_ISOLATED: PROTECTIVELY ISOLATED instance</li>.",
|
|
5657
5848
|
"example": "NORMAL",
|
|
5658
5849
|
"member": "string",
|
|
5659
5850
|
"name": "RestrictState",
|
|
@@ -5753,7 +5944,7 @@
|
|
|
5753
5944
|
},
|
|
5754
5945
|
{
|
|
5755
5946
|
"disabled": false,
|
|
5756
|
-
"document": "
|
|
5947
|
+
"document": "AUTO-Renewal flag. valid values:<br><li>`NOTIFY_AND_MANUAL_RENEW`: indicates that a notification of impending expiration is made but AUTO-renewal is not performed</li><li>`NOTIFY_AND_AUTO_RENEW`: indicates that a notification of impending expiration is made AND AUTO-renewal is performed</li><li>`DISABLE_NOTIFY_AND_MANUAL_RENEW`: indicates that notification that it is about to expire is not made AND AUTO-renewal is not performed.\nNote: this field is null in postpaid mode.",
|
|
5757
5948
|
"example": "NOTIFY_AND_MANUAL_RENEW",
|
|
5758
5949
|
"member": "string",
|
|
5759
5950
|
"name": "RenewFlag",
|
|
@@ -5813,7 +6004,7 @@
|
|
|
5813
6004
|
},
|
|
5814
6005
|
{
|
|
5815
6006
|
"disabled": false,
|
|
5816
|
-
"document": "Instance
|
|
6007
|
+
"document": "Instance status. for specific status types, see the [instance status table](https://www.tencentcloud.com/document/product/213/15753#instancestatus)",
|
|
5817
6008
|
"example": "RUNNING",
|
|
5818
6009
|
"member": "string",
|
|
5819
6010
|
"name": "InstanceState",
|
|
@@ -5833,7 +6024,7 @@
|
|
|
5833
6024
|
},
|
|
5834
6025
|
{
|
|
5835
6026
|
"disabled": false,
|
|
5836
|
-
"document": "
|
|
6027
|
+
"document": "Shutdown billing mode of an instance.\n\nValid values: <br><li>KEEP_CHARGING: billing continues after shutdown</li><li>STOP_CHARGING: billing stops after shutdown</li><li>NOT_APPLICABLE: the instance is NOT shut down or stopping billing after shutdown is NOT APPLICABLE to the instance</li>.",
|
|
5837
6028
|
"example": "NOT_APPLICABLE",
|
|
5838
6029
|
"member": "string",
|
|
5839
6030
|
"name": "StopChargingMode",
|
|
@@ -5863,7 +6054,7 @@
|
|
|
5863
6054
|
},
|
|
5864
6055
|
{
|
|
5865
6056
|
"disabled": false,
|
|
5866
|
-
"document": "The latest operation status of the instance.
|
|
6057
|
+
"document": "The latest operation status of the instance. valid values:<br><li>SUCCESS: indicates that the operation succeeded</li><li>OPERATING: indicates that the operation is in progress</li><li>FAILED: indicates that the operation FAILED</li>.\nNote: This field may return null, indicating that no valid value is found.",
|
|
5867
6058
|
"example": "SUCCESS",
|
|
5868
6059
|
"member": "string",
|
|
5869
6060
|
"name": "LatestOperationState",
|
|
@@ -5883,7 +6074,7 @@
|
|
|
5883
6074
|
},
|
|
5884
6075
|
{
|
|
5885
6076
|
"disabled": false,
|
|
5886
|
-
"document": "
|
|
6077
|
+
"document": "Spread placement group ID.",
|
|
5887
6078
|
"example": "ps-l7sdunxx",
|
|
5888
6079
|
"member": "string",
|
|
5889
6080
|
"name": "DisasterRecoverGroupId",
|
|
@@ -5913,7 +6104,7 @@
|
|
|
5913
6104
|
},
|
|
5914
6105
|
{
|
|
5915
6106
|
"disabled": false,
|
|
5916
|
-
"document": "
|
|
6107
|
+
"document": "High-performance computing cluster ID.",
|
|
5917
6108
|
"example": "hpc-4dxxetpt",
|
|
5918
6109
|
"member": "string",
|
|
5919
6110
|
"name": "HpcClusterId",
|
|
@@ -5933,7 +6124,7 @@
|
|
|
5933
6124
|
},
|
|
5934
6125
|
{
|
|
5935
6126
|
"disabled": false,
|
|
5936
|
-
"document": "",
|
|
6127
|
+
"document": "Dedicated cluster ID where the instance is located.",
|
|
5937
6128
|
"example": "cluster-du3jken",
|
|
5938
6129
|
"member": "string",
|
|
5939
6130
|
"name": "DedicatedClusterId",
|
|
@@ -5943,7 +6134,7 @@
|
|
|
5943
6134
|
},
|
|
5944
6135
|
{
|
|
5945
6136
|
"disabled": false,
|
|
5946
|
-
"document": "
|
|
6137
|
+
"document": "Instance isolation type. valid values:<br><li>ARREAR: indicates arrears isolation<br></li><li>EXPIRE: indicates isolation upon expiration<br></li><li>MANMADE: indicates voluntarily refunded isolation<br></li><li>NOTISOLATED: indicates unisolated<br></li>.",
|
|
5947
6138
|
"example": "NOTISOLATED",
|
|
5948
6139
|
"member": "string",
|
|
5949
6140
|
"name": "IsolatedSource",
|
|
@@ -5953,7 +6144,7 @@
|
|
|
5953
6144
|
},
|
|
5954
6145
|
{
|
|
5955
6146
|
"disabled": false,
|
|
5956
|
-
"document": "GPU information.
|
|
6147
|
+
"document": "GPU information. if it is a gpu type instance, this value will be returned. for other type instances, it does not return.",
|
|
5957
6148
|
"example": "无",
|
|
5958
6149
|
"member": "GPUInfo",
|
|
5959
6150
|
"name": "GPUInfo",
|
|
@@ -5973,7 +6164,7 @@
|
|
|
5973
6164
|
},
|
|
5974
6165
|
{
|
|
5975
6166
|
"disabled": false,
|
|
5976
|
-
"document": "
|
|
6167
|
+
"document": "Instance destruction protection flag indicates whether an instance is allowed to be deleted through an api. value ranges from:<br><li>true: indicates that instance protection is enabled, deletion through apis is not allowed</li><li>false: indicates that instance protection is disabled, allow passage</li><br>default value: false.",
|
|
5977
6168
|
"example": "false",
|
|
5978
6169
|
"member": "bool",
|
|
5979
6170
|
"name": "DisableApiTermination",
|
|
@@ -6013,7 +6204,17 @@
|
|
|
6013
6204
|
},
|
|
6014
6205
|
{
|
|
6015
6206
|
"disabled": false,
|
|
6016
|
-
"document": "
|
|
6207
|
+
"document": "Custom metadata. this parameter corresponds to the metadata information specified when creating a CVM. **note: in beta test**.",
|
|
6208
|
+
"example": "无",
|
|
6209
|
+
"member": "Metadata",
|
|
6210
|
+
"name": "Metadata",
|
|
6211
|
+
"output_required": false,
|
|
6212
|
+
"type": "object",
|
|
6213
|
+
"value_allowed_null": false
|
|
6214
|
+
},
|
|
6215
|
+
{
|
|
6216
|
+
"disabled": false,
|
|
6217
|
+
"document": "Specifies the public IPv6 address bound to the instance.",
|
|
6017
6218
|
"example": "[\"240d:c000:f000:ac00:5460:6340:16aa:6\"]",
|
|
6018
6219
|
"member": "string",
|
|
6019
6220
|
"name": "PublicIPv6Addresses",
|
|
@@ -6084,20 +6285,20 @@
|
|
|
6084
6285
|
{
|
|
6085
6286
|
"disabled": false,
|
|
6086
6287
|
"document": "Full name of the model family.",
|
|
6087
|
-
"example": "",
|
|
6288
|
+
"example": "高IO型I1",
|
|
6088
6289
|
"member": "string",
|
|
6089
6290
|
"name": "InstanceFamilyName",
|
|
6090
|
-
"
|
|
6291
|
+
"output_required": true,
|
|
6091
6292
|
"type": "string",
|
|
6092
6293
|
"value_allowed_null": false
|
|
6093
6294
|
},
|
|
6094
6295
|
{
|
|
6095
6296
|
"disabled": false,
|
|
6096
6297
|
"document": "Acronym of the model family.",
|
|
6097
|
-
"example": "",
|
|
6298
|
+
"example": "I1",
|
|
6098
6299
|
"member": "string",
|
|
6099
6300
|
"name": "InstanceFamily",
|
|
6100
|
-
"
|
|
6301
|
+
"output_required": true,
|
|
6101
6302
|
"type": "string",
|
|
6102
6303
|
"value_allowed_null": false
|
|
6103
6304
|
}
|
|
@@ -6138,7 +6339,7 @@
|
|
|
6138
6339
|
{
|
|
6139
6340
|
"disabled": false,
|
|
6140
6341
|
"document": "Instance `ID`.",
|
|
6141
|
-
"example": "
|
|
6342
|
+
"example": "ins-g4c6xxxx",
|
|
6142
6343
|
"member": "string",
|
|
6143
6344
|
"name": "InstanceId",
|
|
6144
6345
|
"output_required": true,
|
|
@@ -6148,7 +6349,7 @@
|
|
|
6148
6349
|
{
|
|
6149
6350
|
"disabled": false,
|
|
6150
6351
|
"document": "Instance status. Valid values:<br><li>PENDING: Creating.<br></li><li>LAUNCH_FAILED: Creation failed.<br></li><li>RUNNING: Running.<br></li><li>STOPPED: Shut down.<br></li><li>STARTING: Starting up.<br></li><li>STOPPING: Shutting down.<br></li><li>REBOOTING: Restarting.<br></li><li>SHUTDOWN: Shut down and to be terminated.<br></li><li>TERMINATING: Terminating.<br></li><li>ENTER_RESCUE_MODE: Entering the rescue mode.<br></li><li>RESCUE_MODE: In the rescue mode.<br></li><li>EXIT_RESCUE_MODE: Exiting the rescue mode.<br></li><li>ENTER_SERVICE_LIVE_MIGRATE: Entering online service migration.<br></li><li>SERVICE_LIVE_MIGRATE: In online service migration.<br></li><li>EXIT_SERVICE_LIVE_MIGRATE: Exiting online service migration.<br></li>",
|
|
6151
|
-
"example": "
|
|
6352
|
+
"example": "RUNNING",
|
|
6152
6353
|
"member": "string",
|
|
6153
6354
|
"name": "InstanceState",
|
|
6154
6355
|
"output_required": true,
|
|
@@ -6443,7 +6644,7 @@
|
|
|
6443
6644
|
},
|
|
6444
6645
|
{
|
|
6445
6646
|
"disabled": false,
|
|
6446
|
-
"document": "
|
|
6647
|
+
"document": "Line type. for details on various types of lines and supported regions, refer to [EIP IP address types](https://cloud.tencent.com/document/product/1199/41646). default value: BGP.\n<Li>BGP: specifies the general bgp line.</li>.\nFor a user with static single-line IP allowlist enabled, valid values include:.\n<Li>CMCC: china mobile.</li>.\n<Li>CTCC: china telecom</li>.\n<Li>CUCC: china unicom</li>.\nNote: The static single-line IP is only supported in some regions.\n\n",
|
|
6447
6648
|
"example": "BGP",
|
|
6448
6649
|
"member": "string",
|
|
6449
6650
|
"name": "InternetServiceProvider",
|
|
@@ -6454,7 +6655,7 @@
|
|
|
6454
6655
|
},
|
|
6455
6656
|
{
|
|
6456
6657
|
"disabled": false,
|
|
6457
|
-
"document": "
|
|
6658
|
+
"document": "Specifies the public IP type.\n\n<Li>WanIP: specifies the public ip address.</li>.\n<Li>HighQualityEIP: specifies a high quality ip. high quality ip is only supported in Singapore and hong kong (china).</li>.\n<li> AntiDDoSEIP: specifies the anti-ddos eip. only partial regions support anti-ddos eip. details visible in the [elastic IP product overview](https://www.tencentcloud.comom/document/product/1199/41646?from_cn_redirect=1).</li>.\nIf needed, assign a public IPv4 address to the resource by specifying the IPv4 address type.\n\nThis feature is in beta test in selected regions. submit a ticket for consultation (https://console.cloud.tencent.com/workorder/category) if needed.",
|
|
6458
6659
|
"example": "WanIP",
|
|
6459
6660
|
"member": "string",
|
|
6460
6661
|
"name": "IPv4AddressType",
|
|
@@ -6465,7 +6666,7 @@
|
|
|
6465
6666
|
},
|
|
6466
6667
|
{
|
|
6467
6668
|
"disabled": false,
|
|
6468
|
-
"document": "Indicates the type of
|
|
6669
|
+
"document": "Indicates the type of elastic public IPv6.\n<Li>EIPv6: elastic ip version 6.</li>.\n<Li>HighQualityEIPv6: specifies the high quality ipv6. highqualityeipv6 is only supported in hong kong (china).</li>.\nIf needed, assign an elastic IPv6 address for resource allocation.\n\nThis feature is in beta test in selected regions. submit a ticket for consultation (https://console.cloud.tencent.com/workorder/category) if needed.",
|
|
6469
6670
|
"example": "EIPv6",
|
|
6470
6671
|
"member": "string",
|
|
6471
6672
|
"name": "IPv6AddressType",
|
|
@@ -6476,7 +6677,7 @@
|
|
|
6476
6677
|
},
|
|
6477
6678
|
{
|
|
6478
6679
|
"disabled": false,
|
|
6479
|
-
"document": "
|
|
6680
|
+
"document": "DDoS protection package unique ID. this field is required when applying for a ddos protection IP.\n",
|
|
6480
6681
|
"example": "bgp-00000000",
|
|
6481
6682
|
"member": "string",
|
|
6482
6683
|
"name": "AntiDDoSPackageId",
|
|
@@ -7345,7 +7546,7 @@
|
|
|
7345
7546
|
"members": [
|
|
7346
7547
|
{
|
|
7347
7548
|
"disabled": false,
|
|
7348
|
-
"document": "Custom metadata key
|
|
7549
|
+
"document": "Custom metadata key, consisting of uppercase letters (A-Z), lowercase letters (A-Z), digits (0-9), underscores (_), or hyphens (-), with a size limit of 128 bytes.",
|
|
7349
7550
|
"example": "\"key\"",
|
|
7350
7551
|
"member": "string",
|
|
7351
7552
|
"name": "Key",
|
|
@@ -7356,7 +7557,7 @@
|
|
|
7356
7557
|
},
|
|
7357
7558
|
{
|
|
7358
7559
|
"disabled": false,
|
|
7359
|
-
"document": "
|
|
7560
|
+
"document": "Custom metadata value. The upper limit of message size is 256 KB.",
|
|
7360
7561
|
"example": "\"value\"",
|
|
7361
7562
|
"member": "string",
|
|
7362
7563
|
"name": "Value",
|
|
@@ -7482,7 +7683,7 @@
|
|
|
7482
7683
|
{
|
|
7483
7684
|
"disabled": false,
|
|
7484
7685
|
"document": "CDH instance ID(s).",
|
|
7485
|
-
"example": "[\"host-ey16rkyg
|
|
7686
|
+
"example": "[\"host-ey16rkyg\"]",
|
|
7486
7687
|
"member": "string",
|
|
7487
7688
|
"name": "HostIds",
|
|
7488
7689
|
"required": true,
|
|
@@ -7652,7 +7853,7 @@
|
|
|
7652
7853
|
},
|
|
7653
7854
|
{
|
|
7654
7855
|
"disabled": false,
|
|
7655
|
-
"document": "
|
|
7856
|
+
"document": "Modified instance name. can be named as required but should not exceed 128 characters.",
|
|
7656
7857
|
"example": "MyInsName",
|
|
7657
7858
|
"member": "string",
|
|
7658
7859
|
"name": "InstanceName",
|
|
@@ -7670,7 +7871,7 @@
|
|
|
7670
7871
|
},
|
|
7671
7872
|
{
|
|
7672
7873
|
"disabled": false,
|
|
7673
|
-
"document": "
|
|
7874
|
+
"document": "Specifies the security group Id list of the specified instance after modification. the instance will reassociate with the security groups in the specified list, and the associated security group will be unbound.",
|
|
7674
7875
|
"example": "[\"sg-rf6ogz49\"]",
|
|
7675
7876
|
"member": "string",
|
|
7676
7877
|
"name": "SecurityGroups",
|
|
@@ -7706,7 +7907,7 @@
|
|
|
7706
7907
|
},
|
|
7707
7908
|
{
|
|
7708
7909
|
"disabled": false,
|
|
7709
|
-
"document": "
|
|
7910
|
+
"document": "Role type, used in conjunction with CamRoleName. this value can be obtained from the RoleType field in the API response of CAM [DescribeRoleList](https://www.tencentcloud.comom/document/product/598/36223?from_cn_redirect=1) or [GetRole](https://www.tencentcloud.comom/document/product/598/36221?from_cn_redirect=1). currently, only user, system, and service_linked types are accepted.\nFor example, when CamRoleName contains \"LinkedRoleIn\" (such as TKE_QCSLinkedRoleInPrometheusService), DescribeRoleList and GetRole return RoleType as service_linked, this parameter must also transmit service_linked.\nThe parameter default value is user. this parameter can be omitted if CameRoleName is not of the service_linked kind.",
|
|
7710
7911
|
"example": "user",
|
|
7711
7912
|
"member": "string",
|
|
7712
7913
|
"name": "CamRoleType",
|
|
@@ -7737,6 +7938,105 @@
|
|
|
7737
7938
|
],
|
|
7738
7939
|
"type": "object"
|
|
7739
7940
|
},
|
|
7941
|
+
"ModifyInstancesChargeTypeRequest": {
|
|
7942
|
+
"document": "ModifyInstancesChargeType request structure.",
|
|
7943
|
+
"members": [
|
|
7944
|
+
{
|
|
7945
|
+
"disabled": false,
|
|
7946
|
+
"document": "One or more instance ids to be operated. you can obtain the instance ID through the `InstanceId` in the return value from the api [DescribeInstances](https://www.tencentcloud.com/document/api/213/15728?from_cn_redirect=1). the maximum number of instances per request is 30.",
|
|
7947
|
+
"example": "[\"ins-r8hr2upy\"]",
|
|
7948
|
+
"member": "string",
|
|
7949
|
+
"name": "InstanceIds",
|
|
7950
|
+
"required": true,
|
|
7951
|
+
"type": "list"
|
|
7952
|
+
},
|
|
7953
|
+
{
|
|
7954
|
+
"disabled": false,
|
|
7955
|
+
"document": "Modified instance [billing type](https://www.tencentcloud.com/document/product/213/2180?from_cn_redirect=1). <li>`PREPAID`: monthly subscription.</li> \n**Note:** Only supports converting pay-as-you-go instances to annual and monthly subscription instances.\n\ndefault value: `PREPAID`",
|
|
7956
|
+
"example": "PREPAID",
|
|
7957
|
+
"member": "string",
|
|
7958
|
+
"name": "InstanceChargeType",
|
|
7959
|
+
"required": true,
|
|
7960
|
+
"type": "string"
|
|
7961
|
+
},
|
|
7962
|
+
{
|
|
7963
|
+
"disabled": false,
|
|
7964
|
+
"document": "Modified prepaid mode, parameter settings related to monthly/annual subscription. by specifying this parameter, you can specify the purchase duration of annual and monthly subscription instances, whether to enable auto-renewal, and other attributes. ",
|
|
7965
|
+
"example": "无",
|
|
7966
|
+
"member": "InstanceChargePrepaid",
|
|
7967
|
+
"name": "InstanceChargePrepaid",
|
|
7968
|
+
"required": false,
|
|
7969
|
+
"type": "object"
|
|
7970
|
+
},
|
|
7971
|
+
{
|
|
7972
|
+
"disabled": false,
|
|
7973
|
+
"document": "Whether to switch the billing mode of elastic data cloud disks simultaneously. valid values: <li> true: means switching the billing mode of elastic data cloud disks</li><li> false: means not switching the billing mode of elastic data cloud disks</li>default value: false.",
|
|
7974
|
+
"example": "false",
|
|
7975
|
+
"member": "bool",
|
|
7976
|
+
"name": "ModifyPortableDataDisk",
|
|
7977
|
+
"required": false,
|
|
7978
|
+
"type": "bool"
|
|
7979
|
+
}
|
|
7980
|
+
],
|
|
7981
|
+
"type": "object"
|
|
7982
|
+
},
|
|
7983
|
+
"ModifyInstancesChargeTypeResponse": {
|
|
7984
|
+
"document": "ModifyInstancesChargeType response structure.",
|
|
7985
|
+
"members": [
|
|
7986
|
+
{
|
|
7987
|
+
"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.",
|
|
7988
|
+
"member": "string",
|
|
7989
|
+
"name": "RequestId",
|
|
7990
|
+
"type": "string"
|
|
7991
|
+
}
|
|
7992
|
+
],
|
|
7993
|
+
"type": "object"
|
|
7994
|
+
},
|
|
7995
|
+
"ModifyInstancesDisasterRecoverGroupRequest": {
|
|
7996
|
+
"document": "ModifyInstancesDisasterRecoverGroup request structure.",
|
|
7997
|
+
"members": [
|
|
7998
|
+
{
|
|
7999
|
+
"disabled": false,
|
|
8000
|
+
"document": "One or more instance ids to be operated. you can obtain the instance ID through the `InstanceId` in the return value from the api [DescribeInstances](https://www.tencentcloud.com/zh/document/api/213/33258). the maximum number of instances per request is 100.",
|
|
8001
|
+
"example": "[\"ins-r8hr2upy\"]",
|
|
8002
|
+
"member": "string",
|
|
8003
|
+
"name": "InstanceIds",
|
|
8004
|
+
"required": true,
|
|
8005
|
+
"type": "list"
|
|
8006
|
+
},
|
|
8007
|
+
{
|
|
8008
|
+
"disabled": false,
|
|
8009
|
+
"document": "Spread placement group ID. obtain through the api [DescribeDisasterRecoverGroups](https://www.tencentcloud.com/zh/document/api/213/33261).",
|
|
8010
|
+
"example": "ps-a66w6rlb",
|
|
8011
|
+
"member": "string",
|
|
8012
|
+
"name": "DisasterRecoverGroupId",
|
|
8013
|
+
"required": false,
|
|
8014
|
+
"type": "string"
|
|
8015
|
+
},
|
|
8016
|
+
{
|
|
8017
|
+
"disabled": false,
|
|
8018
|
+
"document": "Whether to forcibly change instance hosts. value range:<br><li>true: indicates that the instance is allowed to change hosts, allowing the instance to reboot. local disk machine does not support specifying this parameter.</li><br><li>false: does not allow the instance to change hosts. instances can only be added to the placement group on the current host. this may result in a failure to change the placement group.</li><br><br>default value: false.",
|
|
8019
|
+
"example": "false",
|
|
8020
|
+
"member": "bool",
|
|
8021
|
+
"name": "Force",
|
|
8022
|
+
"required": false,
|
|
8023
|
+
"type": "bool"
|
|
8024
|
+
}
|
|
8025
|
+
],
|
|
8026
|
+
"type": "object"
|
|
8027
|
+
},
|
|
8028
|
+
"ModifyInstancesDisasterRecoverGroupResponse": {
|
|
8029
|
+
"document": "ModifyInstancesDisasterRecoverGroup response structure.",
|
|
8030
|
+
"members": [
|
|
8031
|
+
{
|
|
8032
|
+
"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.",
|
|
8033
|
+
"member": "string",
|
|
8034
|
+
"name": "RequestId",
|
|
8035
|
+
"type": "string"
|
|
8036
|
+
}
|
|
8037
|
+
],
|
|
8038
|
+
"type": "object"
|
|
8039
|
+
},
|
|
7740
8040
|
"ModifyInstancesProjectRequest": {
|
|
7741
8041
|
"document": "ModifyInstancesProject request structure.",
|
|
7742
8042
|
"members": [
|
|
@@ -7950,40 +8250,40 @@
|
|
|
7950
8250
|
{
|
|
7951
8251
|
"disabled": false,
|
|
7952
8252
|
"document": "Instance operation. Valid values: <br><li>`INSTANCE_DEGRADE`: downgrade an instance<br><li>`INTERNET_CHARGE_TYPE_CHANGE`: modify the billing plan of the network connection",
|
|
7953
|
-
"example": "",
|
|
8253
|
+
"example": "INSTANCE_DEGRADE",
|
|
7954
8254
|
"member": "string",
|
|
7955
8255
|
"name": "Operation",
|
|
7956
|
-
"
|
|
8256
|
+
"output_required": true,
|
|
7957
8257
|
"type": "string",
|
|
7958
8258
|
"value_allowed_null": false
|
|
7959
8259
|
},
|
|
7960
8260
|
{
|
|
7961
8261
|
"disabled": false,
|
|
7962
8262
|
"document": "Instance ID.",
|
|
7963
|
-
"example": "",
|
|
8263
|
+
"example": "ins-xxxxx",
|
|
7964
8264
|
"member": "string",
|
|
7965
8265
|
"name": "InstanceId",
|
|
7966
|
-
"
|
|
8266
|
+
"output_required": true,
|
|
7967
8267
|
"type": "string",
|
|
7968
8268
|
"value_allowed_null": false
|
|
7969
8269
|
},
|
|
7970
8270
|
{
|
|
7971
8271
|
"disabled": false,
|
|
7972
8272
|
"document": "Number of operations already performed. If it returns `-1`, it means there is no limit on the times of the operation.",
|
|
7973
|
-
"example": "",
|
|
8273
|
+
"example": "1",
|
|
7974
8274
|
"member": "int64",
|
|
7975
8275
|
"name": "CurrentCount",
|
|
7976
|
-
"
|
|
8276
|
+
"output_required": true,
|
|
7977
8277
|
"type": "int",
|
|
7978
8278
|
"value_allowed_null": false
|
|
7979
8279
|
},
|
|
7980
8280
|
{
|
|
7981
8281
|
"disabled": false,
|
|
7982
8282
|
"document": "Maximum number of times you can perform an operation. If it returns `-1`, it means there is no limit on the times of the operation. If it returns `0`, it means that configuration modification is not supported.",
|
|
7983
|
-
"example": "",
|
|
8283
|
+
"example": "5",
|
|
7984
8284
|
"member": "int64",
|
|
7985
8285
|
"name": "LimitCount",
|
|
7986
|
-
"
|
|
8286
|
+
"output_required": true,
|
|
7987
8287
|
"type": "int",
|
|
7988
8288
|
"value_allowed_null": false
|
|
7989
8289
|
}
|
|
@@ -8042,7 +8342,7 @@
|
|
|
8042
8342
|
},
|
|
8043
8343
|
{
|
|
8044
8344
|
"disabled": false,
|
|
8045
|
-
"document": "
|
|
8345
|
+
"document": "Instance'S project ID. obtain this parameter by calling the `ProjectId` field in the return value of [DescribeProject](https://www.tencentcloud.com/document/product/651/54679). default value 0 means default project.",
|
|
8046
8346
|
"example": "0",
|
|
8047
8347
|
"member": "int64",
|
|
8048
8348
|
"name": "ProjectId",
|
|
@@ -8053,7 +8353,7 @@
|
|
|
8053
8353
|
},
|
|
8054
8354
|
{
|
|
8055
8355
|
"disabled": false,
|
|
8056
|
-
"document": "ID list
|
|
8356
|
+
"document": "Specifies the dedicated host ID list for instance ownership, only used for input parameters. if you purchase a dedicated host and specify this parameter, instances you purchase will be randomly deployed on these dedicated hosts. obtain this parameter by calling the `HostId` field in the return value of [DescribeHosts](https://www.tencentcloud.com/document/product/213/33279?lang=en).",
|
|
8057
8357
|
"example": "[\"host-o5i742go\"]",
|
|
8058
8358
|
"member": "string",
|
|
8059
8359
|
"name": "HostIds",
|
|
@@ -8307,6 +8607,51 @@
|
|
|
8307
8607
|
],
|
|
8308
8608
|
"type": "object"
|
|
8309
8609
|
},
|
|
8610
|
+
"RenewInstancesRequest": {
|
|
8611
|
+
"document": "RenewInstances request structure.",
|
|
8612
|
+
"members": [
|
|
8613
|
+
{
|
|
8614
|
+
"disabled": false,
|
|
8615
|
+
"document": "One or more instance IDs to be operated. You can obtain the instance ID through the `InstanceId` in the return value from the API [DescribeInstances](https://www.tencentcloud.comom/document/api/213/15728?from_cn_redirect=1). The maximum number of instances per request is 100.",
|
|
8616
|
+
"example": "[\"ins-r8hr2upy\"]",
|
|
8617
|
+
"member": "string",
|
|
8618
|
+
"name": "InstanceIds",
|
|
8619
|
+
"required": true,
|
|
8620
|
+
"type": "list"
|
|
8621
|
+
},
|
|
8622
|
+
{
|
|
8623
|
+
"disabled": false,
|
|
8624
|
+
"document": "Prepaid mode, that is, parameter settings related to monthly/annual subscription. specifies attributes of a monthly subscription instance, such as renewal duration and whether to enable auto-renewal, by specifying this parameter. <dx-alert infotype=\"explain\" title=\"\">.\nAnnual and monthly subscription instances. this parameter is a required parameter.</dx-alert>.",
|
|
8625
|
+
"example": "无",
|
|
8626
|
+
"member": "InstanceChargePrepaid",
|
|
8627
|
+
"name": "InstanceChargePrepaid",
|
|
8628
|
+
"required": false,
|
|
8629
|
+
"type": "object"
|
|
8630
|
+
},
|
|
8631
|
+
{
|
|
8632
|
+
"disabled": false,
|
|
8633
|
+
"document": "Whether to renew the elastic data disk. valid values:<br><li>true: indicates renewing the annual and monthly subscription instance and its mounted elastic data disk simultaneously</li><li>false: indicates renewing the annual and monthly subscription instance while no longer renewing its mounted elastic data disk</li><br>default value: true.",
|
|
8634
|
+
"example": "false",
|
|
8635
|
+
"member": "bool",
|
|
8636
|
+
"name": "RenewPortableDataDisk",
|
|
8637
|
+
"required": false,
|
|
8638
|
+
"type": "bool"
|
|
8639
|
+
}
|
|
8640
|
+
],
|
|
8641
|
+
"type": "object"
|
|
8642
|
+
},
|
|
8643
|
+
"RenewInstancesResponse": {
|
|
8644
|
+
"document": "RenewInstances response structure.",
|
|
8645
|
+
"members": [
|
|
8646
|
+
{
|
|
8647
|
+
"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.",
|
|
8648
|
+
"member": "string",
|
|
8649
|
+
"name": "RequestId",
|
|
8650
|
+
"type": "string"
|
|
8651
|
+
}
|
|
8652
|
+
],
|
|
8653
|
+
"type": "object"
|
|
8654
|
+
},
|
|
8310
8655
|
"ReservedInstanceConfigInfoItem": {
|
|
8311
8656
|
"document": "Static configurations of the reserved instance.",
|
|
8312
8657
|
"members": [
|
|
@@ -9178,7 +9523,7 @@
|
|
|
9178
9523
|
"members": [
|
|
9179
9524
|
{
|
|
9180
9525
|
"disabled": false,
|
|
9181
|
-
"document": "Instance ID.
|
|
9526
|
+
"document": "Instance ID to be operated. can be obtained from the `InstanceId` in the return value from the DescribeInstances api (https://www.tencentcloud.comom/document/api/213/15728?from_cn_redirect=1).",
|
|
9182
9527
|
"example": "ins-r8hr2upy",
|
|
9183
9528
|
"member": "string",
|
|
9184
9529
|
"name": "InstanceId",
|
|
@@ -9187,7 +9532,7 @@
|
|
|
9187
9532
|
},
|
|
9188
9533
|
{
|
|
9189
9534
|
"disabled": false,
|
|
9190
|
-
"document": "
|
|
9535
|
+
"document": "Specifies the configuration information of the data disk to be expanded, only supporting specifying the target capacity of the disk to be expanded. only non-elastic data disks (with `Portable` being `false` in the return values of [DescribeDisks](https://www.tencentcloud.comom/document/api/362/16315?from_cn_redirect=1)) can be expanded. the unit of data disk capacity is GiB. the minimum expansion step is 10 GiB. for data disk type selection, refer to [disk product introduction](https://www.tencentcloud.comom/document/product/362/2353?from_cn_redirect=1). the available data disk type is restricted by the instance type `InstanceType`. additionally, the maximum allowable capacity for expansion varies by data disk type.\n<dx-alert infotype=\"explain\" title=\"\">You should specify either DataDisks or SystemDisk, but you cannot specify both at the same time.</dx-alert>",
|
|
9191
9536
|
"example": "无",
|
|
9192
9537
|
"member": "DataDisk",
|
|
9193
9538
|
"name": "DataDisks",
|
|
@@ -9196,7 +9541,7 @@
|
|
|
9196
9541
|
},
|
|
9197
9542
|
{
|
|
9198
9543
|
"disabled": false,
|
|
9199
|
-
"document": "
|
|
9544
|
+
"document": "Specifies whether to forcibly shut down a running instance. it is recommended to manually shut down a running instance first and then expand the instance disk. valid values:<br><li>true: forcibly shut down an instance after a normal shutdown fails.</li><br><li>false: do not forcibly shut down an instance after a normal shutdown fails.</li><br><br>default value: false.<br><br>forced shutdown is equivalent to turning off a physical computer's power switch. forced shutdown may cause data loss or file system corruption and should only be used when a server cannot be shut down normally.",
|
|
9200
9545
|
"example": "true",
|
|
9201
9546
|
"member": "bool",
|
|
9202
9547
|
"name": "ForceStop",
|
|
@@ -9205,7 +9550,7 @@
|
|
|
9205
9550
|
},
|
|
9206
9551
|
{
|
|
9207
9552
|
"disabled": false,
|
|
9208
|
-
"document": "
|
|
9553
|
+
"document": "System disk configuration information to be expanded. only supports specifying the purpose capacity of the disk to be expanded. only supports cloud disk expansion.\n<dx-alert infotype=\"explain\" title=\"\">You should specify either DataDisks or SystemDisk, but you cannot specify both at the same time.</dx-alert>",
|
|
9209
9554
|
"example": "无",
|
|
9210
9555
|
"member": "SystemDisk",
|
|
9211
9556
|
"name": "SystemDisk",
|
|
@@ -9348,7 +9693,16 @@
|
|
|
9348
9693
|
},
|
|
9349
9694
|
{
|
|
9350
9695
|
"disabled": false,
|
|
9351
|
-
"document": "
|
|
9696
|
+
"document": "Specifies the minimum number of instances to create. value range: positive integer not greater than InstanceCount.\nSpecifies the minimum purchasable quantity, guarantees to create at least MinCount instances, and creates InstanceCount instances as much as possible.\nInsufficient inventory to meet the minimum purchasable quantity will trigger an error info indicating insufficient stock.\nOnly applicable to accounts, regions, and billing modes (annual/monthly subscription, pay-as-you-go, spot instance, exclusive sales) with partial support.",
|
|
9697
|
+
"example": "1",
|
|
9698
|
+
"member": "int64",
|
|
9699
|
+
"name": "MinCount",
|
|
9700
|
+
"required": false,
|
|
9701
|
+
"type": "int"
|
|
9702
|
+
},
|
|
9703
|
+
{
|
|
9704
|
+
"disabled": false,
|
|
9705
|
+
"document": "Instance display name. <li>if no instance display name is specified, it will display 'unnamed' by default.</li> <li>when purchasing multiple instances, if the pattern string `{R:x}` is specified, it means generating numbers `[x, x+n-1]`, where `n` represents the number of purchased instances. for example, `server_{R:3}`: when purchasing 1 instance, the instance display name is `server_3`; when purchasing 2 instances, the instance display names are `server_3` and `server_4` respectively. supports specifying multiple pattern strings `{R:x}`.</li> <li>when purchasing multiple instances without specifying a pattern string, suffixes `1, 2...n` will be added to the instance display name, where `n` represents the number of purchased instances. for example, `server_`: when purchasing 2 instances, the instance display names are `server_1` and `server_2` respectively.</li> <li>supports up to 128 characters (including pattern strings).</li>.",
|
|
9352
9706
|
"example": "server_{R:3}",
|
|
9353
9707
|
"member": "string",
|
|
9354
9708
|
"name": "InstanceName",
|
|
@@ -9366,7 +9720,7 @@
|
|
|
9366
9720
|
},
|
|
9367
9721
|
{
|
|
9368
9722
|
"disabled": false,
|
|
9369
|
-
"document": "Security
|
|
9723
|
+
"document": "Security group to which an instance belongs. obtain this parameter by calling the `SecurityGroupId` field in the return value of [DescribeSecurityGroups](https://www.tencentcloud.com/document/product/215/15808?from_search=1). if not specified, bind the default security group under the designated project. if the default security group does not exist, automatically create it.",
|
|
9370
9724
|
"example": "[\"sg-ajhn9qtq\"]",
|
|
9371
9725
|
"member": "string",
|
|
9372
9726
|
"name": "SecurityGroupIds",
|
|
@@ -9412,7 +9766,7 @@
|
|
|
9412
9766
|
{
|
|
9413
9767
|
"disabled": false,
|
|
9414
9768
|
"document": "Placement group ID. You can only specify one.",
|
|
9415
|
-
"example": "[
|
|
9769
|
+
"example": "[\"sg-efil73jd\"]",
|
|
9416
9770
|
"member": "string",
|
|
9417
9771
|
"name": "DisasterRecoverGroupIds",
|
|
9418
9772
|
"required": false,
|
|
@@ -9447,7 +9801,7 @@
|
|
|
9447
9801
|
},
|
|
9448
9802
|
{
|
|
9449
9803
|
"disabled": false,
|
|
9450
|
-
"document": "",
|
|
9804
|
+
"document": "Custom metadata. specifies the support for creating custom metadata key-value pairs when creating a CVM.\n**Note: this field is in beta test.**.",
|
|
9451
9805
|
"example": "无",
|
|
9452
9806
|
"member": "Metadata",
|
|
9453
9807
|
"name": "Metadata",
|
|
@@ -9528,7 +9882,7 @@
|
|
|
9528
9882
|
},
|
|
9529
9883
|
{
|
|
9530
9884
|
"disabled": false,
|
|
9531
|
-
"document": "",
|
|
9885
|
+
"document": "Whether the instance enables jumbo frames. valid values:<br><li/> true: means the instance enables jumbo frames. only models supporting jumbo frames can be set to true.<br><li/> false: means the instance disables jumbo frames. only models supporting jumbo frames can be set to false.<br> instance specifications supporting jumbo frames: [instance specifications](https://www.tencentcloud.com/document/product/213/11518?lang=en&pg=).",
|
|
9532
9886
|
"example": "false",
|
|
9533
9887
|
"member": "bool",
|
|
9534
9888
|
"name": "EnableJumboFrame",
|
|
@@ -9544,7 +9898,7 @@
|
|
|
9544
9898
|
{
|
|
9545
9899
|
"disabled": false,
|
|
9546
9900
|
"document": "If you use this API to create instance(s), this parameter will be returned, representing one or more instance IDs. Retuning the instance ID list does not necessarily mean that the instance(s) were created successfully. To check whether the instance(s) were created successfully, you can call [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1) and check the status of the instances in `InstancesSet` in the response. If the status of an instance changes from \"PENDING\" to \"RUNNING\", it means that the instance has been created successfully.",
|
|
9547
|
-
"example": "[
|
|
9901
|
+
"example": "[\"ins-rn79mzt1\"]",
|
|
9548
9902
|
"member": "string",
|
|
9549
9903
|
"name": "InstanceIdSet",
|
|
9550
9904
|
"output_required": true,
|
|
@@ -9724,7 +10078,7 @@
|
|
|
9724
10078
|
"type": "list"
|
|
9725
10079
|
},
|
|
9726
10080
|
{
|
|
9727
|
-
"disabled":
|
|
10081
|
+
"disabled": true,
|
|
9728
10082
|
"document": "(Disused. Please use `StopType` instead.) Whether to forcibly shut down an instance after a normal shutdown fails. Valid values: <br><li>`TRUE`: yes;<br><li>`FALSE`: no<br><br>Default value: `FALSE`. ",
|
|
9729
10083
|
"example": "false",
|
|
9730
10084
|
"member": "bool",
|
|
@@ -9926,7 +10280,7 @@
|
|
|
9926
10280
|
"members": [
|
|
9927
10281
|
{
|
|
9928
10282
|
"disabled": false,
|
|
9929
|
-
"document": "Specifies the system disk type. for the restrictions on the system disk type, refer to [storage overview](https://
|
|
10283
|
+
"document": "Specifies the system disk type. for the restrictions on the system disk type, refer to [storage overview](https://www.tencentcloud.com/document/product/362/31636). value range:<br>\n<li>LOCAL_BASIC: Local SATA disk</li>\n<li>LOCAL_SSD: Local NVMe SSD</li>\n<li>CLOUD_BASIC: Cloud SATA disk</li>\n<li>CLOUD_SSD: Cloud SSD</li>\n<li>CLOUD_PREMIUM: Premium SSD</li>\n<li>CLOUD_BSSD: Balanced SSD</li>\n<li>CLOUD_HSSD: Enhanced SSD</li>\n<li>CLOUD_TSSD: Tremendous SSD</li>\nDefault value: Current disk types with inventory available.",
|
|
9930
10284
|
"example": "CLOUD_HSSD",
|
|
9931
10285
|
"member": "string",
|
|
9932
10286
|
"name": "DiskType",
|
|
@@ -9937,8 +10291,8 @@
|
|
|
9937
10291
|
},
|
|
9938
10292
|
{
|
|
9939
10293
|
"disabled": false,
|
|
9940
|
-
"document": "
|
|
9941
|
-
"example": "disk-
|
|
10294
|
+
"document": "System disk ID.\nCurrently, this parameter is only used for response parameters in query apis such as [DescribeInstances](https://www.tencentcloud.com/document/api/213/33258) and is not applicable to request parameters in write apis such as [RunInstances](https://www.tencentcloud.com/document/api/213/33237).",
|
|
10295
|
+
"example": "disk-xyzw1a3x",
|
|
9942
10296
|
"member": "string",
|
|
9943
10297
|
"name": "DiskId",
|
|
9944
10298
|
"output_required": false,
|
|
@@ -9959,7 +10313,7 @@
|
|
|
9959
10313
|
},
|
|
9960
10314
|
{
|
|
9961
10315
|
"disabled": false,
|
|
9962
|
-
"document": "Specifies the
|
|
10316
|
+
"document": "Specifies the dedicated cluster ID belonging to.\nNote: This field may return null, indicating that no valid value is found.",
|
|
9963
10317
|
"example": "cdc-xxxxxx",
|
|
9964
10318
|
"member": "string",
|
|
9965
10319
|
"name": "CdcId",
|
|
@@ -10015,7 +10369,7 @@
|
|
|
10015
10369
|
"members": [
|
|
10016
10370
|
{
|
|
10017
10371
|
"disabled": false,
|
|
10018
|
-
"document": "
|
|
10372
|
+
"document": "Specifies the resource type for Tag binding. valid values: \"instance\" (cloud virtual machine), \"host\" (cdh), \"image\" (mirror), \"keypair\" (key), \"ps\" (placement group), \"hpc\" (hyper computing cluster).",
|
|
10019
10373
|
"example": "instance",
|
|
10020
10374
|
"member": "string",
|
|
10021
10375
|
"name": "ResourceType",
|
|
@@ -10114,7 +10468,7 @@
|
|
|
10114
10468
|
"members": [
|
|
10115
10469
|
{
|
|
10116
10470
|
"disabled": false,
|
|
10117
|
-
"document": "
|
|
10471
|
+
"document": "vpc ID, such as `vpc-xxx`. valid vpc ids can be queried by logging in to the console (https://console.cloud.tencent.com/vpc/vpc?rid=1) or by calling the API [DescribeVpcs](https://www.tencentcloud.com/document/product/215/15778?lang=en) and obtaining the `VpcId` field from the API response. if both VpcId and SubnetId are input as `DEFAULT` when creating an instance, the DEFAULT vpc network will be forcibly used.",
|
|
10118
10472
|
"example": "vpc-2ij",
|
|
10119
10473
|
"member": "string",
|
|
10120
10474
|
"name": "VpcId",
|
|
@@ -10125,7 +10479,7 @@
|
|
|
10125
10479
|
},
|
|
10126
10480
|
{
|
|
10127
10481
|
"disabled": false,
|
|
10128
|
-
"document": "vpc subnet ID, in the form of `subnet-xxx`. valid vpc subnet ids can be queried by logging in to the console
|
|
10482
|
+
"document": "vpc subnet ID, in the form of `subnet-xxx`. valid vpc subnet ids can be queried by logging in to the [console](https://console.tencentcloud.com/vpc/subnet); or they can be obtained from the `SubnetId` field in the API response by calling the [DescribeSubnets](https://www.tencentcloud.com/document/product/215/15784) API . if SubnetId and VpcId are both input as `DEFAULT` when creating an instance, the DEFAULT vpc network will be forcibly used.",
|
|
10129
10483
|
"example": "subnet-2ks",
|
|
10130
10484
|
"member": "string",
|
|
10131
10485
|
"name": "SubnetId",
|