tencentcloud-sdk-python-intl-en 3.0.1192__py2.py3-none-any.whl → 3.0.1193__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of tencentcloud-sdk-python-intl-en might be problematic. Click here for more details.

@@ -25,25 +25,17 @@ class ActionTimer(AbstractModel):
25
25
 
26
26
  def __init__(self):
27
27
  r"""
28
- :param _TimerAction: Timer action. Valid value: `TerminateInstances`.
29
- Note: This field may return `null`, indicating that no valid values can be obtained.
28
+ :param _TimerAction: Timer action currently only supports terminating one value: TerminateInstances.
30
29
  :type TimerAction: str
31
- :param _ActionTime: Action time, which follows the ISO8601 standard and uses UTC time. It must be 5 minutes later than the current time. Format: YYYY-MM-DDThh:mm:ssZ. For example: 2018-05-29T11:26:40Z.
32
- Note: This field may return `null`, indicating that no valid values can be obtained.
30
+ :param _ActionTime: Execution time, in standard ISO8601 representation and using UTC time. format: YYYY-MM-DDThh:MM:ssZ. for example, 2018-05-29T11:26:40Z. the execution time must be later than the current time by 5 minutes.
33
31
  :type ActionTime: str
34
- :param _Externals: Extended data
35
- Note: This field may return `null`, indicating that no valid values can be obtained.
32
+ :param _Externals: Extension data. only used as output usage.
36
33
  :type Externals: :class:`tencentcloud.cvm.v20170312.models.Externals`
37
- :param _ActionTimerId: Timer ID.
34
+ :param _ActionTimerId: Timer ID. only used as output usage.
38
35
  :type ActionTimerId: str
39
- :param _Status: Timer status. Valid values:
40
-
41
- UNDO: Not triggered.
42
- DOING: Triggering.
43
- DONE: Triggered already.
44
-
36
+ :param _Status: Timer status, for output usage only. value ranges from: <li>UNDO: unexecuted</li> <li>DOING: executing</li> <li>DONE: execution completed.</li>.
45
37
  :type Status: str
46
- :param _InstanceId: Instance ID corresponding to a timer.
38
+ :param _InstanceId: Instance ID corresponding to a timer. used only for output.
47
39
  :type InstanceId: str
48
40
  """
49
41
  self._TimerAction = None
@@ -55,8 +47,7 @@ DONE: Triggered already.
55
47
 
56
48
  @property
57
49
  def TimerAction(self):
58
- """Timer action. Valid value: `TerminateInstances`.
59
- Note: This field may return `null`, indicating that no valid values can be obtained.
50
+ """Timer action currently only supports terminating one value: TerminateInstances.
60
51
  :rtype: str
61
52
  """
62
53
  return self._TimerAction
@@ -67,8 +58,7 @@ Note: This field may return `null`, indicating that no valid values can be obtai
67
58
 
68
59
  @property
69
60
  def ActionTime(self):
70
- """Action time, which follows the ISO8601 standard and uses UTC time. It must be 5 minutes later than the current time. Format: YYYY-MM-DDThh:mm:ssZ. For example: 2018-05-29T11:26:40Z.
71
- Note: This field may return `null`, indicating that no valid values can be obtained.
61
+ """Execution time, in standard ISO8601 representation and using UTC time. format: YYYY-MM-DDThh:MM:ssZ. for example, 2018-05-29T11:26:40Z. the execution time must be later than the current time by 5 minutes.
72
62
  :rtype: str
73
63
  """
74
64
  return self._ActionTime
@@ -79,8 +69,7 @@ Note: This field may return `null`, indicating that no valid values can be obtai
79
69
 
80
70
  @property
81
71
  def Externals(self):
82
- """Extended data
83
- Note: This field may return `null`, indicating that no valid values can be obtained.
72
+ """Extension data. only used as output usage.
84
73
  :rtype: :class:`tencentcloud.cvm.v20170312.models.Externals`
85
74
  """
86
75
  return self._Externals
@@ -91,7 +80,7 @@ Note: This field may return `null`, indicating that no valid values can be obtai
91
80
 
92
81
  @property
93
82
  def ActionTimerId(self):
94
- """Timer ID.
83
+ """Timer ID. only used as output usage.
95
84
  :rtype: str
96
85
  """
97
86
  return self._ActionTimerId
@@ -102,12 +91,7 @@ Note: This field may return `null`, indicating that no valid values can be obtai
102
91
 
103
92
  @property
104
93
  def Status(self):
105
- """Timer status. Valid values:
106
-
107
- UNDO: Not triggered.
108
- DOING: Triggering.
109
- DONE: Triggered already.
110
-
94
+ """Timer status, for output usage only. value ranges from: <li>UNDO: unexecuted</li> <li>DOING: executing</li> <li>DONE: execution completed.</li>.
111
95
  :rtype: str
112
96
  """
113
97
  return self._Status
@@ -118,7 +102,7 @@ DONE: Triggered already.
118
102
 
119
103
  @property
120
104
  def InstanceId(self):
121
- """Instance ID corresponding to a timer.
105
+ """Instance ID corresponding to a timer. used only for output.
122
106
  :rtype: str
123
107
  """
124
108
  return self._InstanceId
@@ -2068,67 +2052,77 @@ class CreateLaunchTemplateRequest(AbstractModel):
2068
2052
 
2069
2053
  def __init__(self):
2070
2054
  r"""
2071
- :param _LaunchTemplateName: Instance launch template name. It can include 2-128 characters.
2055
+ :param _LaunchTemplateName: Name of an instance launch template. It contains 2 to 128 English or Chinese characters.
2072
2056
  :type LaunchTemplateName: str
2073
- :param _Placement: Location of the instance. You can use this parameter to specify the attributes of the instance, such as its availability zone, project, and CDH (for dedicated CVMs)
2057
+ :param _Placement: Location of the instance. You can specify attributes such as availability zone, project, and host (specified when creating a instance on the CDH) to which the instance belongs through this parameter.
2074
2058
  :type Placement: :class:`tencentcloud.cvm.v20170312.models.Placement`
2075
- :param _ImageId: The [image](https://intl.cloud.tencent.com/document/product/213/4940?from_cn_redirect=1) ID in the format of `img-xxx`. There are four types of images:<br/><li>Public images</li><li>Custom images</li><li>Shared images</li><li>Marketplace images (for Chinese mainland only)</li><br/>To check the image ID:<br/><li>For public images, custom images, and shared images, go to the [console](https://console.cloud.tencent.com/cvm/image?rid=1&imageType=PUBLIC_IMAGE). For marketplace images, go to [Cloud Marketplace](https://market.cloud.tencent.com/list). </li><li>Call [DescribeImages](https://intl.cloud.tencent.com/document/api/213/15715?from_cn_redirect=1), pass in `InstanceType` to retrieve the list of images supported by the current model, and then find the `ImageId` in the response.</li>
2059
+ :param _ImageId: Specify an effective [mirror](https://intl.cloud.tencent.com/document/product/213/4940?from_cn_redirect=1) ID in the format of `img-xxx`. there are four image types: <li>PUBLIC image</li> <li>custom image</li> <li>shared image</li> <li>service market image</li> you can obtain available mirror ids in the following ways: <li>the mirror ids of `PUBLIC image`, `custom image` and `shared image` can be queried by logging in to the [console](https://console.cloud.tencent.com/cvm/image?rid=1&imageType=PUBLIC_image); the mirror ids of `service market image` can be queried through the [cloud market](https://market.cloud.tencent.com/list).</li> <li>call the api [DescribeImages](https://intl.cloud.tencent.com/document/api/213/15715?from_cn_redirect=1), input InstanceType to obtain the list of images supported by the current model, and take the `ImageId` field from the return information.</li>.
2076
2060
  :type ImageId: str
2077
- :param _LaunchTemplateVersionDescription: Description of instance launch template versions. This parameter can contain 2-256 characters.
2061
+ :param _LaunchTemplateVersionDescription: Version description of an instance launch template. It contains 2 to 256 English or Chinese characters.
2078
2062
  :type LaunchTemplateVersionDescription: str
2079
- :param _InstanceType: The instance model. Different resource specifications are specified for different instance models.
2080
- <br><li>To view specific values for `PREPAID` or `POSTPAID_BY_HOUR` instances, you can call [DescribeInstanceTypeConfigs](https://intl.cloud.tencent.com/document/api/213/15749?from_cn_redirect=1) or refer to [Instance Types](https://intl.cloud.tencent.com/document/product/213/11518?from_cn_redirect=1). If this parameter is not specified, the system will specify the default model according to the dynamic resource sales in the current region. <br><li>For `CDHPAID` instances, the value of this parameter is in the format of `CDH_XCXG` based on the number of CPU cores and memory capacity. For example, if you want to create a CDH instance with a single-core CPU and 1 GB memory, you need to specify this parameter as `CDH_1C1G`.
2063
+ :param _InstanceType: Instance model. Different instance models specify different resource specifications.
2064
+
2065
+ <br><li>For instances created with the payment modes PREPAID or POSTPAID_BY_HOUR, the specific values can be obtained BY calling the [DescribeInstanceTypeConfigs](https://intl.cloud.tencent.com/document/api/213/15749?from_cn_redirect=1) api to get the latest specification table or referring to the [instance specifications](https://intl.cloud.tencent.com/document/product/213/11518?from_cn_redirect=1) description. if this parameter is not specified, the system will dynamically assign a default model based on the current resource sales situation in a region.</li><li>for instances created with the payment mode CDHPAID, this parameter has the prefix "CDH_" and is generated based on the 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>.
2081
2066
  :type InstanceType: str
2082
- :param _SystemDisk: System disk configuration of the instance. If this parameter is not specified, the default value will be used.
2067
+ :param _SystemDisk: Instance system disk configuration information. If this parameter is not specified, it will be assigned based on the system default values.
2083
2068
  :type SystemDisk: :class:`tencentcloud.cvm.v20170312.models.SystemDisk`
2084
- :param _DataDisks: The configuration information of instance data disks. If this parameter is not specified, no data disk will be purchased by default. When purchasing, you can specify 21 data disks, which can contain at most 1 LOCAL_BASIC or LOCAL_SSD data disk, and at most 20 CLOUD_BASIC, CLOUD_PREMIUM, or CLOUD_SSD data disks.
2069
+ :param _DataDisks: Instance data disk configuration information. if not specified, no data disks are purchased by default. support specifying 21 data disks at the time of purchase, among which a maximum of 1 LOCAL_BASIC data disk or LOCAL_SSD data disk can be included, and a maximum of 20 CLOUD_BASIC data disks, CLOUD_PREMIUM data disks or CLOUD_SSD data disks can be included.
2085
2070
  :type DataDisks: list of DataDisk
2086
- :param _VirtualPrivateCloud: Configuration information of VPC. This parameter is used to specify VPC ID and subnet ID, etc. If this parameter is not specified, the classic network is used by default. If a VPC IP is specified in this parameter, it indicates the primary ENI IP of each instance. The value of parameter InstanceCount must be same as the number of VPC IPs, which cannot be greater than 20.
2071
+ :param _VirtualPrivateCloud: VPC-related information configuration. You can specify information such as VPC ID and subnet ID through this parameter. If this parameter is not specified, use the basic network by default. If a VPC IP is specified in this parameter, it indicates the primary network interface card IP of each instance. In addition, the number of the InstanceCount parameter should be consistent with the number of the VPC IP and should not exceed 20.
2087
2072
  :type VirtualPrivateCloud: :class:`tencentcloud.cvm.v20170312.models.VirtualPrivateCloud`
2088
- :param _InternetAccessible: Configuration of public network bandwidth. If this parameter is not specified, 0 Mbps will be used by default.
2073
+ :param _InternetAccessible: Public bandwidth-related settings. If this parameter is not specified, the public bandwidth is 0 Mbps by default.
2089
2074
  :type InternetAccessible: :class:`tencentcloud.cvm.v20170312.models.InternetAccessible`
2090
- :param _InstanceCount: Number of instances to be purchased. Value range for monthly-subscribed instances: [1, 300]. Value range for pay-as-you-go instances: [1, 100]. Default value: 1. The specified number of instances to be purchased cannot exceed the remaining quota allowed for the user. For more information on quota, see CVM instance [Purchase Limits](https://intl.cloud.tencent.com/document/product/213/2664).
2075
+ :param _InstanceCount: Number of instances to purchase. value range for monthly subscription instances: [1, 300]. value range for pay-as-you-go instances: [1, 100]. default value: 1. the number of instances to purchase must not exceed the remaining user quota. for specific quota limitations, see [CVM instance purchase limitations](https://intl.cloud.tencent.com/document/product/213/2664?from_cn_redirect=1).
2091
2076
  :type InstanceCount: int
2092
- :param _InstanceName: Instance name to be displayed. <br><li>If this parameter is not specified, "Unnamed" will be displayed by default. </li><li>If you purchase multiple instances at the same time and specify a pattern string `{R:x}`, numbers `[x, x+n-1]` will be generated, where `n` represents the number of instances purchased. For example, you specify a pattern string, `server_{R:3}`. If you only purchase 1 instance, the instance will be named `server_3`; if you purchase 2, they will be named `server_3` and `server_4`. You can specify multiple pattern strings in the format of `{R:x}`. </li><li>If you purchase multiple instances at the same time and do not specify a pattern string, the instance names will be suffixed by `1, 2...n`, where `n` represents the number of instances purchased. For example, if you purchase 2 instances and the instance name body is `server_`, the instance names will be `server_1` and `server_2`. </li><li>This parameter can contain up to 60 characters, including the pattern string.
2077
+ :param _InstanceName: Instance display name. <li>if the instance display name is not specified, it will display by default as 'unnamed'.</li> <li>when purchasing multiple instances, if the pattern string `{R:x}` is specified, it indicates generating numbers `[x, x+n-1]`, where `n` represents the number of purchased instances. for example, `server_{R:3}` will result in instance display names as `server_3` when purchasing 1 instance; when purchasing 2 instances, the instance display names will be `server_3` and `server_4` respectively. it supports specifying multiple pattern strings `{R:x}`.</li> <li>when purchasing multiple instances, if no pattern string is specified, a suffix `1, 2...n` will be added to the instance display name, where `n` represents the number of purchased instances. for example, for `server_`, when purchasing 2 instances, the instance display names will be `server_1` and `server_2` respectively.</li> <li>it supports up to 128 characters (including pattern strings).</li>.
2093
2078
  :type InstanceName: str
2094
- :param _LoginSettings: Login settings of the instance. You can use this parameter to set the login method, password, and key of the instance or keep the login settings of the original image. By default, a random password will be generated and sent to you via the Message Center.
2079
+ :param _LoginSettings: Instance login settings. this parameter allows you to set the instance login method to key or maintain the original login settings of the image.
2095
2080
  :type LoginSettings: :class:`tencentcloud.cvm.v20170312.models.LoginSettings`
2096
- :param _SecurityGroupIds: Security groups to which the instance belongs. To obtain the security group IDs, you can call [DescribeSecurityGroups](https://intl.cloud.tencent.com/document/api/215/15808) and look for the `sgld` fields in the response. If this parameter is not specified, the instance will be associated with default security groups.
2081
+ :param _SecurityGroupIds: Security group to which an instance belongs. this parameter can be obtained by calling the sgId field in the returned value of [DescribeSecurityGroups](https://intl.cloud.tencent.com/document/api/215/15808?from_cn_redirect=1). if not specified, the default security group is bound.
2097
2082
  :type SecurityGroupIds: list of str
2098
- :param _EnhancedService: Enhanced service. You can use this parameter to specify whether to enable services such as Anti-DDoS and Cloud Monitor. If this parameter is not specified, Cloud Monitor and Anti-DDoS are enabled for public images by default. However, for custom images and images from the marketplace, Anti-DDoS and Cloud Monitor are not enabled by default. The original services in the image will be retained.
2083
+ :param _EnhancedService: Enhanced services. You can specify whether to enable services such as Cloud Security and Cloud Monitor through this parameter. If this parameter is not specified, Cloud Monitor and Cloud Security are enabled for public images by default, but not enabled for custom images and marketplace images by default. Instead, they use services retained in the images.
2099
2084
  :type EnhancedService: :class:`tencentcloud.cvm.v20170312.models.EnhancedService`
2100
- :param _ClientToken: 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.
2085
+ :param _ClientToken: A string used to ensure the idempotence of the request. This string is generated by the customer and should be unique across different requests, with a maximum length of 64 ASCII characters. If this parameter is not specified, the idempotence of the request cannot be guaranteed.
2101
2086
  :type ClientToken: str
2102
- :param _HostName: Host name of the CVM. <br><li>Dots (.) or hyphens (-) cannot be the start or end of a host name or appear consecutively in a host name. <br><li>For Windows instances, the host name must be 2-15 characters long and can contain uppercase and lowercase letters, numbers, and hyphens (-). It cannot contain dots (.) or contain only numbers. <br><li>For other instances, such as Linux instances, the host name must be 2-60 characters long. It supports multiple dots (.) and allows uppercase and lowercase letters, numbers, and hyphens (-) between any two dots (.).
2087
+ :param _HostName: Specifies the HostName of the cloud virtual machine.<br><li>the dot (.) and hyphen (-) cannot be used at the beginning or end of the HostName, and cannot be used consecutively.</li><li>for Windows instances: the character length is 2 to 15. it consists of letters (case insensitive), digits, and hyphens (-). dots (.) are not supported, and it cannot be all digits.</li><li>for other types (such as Linux) instances: the character length is 2 to 60. multiple dots are allowed. each segment between dots can include letters (case insensitive), digits, and hyphens (-).</li>.
2103
2088
  :type HostName: str
2104
- :param _ActionTimer: Scheduled tasks. You can use this parameter to specify scheduled tasks for the instance. Only scheduled termination is supported.
2089
+ :param _ActionTimer: Scheduled task. You can specify a scheduled task for the instance through this parameter. Currently, only scheduled termination is supported.
2105
2090
  :type ActionTimer: :class:`tencentcloud.cvm.v20170312.models.ActionTimer`
2106
- :param _DisasterRecoverGroupIds: Placement group ID. You can only specify one.
2091
+ :param _DisasterRecoverGroupIds: Placement group ID. Only one can be specified.
2107
2092
  :type DisasterRecoverGroupIds: list of str
2108
- :param _TagSpecification: The tag description list. This parameter is used to bind a tag to a resource instance. A tag can only be bound to CVM instances.
2093
+ :param _TagSpecification: List of tag descriptions. You can bind tags to corresponding resource instances at the same time by specifying this parameter. Currently, only binding tags to the CVM is supported.
2109
2094
  :type TagSpecification: list of TagSpecification
2110
- :param _InstanceMarketOptions: Market options of the instance, such as parameters related to spot instances. This parameter is required for spot instances.
2095
+ :param _InstanceMarketOptions: Market-Related options of the instance, such as relevant parameters of the bidding instance. this parameter is required if the payment mode of the specified instance is spot payment.
2111
2096
  :type InstanceMarketOptions: :class:`tencentcloud.cvm.v20170312.models.InstanceMarketOptionsRequest`
2112
- :param _UserData: User data provided to the instance. This parameter needs to be encoded in base64 format with the maximum size of 16KB. For more information on how to get the value of this parameter, see the commands you need to execute on startup for [Windows](https://intl.cloud.tencent.com/document/product/213/17526) or [Linux](https://intl.cloud.tencent.com/document/product/213/17525).
2097
+ :param _UserData: User data provided for an instance must be encoded in base64. valid values for maximum data size are up to 16 KB. for details on obtaining this parameter, see running commands at startup for Windows (https://intl.cloud.tencent.com/document/product/213/17526?from_cn_redirect=1) and Linux (https://intl.cloud.tencent.com/document/product/213/17525?from_cn_redirect=1).
2113
2098
  :type UserData: str
2114
- :param _DryRun: Whether the request is a dry run only.
2115
- true: dry run only. The request will not create instance(s). A dry run can check whether all the required parameters are specified, whether the request format is right, whether the request exceeds service limits, and whether the specified CVMs are available.
2116
- If the dry run fails, the corresponding error code will be returned.
2117
- If the dry run succeeds, the RequestId will be returned.
2118
- false (default value): send a normal request and create instance(s) if all the requirements are met.
2099
+ :param _DryRun: Whether it is a pre-check for this request only.
2100
+ true: sends a check request without creating an instance. check items include whether required parameters are filled in, request format, service limits, and cvm inventory.
2101
+ If the check fails, return the corresponding error code.
2102
+ If the check passed, return RequestId.
2103
+ false (default): sends a normal request. after passing the check, creates an instance directly.
2119
2104
  :type DryRun: bool
2120
- :param _CamRoleName: CAM role name, which can be obtained from the `roleName` field in the response of the [`DescribeRoleList`](https://intl.cloud.tencent.com/document/product/598/13887?from_cn_redirect=1) API.
2105
+ :param _CamRoleName: CAM role name. it can be obtained through the roleName in the return value from the API DescribeRoleList.
2121
2106
  :type CamRoleName: str
2122
- :param _HpcClusterId: HPC cluster ID. The HPC cluster must and can only be specified for a high-performance computing instance.
2107
+ :param _HpcClusterId: High-performance computing cluster ID. If the created instance is a high-performance computing instance, the cluster where the instance is placed should be specified. Otherwise, it cannot be specified.
2123
2108
  :type HpcClusterId: str
2124
- :param _InstanceChargeType: Instance [Billing Mode](https://intl.cloud.tencent.com/document/product/213/2180?from_cn_redirect=1). Valid values: <br><li>`PREPAID`: prepaid, i.e., billed for monthly-subscribed instances <br><li>`POSTPAID_BY_HOUR`: pay-as-you-go on an hourly basis <br><li>`CDHPAID`: billed for CDH instances, not the CVMs running on the CDHs. <br><li>`SPOTPAID`: billed for spot instances. <br>Default value: POSTPAID_BY_HOUR.
2109
+ :param _InstanceChargeType: Instance [billing mode](https://intl.cloud.tencent.com/document/product/213/2180?from_cn_redirect=1).<br><li>PREPAID: prepaid, that is, monthly subscription.</li><li>POSTPAID_BY_HOUR: pay-as-you-go by hour.</li><li>CDHPAID: CDH instance (created based on CDH; the resources of the host are free of charge).</li><li>SPOTPAID: spot payment.</li>Default value: POSTPAID_BY_HOUR.
2125
2110
  :type InstanceChargeType: str
2126
- :param _InstanceChargePrepaid: Details of the monthly subscription, including the purchase period, auto-renewal. It is required if the `InstanceChargeType` is `PREPAID`.
2111
+ :param _InstanceChargePrepaid: Prepaid mode, that is, annual and monthly subscription related parameter settings. Through this parameter, you can specify the purchase duration of annual and monthly subscription instances, whether to set auto-renewal, etc. If the specified instance's billing mode is the prepaid mode, this parameter must be passed.
2127
2112
  :type InstanceChargePrepaid: :class:`tencentcloud.cvm.v20170312.models.InstanceChargePrepaid`
2128
- :param _DisableApiTermination: Instance termination protection flag, indicating whether an instance is allowed to be deleted through an API. Valid values:<br><li>true: Instance protection is enabled, and the instance is not allowed to be deleted through the API.</li><br><li>false: Instance protection is disabled, and the instance is allowed to be deleted through the API.</li><br><br>Default value: false.
2113
+ :param _DisableApiTermination: Instance destruction protection flag: indicates whether an instance is allowed to be deleted through an api. value ranges from: - **TRUE**: indicates that instance protection is enabled, deletion through apis is not allowed. - **FALSE**: indicates that instance protection is disabled, deletion through apis is allowed. default value: FALSE.
2129
2114
  :type DisableApiTermination: bool
2130
- :param _LaunchTemplateTagSpecification: Instance launch template tag description list. By specifying the TemplateTag parameter, you can bind tags to the instance launch template.
2115
+ :param _LaunchTemplateTagSpecification: Description list of tags. by specifying this parameter, tags can be bound to the instance launch template.
2131
2116
  :type LaunchTemplateTagSpecification: list of TagSpecification
2117
+ :param _Metadata: Custom metadata. specifies that custom metadata key-value pairs can be added when creating a CVM.
2118
+ Note: this field is in beta test.
2119
+ :type Metadata: :class:`tencentcloud.cvm.v20170312.models.Metadata`
2120
+ :param _TemplateDataModifyAction: Specifies that only the Update and Replace parameters are allowed. this parameter is valid only when custom Metadata is used in the template and Metadata is also transmitted in RunInstances. defaults to Replace.
2121
+
2122
+ -Update: if template t contains this parameter with a value of Update and metadata=[k1:v1, k2:v2], then RunInstances (with metadata=[k2:v3]) + t creates a cvm using metadata=[k1:v1, k2:v3].
2123
+ -Replace: if the template t contains this parameter with a value of Replace and metadata=[k1:v1, k2:v2], then when creating a cvm using RunInstances (with metadata=[k2:v3]) + t, the created cvm will use metadata=[k2:v3].
2124
+ Note: this field is in beta test.
2125
+ :type TemplateDataModifyAction: str
2132
2126
  """
2133
2127
  self._LaunchTemplateName = None
2134
2128
  self._Placement = None
@@ -2158,10 +2152,12 @@ false (default value): send a normal request and create instance(s) if all the r
2158
2152
  self._InstanceChargePrepaid = None
2159
2153
  self._DisableApiTermination = None
2160
2154
  self._LaunchTemplateTagSpecification = None
2155
+ self._Metadata = None
2156
+ self._TemplateDataModifyAction = None
2161
2157
 
2162
2158
  @property
2163
2159
  def LaunchTemplateName(self):
2164
- """Instance launch template name. It can include 2-128 characters.
2160
+ """Name of an instance launch template. It contains 2 to 128 English or Chinese characters.
2165
2161
  :rtype: str
2166
2162
  """
2167
2163
  return self._LaunchTemplateName
@@ -2172,7 +2168,7 @@ false (default value): send a normal request and create instance(s) if all the r
2172
2168
 
2173
2169
  @property
2174
2170
  def Placement(self):
2175
- """Location of the instance. You can use this parameter to specify the attributes of the instance, such as its availability zone, project, and CDH (for dedicated CVMs)
2171
+ """Location of the instance. You can specify attributes such as availability zone, project, and host (specified when creating a instance on the CDH) to which the instance belongs through this parameter.
2176
2172
  :rtype: :class:`tencentcloud.cvm.v20170312.models.Placement`
2177
2173
  """
2178
2174
  return self._Placement
@@ -2183,7 +2179,7 @@ false (default value): send a normal request and create instance(s) if all the r
2183
2179
 
2184
2180
  @property
2185
2181
  def ImageId(self):
2186
- """The [image](https://intl.cloud.tencent.com/document/product/213/4940?from_cn_redirect=1) ID in the format of `img-xxx`. There are four types of images:<br/><li>Public images</li><li>Custom images</li><li>Shared images</li><li>Marketplace images (for Chinese mainland only)</li><br/>To check the image ID:<br/><li>For public images, custom images, and shared images, go to the [console](https://console.cloud.tencent.com/cvm/image?rid=1&imageType=PUBLIC_IMAGE). For marketplace images, go to [Cloud Marketplace](https://market.cloud.tencent.com/list). </li><li>Call [DescribeImages](https://intl.cloud.tencent.com/document/api/213/15715?from_cn_redirect=1), pass in `InstanceType` to retrieve the list of images supported by the current model, and then find the `ImageId` in the response.</li>
2182
+ """Specify an effective [mirror](https://intl.cloud.tencent.com/document/product/213/4940?from_cn_redirect=1) ID in the format of `img-xxx`. there are four image types: <li>PUBLIC image</li> <li>custom image</li> <li>shared image</li> <li>service market image</li> you can obtain available mirror ids in the following ways: <li>the mirror ids of `PUBLIC image`, `custom image` and `shared image` can be queried by logging in to the [console](https://console.cloud.tencent.com/cvm/image?rid=1&imageType=PUBLIC_image); the mirror ids of `service market image` can be queried through the [cloud market](https://market.cloud.tencent.com/list).</li> <li>call the api [DescribeImages](https://intl.cloud.tencent.com/document/api/213/15715?from_cn_redirect=1), input InstanceType to obtain the list of images supported by the current model, and take the `ImageId` field from the return information.</li>.
2187
2183
  :rtype: str
2188
2184
  """
2189
2185
  return self._ImageId
@@ -2194,7 +2190,7 @@ false (default value): send a normal request and create instance(s) if all the r
2194
2190
 
2195
2191
  @property
2196
2192
  def LaunchTemplateVersionDescription(self):
2197
- """Description of instance launch template versions. This parameter can contain 2-256 characters.
2193
+ """Version description of an instance launch template. It contains 2 to 256 English or Chinese characters.
2198
2194
  :rtype: str
2199
2195
  """
2200
2196
  return self._LaunchTemplateVersionDescription
@@ -2205,8 +2201,9 @@ false (default value): send a normal request and create instance(s) if all the r
2205
2201
 
2206
2202
  @property
2207
2203
  def InstanceType(self):
2208
- """The instance model. Different resource specifications are specified for different instance models.
2209
- <br><li>To view specific values for `PREPAID` or `POSTPAID_BY_HOUR` instances, you can call [DescribeInstanceTypeConfigs](https://intl.cloud.tencent.com/document/api/213/15749?from_cn_redirect=1) or refer to [Instance Types](https://intl.cloud.tencent.com/document/product/213/11518?from_cn_redirect=1). If this parameter is not specified, the system will specify the default model according to the dynamic resource sales in the current region. <br><li>For `CDHPAID` instances, the value of this parameter is in the format of `CDH_XCXG` based on the number of CPU cores and memory capacity. For example, if you want to create a CDH instance with a single-core CPU and 1 GB memory, you need to specify this parameter as `CDH_1C1G`.
2204
+ """Instance model. Different instance models specify different resource specifications.
2205
+
2206
+ <br><li>For instances created with the payment modes PREPAID or POSTPAID_BY_HOUR, the specific values can be obtained BY calling the [DescribeInstanceTypeConfigs](https://intl.cloud.tencent.com/document/api/213/15749?from_cn_redirect=1) api to get the latest specification table or referring to the [instance specifications](https://intl.cloud.tencent.com/document/product/213/11518?from_cn_redirect=1) description. if this parameter is not specified, the system will dynamically assign a default model based on the current resource sales situation in a region.</li><li>for instances created with the payment mode CDHPAID, this parameter has the prefix "CDH_" and is generated based on the 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>.
2210
2207
  :rtype: str
2211
2208
  """
2212
2209
  return self._InstanceType
@@ -2217,7 +2214,7 @@ false (default value): send a normal request and create instance(s) if all the r
2217
2214
 
2218
2215
  @property
2219
2216
  def SystemDisk(self):
2220
- """System disk configuration of the instance. If this parameter is not specified, the default value will be used.
2217
+ """Instance system disk configuration information. If this parameter is not specified, it will be assigned based on the system default values.
2221
2218
  :rtype: :class:`tencentcloud.cvm.v20170312.models.SystemDisk`
2222
2219
  """
2223
2220
  return self._SystemDisk
@@ -2228,7 +2225,7 @@ false (default value): send a normal request and create instance(s) if all the r
2228
2225
 
2229
2226
  @property
2230
2227
  def DataDisks(self):
2231
- """The configuration information of instance data disks. If this parameter is not specified, no data disk will be purchased by default. When purchasing, you can specify 21 data disks, which can contain at most 1 LOCAL_BASIC or LOCAL_SSD data disk, and at most 20 CLOUD_BASIC, CLOUD_PREMIUM, or CLOUD_SSD data disks.
2228
+ """Instance data disk configuration information. if not specified, no data disks are purchased by default. support specifying 21 data disks at the time of purchase, among which a maximum of 1 LOCAL_BASIC data disk or LOCAL_SSD data disk can be included, and a maximum of 20 CLOUD_BASIC data disks, CLOUD_PREMIUM data disks or CLOUD_SSD data disks can be included.
2232
2229
  :rtype: list of DataDisk
2233
2230
  """
2234
2231
  return self._DataDisks
@@ -2239,7 +2236,7 @@ false (default value): send a normal request and create instance(s) if all the r
2239
2236
 
2240
2237
  @property
2241
2238
  def VirtualPrivateCloud(self):
2242
- """Configuration information of VPC. This parameter is used to specify VPC ID and subnet ID, etc. If this parameter is not specified, the classic network is used by default. If a VPC IP is specified in this parameter, it indicates the primary ENI IP of each instance. The value of parameter InstanceCount must be same as the number of VPC IPs, which cannot be greater than 20.
2239
+ """VPC-related information configuration. You can specify information such as VPC ID and subnet ID through this parameter. If this parameter is not specified, use the basic network by default. If a VPC IP is specified in this parameter, it indicates the primary network interface card IP of each instance. In addition, the number of the InstanceCount parameter should be consistent with the number of the VPC IP and should not exceed 20.
2243
2240
  :rtype: :class:`tencentcloud.cvm.v20170312.models.VirtualPrivateCloud`
2244
2241
  """
2245
2242
  return self._VirtualPrivateCloud
@@ -2250,7 +2247,7 @@ false (default value): send a normal request and create instance(s) if all the r
2250
2247
 
2251
2248
  @property
2252
2249
  def InternetAccessible(self):
2253
- """Configuration of public network bandwidth. If this parameter is not specified, 0 Mbps will be used by default.
2250
+ """Public bandwidth-related settings. If this parameter is not specified, the public bandwidth is 0 Mbps by default.
2254
2251
  :rtype: :class:`tencentcloud.cvm.v20170312.models.InternetAccessible`
2255
2252
  """
2256
2253
  return self._InternetAccessible
@@ -2261,7 +2258,7 @@ false (default value): send a normal request and create instance(s) if all the r
2261
2258
 
2262
2259
  @property
2263
2260
  def InstanceCount(self):
2264
- """Number of instances to be purchased. Value range for monthly-subscribed instances: [1, 300]. Value range for pay-as-you-go instances: [1, 100]. Default value: 1. The specified number of instances to be purchased cannot exceed the remaining quota allowed for the user. For more information on quota, see CVM instance [Purchase Limits](https://intl.cloud.tencent.com/document/product/213/2664).
2261
+ """Number of instances to purchase. value range for monthly subscription instances: [1, 300]. value range for pay-as-you-go instances: [1, 100]. default value: 1. the number of instances to purchase must not exceed the remaining user quota. for specific quota limitations, see [CVM instance purchase limitations](https://intl.cloud.tencent.com/document/product/213/2664?from_cn_redirect=1).
2265
2262
  :rtype: int
2266
2263
  """
2267
2264
  return self._InstanceCount
@@ -2272,7 +2269,7 @@ false (default value): send a normal request and create instance(s) if all the r
2272
2269
 
2273
2270
  @property
2274
2271
  def InstanceName(self):
2275
- """Instance name to be displayed. <br><li>If this parameter is not specified, "Unnamed" will be displayed by default. </li><li>If you purchase multiple instances at the same time and specify a pattern string `{R:x}`, numbers `[x, x+n-1]` will be generated, where `n` represents the number of instances purchased. For example, you specify a pattern string, `server_{R:3}`. If you only purchase 1 instance, the instance will be named `server_3`; if you purchase 2, they will be named `server_3` and `server_4`. You can specify multiple pattern strings in the format of `{R:x}`. </li><li>If you purchase multiple instances at the same time and do not specify a pattern string, the instance names will be suffixed by `1, 2...n`, where `n` represents the number of instances purchased. For example, if you purchase 2 instances and the instance name body is `server_`, the instance names will be `server_1` and `server_2`. </li><li>This parameter can contain up to 60 characters, including the pattern string.
2272
+ """Instance display name. <li>if the instance display name is not specified, it will display by default as 'unnamed'.</li> <li>when purchasing multiple instances, if the pattern string `{R:x}` is specified, it indicates generating numbers `[x, x+n-1]`, where `n` represents the number of purchased instances. for example, `server_{R:3}` will result in instance display names as `server_3` when purchasing 1 instance; when purchasing 2 instances, the instance display names will be `server_3` and `server_4` respectively. it supports specifying multiple pattern strings `{R:x}`.</li> <li>when purchasing multiple instances, if no pattern string is specified, a suffix `1, 2...n` will be added to the instance display name, where `n` represents the number of purchased instances. for example, for `server_`, when purchasing 2 instances, the instance display names will be `server_1` and `server_2` respectively.</li> <li>it supports up to 128 characters (including pattern strings).</li>.
2276
2273
  :rtype: str
2277
2274
  """
2278
2275
  return self._InstanceName
@@ -2283,7 +2280,7 @@ false (default value): send a normal request and create instance(s) if all the r
2283
2280
 
2284
2281
  @property
2285
2282
  def LoginSettings(self):
2286
- """Login settings of the instance. You can use this parameter to set the login method, password, and key of the instance or keep the login settings of the original image. By default, a random password will be generated and sent to you via the Message Center.
2283
+ """Instance login settings. this parameter allows you to set the instance login method to key or maintain the original login settings of the image.
2287
2284
  :rtype: :class:`tencentcloud.cvm.v20170312.models.LoginSettings`
2288
2285
  """
2289
2286
  return self._LoginSettings
@@ -2294,7 +2291,7 @@ false (default value): send a normal request and create instance(s) if all the r
2294
2291
 
2295
2292
  @property
2296
2293
  def SecurityGroupIds(self):
2297
- """Security groups to which the instance belongs. To obtain the security group IDs, you can call [DescribeSecurityGroups](https://intl.cloud.tencent.com/document/api/215/15808) and look for the `sgld` fields in the response. If this parameter is not specified, the instance will be associated with default security groups.
2294
+ """Security group to which an instance belongs. this parameter can be obtained by calling the sgId field in the returned value of [DescribeSecurityGroups](https://intl.cloud.tencent.com/document/api/215/15808?from_cn_redirect=1). if not specified, the default security group is bound.
2298
2295
  :rtype: list of str
2299
2296
  """
2300
2297
  return self._SecurityGroupIds
@@ -2305,7 +2302,7 @@ false (default value): send a normal request and create instance(s) if all the r
2305
2302
 
2306
2303
  @property
2307
2304
  def EnhancedService(self):
2308
- """Enhanced service. You can use this parameter to specify whether to enable services such as Anti-DDoS and Cloud Monitor. If this parameter is not specified, Cloud Monitor and Anti-DDoS are enabled for public images by default. However, for custom images and images from the marketplace, Anti-DDoS and Cloud Monitor are not enabled by default. The original services in the image will be retained.
2305
+ """Enhanced services. You can specify whether to enable services such as Cloud Security and Cloud Monitor through this parameter. If this parameter is not specified, Cloud Monitor and Cloud Security are enabled for public images by default, but not enabled for custom images and marketplace images by default. Instead, they use services retained in the images.
2309
2306
  :rtype: :class:`tencentcloud.cvm.v20170312.models.EnhancedService`
2310
2307
  """
2311
2308
  return self._EnhancedService
@@ -2316,7 +2313,7 @@ false (default value): send a normal request and create instance(s) if all the r
2316
2313
 
2317
2314
  @property
2318
2315
  def ClientToken(self):
2319
- """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.
2316
+ """A string used to ensure the idempotence of the request. This string is generated by the customer and should be unique across different requests, with a maximum length of 64 ASCII characters. If this parameter is not specified, the idempotence of the request cannot be guaranteed.
2320
2317
  :rtype: str
2321
2318
  """
2322
2319
  return self._ClientToken
@@ -2327,7 +2324,7 @@ false (default value): send a normal request and create instance(s) if all the r
2327
2324
 
2328
2325
  @property
2329
2326
  def HostName(self):
2330
- """Host name of the CVM. <br><li>Dots (.) or hyphens (-) cannot be the start or end of a host name or appear consecutively in a host name. <br><li>For Windows instances, the host name must be 2-15 characters long and can contain uppercase and lowercase letters, numbers, and hyphens (-). It cannot contain dots (.) or contain only numbers. <br><li>For other instances, such as Linux instances, the host name must be 2-60 characters long. It supports multiple dots (.) and allows uppercase and lowercase letters, numbers, and hyphens (-) between any two dots (.).
2327
+ """Specifies the HostName of the cloud virtual machine.<br><li>the dot (.) and hyphen (-) cannot be used at the beginning or end of the HostName, and cannot be used consecutively.</li><li>for Windows instances: the character length is 2 to 15. it consists of letters (case insensitive), digits, and hyphens (-). dots (.) are not supported, and it cannot be all digits.</li><li>for other types (such as Linux) instances: the character length is 2 to 60. multiple dots are allowed. each segment between dots can include letters (case insensitive), digits, and hyphens (-).</li>.
2331
2328
  :rtype: str
2332
2329
  """
2333
2330
  return self._HostName
@@ -2338,7 +2335,7 @@ false (default value): send a normal request and create instance(s) if all the r
2338
2335
 
2339
2336
  @property
2340
2337
  def ActionTimer(self):
2341
- """Scheduled tasks. You can use this parameter to specify scheduled tasks for the instance. Only scheduled termination is supported.
2338
+ """Scheduled task. You can specify a scheduled task for the instance through this parameter. Currently, only scheduled termination is supported.
2342
2339
  :rtype: :class:`tencentcloud.cvm.v20170312.models.ActionTimer`
2343
2340
  """
2344
2341
  return self._ActionTimer
@@ -2349,7 +2346,7 @@ false (default value): send a normal request and create instance(s) if all the r
2349
2346
 
2350
2347
  @property
2351
2348
  def DisasterRecoverGroupIds(self):
2352
- """Placement group ID. You can only specify one.
2349
+ """Placement group ID. Only one can be specified.
2353
2350
  :rtype: list of str
2354
2351
  """
2355
2352
  return self._DisasterRecoverGroupIds
@@ -2360,7 +2357,7 @@ false (default value): send a normal request and create instance(s) if all the r
2360
2357
 
2361
2358
  @property
2362
2359
  def TagSpecification(self):
2363
- """The tag description list. This parameter is used to bind a tag to a resource instance. A tag can only be bound to CVM instances.
2360
+ """List of tag descriptions. You can bind tags to corresponding resource instances at the same time by specifying this parameter. Currently, only binding tags to the CVM is supported.
2364
2361
  :rtype: list of TagSpecification
2365
2362
  """
2366
2363
  return self._TagSpecification
@@ -2371,7 +2368,7 @@ false (default value): send a normal request and create instance(s) if all the r
2371
2368
 
2372
2369
  @property
2373
2370
  def InstanceMarketOptions(self):
2374
- """Market options of the instance, such as parameters related to spot instances. This parameter is required for spot instances.
2371
+ """Market-Related options of the instance, such as relevant parameters of the bidding instance. this parameter is required if the payment mode of the specified instance is spot payment.
2375
2372
  :rtype: :class:`tencentcloud.cvm.v20170312.models.InstanceMarketOptionsRequest`
2376
2373
  """
2377
2374
  return self._InstanceMarketOptions
@@ -2382,7 +2379,7 @@ false (default value): send a normal request and create instance(s) if all the r
2382
2379
 
2383
2380
  @property
2384
2381
  def UserData(self):
2385
- """User data provided to the instance. This parameter needs to be encoded in base64 format with the maximum size of 16KB. For more information on how to get the value of this parameter, see the commands you need to execute on startup for [Windows](https://intl.cloud.tencent.com/document/product/213/17526) or [Linux](https://intl.cloud.tencent.com/document/product/213/17525).
2382
+ """User data provided for an instance must be encoded in base64. valid values for maximum data size are up to 16 KB. for details on obtaining this parameter, see running commands at startup for Windows (https://intl.cloud.tencent.com/document/product/213/17526?from_cn_redirect=1) and Linux (https://intl.cloud.tencent.com/document/product/213/17525?from_cn_redirect=1).
2386
2383
  :rtype: str
2387
2384
  """
2388
2385
  return self._UserData
@@ -2393,11 +2390,11 @@ false (default value): send a normal request and create instance(s) if all the r
2393
2390
 
2394
2391
  @property
2395
2392
  def DryRun(self):
2396
- """Whether the request is a dry run only.
2397
- true: dry run only. The request will not create instance(s). A dry run can check whether all the required parameters are specified, whether the request format is right, whether the request exceeds service limits, and whether the specified CVMs are available.
2398
- If the dry run fails, the corresponding error code will be returned.
2399
- If the dry run succeeds, the RequestId will be returned.
2400
- false (default value): send a normal request and create instance(s) if all the requirements are met.
2393
+ """Whether it is a pre-check for this request only.
2394
+ true: sends a check request without creating an instance. check items include whether required parameters are filled in, request format, service limits, and cvm inventory.
2395
+ If the check fails, return the corresponding error code.
2396
+ If the check passed, return RequestId.
2397
+ false (default): sends a normal request. after passing the check, creates an instance directly.
2401
2398
  :rtype: bool
2402
2399
  """
2403
2400
  return self._DryRun
@@ -2408,7 +2405,7 @@ false (default value): send a normal request and create instance(s) if all the r
2408
2405
 
2409
2406
  @property
2410
2407
  def CamRoleName(self):
2411
- """CAM role name, which can be obtained from the `roleName` field in the response of the [`DescribeRoleList`](https://intl.cloud.tencent.com/document/product/598/13887?from_cn_redirect=1) API.
2408
+ """CAM role name. it can be obtained through the roleName in the return value from the API DescribeRoleList.
2412
2409
  :rtype: str
2413
2410
  """
2414
2411
  return self._CamRoleName
@@ -2419,7 +2416,7 @@ false (default value): send a normal request and create instance(s) if all the r
2419
2416
 
2420
2417
  @property
2421
2418
  def HpcClusterId(self):
2422
- """HPC cluster ID. The HPC cluster must and can only be specified for a high-performance computing instance.
2419
+ """High-performance computing cluster ID. If the created instance is a high-performance computing instance, the cluster where the instance is placed should be specified. Otherwise, it cannot be specified.
2423
2420
  :rtype: str
2424
2421
  """
2425
2422
  return self._HpcClusterId
@@ -2430,7 +2427,7 @@ false (default value): send a normal request and create instance(s) if all the r
2430
2427
 
2431
2428
  @property
2432
2429
  def InstanceChargeType(self):
2433
- """Instance [Billing Mode](https://intl.cloud.tencent.com/document/product/213/2180?from_cn_redirect=1). Valid values: <br><li>`PREPAID`: prepaid, i.e., billed for monthly-subscribed instances <br><li>`POSTPAID_BY_HOUR`: pay-as-you-go on an hourly basis <br><li>`CDHPAID`: billed for CDH instances, not the CVMs running on the CDHs. <br><li>`SPOTPAID`: billed for spot instances. <br>Default value: POSTPAID_BY_HOUR.
2430
+ """Instance [billing mode](https://intl.cloud.tencent.com/document/product/213/2180?from_cn_redirect=1).<br><li>PREPAID: prepaid, that is, monthly subscription.</li><li>POSTPAID_BY_HOUR: pay-as-you-go by hour.</li><li>CDHPAID: CDH instance (created based on CDH; the resources of the host are free of charge).</li><li>SPOTPAID: spot payment.</li>Default value: POSTPAID_BY_HOUR.
2434
2431
  :rtype: str
2435
2432
  """
2436
2433
  return self._InstanceChargeType
@@ -2441,7 +2438,7 @@ false (default value): send a normal request and create instance(s) if all the r
2441
2438
 
2442
2439
  @property
2443
2440
  def InstanceChargePrepaid(self):
2444
- """Details of the monthly subscription, including the purchase period, auto-renewal. It is required if the `InstanceChargeType` is `PREPAID`.
2441
+ """Prepaid mode, that is, annual and monthly subscription related parameter settings. Through this parameter, you can specify the purchase duration of annual and monthly subscription instances, whether to set auto-renewal, etc. If the specified instance's billing mode is the prepaid mode, this parameter must be passed.
2445
2442
  :rtype: :class:`tencentcloud.cvm.v20170312.models.InstanceChargePrepaid`
2446
2443
  """
2447
2444
  return self._InstanceChargePrepaid
@@ -2452,7 +2449,7 @@ false (default value): send a normal request and create instance(s) if all the r
2452
2449
 
2453
2450
  @property
2454
2451
  def DisableApiTermination(self):
2455
- """Instance termination protection flag, indicating whether an instance is allowed to be deleted through an API. Valid values:<br><li>true: Instance protection is enabled, and the instance is not allowed to be deleted through the API.</li><br><li>false: Instance protection is disabled, and the instance is allowed to be deleted through the API.</li><br><br>Default value: false.
2452
+ """Instance destruction protection flag: indicates whether an instance is allowed to be deleted through an api. value ranges from: - **TRUE**: indicates that instance protection is enabled, deletion through apis is not allowed. - **FALSE**: indicates that instance protection is disabled, deletion through apis is allowed. default value: FALSE.
2456
2453
  :rtype: bool
2457
2454
  """
2458
2455
  return self._DisableApiTermination
@@ -2463,7 +2460,7 @@ false (default value): send a normal request and create instance(s) if all the r
2463
2460
 
2464
2461
  @property
2465
2462
  def LaunchTemplateTagSpecification(self):
2466
- """Instance launch template tag description list. By specifying the TemplateTag parameter, you can bind tags to the instance launch template.
2463
+ """Description list of tags. by specifying this parameter, tags can be bound to the instance launch template.
2467
2464
  :rtype: list of TagSpecification
2468
2465
  """
2469
2466
  return self._LaunchTemplateTagSpecification
@@ -2472,6 +2469,33 @@ false (default value): send a normal request and create instance(s) if all the r
2472
2469
  def LaunchTemplateTagSpecification(self, LaunchTemplateTagSpecification):
2473
2470
  self._LaunchTemplateTagSpecification = LaunchTemplateTagSpecification
2474
2471
 
2472
+ @property
2473
+ def Metadata(self):
2474
+ """Custom metadata. specifies that custom metadata key-value pairs can be added when creating a CVM.
2475
+ Note: this field is in beta test.
2476
+ :rtype: :class:`tencentcloud.cvm.v20170312.models.Metadata`
2477
+ """
2478
+ return self._Metadata
2479
+
2480
+ @Metadata.setter
2481
+ def Metadata(self, Metadata):
2482
+ self._Metadata = Metadata
2483
+
2484
+ @property
2485
+ def TemplateDataModifyAction(self):
2486
+ """Specifies that only the Update and Replace parameters are allowed. this parameter is valid only when custom Metadata is used in the template and Metadata is also transmitted in RunInstances. defaults to Replace.
2487
+
2488
+ -Update: if template t contains this parameter with a value of Update and metadata=[k1:v1, k2:v2], then RunInstances (with metadata=[k2:v3]) + t creates a cvm using metadata=[k1:v1, k2:v3].
2489
+ -Replace: if the template t contains this parameter with a value of Replace and metadata=[k1:v1, k2:v2], then when creating a cvm using RunInstances (with metadata=[k2:v3]) + t, the created cvm will use metadata=[k2:v3].
2490
+ Note: this field is in beta test.
2491
+ :rtype: str
2492
+ """
2493
+ return self._TemplateDataModifyAction
2494
+
2495
+ @TemplateDataModifyAction.setter
2496
+ def TemplateDataModifyAction(self, TemplateDataModifyAction):
2497
+ self._TemplateDataModifyAction = TemplateDataModifyAction
2498
+
2475
2499
 
2476
2500
  def _deserialize(self, params):
2477
2501
  self._LaunchTemplateName = params.get("LaunchTemplateName")
@@ -2535,6 +2559,10 @@ false (default value): send a normal request and create instance(s) if all the r
2535
2559
  obj = TagSpecification()
2536
2560
  obj._deserialize(item)
2537
2561
  self._LaunchTemplateTagSpecification.append(obj)
2562
+ if params.get("Metadata") is not None:
2563
+ self._Metadata = Metadata()
2564
+ self._Metadata._deserialize(params.get("Metadata"))
2565
+ self._TemplateDataModifyAction = params.get("TemplateDataModifyAction")
2538
2566
  memeber_set = set(params.keys())
2539
2567
  for name, value in vars(self).items():
2540
2568
  property_name = name[1:]
@@ -2552,7 +2580,7 @@ class CreateLaunchTemplateResponse(AbstractModel):
2552
2580
 
2553
2581
  def __init__(self):
2554
2582
  r"""
2555
- :param _LaunchTemplateId: The ID of successfully created instance launch template. This parameter will be returned when the instance launch template is created through the `CreateLaunchTemplate` API.
2583
+ :param _LaunchTemplateId: Specifies the ID of the successfully created instance launch template when this parameter is returned by creating an instance launch template through this interface.
2556
2584
  :type LaunchTemplateId: str
2557
2585
  :param _RequestId: 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.
2558
2586
  :type RequestId: str
@@ -2562,7 +2590,7 @@ class CreateLaunchTemplateResponse(AbstractModel):
2562
2590
 
2563
2591
  @property
2564
2592
  def LaunchTemplateId(self):
2565
- """The ID of successfully created instance launch template. This parameter will be returned when the instance launch template is created through the `CreateLaunchTemplate` API.
2593
+ """Specifies the ID of the successfully created instance launch template when this parameter is returned by creating an instance launch template through this interface.
2566
2594
  :rtype: str
2567
2595
  """
2568
2596
  return self._LaunchTemplateId
@@ -2607,7 +2635,7 @@ class CreateLaunchTemplateVersionRequest(AbstractModel):
2607
2635
 
2608
2636
  <br><li>For instances created with the payment modes PREPAID or POSTPAID_BY_HOUR, the specific values can be obtained by calling the [DescribeInstanceTypeConfigs](https://intl.cloud.tencent.com/document/api/213/15749?from_cn_redirect=1) API for the latest specification table or referring to [Instance Specifications](https://intl.cloud.tencent.com/document/product/213/11518?from_cn_redirect=1). If this parameter is 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, this parameter has the prefix "CDH_" and is generated based on the 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>
2609
2637
  :type InstanceType: str
2610
- :param _ImageId: The [image](https://intl.cloud.tencent.com/document/product/213/4940?from_cn_redirect=1) ID in the format of `img-xxx`. There are four types of images:<br/><li>Public images</li><li>Custom images</li><li>Shared images</li><li>Marketplace images (for Chinese mainland only)</li><br/>To check the image ID:<br/><li>For public images, custom images, and shared images, go to the [console](https://console.cloud.tencent.com/cvm/image?rid=1&imageType=PUBLIC_IMAGE). For marketplace images, go to [Cloud Marketplace](https://market.cloud.tencent.com/list). </li><li>Call [DescribeImages](https://intl.cloud.tencent.com/document/api/213/15715?from_cn_redirect=1), pass in `InstanceType` to retrieve the list of images supported by the current model, and then find the `ImageId` in the response.</li>
2638
+ :param _ImageId: Assign an effective [mirror](https://intl.cloud.tencent.com/document/product/213/4940?from_cn_redirect=1) ID in the format like `img-xxx`. there are four image types: <br/><li>PUBLIC image</li><li>custom image</li><li>shared image</li><li>cloud image market</li><br/>you can obtain available mirror ids in the following ways: <br/><li>the mirror ids of `PUBLIC image`, `custom image` and `shared image` can be queried by logging in to the [console](https://console.cloud.tencent.com/cvm/image?rid=1&imageType=PUBLIC_image); the mirror ID of `cloud image market` can be queried through the [cloud market](https://market.cloud.tencent.com/list).</li><li>call the api [DescribeImages](https://intl.cloud.tencent.com/document/api/213/15715?from_cn_redirect=1), input InstanceType to obtain the list of images supported by the current model, and take the `ImageId` field from the return information.</li>.
2611
2639
  :type ImageId: str
2612
2640
  :param _SystemDisk: System disk configuration of the instance. If this parameter is not specified, the default value will be used.
2613
2641
  :type SystemDisk: :class:`tencentcloud.cvm.v20170312.models.SystemDisk`
@@ -2619,13 +2647,13 @@ class CreateLaunchTemplateVersionRequest(AbstractModel):
2619
2647
  :type InternetAccessible: :class:`tencentcloud.cvm.v20170312.models.InternetAccessible`
2620
2648
  :param _InstanceCount: Number of instances to be purchased. Value range for monthly-subscribed instances: [1, 300]. Value range for pay-as-you-go instances: [1, 100]. Default value: 1. The specified number of instances to be purchased cannot exceed the remaining quota allowed for the user. For more information on quota, see CVM instance [Purchase Limits](https://intl.cloud.tencent.com/document/product/213/2664).
2621
2649
  :type InstanceCount: int
2622
- :param _InstanceName: Instance name.<br><li>If this parameter is not specified, "Unnamed" will be displayed by default.</li><li>If you purchase multiple instances and specify a pattern string `{R:x}`, numbers `[x, x+n-1]` will be generated, where `n` represents the number of instances purchased. For example, you specify a pattern string `server_{R:3}`. If you purchase only one instance, the instance will be named `server_3`; if you purchase two, they will be named `server_3` and `server_4`. You can specify multiple pattern strings in the format of `{R:x}`.</li><li>If you purchase multiple instances without specifying a pattern string, the instance names will be suffixed with `1, 2...n`, where `n` represents the number of instances purchased. For example, if you purchase two instances with the name `server_`, the instance names will be `server_1` and `server_2`.</li><li>This parameter can contain up to 60 characters (including pattern strings).</li>
2650
+ :param _InstanceName: Instance display name. <li>if the instance display name is not specified, it will display by default as 'unnamed'.</li> <li>when purchasing multiple instances, if the pattern string `{R:x}` is specified, it indicates generating numbers `[x, x+n-1]`, where `n` represents the number of purchased instances. for example, `server_{R:3}` will result in instance display names as `server_3` when purchasing 1 instance; when purchasing 2 instances, the instance display names will be `server_3` and `server_4` respectively. it supports specifying multiple pattern strings `{R:x}`.</li> <li>when purchasing multiple instances, if no pattern string is specified, a suffix `1, 2...n` will be added to the instance display name, where `n` represents the number of purchased instances. for example, for `server_`, when purchasing 2 instances, the instance display names will be `server_1` and `server_2` respectively.</li> <li>it supports up to 128 characters (including pattern strings).</li>.
2623
2651
  :type InstanceName: str
2624
- :param _LoginSettings: Login settings of the instance. You can use this parameter to set the login method, password, and key of the instance or keep the login settings of the original image. By default, a random password will be generated and sent to you via the Message Center.
2652
+ :param _LoginSettings: Instance login settings. you can use this parameter to set the instance's login method to key or keep the original login settings of the image.
2625
2653
  :type LoginSettings: :class:`tencentcloud.cvm.v20170312.models.LoginSettings`
2626
2654
  :param _SecurityGroupIds: Security groups to which the instance belongs. To obtain the security group IDs, you can call [DescribeSecurityGroups](https://intl.cloud.tencent.com/document/api/215/15808) and look for the `sgld` fields in the response. If this parameter is not specified, the instance will be associated with default security groups.
2627
2655
  :type SecurityGroupIds: list of str
2628
- :param _EnhancedService: Enhanced service. You can use this parameter to specify whether to enable services such as Anti-DDoS and Cloud Monitor. If this parameter is not specified, Cloud Monitor and Anti-DDoS are enabled for public images by default. However, for custom images and images from the marketplace, Anti-DDoS and Cloud Monitor are not enabled by default. The original services in the image will be retained.
2656
+ :param _EnhancedService: Enhanced service. this parameter can be used to specify whether to enable services such as cloud security and cloud monitoring. if this parameter is not specified, cloud monitor and cloud security services are enabled for public images by default; for custom images and marketplace images, cloud monitor and cloud security services are not enabled by default, and the services retained in the image will be used.
2629
2657
  :type EnhancedService: :class:`tencentcloud.cvm.v20170312.models.EnhancedService`
2630
2658
  :param _ClientToken: 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.
2631
2659
  :type ClientToken: str
@@ -2657,6 +2685,15 @@ If the dry run succeeds, the RequestId will be returned.
2657
2685
  :type InstanceChargePrepaid: :class:`tencentcloud.cvm.v20170312.models.InstanceChargePrepaid`
2658
2686
  :param _DisableApiTermination: Instance termination protection flag, indicating whether an instance is allowed to be deleted through an API. Valid values:<br><li>TRUE: Instance protection is enabled, and the instance is not allowed to be deleted through the API.</li><br><li>FALSE: Instance protection is disabled, and the instance is allowed to be deleted through the API.</li><br><br>Default value: FALSE.
2659
2687
  :type DisableApiTermination: bool
2688
+ :param _Metadata: Custom metadata. specifies that custom metadata key-value pairs can be added when creating a CVM.
2689
+ Note: this field is in beta test.
2690
+ :type Metadata: :class:`tencentcloud.cvm.v20170312.models.Metadata`
2691
+ :param _TemplateDataModifyAction: Specifies that only the Update and Replace parameters are allowed. this parameter is valid only when custom Metadata is used in the template and Metadata is also transmitted in RunInstances. defaults to Replace.
2692
+
2693
+ -Update: if template t contains this parameter with a value of Update and metadata=[k1:v1, k2:v2], then RunInstances (with metadata=[k2:v3]) + t creates a cvm using metadata=[k1:v1, k2:v3].
2694
+ -Replace: if the template t contains this parameter with a value of Replace and metadata=[k1:v1, k2:v2], then when creating a cvm using RunInstances (with metadata=[k2:v3]) + t, the created cvm will use metadata=[k2:v3].
2695
+ Note: this field is in beta test.
2696
+ :type TemplateDataModifyAction: str
2660
2697
  """
2661
2698
  self._Placement = None
2662
2699
  self._LaunchTemplateId = None
@@ -2686,6 +2723,8 @@ If the dry run succeeds, the RequestId will be returned.
2686
2723
  self._InstanceChargeType = None
2687
2724
  self._InstanceChargePrepaid = None
2688
2725
  self._DisableApiTermination = None
2726
+ self._Metadata = None
2727
+ self._TemplateDataModifyAction = None
2689
2728
 
2690
2729
  @property
2691
2730
  def Placement(self):
@@ -2746,7 +2785,7 @@ If the dry run succeeds, the RequestId will be returned.
2746
2785
 
2747
2786
  @property
2748
2787
  def ImageId(self):
2749
- """The [image](https://intl.cloud.tencent.com/document/product/213/4940?from_cn_redirect=1) ID in the format of `img-xxx`. There are four types of images:<br/><li>Public images</li><li>Custom images</li><li>Shared images</li><li>Marketplace images (for Chinese mainland only)</li><br/>To check the image ID:<br/><li>For public images, custom images, and shared images, go to the [console](https://console.cloud.tencent.com/cvm/image?rid=1&imageType=PUBLIC_IMAGE). For marketplace images, go to [Cloud Marketplace](https://market.cloud.tencent.com/list). </li><li>Call [DescribeImages](https://intl.cloud.tencent.com/document/api/213/15715?from_cn_redirect=1), pass in `InstanceType` to retrieve the list of images supported by the current model, and then find the `ImageId` in the response.</li>
2788
+ """Assign an effective [mirror](https://intl.cloud.tencent.com/document/product/213/4940?from_cn_redirect=1) ID in the format like `img-xxx`. there are four image types: <br/><li>PUBLIC image</li><li>custom image</li><li>shared image</li><li>cloud image market</li><br/>you can obtain available mirror ids in the following ways: <br/><li>the mirror ids of `PUBLIC image`, `custom image` and `shared image` can be queried by logging in to the [console](https://console.cloud.tencent.com/cvm/image?rid=1&imageType=PUBLIC_image); the mirror ID of `cloud image market` can be queried through the [cloud market](https://market.cloud.tencent.com/list).</li><li>call the api [DescribeImages](https://intl.cloud.tencent.com/document/api/213/15715?from_cn_redirect=1), input InstanceType to obtain the list of images supported by the current model, and take the `ImageId` field from the return information.</li>.
2750
2789
  :rtype: str
2751
2790
  """
2752
2791
  return self._ImageId
@@ -2812,7 +2851,7 @@ If the dry run succeeds, the RequestId will be returned.
2812
2851
 
2813
2852
  @property
2814
2853
  def InstanceName(self):
2815
- """Instance name.<br><li>If this parameter is not specified, "Unnamed" will be displayed by default.</li><li>If you purchase multiple instances and specify a pattern string `{R:x}`, numbers `[x, x+n-1]` will be generated, where `n` represents the number of instances purchased. For example, you specify a pattern string `server_{R:3}`. If you purchase only one instance, the instance will be named `server_3`; if you purchase two, they will be named `server_3` and `server_4`. You can specify multiple pattern strings in the format of `{R:x}`.</li><li>If you purchase multiple instances without specifying a pattern string, the instance names will be suffixed with `1, 2...n`, where `n` represents the number of instances purchased. For example, if you purchase two instances with the name `server_`, the instance names will be `server_1` and `server_2`.</li><li>This parameter can contain up to 60 characters (including pattern strings).</li>
2854
+ """Instance display name. <li>if the instance display name is not specified, it will display by default as 'unnamed'.</li> <li>when purchasing multiple instances, if the pattern string `{R:x}` is specified, it indicates generating numbers `[x, x+n-1]`, where `n` represents the number of purchased instances. for example, `server_{R:3}` will result in instance display names as `server_3` when purchasing 1 instance; when purchasing 2 instances, the instance display names will be `server_3` and `server_4` respectively. it supports specifying multiple pattern strings `{R:x}`.</li> <li>when purchasing multiple instances, if no pattern string is specified, a suffix `1, 2...n` will be added to the instance display name, where `n` represents the number of purchased instances. for example, for `server_`, when purchasing 2 instances, the instance display names will be `server_1` and `server_2` respectively.</li> <li>it supports up to 128 characters (including pattern strings).</li>.
2816
2855
  :rtype: str
2817
2856
  """
2818
2857
  return self._InstanceName
@@ -2823,7 +2862,7 @@ If the dry run succeeds, the RequestId will be returned.
2823
2862
 
2824
2863
  @property
2825
2864
  def LoginSettings(self):
2826
- """Login settings of the instance. You can use this parameter to set the login method, password, and key of the instance or keep the login settings of the original image. By default, a random password will be generated and sent to you via the Message Center.
2865
+ """Instance login settings. you can use this parameter to set the instance's login method to key or keep the original login settings of the image.
2827
2866
  :rtype: :class:`tencentcloud.cvm.v20170312.models.LoginSettings`
2828
2867
  """
2829
2868
  return self._LoginSettings
@@ -2845,7 +2884,7 @@ If the dry run succeeds, the RequestId will be returned.
2845
2884
 
2846
2885
  @property
2847
2886
  def EnhancedService(self):
2848
- """Enhanced service. You can use this parameter to specify whether to enable services such as Anti-DDoS and Cloud Monitor. If this parameter is not specified, Cloud Monitor and Anti-DDoS are enabled for public images by default. However, for custom images and images from the marketplace, Anti-DDoS and Cloud Monitor are not enabled by default. The original services in the image will be retained.
2887
+ """Enhanced service. this parameter can be used to specify whether to enable services such as cloud security and cloud monitoring. if this parameter is not specified, cloud monitor and cloud security services are enabled for public images by default; for custom images and marketplace images, cloud monitor and cloud security services are not enabled by default, and the services retained in the image will be used.
2849
2888
  :rtype: :class:`tencentcloud.cvm.v20170312.models.EnhancedService`
2850
2889
  """
2851
2890
  return self._EnhancedService
@@ -3001,6 +3040,33 @@ If the dry run succeeds, the RequestId will be returned.
3001
3040
  def DisableApiTermination(self, DisableApiTermination):
3002
3041
  self._DisableApiTermination = DisableApiTermination
3003
3042
 
3043
+ @property
3044
+ def Metadata(self):
3045
+ """Custom metadata. specifies that custom metadata key-value pairs can be added when creating a CVM.
3046
+ Note: this field is in beta test.
3047
+ :rtype: :class:`tencentcloud.cvm.v20170312.models.Metadata`
3048
+ """
3049
+ return self._Metadata
3050
+
3051
+ @Metadata.setter
3052
+ def Metadata(self, Metadata):
3053
+ self._Metadata = Metadata
3054
+
3055
+ @property
3056
+ def TemplateDataModifyAction(self):
3057
+ """Specifies that only the Update and Replace parameters are allowed. this parameter is valid only when custom Metadata is used in the template and Metadata is also transmitted in RunInstances. defaults to Replace.
3058
+
3059
+ -Update: if template t contains this parameter with a value of Update and metadata=[k1:v1, k2:v2], then RunInstances (with metadata=[k2:v3]) + t creates a cvm using metadata=[k1:v1, k2:v3].
3060
+ -Replace: if the template t contains this parameter with a value of Replace and metadata=[k1:v1, k2:v2], then when creating a cvm using RunInstances (with metadata=[k2:v3]) + t, the created cvm will use metadata=[k2:v3].
3061
+ Note: this field is in beta test.
3062
+ :rtype: str
3063
+ """
3064
+ return self._TemplateDataModifyAction
3065
+
3066
+ @TemplateDataModifyAction.setter
3067
+ def TemplateDataModifyAction(self, TemplateDataModifyAction):
3068
+ self._TemplateDataModifyAction = TemplateDataModifyAction
3069
+
3004
3070
 
3005
3071
  def _deserialize(self, params):
3006
3072
  if params.get("Placement") is not None:
@@ -3059,6 +3125,10 @@ If the dry run succeeds, the RequestId will be returned.
3059
3125
  self._InstanceChargePrepaid = InstanceChargePrepaid()
3060
3126
  self._InstanceChargePrepaid._deserialize(params.get("InstanceChargePrepaid"))
3061
3127
  self._DisableApiTermination = params.get("DisableApiTermination")
3128
+ if params.get("Metadata") is not None:
3129
+ self._Metadata = Metadata()
3130
+ self._Metadata._deserialize(params.get("Metadata"))
3131
+ self._TemplateDataModifyAction = params.get("TemplateDataModifyAction")
3062
3132
  memeber_set = set(params.keys())
3063
3133
  for name, value in vars(self).items():
3064
3134
  property_name = name[1:]
@@ -3119,54 +3189,33 @@ class DataDisk(AbstractModel):
3119
3189
 
3120
3190
  def __init__(self):
3121
3191
  r"""
3122
- :param _DiskSize: Data disk size (in GB). The minimum adjustment increment is 10 GB. The value range varies by data disk type. For more information on limits, see [Storage Overview](https://intl.cloud.tencent.com/document/product/213/4952?from_cn_redirect=1). The default value is 0, indicating that no data disk is purchased. For more information, see the product documentation.
3192
+ :param _DiskSize: Data disk size, unit: GiB. the minimum adjustment step size is 10 GiB. the value ranges of different data disk types vary. for specific limitations, see the storage overview (https://intl.cloud.tencent.com/document/product/213/4952?from_cn_redirect=1). the default value is 0, which means no data disk purchase. for more restrictions, see the product document.
3123
3193
  :type DiskSize: int
3124
3194
  :param _DiskType: Data disk type. For the detailed restrictions on the data disk type, refer to [Storage Overview](https://cloud.tencent.com/document/product/213/4952). Valid values: <br /><li>LOCAL_BASIC: Local Disk <br /><li>LOCAL_SSD: Local SSD <br /><li>LOCAL_NVME: Local NVMe Disk, which is strongly related with InstanceType and can not be specified <br /><li>LOCAL_PRO: Local HDD, which is strongly related with InstanceType and can not be specified <br /><li>CLOUD_BASIC: Basic Cloud Disk <br /><li>CLOUD_PREMIUM: Premium Disk <br /><li>CLOUD_SSD: Cloud SSD <br /><li>CLOUD_HSSD: Enhanced SSD <br /><li>CLOUD_TSSD: Tremendous SSD <br /><li>CLOUD_BSSD: Balanced SSD <br /><br />Default value: LOCAL_BASIC. <br /><br />This parameter is invalid for the `ResizeInstanceDisk` API.</li></li></li> </li> </li></li></li></li></li></li>
3125
3195
  :type DiskType: str
3126
- :param _DiskId: Data disk ID. Note that it's not available for `LOCAL_BASIC` and `LOCAL_SSD` disks.
3127
- It is only used as a response parameter for APIs such as `DescribeInstances`, and cannot be used as a request parameter for APIs such as `RunInstances`.
3196
+ :param _DiskId: Specifies the data disk ID.
3197
+ This parameter currently only serves as a response parameter for query apis such as `DescribeInstances`, and cannot be used as an input parameter for write apis such as `RunInstances`.
3128
3198
  :type DiskId: str
3129
- :param _DeleteWithInstance: Whether the data disk is terminated with the Cloud Virtual Machine (CVM). Valid values:
3130
-
3131
- <li>true: Terminate the data disk when the CVM is terminated. Only the pay-as-you-go cloud disk billed by hour is supported.</li>
3132
- <li>
3133
- false: Retain the data disk when the CVM is terminated.<br />
3134
- Default value: true.<br />
3135
- This parameter is currently only used for the `RunInstances` API.
3136
- </li>
3137
- Note: This field may return null, indicating that no valid value is found.
3199
+ :param _DeleteWithInstance: Whether the data disk is terminated with the instance. value range: <li>true: when the instance is terminated, the data disk is also terminated. only hourly postpaid cloud disks are supported. <li>false: when the instance is terminated, the data disk is retained. <br>default value: true <br>currently, this parameter is only used for the API `RunInstances`.
3138
3200
  :type DeleteWithInstance: bool
3139
- :param _SnapshotId: Data disk snapshot ID. The size of the selected data disk snapshot must be smaller than that of the data disk.
3140
- Note: This field may return null, indicating that no valid value is found.
3201
+ :param _SnapshotId: Data disk snapshot ID. the size of the selected data disk snapshot must be less than the data disk size.
3141
3202
  :type SnapshotId: str
3142
- :param _Encrypt: Whether a data disk is encrypted. Valid values:
3143
- <li>true: encrypted.</li>
3144
- <li>
3145
- false: not encrypted.<br/>
3146
- Default value: false.<br/>
3147
- This parameter is currently used only in the `RunInstances` API.
3148
- </li>
3149
- Note: This field may return null, indicating that no valid value is found.
3203
+ :param _Encrypt: Specifies whether the data disk is encrypted. value range: <li>true: encrypted</li> <li>false: unencrypted</li><br/> default value: false<br/> this parameter is currently only used for the `RunInstances` api.
3150
3204
  :type Encrypt: bool
3151
- :param _KmsKeyId: ID of the custom CMK in the format of UUID or "kms-abcd1234". This parameter is used to encrypt cloud disks.
3205
+ :param _KmsKeyId: Custom CMK's corresponding ID, with a value of UUID or something similar to kms - abcd1234. used for encrypting cloud disks.
3152
3206
 
3153
- Currently, this parameter is only used in the `RunInstances` API.
3154
- Note: this field may return null, indicating that no valid values can be obtained.
3207
+ This parameter is currently only used for the `RunInstances` api.
3155
3208
  :type KmsKeyId: str
3156
- :param _ThroughputPerformance: Cloud disk performance, in MB/s
3157
- Note: this field may return `null`, indicating that no valid values can be obtained.
3209
+ :param _ThroughputPerformance: Specifies the cloud disk performance (unit: MiB/s). using this parameter allows you to purchase additional performance for the cloud disk.
3210
+ Currently only supports ultra-fast CLOUD disk (CLOUD_TSSD) and enhanced SSD CLOUD disk (CLOUD_HSSD).
3158
3211
  :type ThroughputPerformance: int
3159
- :param _CdcId: ID of the dedicated cluster to which the instance belongs.
3160
- Note: this field may return `null`, indicating that no valid values can be obtained.
3212
+ :param _CdcId: Specifies the exclusive cluster ID it belongs to.
3161
3213
  :type CdcId: str
3162
3214
  :param _BurstPerformance: Burst performance.
3163
3215
 
3164
- <b>Note: This field is in beta test.</b>
3165
- Note: This field may return null, indicating that no valid value is found.
3216
+ <B>Note: this feature is in beta test.</b>.
3166
3217
  :type BurstPerformance: bool
3167
- :param _DiskName: Disk name, with a length of not more than 128 characters.
3168
-
3169
- This parameter is in invite-only testing and is not yet open for use.
3218
+ :param _DiskName: Disk name, with a length not exceeding 128 characters.
3170
3219
  :type DiskName: str
3171
3220
  """
3172
3221
  self._DiskSize = None
@@ -3183,7 +3232,7 @@ This parameter is in invite-only testing and is not yet open for use.
3183
3232
 
3184
3233
  @property
3185
3234
  def DiskSize(self):
3186
- """Data disk size (in GB). The minimum adjustment increment is 10 GB. The value range varies by data disk type. For more information on limits, see [Storage Overview](https://intl.cloud.tencent.com/document/product/213/4952?from_cn_redirect=1). The default value is 0, indicating that no data disk is purchased. For more information, see the product documentation.
3235
+ """Data disk size, unit: GiB. the minimum adjustment step size is 10 GiB. the value ranges of different data disk types vary. for specific limitations, see the storage overview (https://intl.cloud.tencent.com/document/product/213/4952?from_cn_redirect=1). the default value is 0, which means no data disk purchase. for more restrictions, see the product document.
3187
3236
  :rtype: int
3188
3237
  """
3189
3238
  return self._DiskSize
@@ -3205,8 +3254,8 @@ This parameter is in invite-only testing and is not yet open for use.
3205
3254
 
3206
3255
  @property
3207
3256
  def DiskId(self):
3208
- """Data disk ID. Note that it's not available for `LOCAL_BASIC` and `LOCAL_SSD` disks.
3209
- It is only used as a response parameter for APIs such as `DescribeInstances`, and cannot be used as a request parameter for APIs such as `RunInstances`.
3257
+ """Specifies the data disk ID.
3258
+ This parameter currently only serves as a response parameter for query apis such as `DescribeInstances`, and cannot be used as an input parameter for write apis such as `RunInstances`.
3210
3259
  :rtype: str
3211
3260
  """
3212
3261
  return self._DiskId
@@ -3217,15 +3266,7 @@ It is only used as a response parameter for APIs such as `DescribeInstances`, an
3217
3266
 
3218
3267
  @property
3219
3268
  def DeleteWithInstance(self):
3220
- """Whether the data disk is terminated with the Cloud Virtual Machine (CVM). Valid values:
3221
-
3222
- <li>true: Terminate the data disk when the CVM is terminated. Only the pay-as-you-go cloud disk billed by hour is supported.</li>
3223
- <li>
3224
- false: Retain the data disk when the CVM is terminated.<br />
3225
- Default value: true.<br />
3226
- This parameter is currently only used for the `RunInstances` API.
3227
- </li>
3228
- Note: This field may return null, indicating that no valid value is found.
3269
+ """Whether the data disk is terminated with the instance. value range: <li>true: when the instance is terminated, the data disk is also terminated. only hourly postpaid cloud disks are supported. <li>false: when the instance is terminated, the data disk is retained. <br>default value: true <br>currently, this parameter is only used for the API `RunInstances`.
3229
3270
  :rtype: bool
3230
3271
  """
3231
3272
  return self._DeleteWithInstance
@@ -3236,8 +3277,7 @@ Note: This field may return null, indicating that no valid value is found.
3236
3277
 
3237
3278
  @property
3238
3279
  def SnapshotId(self):
3239
- """Data disk snapshot ID. The size of the selected data disk snapshot must be smaller than that of the data disk.
3240
- Note: This field may return null, indicating that no valid value is found.
3280
+ """Data disk snapshot ID. the size of the selected data disk snapshot must be less than the data disk size.
3241
3281
  :rtype: str
3242
3282
  """
3243
3283
  return self._SnapshotId
@@ -3248,14 +3288,7 @@ Note: This field may return null, indicating that no valid value is found.
3248
3288
 
3249
3289
  @property
3250
3290
  def Encrypt(self):
3251
- """Whether a data disk is encrypted. Valid values:
3252
- <li>true: encrypted.</li>
3253
- <li>
3254
- false: not encrypted.<br/>
3255
- Default value: false.<br/>
3256
- This parameter is currently used only in the `RunInstances` API.
3257
- </li>
3258
- Note: This field may return null, indicating that no valid value is found.
3291
+ """Specifies whether the data disk is encrypted. value range: <li>true: encrypted</li> <li>false: unencrypted</li><br/> default value: false<br/> this parameter is currently only used for the `RunInstances` api.
3259
3292
  :rtype: bool
3260
3293
  """
3261
3294
  return self._Encrypt
@@ -3266,10 +3299,9 @@ Note: This field may return null, indicating that no valid value is found.
3266
3299
 
3267
3300
  @property
3268
3301
  def KmsKeyId(self):
3269
- """ID of the custom CMK in the format of UUID or "kms-abcd1234". This parameter is used to encrypt cloud disks.
3302
+ """Custom CMK's corresponding ID, with a value of UUID or something similar to kms - abcd1234. used for encrypting cloud disks.
3270
3303
 
3271
- Currently, this parameter is only used in the `RunInstances` API.
3272
- Note: this field may return null, indicating that no valid values can be obtained.
3304
+ This parameter is currently only used for the `RunInstances` api.
3273
3305
  :rtype: str
3274
3306
  """
3275
3307
  return self._KmsKeyId
@@ -3280,8 +3312,8 @@ Note: this field may return null, indicating that no valid values can be obtaine
3280
3312
 
3281
3313
  @property
3282
3314
  def ThroughputPerformance(self):
3283
- """Cloud disk performance, in MB/s
3284
- Note: this field may return `null`, indicating that no valid values can be obtained.
3315
+ """Specifies the cloud disk performance (unit: MiB/s). using this parameter allows you to purchase additional performance for the cloud disk.
3316
+ Currently only supports ultra-fast CLOUD disk (CLOUD_TSSD) and enhanced SSD CLOUD disk (CLOUD_HSSD).
3285
3317
  :rtype: int
3286
3318
  """
3287
3319
  return self._ThroughputPerformance
@@ -3292,8 +3324,7 @@ Note: this field may return `null`, indicating that no valid values can be obtai
3292
3324
 
3293
3325
  @property
3294
3326
  def CdcId(self):
3295
- """ID of the dedicated cluster to which the instance belongs.
3296
- Note: this field may return `null`, indicating that no valid values can be obtained.
3327
+ """Specifies the exclusive cluster ID it belongs to.
3297
3328
  :rtype: str
3298
3329
  """
3299
3330
  return self._CdcId
@@ -3306,8 +3337,7 @@ Note: this field may return `null`, indicating that no valid values can be obtai
3306
3337
  def BurstPerformance(self):
3307
3338
  """Burst performance.
3308
3339
 
3309
- <b>Note: This field is in beta test.</b>
3310
- Note: This field may return null, indicating that no valid value is found.
3340
+ <B>Note: this feature is in beta test.</b>.
3311
3341
  :rtype: bool
3312
3342
  """
3313
3343
  return self._BurstPerformance
@@ -3318,9 +3348,7 @@ Note: This field may return null, indicating that no valid value is found.
3318
3348
 
3319
3349
  @property
3320
3350
  def DiskName(self):
3321
- """Disk name, with a length of not more than 128 characters.
3322
-
3323
- This parameter is in invite-only testing and is not yet open for use.
3351
+ """Disk name, with a length not exceeding 128 characters.
3324
3352
  :rtype: str
3325
3353
  """
3326
3354
  return self._DiskName
@@ -7508,14 +7536,11 @@ class Externals(AbstractModel):
7508
7536
 
7509
7537
  def __init__(self):
7510
7538
  r"""
7511
- :param _ReleaseAddress: Release address
7512
- Note: This field may return null, indicating that no valid value is found.
7539
+ :param _ReleaseAddress: Release Address
7513
7540
  :type ReleaseAddress: bool
7514
- :param _UnsupportNetworks: Not supported network. Value: <br><li>BASIC: classic network<br><li>VPC1.0: VPC1.0
7515
- Note: This field may return null, indicating that no valid value was found.
7541
+ :param _UnsupportNetworks: Unsupported network type. valid values: <br><li>BASIC: BASIC network</li><li>VPC1.0: private network VPC1.0</li>.
7516
7542
  :type UnsupportNetworks: list of str
7517
- :param _StorageBlockAttr: Attributes of local HDD storage
7518
- Note: This field may return null, indicating that no valid value is found.
7543
+ :param _StorageBlockAttr: Specifies the HDD local storage attributes.
7519
7544
  :type StorageBlockAttr: :class:`tencentcloud.cvm.v20170312.models.StorageBlock`
7520
7545
  """
7521
7546
  self._ReleaseAddress = None
@@ -7524,8 +7549,7 @@ Note: This field may return null, indicating that no valid value is found.
7524
7549
 
7525
7550
  @property
7526
7551
  def ReleaseAddress(self):
7527
- """Release address
7528
- Note: This field may return null, indicating that no valid value is found.
7552
+ """Release Address
7529
7553
  :rtype: bool
7530
7554
  """
7531
7555
  return self._ReleaseAddress
@@ -7536,8 +7560,7 @@ Note: This field may return null, indicating that no valid value is found.
7536
7560
 
7537
7561
  @property
7538
7562
  def UnsupportNetworks(self):
7539
- """Not supported network. Value: <br><li>BASIC: classic network<br><li>VPC1.0: VPC1.0
7540
- Note: This field may return null, indicating that no valid value was found.
7563
+ """Unsupported network type. valid values: <br><li>BASIC: BASIC network</li><li>VPC1.0: private network VPC1.0</li>.
7541
7564
  :rtype: list of str
7542
7565
  """
7543
7566
  return self._UnsupportNetworks
@@ -7548,8 +7571,7 @@ Note: This field may return null, indicating that no valid value was found.
7548
7571
 
7549
7572
  @property
7550
7573
  def StorageBlockAttr(self):
7551
- """Attributes of local HDD storage
7552
- Note: This field may return null, indicating that no valid value is found.
7574
+ """Specifies the HDD local storage attributes.
7553
7575
  :rtype: :class:`tencentcloud.cvm.v20170312.models.StorageBlock`
7554
7576
  """
7555
7577
  return self._StorageBlockAttr
@@ -10623,11 +10645,9 @@ class InstanceChargePrepaid(AbstractModel):
10623
10645
 
10624
10646
  def __init__(self):
10625
10647
  r"""
10626
- :param _Period: Subscription period (in month). Valid values: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `24`, `36`, `48’, `60`.
10627
- Note: This field may return `null`, indicating that no valid values can be obtained.
10648
+ :param _Period: Subscription period in months. value range: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60.
10628
10649
  :type Period: int
10629
- :param _RenewFlag: Auto-renewal flag. Valid values:<br><li>NOTIFY_AND_AUTO_RENEW: Notify of expiration and automatically renew.</li><br><li>NOTIFY_AND_MANUAL_RENEW: Notify of expiration and manually renew.</li><br><li>DISABLE_NOTIFY_AND_MANUAL_RENEW: Do not notify of expiration and do not automatically renew.</li><br><br>Default value: NOTIFY_AND_MANUAL_RENEW. If this parameter is set to NOTIFY_AND_AUTO_RENEW, an instance will be automatically renewed monthly after expiration, provided that the account balance is sufficient.
10630
- Note: This field may return null, indicating that no valid value is found.
10650
+ :param _RenewFlag: AUTO-Renewal flag. value ranges:<br><li>NOTIFY_AND_AUTO_RENEW: NOTIFY of expiration AND automatically RENEW.</li><br><li>NOTIFY_AND_MANUAL_RENEW: NOTIFY of expiration but do not automatically RENEW.</li><br><li>DISABLE_NOTIFY_AND_MANUAL_RENEW: do not NOTIFY of expiration AND do not automatically RENEW.</li><br><br>default value: NOTIFY_AND_MANUAL_RENEW. if this parameter is set to NOTIFY_AND_AUTO_RENEW, the instance will be automatically renewed monthly after expiration, provided that the account balance is sufficient.
10631
10651
  :type RenewFlag: str
10632
10652
  """
10633
10653
  self._Period = None
@@ -10635,8 +10655,7 @@ Note: This field may return null, indicating that no valid value is found.
10635
10655
 
10636
10656
  @property
10637
10657
  def Period(self):
10638
- """Subscription period (in month). Valid values: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `24`, `36`, `48’, `60`.
10639
- Note: This field may return `null`, indicating that no valid values can be obtained.
10658
+ """Subscription period in months. value range: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60.
10640
10659
  :rtype: int
10641
10660
  """
10642
10661
  return self._Period
@@ -10647,8 +10666,7 @@ Note: This field may return `null`, indicating that no valid values can be obtai
10647
10666
 
10648
10667
  @property
10649
10668
  def RenewFlag(self):
10650
- """Auto-renewal flag. Valid values:<br><li>NOTIFY_AND_AUTO_RENEW: Notify of expiration and automatically renew.</li><br><li>NOTIFY_AND_MANUAL_RENEW: Notify of expiration and manually renew.</li><br><li>DISABLE_NOTIFY_AND_MANUAL_RENEW: Do not notify of expiration and do not automatically renew.</li><br><br>Default value: NOTIFY_AND_MANUAL_RENEW. If this parameter is set to NOTIFY_AND_AUTO_RENEW, an instance will be automatically renewed monthly after expiration, provided that the account balance is sufficient.
10651
- Note: This field may return null, indicating that no valid value is found.
10669
+ """AUTO-Renewal flag. value ranges:<br><li>NOTIFY_AND_AUTO_RENEW: NOTIFY of expiration AND automatically RENEW.</li><br><li>NOTIFY_AND_MANUAL_RENEW: NOTIFY of expiration but do not automatically RENEW.</li><br><li>DISABLE_NOTIFY_AND_MANUAL_RENEW: do not NOTIFY of expiration AND do not automatically RENEW.</li><br><br>default value: NOTIFY_AND_MANUAL_RENEW. if this parameter is set to NOTIFY_AND_AUTO_RENEW, the instance will be automatically renewed monthly after expiration, provided that the account balance is sufficient.
10652
10670
  :rtype: str
10653
10671
  """
10654
10672
  return self._RenewFlag
@@ -10730,11 +10748,9 @@ class InstanceMarketOptionsRequest(AbstractModel):
10730
10748
 
10731
10749
  def __init__(self):
10732
10750
  r"""
10733
- :param _SpotOptions: Spot-related options
10734
- Note: This field may return `null`, indicating that no valid values can be obtained.
10751
+ :param _SpotOptions: Relevant options for spot instances.
10735
10752
  :type SpotOptions: :class:`tencentcloud.cvm.v20170312.models.SpotMarketOptions`
10736
- :param _MarketType: Market type. Valid value: `spot`.
10737
- Note: This field may return `null`, indicating that no valid values can be obtained.
10753
+ :param _MarketType: Market option type. The value can only be spot currently.
10738
10754
  :type MarketType: str
10739
10755
  """
10740
10756
  self._SpotOptions = None
@@ -10742,8 +10758,7 @@ Note: This field may return `null`, indicating that no valid values can be obtai
10742
10758
 
10743
10759
  @property
10744
10760
  def SpotOptions(self):
10745
- """Spot-related options
10746
- Note: This field may return `null`, indicating that no valid values can be obtained.
10761
+ """Relevant options for spot instances.
10747
10762
  :rtype: :class:`tencentcloud.cvm.v20170312.models.SpotMarketOptions`
10748
10763
  """
10749
10764
  return self._SpotOptions
@@ -10754,8 +10769,7 @@ Note: This field may return `null`, indicating that no valid values can be obtai
10754
10769
 
10755
10770
  @property
10756
10771
  def MarketType(self):
10757
- """Market type. Valid value: `spot`.
10758
- Note: This field may return `null`, indicating that no valid values can be obtained.
10772
+ """Market option type. The value can only be spot currently.
10759
10773
  :rtype: str
10760
10774
  """
10761
10775
  return self._MarketType
@@ -11233,7 +11247,7 @@ class InternetAccessible(AbstractModel):
11233
11247
  :type InternetMaxBandwidthOut: int
11234
11248
  :param _PublicIpAssigned: Whether to allocate a public IP address. Valid values:<br><li>true: Allocate a public IP address.</li><li>false: Do not allocate a public IP address.</li><br>When the public network bandwidth is greater than 0 Mbps, you can choose whether to enable the public IP address. The public IP address is enabled by default. When the public network bandwidth is 0, allocating the public IP address is not supported. This parameter is only used as an input parameter in the RunInstances API.
11235
11249
  :type PublicIpAssigned: bool
11236
- :param _BandwidthPackageId: Bandwidth package ID. To obatin the IDs, you can call [`DescribeBandwidthPackages`](https://intl.cloud.tencent.com/document/api/215/19209?from_cn_redirect=1) and look for the `BandwidthPackageId` fields in the response.
11250
+ :param _BandwidthPackageId: Bandwidth package ID. it can be obtained through the `BandwidthPackageId` in the return value from the DescribeBandwidthPackages api. this parameter is used as an input parameter only in the RunInstances api.
11237
11251
  :type BandwidthPackageId: str
11238
11252
  """
11239
11253
  self._InternetChargeType = None
@@ -11276,7 +11290,7 @@ class InternetAccessible(AbstractModel):
11276
11290
 
11277
11291
  @property
11278
11292
  def BandwidthPackageId(self):
11279
- """Bandwidth package ID. To obatin the IDs, you can call [`DescribeBandwidthPackages`](https://intl.cloud.tencent.com/document/api/215/19209?from_cn_redirect=1) and look for the `BandwidthPackageId` fields in the response.
11293
+ """Bandwidth package ID. it can be obtained through the `BandwidthPackageId` in the return value from the DescribeBandwidthPackages api. this parameter is used as an input parameter only in the RunInstances api.
11280
11294
  :rtype: str
11281
11295
  """
11282
11296
  return self._BandwidthPackageId
@@ -12775,8 +12789,7 @@ class LoginSettings(AbstractModel):
12775
12789
  :param _KeyIds: 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`](https://intl.cloud.tencent.com/document/api/213/15699?from_cn_redirect=1) to obtain `KeyId`. You cannot specify a key and a password at the same time. Windows instances do not support keys.
12776
12790
  Note: This field may return `null`, indicating that no valid values can be obtained.
12777
12791
  :type KeyIds: list of str
12778
- :param _KeepImageLogin: Maintains the original settings of the image. This parameter cannot be specified simultaneously with Password or KeyIds.N. It can be set to true only when an instance is created with a custom image, shared image, or externally imported image. Valid values: <li>true: indicates that the login settings of the image are maintained</li><li>false: indicates that the login settings of the image are not maintained</li>Default value: false.
12779
- Note: This field may return null, indicating that no valid value is found.
12792
+ :param _KeepImageLogin: Retain the original settings of the image. this parameter cannot be specified simultaneously with Password or KeyIds.N. it can be set to true only when an instance is created with a custom image, shared image, or externally imported image. value ranges from true to false: <li>true: indicates that the login settings of the image are retained</li><li>false: indicates that the login settings of the image are not retained</li>. default value: false.
12780
12793
  :type KeepImageLogin: str
12781
12794
  """
12782
12795
  self._Password = None
@@ -12808,8 +12821,7 @@ Note: This field may return `null`, indicating that no valid values can be obtai
12808
12821
 
12809
12822
  @property
12810
12823
  def KeepImageLogin(self):
12811
- """Maintains the original settings of the image. This parameter cannot be specified simultaneously with Password or KeyIds.N. It can be set to true only when an instance is created with a custom image, shared image, or externally imported image. Valid values: <li>true: indicates that the login settings of the image are maintained</li><li>false: indicates that the login settings of the image are not maintained</li>Default value: false.
12812
- Note: This field may return null, indicating that no valid value is found.
12824
+ """Retain the original settings of the image. this parameter cannot be specified simultaneously with Password or KeyIds.N. it can be set to true only when an instance is created with a custom image, shared image, or externally imported image. value ranges from true to false: <li>true: indicates that the login settings of the image are retained</li><li>false: indicates that the login settings of the image are not retained</li>. default value: false.
12813
12825
  :rtype: str
12814
12826
  """
12815
12827
  return self._KeepImageLogin
@@ -12833,6 +12845,100 @@ Note: This field may return null, indicating that no valid value is found.
12833
12845
 
12834
12846
 
12835
12847
 
12848
+ class Metadata(AbstractModel):
12849
+ """Custom metadata.
12850
+
12851
+ """
12852
+
12853
+ def __init__(self):
12854
+ r"""
12855
+ :param _Items: A list of custom metadata key-value pairs.
12856
+ :type Items: list of MetadataItem
12857
+ """
12858
+ self._Items = None
12859
+
12860
+ @property
12861
+ def Items(self):
12862
+ """A list of custom metadata key-value pairs.
12863
+ :rtype: list of MetadataItem
12864
+ """
12865
+ return self._Items
12866
+
12867
+ @Items.setter
12868
+ def Items(self, Items):
12869
+ self._Items = Items
12870
+
12871
+
12872
+ def _deserialize(self, params):
12873
+ if params.get("Items") is not None:
12874
+ self._Items = []
12875
+ for item in params.get("Items"):
12876
+ obj = MetadataItem()
12877
+ obj._deserialize(item)
12878
+ self._Items.append(obj)
12879
+ memeber_set = set(params.keys())
12880
+ for name, value in vars(self).items():
12881
+ property_name = name[1:]
12882
+ if property_name in memeber_set:
12883
+ memeber_set.remove(property_name)
12884
+ if len(memeber_set) > 0:
12885
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
12886
+
12887
+
12888
+
12889
+ class MetadataItem(AbstractModel):
12890
+ """Custom metadata key and value.
12891
+
12892
+ """
12893
+
12894
+ def __init__(self):
12895
+ r"""
12896
+ :param _Key: Custom metadata key. it must comply with the regular expression ^[a-zA-Z0-9_-]+$. the length is less than or equal to 128 bytes (case-sensitive).
12897
+
12898
+ :type Key: str
12899
+ :param _Value: Specifies a custom metadata value. it supports any data . The size is &le; 256 KB. it is case-sensitive.
12900
+ :type Value: str
12901
+ """
12902
+ self._Key = None
12903
+ self._Value = None
12904
+
12905
+ @property
12906
+ def Key(self):
12907
+ """Custom metadata key. it must comply with the regular expression ^[a-zA-Z0-9_-]+$. the length is less than or equal to 128 bytes (case-sensitive).
12908
+
12909
+ :rtype: str
12910
+ """
12911
+ return self._Key
12912
+
12913
+ @Key.setter
12914
+ def Key(self, Key):
12915
+ self._Key = Key
12916
+
12917
+ @property
12918
+ def Value(self):
12919
+ """Specifies a custom metadata value. it supports any data . The size is &le; 256 KB. it is case-sensitive.
12920
+ :rtype: str
12921
+ """
12922
+ return self._Value
12923
+
12924
+ @Value.setter
12925
+ def Value(self, Value):
12926
+ self._Value = Value
12927
+
12928
+
12929
+ def _deserialize(self, params):
12930
+ self._Key = params.get("Key")
12931
+ self._Value = params.get("Value")
12932
+ memeber_set = set(params.keys())
12933
+ for name, value in vars(self).items():
12934
+ property_name = name[1:]
12935
+ if property_name in memeber_set:
12936
+ memeber_set.remove(property_name)
12937
+ if len(memeber_set) > 0:
12938
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
12939
+
12940
+
12941
+
12836
12942
  class ModifyChcAttributeRequest(AbstractModel):
12837
12943
  """ModifyChcAttribute request structure.
12838
12944
 
@@ -17026,14 +17132,14 @@ class RunMonitorServiceEnabled(AbstractModel):
17026
17132
 
17027
17133
  def __init__(self):
17028
17134
  r"""
17029
- :param _Enabled: Whether to enable [Cloud Monitor](https://intl.cloud.tencent.com/document/product/248?from_cn_redirect=1). Valid values: <br><li>TRUE: enable Cloud Monitor <br><li>FALSE: do not enable Cloud Monitor <br><br>Default value: TRUE.
17135
+ :param _Enabled: Whether to enable the cloud monitor service. value ranges from: <li>true: indicates enabling the cloud monitor service</li> <li>false: indicates disabling the cloud monitor service</li> default value: true.
17030
17136
  :type Enabled: bool
17031
17137
  """
17032
17138
  self._Enabled = None
17033
17139
 
17034
17140
  @property
17035
17141
  def Enabled(self):
17036
- """Whether to enable [Cloud Monitor](https://intl.cloud.tencent.com/document/product/248?from_cn_redirect=1). Valid values: <br><li>TRUE: enable Cloud Monitor <br><li>FALSE: do not enable Cloud Monitor <br><br>Default value: TRUE.
17142
+ """Whether to enable the cloud monitor service. value ranges from: <li>true: indicates enabling the cloud monitor service</li> <li>false: indicates disabling the cloud monitor service</li> default value: true.
17037
17143
  :rtype: bool
17038
17144
  """
17039
17145
  return self._Enabled
@@ -17219,9 +17325,9 @@ class SpotMarketOptions(AbstractModel):
17219
17325
 
17220
17326
  def __init__(self):
17221
17327
  r"""
17222
- :param _MaxPrice: Bidding price
17328
+ :param _MaxPrice: Bid price.
17223
17329
  :type MaxPrice: str
17224
- :param _SpotInstanceType: Bidding request type. Currently only "one-time" is supported.
17330
+ :param _SpotInstanceType: Bid request type. valid values: one-time. currently, only the one-time type is supported.
17225
17331
  :type SpotInstanceType: str
17226
17332
  """
17227
17333
  self._MaxPrice = None
@@ -17229,7 +17335,7 @@ class SpotMarketOptions(AbstractModel):
17229
17335
 
17230
17336
  @property
17231
17337
  def MaxPrice(self):
17232
- """Bidding price
17338
+ """Bid price.
17233
17339
  :rtype: str
17234
17340
  """
17235
17341
  return self._MaxPrice
@@ -17240,7 +17346,7 @@ class SpotMarketOptions(AbstractModel):
17240
17346
 
17241
17347
  @property
17242
17348
  def SpotInstanceType(self):
17243
- """Bidding request type. Currently only "one-time" is supported.
17349
+ """Bid request type. valid values: one-time. currently, only the one-time type is supported.
17244
17350
  :rtype: str
17245
17351
  """
17246
17352
  return self._SpotInstanceType
@@ -17447,14 +17553,11 @@ class StorageBlock(AbstractModel):
17447
17553
 
17448
17554
  def __init__(self):
17449
17555
  r"""
17450
- :param _Type: Local HDD storage type. Value: LOCAL_PRO.
17451
- Note: This field may return null, indicating that no valid value is found.
17556
+ :param _Type: HDD LOCAL storage type specifies the value: LOCAL_PRO.
17452
17557
  :type Type: str
17453
- :param _MinSize: Minimum capacity of local HDD storage
17454
- Note: This field may return null, indicating that no valid value is found.
17558
+ :param _MinSize: Specifies the minimum HDD local storage capacity. measurement unit: GiB.
17455
17559
  :type MinSize: int
17456
- :param _MaxSize: Maximum capacity of local HDD storage
17457
- Note: This field may return null, indicating that no valid value is found.
17560
+ :param _MaxSize: Specifies the maximum capacity of HDD local storage. measurement unit: GiB.
17458
17561
  :type MaxSize: int
17459
17562
  """
17460
17563
  self._Type = None
@@ -17463,8 +17566,7 @@ Note: This field may return null, indicating that no valid value is found.
17463
17566
 
17464
17567
  @property
17465
17568
  def Type(self):
17466
- """Local HDD storage type. Value: LOCAL_PRO.
17467
- Note: This field may return null, indicating that no valid value is found.
17569
+ """HDD LOCAL storage type specifies the value: LOCAL_PRO.
17468
17570
  :rtype: str
17469
17571
  """
17470
17572
  return self._Type
@@ -17475,8 +17577,7 @@ Note: This field may return null, indicating that no valid value is found.
17475
17577
 
17476
17578
  @property
17477
17579
  def MinSize(self):
17478
- """Minimum capacity of local HDD storage
17479
- Note: This field may return null, indicating that no valid value is found.
17580
+ """Specifies the minimum HDD local storage capacity. measurement unit: GiB.
17480
17581
  :rtype: int
17481
17582
  """
17482
17583
  return self._MinSize
@@ -17487,8 +17588,7 @@ Note: This field may return null, indicating that no valid value is found.
17487
17588
 
17488
17589
  @property
17489
17590
  def MaxSize(self):
17490
- """Maximum capacity of local HDD storage
17491
- Note: This field may return null, indicating that no valid value is found.
17591
+ """Specifies the maximum capacity of HDD local storage. measurement unit: GiB.
17492
17592
  :rtype: int
17493
17593
  """
17494
17594
  return self._MaxSize
@@ -17760,28 +17860,25 @@ class SystemDisk(AbstractModel):
17760
17860
 
17761
17861
  def __init__(self):
17762
17862
  r"""
17763
- :param _DiskType: System disk type. For the restrictions on the system disk type, refer to [Storage Overview](https://intl.cloud.tencent.com/document/product/213/4952?from_cn_redirect=1). Value values:<br>
17764
- <li>LOCAL_BASIC: Local Disk</li>
17765
- <li>LOCAL_SSD: Local SSD</li>
17766
- <li>CLOUD_BASIC: Basic Cloud Disk</li>
17767
- <li>CLOUD_SSD: Cloud SSD</li>
17768
- <li>CLOUD_PREMIUM: Premium Disk</li>
17769
- <li>CLOUD_BSSD: Balanced SSD</li>
17770
- <li>CLOUD_HSSD: Enhanced SSD</li>
17771
- <li>CLOUD_TSSD: Tremendous SSD</li><br>
17863
+ :param _DiskType: Specifies the system disk type. for the restrictions on the system disk type, refer to [storage overview](https://intl.cloud.tencent.com/document/product/213/4952?from_cn_redirect=1). value range:<br>.
17864
+ <Li>LOCAL_BASIC: specifies a local hard disk.</li>.
17865
+ <Li>LOCAL_SSD: specifies a local ssd.</li>.
17866
+ <Li>CLOUD_BASIC: ordinary cloud disk.</li>.
17867
+ <Li>CLOUD_SSD: ssd cloud disk</li>.
17868
+ <Li>CLOUD_PREMIUM: high-performance cloud block storage.</li>.
17869
+ <Li>CLOUD_BSSD: universal type ssd cloud disk</li>.
17870
+ <Li>CLOUD_HSSD: enhanced ssd cloud disk</li>.
17871
+ <li>CLOUD_TSSD: ultra-fast SSD cbs</li.
17772
17872
  Default value: Current disk types with inventory available.
17773
17873
  :type DiskType: str
17774
- :param _DiskId: System disk ID. System disks whose type is `LOCAL_BASIC` or `LOCAL_SSD` do not have an ID and do not support this parameter.
17775
- It is only used as a response parameter for APIs such as `DescribeInstances`, and cannot be used as a request parameter for APIs such as `RunInstances`.
17874
+ :param _DiskId: Specifies the system disk ID.
17875
+ This parameter currently only serves as a response parameter for query apis such as `DescribeInstances`, and cannot be used as an input parameter for write apis such as `RunInstances`.
17776
17876
  :type DiskId: str
17777
- :param _DiskSize: System disk size; unit: GB; default value: 50 GB.
17877
+ :param _DiskSize: System disk size; unit: GiB; default value: 50 GiB.
17778
17878
  :type DiskSize: int
17779
- :param _CdcId: ID of the dedicated cluster to which the instance belongs.
17879
+ :param _CdcId: Specifies the exclusive cluster ID it belongs to.
17780
17880
  :type CdcId: str
17781
- :param _DiskName: Disk name, with a length of not more than 128 characters.
17782
-
17783
- This parameter is in invite-only testing and is not yet open for use.
17784
- Note: This field may return null, indicating that no valid value is found.
17881
+ :param _DiskName: Disk name, which specifies a length not exceeding 128 characters.
17785
17882
  :type DiskName: str
17786
17883
  """
17787
17884
  self._DiskType = None
@@ -17792,15 +17889,15 @@ Note: This field may return null, indicating that no valid value is found.
17792
17889
 
17793
17890
  @property
17794
17891
  def DiskType(self):
17795
- """System disk type. For the restrictions on the system disk type, refer to [Storage Overview](https://intl.cloud.tencent.com/document/product/213/4952?from_cn_redirect=1). Value values:<br>
17796
- <li>LOCAL_BASIC: Local Disk</li>
17797
- <li>LOCAL_SSD: Local SSD</li>
17798
- <li>CLOUD_BASIC: Basic Cloud Disk</li>
17799
- <li>CLOUD_SSD: Cloud SSD</li>
17800
- <li>CLOUD_PREMIUM: Premium Disk</li>
17801
- <li>CLOUD_BSSD: Balanced SSD</li>
17802
- <li>CLOUD_HSSD: Enhanced SSD</li>
17803
- <li>CLOUD_TSSD: Tremendous SSD</li><br>
17892
+ """Specifies the system disk type. for the restrictions on the system disk type, refer to [storage overview](https://intl.cloud.tencent.com/document/product/213/4952?from_cn_redirect=1). value range:<br>.
17893
+ <Li>LOCAL_BASIC: specifies a local hard disk.</li>.
17894
+ <Li>LOCAL_SSD: specifies a local ssd.</li>.
17895
+ <Li>CLOUD_BASIC: ordinary cloud disk.</li>.
17896
+ <Li>CLOUD_SSD: ssd cloud disk</li>.
17897
+ <Li>CLOUD_PREMIUM: high-performance cloud block storage.</li>.
17898
+ <Li>CLOUD_BSSD: universal type ssd cloud disk</li>.
17899
+ <Li>CLOUD_HSSD: enhanced ssd cloud disk</li>.
17900
+ <li>CLOUD_TSSD: ultra-fast SSD cbs</li.
17804
17901
  Default value: Current disk types with inventory available.
17805
17902
  :rtype: str
17806
17903
  """
@@ -17812,8 +17909,8 @@ Default value: Current disk types with inventory available.
17812
17909
 
17813
17910
  @property
17814
17911
  def DiskId(self):
17815
- """System disk ID. System disks whose type is `LOCAL_BASIC` or `LOCAL_SSD` do not have an ID and do not support this parameter.
17816
- It is only used as a response parameter for APIs such as `DescribeInstances`, and cannot be used as a request parameter for APIs such as `RunInstances`.
17912
+ """Specifies the system disk ID.
17913
+ This parameter currently only serves as a response parameter for query apis such as `DescribeInstances`, and cannot be used as an input parameter for write apis such as `RunInstances`.
17817
17914
  :rtype: str
17818
17915
  """
17819
17916
  return self._DiskId
@@ -17824,7 +17921,7 @@ It is only used as a response parameter for APIs such as `DescribeInstances`, an
17824
17921
 
17825
17922
  @property
17826
17923
  def DiskSize(self):
17827
- """System disk size; unit: GB; default value: 50 GB.
17924
+ """System disk size; unit: GiB; default value: 50 GiB.
17828
17925
  :rtype: int
17829
17926
  """
17830
17927
  return self._DiskSize
@@ -17835,7 +17932,7 @@ It is only used as a response parameter for APIs such as `DescribeInstances`, an
17835
17932
 
17836
17933
  @property
17837
17934
  def CdcId(self):
17838
- """ID of the dedicated cluster to which the instance belongs.
17935
+ """Specifies the exclusive cluster ID it belongs to.
17839
17936
  :rtype: str
17840
17937
  """
17841
17938
  return self._CdcId
@@ -17846,10 +17943,7 @@ It is only used as a response parameter for APIs such as `DescribeInstances`, an
17846
17943
 
17847
17944
  @property
17848
17945
  def DiskName(self):
17849
- """Disk name, with a length of not more than 128 characters.
17850
-
17851
- This parameter is in invite-only testing and is not yet open for use.
17852
- Note: This field may return null, indicating that no valid value is found.
17946
+ """Disk name, which specifies a length not exceeding 128 characters.
17853
17947
  :rtype: str
17854
17948
  """
17855
17949
  return self._DiskName
@@ -17933,11 +18027,9 @@ class TagSpecification(AbstractModel):
17933
18027
 
17934
18028
  def __init__(self):
17935
18029
  r"""
17936
- :param _ResourceType: Resource type. Valid values: `instance` (CVM), `host` (CDH), `image` (for image), and `keypair` (for key).
17937
- Note: This field may return `null`, indicating that no valid values can be obtained.
18030
+ :param _ResourceType: Tag-Bound resource type. "instance" for cloud virtual machine, "host" for cdh, "image" for mirror, and "keypair" for key.
17938
18031
  :type ResourceType: str
17939
- :param _Tags: Tag pairs
17940
- Note: This field may return `null`, indicating that no valid values can be obtained.
18032
+ :param _Tags: Tag pair list
17941
18033
  :type Tags: list of Tag
17942
18034
  """
17943
18035
  self._ResourceType = None
@@ -17945,8 +18037,7 @@ Note: This field may return `null`, indicating that no valid values can be obtai
17945
18037
 
17946
18038
  @property
17947
18039
  def ResourceType(self):
17948
- """Resource type. Valid values: `instance` (CVM), `host` (CDH), `image` (for image), and `keypair` (for key).
17949
- Note: This field may return `null`, indicating that no valid values can be obtained.
18040
+ """Tag-Bound resource type. "instance" for cloud virtual machine, "host" for cdh, "image" for mirror, and "keypair" for key.
17950
18041
  :rtype: str
17951
18042
  """
17952
18043
  return self._ResourceType
@@ -17957,8 +18048,7 @@ Note: This field may return `null`, indicating that no valid values can be obtai
17957
18048
 
17958
18049
  @property
17959
18050
  def Tags(self):
17960
- """Tag pairs
17961
- Note: This field may return `null`, indicating that no valid values can be obtained.
18051
+ """Tag pair list
17962
18052
  :rtype: list of Tag
17963
18053
  """
17964
18054
  return self._Tags
@@ -18127,7 +18217,7 @@ class VirtualPrivateCloud(AbstractModel):
18127
18217
  r"""
18128
18218
  :param _VpcId: VPC ID in the format of `vpc-xxx`. To obtain valid VPC IDs, you can log in to the [console](https://console.cloud.tencent.com/vpc/vpc?rid=1) or call the [DescribeVpcs](https://www.tencentcloud.com/document/product/215/15778) API and look for the `unVpcId` fields in the response. If you specify `DEFAULT` for both `VpcId` and `SubnetId` when creating an instance, the default VPC will be used.
18129
18219
  :type VpcId: str
18130
- :param _SubnetId: VPC subnet ID in the format `subnet-xxx`. To obtain valid subnet IDs, you can log in to the [console](https://console.cloud.tencent.com/vpc/subnet?rid=1) or call [DescribeSubnets](https://intl.cloud.tencent.com/document/api/215/15784?from_cn_redirect=1) and look for the `unSubnetId` fields in the response. If you specify `DEFAULT` for both `SubnetId` and `VpcId` when creating an instance, the default VPC will be used.
18220
+ :param _SubnetId: vpc subnet ID, in the form of `subnet-xxx`. valid vpc subnet ids can be queried by logging in to the console (https://console.cloud.tencent.com/vpc/subnet?rid=1); or they can be 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). if SubnetId and VpcId are both input as `DEFAULT` when creating an instance, the DEFAULT vpc network will be forcibly used.
18131
18221
  :type SubnetId: str
18132
18222
  :param _AsVpcGateway: Whether it is used as a public gateway. A public gateway can only be used normally when an instance has a public IP address and is in a VPC. Valid values:<li>true: It is used as a public gateway.</li><li>false: It is not used as a public gateway.</li>Default value: false.
18133
18223
  :type AsVpcGateway: bool
@@ -18155,7 +18245,7 @@ class VirtualPrivateCloud(AbstractModel):
18155
18245
 
18156
18246
  @property
18157
18247
  def SubnetId(self):
18158
- """VPC subnet ID in the format `subnet-xxx`. To obtain valid subnet IDs, you can log in to the [console](https://console.cloud.tencent.com/vpc/subnet?rid=1) or call [DescribeSubnets](https://intl.cloud.tencent.com/document/api/215/15784?from_cn_redirect=1) and look for the `unSubnetId` fields in the response. If you specify `DEFAULT` for both `SubnetId` and `VpcId` when creating an instance, the default VPC will be used.
18248
+ """vpc subnet ID, in the form of `subnet-xxx`. valid vpc subnet ids can be queried by logging in to the console (https://console.cloud.tencent.com/vpc/subnet?rid=1); or they can be 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). if SubnetId and VpcId are both input as `DEFAULT` when creating an instance, the DEFAULT vpc network will be forcibly used.
18159
18249
  :rtype: str
18160
18250
  """
18161
18251
  return self._SubnetId