tencent cloud

Data Types
Download PDF
Last updated: 2025-11-21 11:59:34
Data Types
Last updated: 2025-11-21 11:59:34
Download PDF

ActionTimer

Scheduled tasks.

Used by actions: CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeLaunchTemplateVersions, RunInstances.

Name Type Required Description
TimerAction String No Timer action currently only supports terminating one value: TerminateInstances.
ActionTime String No 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.
Externals Externals No Extension data. only used as output usage.
ActionTimerId String No Timer ID. only used as output usage.
Status String No Timer status, for output usage only. value ranges from:
  • UNDO: unexecuted
  • DOING: executing
  • DONE: execution completed.
    • .
    InstanceId String No Instance ID corresponding to a timer. used only for output.

    Attribute

    Attribute information.

    Used by actions: DescribeInstancesAttributes.

    Name Type Required Description
    UserData String No Custom data of instances.

    ChargePrepaid

    Parameters related to the prepaid billing method, including the subscription period, the auto renewal logic, etc.

    Used by actions: AllocateHosts.

    Name Type Required Description
    Period Integer Yes Purchased usage period, in month. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36
    RenewFlag String No Auto renewal flag. Valid values:
  • NOTIFY_AND_AUTO_RENEW: notify upon expiration and renew automatically
  • NOTIFY_AND_MANUAL_RENEW: notify upon expiration but do not renew automatically
  • DISABLE_NOTIFY_AND_MANUAL_RENEW: neither notify upon expiration nor renew automatically

    Default value: NOTIFY_AND_AUTO_RENEW. If this parameter is specified as NOTIFY_AND_AUTO_RENEW, the instance will be automatically renewed on a monthly basis if the account balance is sufficient.
    		•

    ChcDeployExtraConfig

    Configuration options for MiniOS of the CHC deployment network

    Used by actions: ConfigureChcAssistVpc, ConfigureChcDeployVpc, DescribeChcHosts.

    Name Type Required Description
    MiniOsType String Yes
    BootType String Yes
    BootFile String No
    NextServerAddress String No

    ChcHost

    CHC host information

    Used by actions: DescribeChcHosts.

    Name Type Description
    ChcId String CHC host ID
    InstanceName String Instance name
    SerialNumber String Server serial number
    InstanceState String CHC host status


    • REGISTERED: The CHC host is registered, but the out-of-band network and deployment network are not configured.
    • VPC_READY: The out-of-band network and deployment network are configured.
    • PREPARED: It’s ready and can be associated with a CVM.
    • ONLINE: It’s already associated with a CVM.
    DeviceType String Device type
    Note: This field may return null, indicating that no valid values can be obtained.
    Placement Placement Availability zone
    BmcVirtualPrivateCloud VirtualPrivateCloud Out-of-band network
    Note: This field may return null, indicating that no valid values can be obtained.
    BmcIp String Out-of-band network IP
    Note: This field may return null, indicating that no valid values can be obtained.
    BmcSecurityGroupIds Array of String Out-of-band network security group ID
    Note: This field may return null, indicating that no valid values can be obtained.
    DeployVirtualPrivateCloud VirtualPrivateCloud Deployment network
    Note: This field may return null, indicating that no valid values can be obtained.
    DeployIp String Deployment network IP
    Note: This field may return null, indicating that no valid values can be obtained.
    DeploySecurityGroupIds Array of String Deployment network security group ID
    Note: This field may return null, indicating that no valid values can be obtained.
    CvmInstanceId String ID of the associated CVM
    Note: This field may return null, indicating that no valid values can be obtained.
    CreatedTime String Server creation time
    HardwareDescription String Instance hardware description, including CPU cores, memory capacity and disk capacity.
    Note: This field may return null, indicating that no valid values can be obtained.
    CPU Integer CPU cores of the CHC host
    Note: This field may return null, indicating that no valid values can be obtained.
    Memory Integer Memory capacity of the CHC host (unit: GB)
    Note: This field may return null, indicating that no valid values can be obtained.
    Disk String Disk capacity of the CHC host
    Note: This field may return null, indicating that no valid values can be obtained.
    BmcMAC String MAC address assigned under the out-of-band network
    Note: This field may return null, indicating that no valid values can be obtained.
    DeployMAC String MAC address assigned under the deployment network
    Note: This field may return null, indicating that no valid values can be obtained.
    TenantType String Management type
    HOSTING: Hosting
    TENANT: Leasing
    Note: This field may return null, indicating that no valid values can be obtained.
    DeployExtraConfig ChcDeployExtraConfig CHC DHCP option, which is used for MiniOS debugging.
    Note: This field may return null, indicating that no valid values can be obtained.

    ChcHostDeniedActions

    Describe details of actions not allowed for a CHC instance

    Used by actions: DescribeChcDeniedActions.

    Name Type Description
    ChcId String CHC instance ID
    State String CHC instance status
    DenyActions Array of String Actions not allowed for the current CHC instance

    CpuTopology

    Information about the CPU topology of an instance.

    Used by actions: InquiryPriceRunInstances, RunInstances.

    Name Type Required Description
    CoreCount Integer No Number of physical CPU cores to enable.
    ThreadPerCore Integer No Number of threads per core. This parameter determines whether to enable or disable hyper-threading.
  • 1: Disable hyper-threading.

  • 2: Enable hyper-threading.

    • If not set, an instance uses the default hyper-threading policy. For how to enable or disable hyper-threading, refer to Enabling and Disabling Hyper-Threading.

    DataDisk

    Describes data disk information.

    Used by actions: CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeInstances, DescribeLaunchTemplateVersions, InquiryPriceResizeInstanceDisks, InquiryPriceRunInstances, ResizeInstanceDisks, RunInstances.

    Name Type Required Description
    DiskSize Integer Yes 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://www.tencentcloud.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.
    DiskType String No Specifies the data disk type. for restrictions on data disk types, refer to storage overview. valid values:
  • LOCAL_BASIC: LOCAL disk
  • LOCAL_SSD: LOCAL SSD
  • LOCAL_NVME: LOCAL NVME disk, which is closely related to InstanceType and cannot be specified
  • LOCAL_PRO: LOCAL HDD, which is closely related to InstanceType and cannot be specified
  • cloud_BASIC: BASIC cloud disk
  • cloud_PREMIUM: high-performance cloud block storage
  • cloud_SSD: SSD cloud disk
  • cloud_HSSD: enhanced SSD cloud disk
  • cloud_TSSD: ultra-fast SSD cbs
  • cloud_BSSD: universal SSD cloud disk

    • default: LOCAL_BASIC.

    this parameter is invalid for the ResizeInstanceDisk api.
    DiskId String No Specifies the data disk ID.
    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.
    DeleteWithInstance Boolean No Whether the data disk is terminated with the instance. value range:
  • true: when the instance is terminated, the data disk is also terminated. only hourly postpaid cloud disks are supported.
  • false: when the instance is terminated, the data disk is retained.
    default value: true
    currently, this parameter is only used for the API RunInstances.
    		•
    SnapshotId String No Data disk snapshot ID. the size of the selected data disk snapshot must be less than the data disk size.
    Encrypt Boolean No Specifies whether the data disk is encrypted. value range:
  • true: encrypted
  • false: unencrypted

    • default value: false
    this parameter is currently only used for the RunInstances api.
    KmsKeyId String No Custom CMK ID, value is UUID or similar to kms-abcd1234. used for encrypted cloud disk.

    This parameter is currently only used for the RunInstances api.
    Note: This field may return null, indicating that no valid value is found.
    ThroughputPerformance Integer No Cloud disk performance (unit: MiB/s). specifies additional performance for cloud disks.
    Currently only supports extreme cbs (CLOUD_TSSD) and enhanced SSD CLOUD disk (CLOUD_HSSD).
    Note: This field may return null, indicating that no valid value is found.
    CdcId String No Specifies the dedicated cluster ID belonging to.
    Note: This field may return null, indicating that no valid value is found.
    BurstPerformance Boolean No Burstable performance.

    Note: this field is in beta test..
    DiskName String No Disk name, with a length not exceeding 128 characters.

    DisasterRecoverGroup

    Information on disaster recovery groups

    Used by actions: DescribeDisasterRecoverGroups.

    Name Type Description
    DisasterRecoverGroupId String ID of a spread placement group.
    Name String Name of a spread placement group, which must be 1-60 characters long.
    Type String Type of a spread placement group. Valid values:

  • HOST: physical machine.
  • SW: switch.
  • RACK: rack.
    		•
    CvmQuotaTotal Integer The maximum number of CVMs that can be hosted in a spread placement group.
    CurrentNum Integer The current number of CVMs in a spread placement group.
    InstanceIds Array of String The list of CVM IDs in a spread placement group.
    Note: This field may return null, indicating that no valid value was found.
    CreateTime Timestamp ISO8601 Creation time of a spread placement group.
    Note: This field may return null, indicating that no valid value is found.
    Affinity Integer
    Tags Array of Tag List of tags associated with the placement group.

    EnhancedService

    Describes the configuration of enhanced services, such as Cloud Security and Cloud Monitor.

    Used by actions: CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeLaunchTemplateVersions, InquiryPriceResetInstance, InquiryPriceRunInstances, ResetInstance, RunInstances.

    Name Type Required Description
    SecurityService RunSecurityServiceEnabled No Enables cloud security service. If this parameter is not specified, the cloud security service will be enabled by default.
    MonitorService RunMonitorServiceEnabled No Enables cloud monitor service. If this parameter is not specified, the cloud monitor service will be enabled by default.
    AutomationService RunAutomationServiceEnabled No Whether to enable the TAT service. If this parameter is not specified, the TAT service is enabled for public images and disabled for other images by default.

    Externals

    Additional data

    Used by actions: CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeReservedInstancesConfigInfos, DescribeZoneInstanceConfigInfos, RunInstances.

    Name Type Required Description
    ReleaseAddress Boolean No Release Address
    UnsupportNetworks Array of String No Unsupported network type. valid values:
  • BASIC: BASIC network
  • VPC1.0: private network VPC1.0
    • .
    StorageBlockAttr StorageBlock No Specifies the HDD local storage attributes.

    Filter

    Key-value pair filters used for conditional queries, such as filtering results by ID, name, and state.

    • If there are multiple Filter parameters, they are evaluated using the logical AND operator.
    • If a Filter contains multiple Values, they are evaluated using the logical OR operator.

    Take DescribeInstances as an example. You can use the following filters to query the instances in availability zone (zone) Guangzhou Zone 1 and whose billing plan (instance-charge-type) is pay-as-you-go:

    Filters.0.Name=zone
&Filters.0.Values.0=ap-guangzhou-1
&Filters.1.Name=instance-charge-type
&Filters.1.Values.0=POSTPAID_BY_HOUR

    Used by actions: DescribeChcHosts, DescribeDisasterRecoverGroups, DescribeHosts, DescribeImages, DescribeInstances, DescribeKeyPairs, DescribeLaunchTemplates, DescribeReservedInstances, DescribeReservedInstancesConfigInfos, DescribeReservedInstancesOfferings, DescribeZoneInstanceConfigInfos.

    Name Type Required Description
    Name String Yes Filters.
    Values Array of String Yes Filter values.

    GPUInfo

    GPU information of the instance

    Used by actions: DescribeInstances.

    Name Type Description
    GPUCount Float Specifies the GPU count of the instance. a value less than 1 indicates VGPU type, and a value larger than 1 indicates GPU passthrough type.
    GPUId Array of String Specifies the GPU address of the instance.
    GPUType String Specifies the GPU type of the instance.

    HostItem

    CDH instance details

    Used by actions: DescribeHosts.

    Name Type Description
    Placement Placement CDH instance location. This parameter is used to specify the AZ, project, and other attributes of the instance.
    HostId String CDH instance ID
    HostType String CDH instance type
    HostName String CDH instance name
    HostChargeType String CDH instance billing mode
    RenewFlag String CDH instance renewal flag
    CreatedTime Timestamp ISO8601 CDH instance creation time
    ExpiredTime Timestamp ISO8601 CDH instance expiry time
    InstanceIds Array of String List of IDs of CVMs created on a CDH instance
    HostState String CDH instance status
    HostIp String CDH instance IP
    HostResource HostResource CDH instance resource information
    CageId String Cage ID of the CDH instance. This parameter is only valid for CDH instances in the cages of finance availability zones.
    Note: This field may return null, indicating that no valid value is found.

    HostResource

    Resource information of the CDH instance

    Used by actions: DescribeHosts.

    Name Type Description
    CpuTotal Integer Total number of CPU cores in the CDH instance
    CpuAvailable Integer Number of available CPU cores in the CDH instance
    MemTotal Float Total memory size of the CDH instance (unit: GiB)
    MemAvailable Float Available memory size of the CDH instance (unit: GiB)
    DiskTotal Integer Total disk size of the CDH instance (unit: GiB)
    DiskAvailable Integer Available disk size of the CDH instance (unit: GiB)
    DiskType String Disk type of the CDH instance
    GpuTotal Integer Total number of GPU cards in the CDH instance
    GpuAvailable Integer Number of available GPU cards in the CDH instance

    Image

    Details about an image, including its state and attributes.

    Used by actions: DescribeImageFromFamily, DescribeImages.

    Name Type Description
    ImageId String Image ID
    OsName String Operating system of the image
    ImageType String Image type
    CreatedTime Timestamp ISO8601 Creation time of the image
    ImageName String Image name
    ImageDescription String Image description
    ImageSize Integer Image size
    Architecture String Image architecture
    ImageState String Image state
    Platform String Source platform of the image
    ImageCreator String Image creator
    ImageSource String Image source
    SyncPercent Integer Synchronization percentage
    Note: This field may return null, indicating that no valid value is found.
    IsSupportCloudinit Boolean Whether the image supports cloud-init
    Note: This field may return null, indicating that no valid value is found.
    SnapshotSet Array of Snapshot Information on the snapshots associated with the image
    Note: This field may return null, indicating that no valid value is found.
    Tags Array of Tag The list of tags bound to the image.
    Note: This field may return null, indicating that no valid value was found.
    LicenseType String Image license type
    ImageFamily String Image family, Note: This field may return empty
    ImageDeprecated Boolean Whether the image is deprecated

    ImageOsList

    Supported operating systems. They are divided into two categories, Windows and Linux.

    Used by actions: DescribeImportImageOs.

    Name Type Description
    Windows Array of String Supported Windows OS
    Note: This field may return null, indicating that no valid values can be obtained.
    Linux Array of String Supported Linux OS
    Note: This field may return null, indicating that no valid values can be obtained.

    Instance

    Describes information on an instance

    Used by actions: DescribeInstances.

    Name Type Description
    Placement Placement Location of the instance
    InstanceId String Instance ID
    InstanceType String Instance model
    CPU Integer Number of CPU cores of the instance; unit: core
    Memory Integer Instance memory capacity. unit: GiB.
    RestrictState String Instance business status. valid values:
  • NORMAL: indicates an instance in the NORMAL state
  • EXPIRED: indicates an EXPIRED instance
  • PROTECTIVELY_ISOLATED: PROTECTIVELY ISOLATED instance
    • .
    InstanceName String Instance name
    InstanceChargeType String Instance billing plan. Valid values:
  • POSTPAID_BY_HOUR: pay after use. You are billed by the hour, by traffic.
  • CDHPAID: CDH billing plan. Applicable to CDH only, not the instances on the host.
    		•
    SystemDisk SystemDisk Information on the system disk of the instance
    DataDisks Array of DataDisk Information of the instance data disks.
    PrivateIpAddresses Array of String List of private IPs of the instance's primary ENI.
    PublicIpAddresses Array of String List of public IPs of the instance's primary ENI.
    Note: This field may return null, indicating that no valid value is found.
    InternetAccessible InternetAccessible Information on instance bandwidth.
    VirtualPrivateCloud VirtualPrivateCloud Information on the VPC where the instance resides.
    ImageId String ID of the image used to create the instance.
    RenewFlag String AUTO-Renewal flag. valid values:
  • NOTIFY_AND_MANUAL_RENEW: indicates that a notification of impending expiration is made but AUTO-renewal is not performed
  • NOTIFY_AND_AUTO_RENEW: indicates that a notification of impending expiration is made AND AUTO-renewal is performed
  • DISABLE_NOTIFY_AND_MANUAL_RENEW: indicates that notification that it is about to expire is not made AND AUTO-renewal is not performed.
    Note: this field is null in postpaid mode.
    		•
    CreatedTime Timestamp ISO8601 Creation time following the ISO8601 standard and using UTC time in the format of YYYY-MM-DDThh:mm:ssZ.
    ExpiredTime Timestamp ISO8601 Expiration time in UTC format following the ISO8601 standard: YYYY-MM-DDThh:mm:ssZ. Note: this parameter is null for postpaid instances.
    OsName String Operating system name.
    SecurityGroupIds Array of String Security groups to which the instance belongs. To obtain the security group IDs, you can call DescribeSecurityGroups and look for the sgld fields in the response.
    LoginSettings LoginSettings Login settings of the instance. Currently only the key associated with the instance is returned.
    InstanceState String Instance status. for specific status types, see the instance status table
    Tags Array of Tag List of tags associated with the instance.
    StopChargingMode String Shutdown billing mode of an instance.

    Valid values:
  • KEEP_CHARGING: billing continues after shutdown
  • STOP_CHARGING: billing stops after shutdown
  • NOT_APPLICABLE: the instance is NOT shut down or stopping billing after shutdown is NOT APPLICABLE to the instance
    • .
    Uuid String Globally unique ID of the instance.
    LatestOperation String Last operation of the instance, such as StopInstances or ResetInstance.
    LatestOperationState String The latest operation status of the instance. valid values:
  • SUCCESS: indicates that the operation succeeded
  • OPERATING: indicates that the operation is in progress
  • FAILED: indicates that the operation FAILED
    • .
    Note: This field may return null, indicating that no valid value is found.
    LatestOperationRequestId String Unique request ID for the last operation of the instance.
    DisasterRecoverGroupId String Spread placement group ID.
    IPv6Addresses Array of String IPv6 address of the instance.
    Note: this field may return null, indicating that no valid value is obtained.
    CamRoleName String CAM role name.
    Note: this field may return null, indicating that no valid value is obtained.
    HpcClusterId String High-performance computing cluster ID.
    RdmaIpAddresses Array of String IP list of HPC cluster.
    Note: this field may return null, indicating that no valid value was found.
    DedicatedClusterId String Dedicated cluster ID where the instance is located.
    IsolatedSource String Instance isolation type. valid values:
  • ARREAR: indicates arrears isolation
  • EXPIRE: indicates isolation upon expiration
  • MANMADE: indicates voluntarily refunded isolation
  • NOTISOLATED: indicates unisolated
    • .
    GPUInfo GPUInfo GPU information. if it is a gpu type instance, this value will be returned. for other type instances, it does not return.
    LicenseType String Instance OS license type. Default value: TencentCloud
    DisableApiTermination Boolean 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, allow passage

    • default value: false.
    DefaultLoginUser String Default login user
    DefaultLoginPort Integer Default login port
    LatestOperationErrorMsg String Latest operation errors of the instance.
    Note: This field may return null, indicating that no valid values can be obtained.
    Metadata Metadata Custom metadata. this parameter corresponds to the metadata information specified when creating a CVM. note: in beta test.
    PublicIPv6Addresses Array of String Specifies the public IPv6 address bound to the instance.

    InstanceAttribute

    Instance attributes.

    Used by actions: DescribeInstancesAttributes.

    Name Type Description
    InstanceId String Instance ID.
    Attributes Attribute Instance attribute information.

    InstanceChargePrepaid

    Describes the billing method of an instance.

    Used by actions: CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeLaunchTemplateVersions, InquiryPriceModifyInstancesChargeType, InquiryPriceRenewInstances, InquiryPriceRunInstances, ModifyInstancesChargeType, RenewInstances, RunInstances.

    Name Type Required Description
    Period Integer Yes Subscription period in months. value range: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60.
    RenewFlag String No AUTO-Renewal flag. value ranges:
  • NOTIFY_AND_AUTO_RENEW: NOTIFY of expiration AND automatically RENEW.

  • NOTIFY_AND_MANUAL_RENEW: NOTIFY of expiration but do not automatically RENEW.

  • DISABLE_NOTIFY_AND_MANUAL_RENEW: do not NOTIFY of expiration AND do not automatically RENEW.


    • 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.

    InstanceFamilyConfig

    Describes the model family of the instance.
    Examples: {'InstanceFamilyName': 'Standard S1', 'InstanceFamily': 'S1'}, {'InstanceFamilyName': 'Network-optimized N1', 'InstanceFamily': 'N1'}, {'InstanceFamilyName': 'High IO I1', 'InstanceFamily': 'I1'}, etc.

    Used by actions: DescribeInstanceFamilyConfigs.

    Name Type Description
    InstanceFamilyName String Full name of the model family.
    InstanceFamily String Acronym of the model family.

    InstanceMarketOptionsRequest

    Options related to bidding requests

    Used by actions: CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeLaunchTemplateVersions, InquiryPriceRunInstances, RunInstances.

    Name Type Required Description
    SpotOptions SpotMarketOptions Yes Relevant options for spot instances.
    MarketType String No Market option type. The value can only be spot currently.

    InstanceStatus

    Describes instance states. For state types, see here.

    Used by actions: DescribeInstancesStatus.

    Name Type Description
    InstanceId String Instance ID.
    InstanceState String Instance status. Valid values:
  • PENDING: Creating.
  • LAUNCH_FAILED: Creation failed.
  • RUNNING: Running.
  • STOPPED: Shut down.
  • STARTING: Starting up.
  • STOPPING: Shutting down.
  • REBOOTING: Restarting.
  • SHUTDOWN: Shut down and to be terminated.
  • TERMINATING: Terminating.
  • ENTER_RESCUE_MODE: Entering the rescue mode.
  • RESCUE_MODE: In the rescue mode.
  • EXIT_RESCUE_MODE: Exiting the rescue mode.
  • ENTER_SERVICE_LIVE_MIGRATE: Entering online service migration.
  • SERVICE_LIVE_MIGRATE: In online service migration.
  • EXIT_SERVICE_LIVE_MIGRATE: Exiting online service migration.
    		•

    InstanceTypeQuotaItem

    Describes instance model quota.

    Used by actions: DescribeZoneInstanceConfigInfos.

    Name Type Description
    Zone String Availability zone.
    InstanceType String Instance model.
    InstanceChargeType String Instance billing plan. Valid values:
  • POSTPAID_BY_HOUR: pay after use. You are billed for your traffic by the hour.
  • CDHPAID: CDH billing plan. Applicable to CDH only, not the instances on the host.
    		•
    NetworkCard Integer ENI type. For example, 25 represents an ENI of 25 GB.
    Externals Externals Additional data.
    Note: This field may return null, indicating that no valid value is found.
    Cpu Integer Number of CPU cores of an instance model.
    Memory Integer Instance memory capacity; unit: GB.
    InstanceFamily String Instance model family.
    TypeName String Model name.
    LocalDiskTypeList Array of LocalDiskType List of local disk specifications. If the parameter returns null, it means that local disks cannot be created.
    Status String Whether an instance is for sale. Valid values:
  • SELL: The instance is available for purchase.
    • SOLD_OUT: The instance has been sold out.
    Price ItemPrice Price of an instance model.
    SoldOutReason String Details of out-of-stock items
    Note: this field may return null, indicating that no valid value is obtained.
    InstanceBandwidth Float Private network bandwidth, in Gbps.
    InstancePps Integer The max packet sending and receiving capability (in 10k PPS).
    StorageBlockAmount Integer Number of local storage blocks.
    CpuType String CPU type.
    Gpu Integer Number of GPUs of the instance.
    Fpga Integer Number of FPGAs of the instance.
    Remark String Descriptive information of the instance.
    GpuCount Float
    Frequency String CPU clock rate of the instance
    StatusCategory String Inventory status. Valid values:
  • EnoughStock: Inventory is sufficient.

  • NormalStock: Supply is guaranteed.
  • UnderStock: Inventory is about to sell out.

  • WithoutStock: Inventory is already sold out.

    • Note: This field may return null, indicating that no valid value is found.

    InternetAccessible

    Describes the accessibility of an instance in the public network, including its network billing method, maximum bandwidth, etc.

    Used by actions: CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeInstances, DescribeLaunchTemplateVersions, InquiryPriceResetInstancesInternetMaxBandwidth, InquiryPriceRunInstances, ResetInstancesInternetMaxBandwidth, RunInstances.

    Name Type Required Description
    InternetChargeType String No Network connection billing plan. Valid value:

  • TRAFFIC_POSTPAID_BY_HOUR: pay after use. You are billed for your traffic, by the hour.
  • BANDWIDTH_PACKAGE: Bandwidth package user.
    • InternetMaxBandwidthOut Integer No The maximum outbound bandwidth of the public network, in Mbps. The default value is 0 Mbps. The upper limit of bandwidth varies for different models. For more information, see Purchase Network Bandwidth.
    PublicIpAssigned Boolean No Whether to allocate a public IP address. Valid values:
  • true: Allocate a public IP address.
  • false: Do not allocate a public IP address.

    • 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.
    BandwidthPackageId String No 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.
    InternetServiceProvider String No Line type. for details on various types of lines and supported regions, refer to EIP IP address types. default value: BGP.
  • BGP: specifies the general bgp line.
    • .
    For a user with static single-line IP allowlist enabled, valid values include:.
  • CMCC: china mobile.
    • .
  • CTCC: china telecom
    • .
  • CUCC: china unicom
    • .
    Note: The static single-line IP is only supported in some regions.
    IPv4AddressType String No Specifies the public IP type.

  • WanIP: specifies the public ip address.
    • .
  • HighQualityEIP: specifies a high quality ip. high quality ip is only supported in Singapore and hong kong (china).
    • .
  • AntiDDoSEIP: specifies the anti-ddos eip. only partial regions support anti-ddos eip. details visible in the elastic IP product overview.
    • .
    If needed, assign a public IPv4 address to the resource by specifying the IPv4 address type.

    This feature is in beta test in selected regions. submit a ticket for consultation (https://console.tencentcloud.com/workorder/category) if needed.
    IPv6AddressType String No Indicates the type of elastic public IPv6.
  • EIPv6: elastic ip version 6.
    • .
  • HighQualityEIPv6: specifies the high quality ipv6. highqualityeipv6 is only supported in hong kong (china).
    • .
    If needed, assign an elastic IPv6 address for resource allocation.

    This feature is in beta test in selected regions. submit a ticket for consultation (https://console.tencentcloud.com/workorder/category) if needed.
    AntiDDoSPackageId String No DDoS protection package unique ID. this field is required when applying for a ddos protection IP.

    InternetChargeTypeConfig

    Describes network billing.

    Used by actions: DescribeInternetChargeTypeConfigs.

    Name Type Required Description
    InternetChargeType String No Network billing method.
    Description String No Description of the network billing method.

    ItemPrice

    Describes pricing information.

    Used by actions: DescribeZoneInstanceConfigInfos, InquiryPriceModifyInstancesChargeType, InquiryPriceRenewInstances, InquiryPriceResetInstance, InquiryPriceResetInstancesInternetMaxBandwidth, InquiryPriceResetInstancesType, InquiryPriceResizeInstanceDisks, InquiryPriceRunInstances.

    Name Type Description
    UnitPrice Float Original price of subsequent total costs, postpaid billing mode usage, unit: usd.
  • if other time interval items are returned, such as UnitPriceSecondStep, this item represents the time interval (0, 96) hr. if no other time interval items are returned, this item represents the full period (0, ∞) hr.
    		•
    ChargeUnit String Billing unit for pay-as-you-go mode. valid values:
  • HOUR: billed on an hourly basis. it's used for hourly POSTPAID instances (POSTPAID_BY_HOUR).
  • GB: bill BY TRAFFIC in GB. it's used for POSTPAID products that are billed BY the hourly TRAFFIC (TRAFFIC_POSTPAID_BY_HOUR).
    		•
    OriginalPrice Float Original price of total prepaid costs. measurement unit: usd.
    DiscountPrice Float Discount price of total prepaid costs. unit: usd.
    Discount Float Discount, such as 20.0 representing 80% off.
    UnitPriceDiscount Float Discounted price of subsequent total cost, postpaid billing mode usage, unit: usd
  • if other time interval items are returned, such as UnitPriceDiscountSecondStep, this item represents the time interval (0, 96) hr; if no other time interval items are returned, this item represents the full period (0, ∞) hr.
    		•
    UnitPriceSecondStep Float Original price of subsequent total costs for usage time range (96, 360) hr in postpaid billing mode. unit: usd.
    UnitPriceDiscountSecondStep Float Discounted price of subsequent total cost for usage time interval (96, 360) hr in postpaid billing mode. unit: usd.
    UnitPriceThirdStep Float Specifies the original price of subsequent total costs with a usage time interval exceeding 360 hr in postpaid billing mode. measurement unit: usd.
    UnitPriceDiscountThirdStep Float Discounted price of subsequent total cost for usage time interval exceeding 360 hr in postpaid billing mode. measurement unit: usd.
    OriginalPriceThreeYear Float Specifies the original price of total 3-year prepaid costs in prepaid billing mode. measurement unit: usd.
    Note: This field may return null, indicating that no valid value is found.
    DiscountPriceThreeYear Float Specifies the discount price for an advance payment of the total fee for three years, prepaid mode usage, measurement unit: usd.
    Note: This field may return null, indicating that no valid value is found.
    DiscountThreeYear Float Specifies the discount for a 3-year advance payment, for example 20.0 represents 80% off.
    Note: This field may return null, indicating that no valid value is found.
    OriginalPriceFiveYear Float Specifies the original price of the 5-year total cost with advance payment, using prepaid billing mode. measurement unit: usd.
    Note: This field may return null, indicating that no valid value is found.
    DiscountPriceFiveYear Float Prepaid 5-year total cost discount price, prepaid billing mode usage. unit: usd.
    Note: This field may return null, indicating that no valid value is found.
    DiscountFiveYear Float Specifies the discount for 5-year advance payment, such as 20.0 for 80% off.
    Note: This field may return null, indicating that no valid value is found.
    OriginalPriceOneYear Float Original price of one-year advance payment total cost. prepaid mode usage. unit: usd.
    Note: This field may return null, indicating that no valid value is found.
    DiscountPriceOneYear Float Discount price for total advance payment for one year. specifies prepaid mode usage. measurement unit: usd.
    Note: This field may return null, indicating that no valid value is found.
    DiscountOneYear Float Specifies the discount for a one-year advance payment, such as 20.0 for 80% off.
    Note: This field may return null, indicating that no valid value is found.

    KeyPair

    Describes key pair information.

    Used by actions: CreateKeyPair, DescribeKeyPairs.

    Name Type Description
    KeyId String Key pair ID, the unique identifier of a key pair.
    KeyName String Key pair name.
    ProjectId Integer ID of the project to which a key pair belongs.
    Description String Key pair description.
    PublicKey String Content of public key in a key pair.
    PrivateKey String Content of private key in a key pair. Tencent Cloud do not keep private keys. Please keep it properly.
    AssociatedInstanceIds Array of String ID list of instances associated with a key.
    CreatedTime Timestamp ISO8601 Creation time, which follows the ISO8601 standard and uses UTC time in the format of YYYY-MM-DDThh:mm:ssZ.
    Tags Array of Tag The list of tags bound to the key.
    Note: This field may return null, indicating that no valid value can be obtained.

    LaunchTemplate

    Instance launch template. This parameter enables you to create an instance using the preset parameters in the template.

    Used by actions: InquiryPriceRunInstances, RunInstances.

    Name Type Required Description
    LaunchTemplateId String No Instance launch template ID. This parameter enables you to create an instance using the preset parameters in the template.
    LaunchTemplateVersion Integer No Instance launch template version number. If specified, this parameter will be used to create a new instance launch template.

    LaunchTemplateInfo

    Information of instance launch template.

    Used by actions: DescribeLaunchTemplates.

    Name Type Description
    LatestVersionNumber Integer Instance launch template version number.
    Note: This field may return null, indicating that no valid values can be obtained.
    LaunchTemplateId String Instance launch template ID.
    Note: This field may return null, indicating that no valid values can be obtained.
    LaunchTemplateName String Instance launch template name.
    Note: This field may return null, indicating that no valid values can be obtained.
    DefaultVersionNumber Integer Default instance launch template version number.
    Note: This field may return null, indicating that no valid values can be obtained.
    LaunchTemplateVersionCount Integer Total number of versions that the instance launch template contains.
    Note: This field may return null, indicating that no valid values can be obtained.
    CreatedBy String UIN of the user who created the template.
    Note: This field may return null, indicating that no valid values can be obtained.
    CreationTime Timestamp ISO8601 Creation time of the template.
    Note: This field may return null, indicating that no valid values can be obtained.

    LaunchTemplateVersionData

    Information of instance launch template versions

    Used by actions: DescribeLaunchTemplateVersions.

    Name Type Description
    Placement Placement Location of the instance.
    Note: This field may return null, indicating that no valid values can be obtained.
    InstanceType String Instance model.
    Note: This field may return null, indicating that no valid values can be obtained.
    InstanceName String Instance name.
    Note: This field may return null, indicating that no valid values can be obtained.
    InstanceChargeType String Instance billing mode. Valid values:
  • POSTPAID_BY_HOUR: postpaid for pay-as-you-go instances
  • CDHPAID: billed for CDH instances, not the CVMs running on the CDHs.

    Note: This field may return null, indicating that no valid values can be obtained.
    		•
    SystemDisk SystemDisk Instance system disk information.
    Note: This field may return null, indicating that no valid values can be obtained.
    DataDisks Array of DataDisk Instance data disk information. This parameter only covers the data disks purchased together with the instance.
    Note: This field may return null, indicating that no valid values can be obtained.
    InternetAccessible InternetAccessible Instance bandwidth information.
    Note: This field may return null, indicating that no valid values can be obtained.
    VirtualPrivateCloud VirtualPrivateCloud Information of the VPC where the instance resides.
    Note: This field may return null, indicating that no valid values can be obtained.
    ImageId String ID of the image used to create the instance.
    Note: This field may return null, indicating that no valid values can be obtained.
    SecurityGroupIds Array of String Security groups to which the instance belongs. To obtain the security group IDs, you can call DescribeSecurityGroups and look for the sgld fields in the response.
    Note: This field may return null, indicating that no valid values can be obtained.
    LoginSettings LoginSettings Login settings of the instance. Currently, only the key associated with the instance is returned.
    Note: This field may return null, indicating that no valid values can be obtained.
    CamRoleName String CAM role name.
    Note: This field may return null, indicating that no valid values can be obtained.
    HpcClusterId String HPC cluster ID.
    Note: This field may return null, indicating that no valid values can be obtained.
    InstanceCount Integer Number of instances purchased.
    Note: This field may return null, indicating that no valid values can be obtained.
    EnhancedService EnhancedService Enhanced service.
    Note: This field may return null, indicating that no valid values can be obtained.
    UserData String User data provided to the instance. This parameter needs to be encoded in base64 format with the maximum size of 16KB.
    Note: This field may return null, indicating that no valid values can be obtained.
    DisasterRecoverGroupIds Array of String Placement group ID. You can only specify one.
    Note: This field may return null, indicating that no valid values can be obtained.
    ActionTimer ActionTimer Scheduled tasks. You can use this parameter to specify scheduled tasks for the instance. Only scheduled termination is supported.
    Note: This field may return null, indicating that no valid values can be obtained.
    InstanceMarketOptions InstanceMarketOptionsRequest Market options of the instance, such as parameters related to spot instances. This parameter is required for spot instances.
    Note: This field may return null, indicating that no valid values can be obtained.
    HostName String Hostname of a CVM.
    Note: This field may return null, indicating that no valid values can be obtained.
    ClientToken String A string used to ensure the idempotency of the request.
    Note: This field may return null, indicating that no valid values can be obtained.
    InstanceChargePrepaid InstanceChargePrepaid Prepaid mode. This parameter indicates relevant parameter settings for monthly-subscribed instances.
    Note: This field may return null, indicating that no valid values can be obtained.
    TagSpecification Array of TagSpecification List of tag description. By specifying this parameter, the tag can be bound to the corresponding CVM and CBS instances at the same time.
    Note: This field may return null, indicating that no valid values can be obtained.
    DisableApiTermination Boolean Whether to enable termination protection. Valid values:

    TRUE: Termination protection is enabled.
    FALSE: Termination protection is disabled.

    Default value: FALSE.
    Note: This field may return null, indicating that no valid values can be obtained.

    LaunchTemplateVersionInfo

    Set of instance launch template versions.

    Used by actions: DescribeLaunchTemplateVersions.

    Name Type Description
    LaunchTemplateVersion Integer Instance launch template version number.
    Note: This field may return null, indicating that no valid values can be obtained.
    LaunchTemplateVersionData LaunchTemplateVersionData Details of instance launch template versions.
    CreationTime Timestamp ISO8601 Creation time of the instance launch template version.
    LaunchTemplateId String Instance launch template ID.
    IsDefaultVersion Boolean Specifies whether it’s the default launch template version.
    LaunchTemplateVersionDescription String Information of instance launch template version description.
    Note: This field may return null, indicating that no valid values can be obtained.
    CreatedBy String Creator account

    LocalDiskType

    Describes local disk specifications.

    Used by actions: DescribeZoneInstanceConfigInfos.

    Name Type Description
    Type String Type of a local disk.
    PartitionType String Attributes of a local disk.
    MinSize Integer Minimum size of a local disk.
    MaxSize Integer Maximum size of a local disk.
    Required String Whether a local disk is required during purchase. Valid values:
  • REQUIRED: required
  • OPTIONAL: optional
    		•

    LoginSettings

    Describes login settings of an instance.

    Used by actions: CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeInstances, DescribeLaunchTemplateVersions, InquiryPriceResetInstance, InquiryPriceRunInstances, ResetInstance, RunInstances.

    Name Type Required Description
    Password String No Instance login password. The password complexity limits vary with the operating system type as follows:
  • The Linux instance password must be 8 to 30 characters long and include at least two of the following: [a-z], [A-Z], [0-9], and special characters of [( ) ` ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? / ].
  • The Windows instance password must be 12 to 30 characters long and include at least three of the following: [a-z], [A-Z], [0-9], and special characters [( ) ` ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? /].

    If this parameter is not specified, you need to set it before login by using the console to "reset password" or by calling the ResetInstancesPassword API.
    		•
    KeyIds Array of String No List of key IDs. After an instance is associated with a key, you can access the instance with the private key in the key pair. You can call DescribeKeyPairs to obtain KeyId. You cannot specify a key and a password at the same time. Windows instances do not support keys.
    Note: This field may return null, indicating that no valid values can be obtained.
    KeepImageLogin String No 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:
  • true: indicates that the login settings of the image are retained
  • false: indicates that the login settings of the image are not retained
    • . default value: false.

    Metadata

    Custom metadata.

    Used by actions: CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeInstances, InquiryPriceRunInstances, RunInstances.

    Name Type Required Description
    Items Array of MetadataItem Yes A list of custom metadata key-value pairs.

    MetadataItem

    Custom metadata key and value.

    Used by actions: CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeInstances, InquiryPriceRunInstances, RunInstances.

    Name Type Required Description
    Key String Yes Custom metadata key, consisting of uppercase letters (A-Z), lowercase letters (A-Z), digits (0-9), underscores (_), or hyphens (-), with a size limit of 128 bytes.
    Value String Yes Custom metadata value. The upper limit of message size is 256 KB.

    OperationCountLimit

    Describes the maximum number of times you can perform an operation on a single instance.

    Used by actions: DescribeInstancesOperationLimit.

    Name Type Description
    Operation String Instance operation. Valid values:
  • INSTANCE_DEGRADE: downgrade an instance
  • INTERNET_CHARGE_TYPE_CHANGE: modify the billing plan of the network connection
    		•
    InstanceId String Instance ID.
    CurrentCount Integer Number of operations already performed. If it returns -1, it means there is no limit on the times of the operation.
    LimitCount Integer Maximum number of times you can perform an operation. If it returns -1, it means there is no limit on the times of the operation. If it returns 0, it means that configuration modification is not supported.

    OsVersion

    Supported operating system types.

    Used by actions: DescribeImportImageOs.

    Name Type Description
    OsName String Operating system type
    OsVersions Array of String Supported operating system versions
    Architecture Array of String Supported operating system architecture

    Placement

    Placement of an instance, including its availability zone, project, host (for CDH products only), master host IP, etc.

    Used by actions: AllocateHosts, CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeChcHosts, DescribeHosts, DescribeInstances, DescribeLaunchTemplateVersions, InquiryPriceRunInstances, RunInstances.

    Name Type Required Description
    Zone String Yes ID of the availability zone where the instance resides. You can call the DescribeZones API and obtain the ID in the returned Zone field.
    ProjectId Integer No Instance'S project ID. obtain this parameter by calling the ProjectId field in the return value of DescribeProject. default value 0 means default project.
    HostIds Array of String No Specifies the dedicated host ID list for instance ownership, only used for input parameters. if you purchase a dedicated host and specify this parameter, instances you purchase will be randomly deployed on these dedicated hosts. obtain this parameter by calling the HostId field in the return value of DescribeHosts.
    HostId String No The ID of the CDH to which the instance belongs, only used as an output parameter.

    Price

    Price.

    Used by actions: InquiryPriceModifyInstancesChargeType, InquiryPriceRenewInstances, InquiryPriceResetInstance, InquiryPriceResetInstancesInternetMaxBandwidth, InquiryPriceResetInstancesType, InquiryPriceResizeInstanceDisks, InquiryPriceRunInstances.

    Name Type Description
    InstancePrice ItemPrice Instance price.
    BandwidthPrice ItemPrice Network price.

    RegionInfo

    Region information.

    Used by actions: DescribeRegions.

    Name Type Description
    Region String Region name, such as ap-guangzhou
    RegionName String Region description, such as South China (Guangzhou)
    RegionState String Whether the region is available

    ReservedInstanceConfigInfoItem

    Static configurations of the reserved instance.

    Used by actions: DescribeReservedInstancesConfigInfos.

    Name Type Description
    Type String Abbreviation name of the instance type.
    TypeName String Full name of the instance type.
    Order Integer Priority.
    InstanceFamilies Array of ReservedInstanceFamilyItem List of instance families.

    ReservedInstanceFamilyItem

    RI-related instance family.

    Used by actions: DescribeReservedInstancesConfigInfos.

    Name Type Description
    InstanceFamily String Instance family.
    Order Integer Priority.
    InstanceTypes Array of ReservedInstanceTypeItem List of instance types.

    ReservedInstancePrice

    Price of the reserved instance. Currently, RIs are only offered to beta users.

    Used by actions: InquirePricePurchaseReservedInstancesOffering.

    Name Type Description
    OriginalFixedPrice Float Original upfront payment, in USD.
    DiscountFixedPrice Float Discounted upfront payment, in USD.
    OriginalUsagePrice Float Original subsequent unit price, in USD/hr.
    DiscountUsagePrice Float Discounted subsequent unit price, in USD/hr.
    FixedPriceDiscount Float Discount on upfront cost. For example, 20.0 indicates 80% off. Note: This field may return null, indicating that no valid value is found.
    Note: This field may return null, indicating that no valid value is found.
    UsagePriceDiscount Float Discount on subsequent cost. For example, 20.0 indicates 80% off. Note: This field may return null, indicating that no valid value is found.
    Note: This field may return null, indicating that no valid value is found.

    ReservedInstancePriceItem

    Price information of the reserved instance based on the payment method.

    Used by actions: DescribeReservedInstancesConfigInfos.

    Name Type Description
    OfferingType String Payment method. Valid values: All Upfront, Partial Upfront, and No Upfront.
    FixedPrice Float Upfront payment, in USD.
    UsagePrice Float Subsequent unit price, in USD/hr.
    ReservedInstancesOfferingId String The ID of the reserved instance offering.
    Zone String The availability zone in which the reserved instance can be purchased.
    Duration Integer The validity of the reserved instance in seconds, which is the purchased usage period. For example, 31536000.
    Unit: second
    ProductDescription String The operating system of the reserved instance, such as Linux.
    Valid value: Linux.
    DiscountUsagePrice Float Discount price for subsequent total cost, in USD/hr.
    DiscountFixedPrice Float Discount price for upfront total cost, in USD.

    ReservedInstanceTypeItem

    Reserved instance specification.

    Used by actions: DescribeReservedInstancesConfigInfos.

    Name Type Description
    InstanceType String Instance type.
    Cpu Integer Number of CPU cores.
    Memory Integer Memory size.
    Gpu Integer Number of GPUs.
    Fpga Integer Number of FPGAs.
    StorageBlock Integer Number of local storage blocks.
    NetworkCard Integer Number of NICs.
    MaxBandwidth Float Maximum bandwidth.
    Frequency String CPU frequency.
    CpuModelName String CPU type.
    Pps Integer Packet forwarding rate.
    Externals Externals Other information.
    Remark String Remarks.
    Prices Array of ReservedInstancePriceItem Price information about the reserved instance.

    ReservedInstances

    Information on reserved instances purchased by the user.

    Used by actions: DescribeReservedInstances.

    Name Type Description
    InstanceType String Specifications of reserved instances. For example, S3.MEDIUM4.
    Return values: Reserved instance specification list.
    Zone String Availability zones in which reserved instances can be purchased. For example, ap-guangzhou-1.
    Return values: Availability zone list.
    StartTime Timestamp Billing start time of reserved instances. For example, 1949-10-01 00:00:00.
    EndTime Timestamp Billing end time of reserved instances. For example, 1949-10-01 00:00:00.
    Duration Integer Validity periods of reserved instances, which is the purchase duration of reserved instances. For example, 31536000.
    Unit: second.
    InstanceCount Integer Number of purchased reserved instances. For example, 10.
    ProductDescription String Platform descriptions (operating systems) of reserved instances. For example, linux.
    Return value: linux.
    State String Statuses of purchased reserved instances. For example: active.
    Return values: active (created) | pending (waiting to be created) | retired (expired).
    CurrencyCode String Billing currencies of purchasable reserved instances. Use standard currency codes defined in ISO 4217. For example, USD.
    Return value: USD.
    OfferingType String Payment types of reserved instances. For example, All Upfront.
    Return value: All Upfront (fully prepaid).
    InstanceFamily String Types of reserved instances. For example, S3.
    Return values: Reserved instance type list.
    ReservedInstanceId String IDs of purchased reserved instances. For example, ri-rtbh4han.
    ReservedInstanceName String Display names of reserved instances. For example, riname-01.

    ReservedInstancesOffering

    The information of the Reserved Instance offering.

    Used by actions: DescribeReservedInstancesOfferings.

    Name Type Description
    Zone String The availability zones in which the Reserved Instance can be purchased, such as ap-guangzhou-1.
    Valid value: Availability Zones
    CurrencyCode String The billing currency of the Reserved Instance you are purchasing. It's specified using ISO 4217 standard currency.
    Value: USD.
    Duration Integer The validity of the Reserved Instance in seconds, which is the purchased usage period. For example, 31536000.
    Unit: second
    FixedPrice Float The purchase price of the Reserved Instance, such as 4000.0.
    Unit: this field uses the currency code specified in currencyCode, and only supports “USD” at this time.
    InstanceType String The instance model of the Reserved Instance, such as S3.MEDIUM4.
    Valid values: please see Reserved Instance Types
    OfferingType String The payment term of the Reserved Instance, such as All Upfront.
    Valid value: All Upfront.
    ReservedInstancesOfferingId String The ID of the Reserved Instance offering, such as 650c138f-ae7e-4750-952a-96841d6e9fc1.
    ProductDescription String The operating system of the Reserved Instance, such as linux.
    Valid value: linux.
    UsagePrice Float The hourly usage price of the Reserved Instance, such as 0.0.
    Currently, the only supported payment mode is All Upfront, so the default value of UsagePrice is 0 USD/hr.
    Unit: USD/hr. This field uses the currency code specified in currencyCode, and only supports “USD” at this time.

    RunAutomationServiceEnabled

    Describes the TAT service information.

    Used by actions: CreateLaunchTemplate, CreateLaunchTemplateVersion, InquiryPriceResetInstance, InquiryPriceRunInstances, ResetInstance, RunInstances.

    Name Type Required Description
    Enabled Boolean No Whether to enable the TAT service. Valid values:
  • TRUE: yes;
  • FALSE: no

    Default: FALSE.
    		•

    RunMonitorServiceEnabled

    Describes information related to the Cloud Monitor service.

    Used by actions: CreateLaunchTemplate, CreateLaunchTemplateVersion, InquiryPriceResetInstance, InquiryPriceRunInstances, ResetInstance, RunInstances.

    Name Type Required Description
    Enabled Boolean No Whether to enable the cloud monitor service. value ranges from:
  • true: indicates enabling the cloud monitor service
  • false: indicates disabling the cloud monitor service
    • default value: true.

    RunSecurityServiceEnabled

    Describes information related to the Cloud Security service.

    Used by actions: CreateLaunchTemplate, CreateLaunchTemplateVersion, InquiryPriceResetInstance, InquiryPriceRunInstances, ResetInstance, RunInstances.

    Name Type Required Description
    Enabled Boolean No Whether to enable Cloud Security. Valid values:
  • TRUE: enable Cloud Security
  • FALSE: do not enable Cloud Security

    Default value: TRUE.
    		•

    SharePermission

    Describes image sharing information.

    Used by actions: DescribeImageSharePermission.

    Name Type Description
    CreatedTime Timestamp ISO8601 Time when an image was shared.
    AccountId String ID of the account with which the image is shared.

    Snapshot

    Describes information on the snapshot associated with an image.

    Used by actions: DescribeImageFromFamily, DescribeImages.

    Name Type Description
    SnapshotId String Snapshot ID.
    DiskUsage String Type of the cloud disk used to create the snapshot. Valid values:
    SYSTEM_DISK: system disk
    DATA_DISK: data disk
    DiskSize Integer Size of the cloud disk used to create the snapshot; unit: GB.

    SpotMarketOptions

    Options related to bidding.

    Used by actions: CreateLaunchTemplate, CreateLaunchTemplateVersion, InquiryPriceRunInstances, RunInstances.

    Name Type Required Description
    MaxPrice String Yes Bid price.
    SpotInstanceType String No Bid request type. valid values: one-time. currently, only the one-time type is supported.

    StorageBlock

    Information on local HDD storage.

    Used by actions: CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeZoneInstanceConfigInfos, RunInstances.

    Name Type Required Description
    Type String No HDD LOCAL storage type specifies the value: LOCAL_PRO.
    MinSize Integer No Specifies the minimum HDD local storage capacity. measurement unit: GiB.
    MaxSize Integer No Specifies the maximum capacity of HDD local storage. measurement unit: GiB.

    SyncImage

    Image sync information

    Used by actions: SyncImages.

    Name Type Description
    ImageId String Image ID
    Region String Region

    SystemDisk

    Describes information on the block device where the operating system is stored, i.e., the system disk.

    Used by actions: CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeInstances, DescribeLaunchTemplateVersions, InquiryPriceResetInstance, InquiryPriceRunInstances, ResetInstance, ResizeInstanceDisks, RunInstances.

    Name Type Required Description
    DiskType String No Specifies the system disk type. for the restrictions on the system disk type, refer to storage overview. value range:

  • LOCAL_BASIC: Local SATA disk
  • LOCAL_SSD: Local NVMe SSD
  • CLOUD_BASIC: Cloud SATA disk
  • CLOUD_SSD: Cloud SSD
  • CLOUD_PREMIUM: Premium SSD
  • CLOUD_BSSD: Balanced SSD
  • CLOUD_HSSD: Enhanced SSD
  • CLOUD_TSSD: Tremendous SSD

    • Default value: Current disk types with inventory available.
    DiskId String No System disk ID.
    Currently, this parameter is only used for response parameters in query apis such as DescribeInstances and is not applicable to request parameters in write apis such as RunInstances.
    DiskSize Integer No System disk size; unit: GiB; default value: 50 GiB.
    CdcId String No Specifies the dedicated cluster ID belonging to.
    Note: This field may return null, indicating that no valid value is found.
    DiskName String No Disk name, which specifies a length not exceeding 128 characters.

    Tag

    Key-value pair of a tag.

    Used by actions: AllocateHosts, CreateDisasterRecoverGroup, CreateImage, CreateKeyPair, CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeDisasterRecoverGroups, DescribeImageFromFamily, DescribeImages, DescribeInstances, DescribeKeyPairs, ImportImage, ImportKeyPair, InquiryPriceRunInstances, RunInstances.

    Name Type Required Description
    Key String Yes Tag key
    Value String Yes Tag value

    TagSpecification

    Description of tags associated with resource instances during instance creation.

    Used by actions: AllocateHosts, CreateDisasterRecoverGroup, CreateImage, CreateKeyPair, CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeLaunchTemplateVersions, ImportImage, ImportKeyPair, InquiryPriceRunInstances, RunInstances.

    Name Type Required Description
    ResourceType String Yes Specifies the resource type for Tag binding. valid values: "instance" (cloud virtual machine), "host" (cdh), "image" (mirror), "keypair" (key), "ps" (placement group), "hpc" (hyper computing cluster).
    Tags Array of Tag Yes Tag pair list

    TargetOS

    Information about the target operating system for operating system switching.

    Used by actions: ConvertOperatingSystems.

    Name Type Description
    TargetOSType String Target operating system type.
    TargetOSVersion String Target operating system version.

    VirtualPrivateCloud

    Describes information on VPC, including subnets, IP addresses, etc.

    Used by actions: ConfigureChcAssistVpc, ConfigureChcDeployVpc, CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeChcHosts, DescribeInstances, DescribeLaunchTemplateVersions, InquiryPriceRunInstances, ModifyInstancesVpcAttribute, RunInstances.

    Name Type Required Description
    VpcId String Yes vpc ID, such as vpc-xxx. valid vpc ids can be queried by logging in to the console (https://console.tencentcloud.com/vpc/vpc?rid=1) or by calling the API DescribeVpcs and obtaining the VpcId field from the API response. if both VpcId and SubnetId are input as DEFAULT when creating an instance, the DEFAULT vpc network will be forcibly used.
    SubnetId String Yes vpc subnet ID, in the form of subnet-xxx. valid vpc subnet ids can be queried by logging in to the console; or they can be obtained from the SubnetId field in the API response by calling the DescribeSubnets API . if SubnetId and VpcId are both input as DEFAULT when creating an instance, the DEFAULT vpc network will be forcibly used.
    AsVpcGateway Boolean No 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:
  • true: It is used as a public gateway.
  • false: It is not used as a public gateway.
    • Default value: false.
    PrivateIpAddresses Array of String No Array of VPC subnet IPs. You can use this parameter when creating instances or modifying VPC attributes of instances. Currently you can specify multiple IPs in one subnet only when creating multiple instances at the same time.
    Ipv6AddressCount Integer No Number of IPv6 addresses randomly generated for the ENI.
    If IPv6AddressType is specified under InternetAccessible, this parameter must not be set to 0.

    ZoneInfo

    Information on availability zones.

    Used by actions: DescribeZones.

    Name Type Description
    Zone String Availability zone name, for example, ap-guangzhou-3.

    The names of availability zones across the network are as follows:
  • ap-chongqing-1
  • ap-seoul-1
  • ap-seoul-2
  • ap-chengdu-1
  • ap-chengdu-2
  • ap-hongkong-1 (sold out)
  • ap-hongkong-2
  • ap-hongkong-3
  • ap-shenzhen-fsi-1
  • ap-shenzhen-fsi-2
  • ap-shenzhen-fsi-3 (sold out)
  • ap-guangzhou-1 (sold out)
  • ap-guangzhou-2 (sold out)
  • ap-guangzhou-3
  • ap-guangzhou-4
  • ap-guangzhou-6
  • ap-guangzhou-7
  • ap-tokyo-1
  • ap-tokyo-2
  • ap-singapore-1
  • ap-singapore-2
  • ap-singapore-3
  • ap-singapore-4
  • ap-shanghai-fsi-1
  • ap-shanghai-fsi-2
  • ap-shanghai-fsi-3
  • ap-bangkok-1
  • ap-bangkok-2
  • ap-shanghai-1 (sold out)
  • ap-shanghai-2
  • ap-shanghai-3
  • ap-shanghai-4
  • ap-shanghai-5
  • ap-shanghai-8
  • ap-mumbai-1
  • ap-mumbai-2
  • ap-beijing-1 (sold out)
  • ap-beijing-2
  • ap-beijing-3
  • ap-beijing-4
  • ap-beijing-5
  • ap-beijing-6
  • ap-beijing-7
  • na-siliconvalley-1
  • na-siliconvalley-2
  • eu-frankfurt-1
  • eu-frankfurt-2
  • na-ashburn-1
  • na-ashburn-2
  • ap-nanjing-1
  • ap-nanjing-2
  • ap-nanjing-3
  • sa-saopaulo-1
  • ap-jakarta-1
  • ap-jakarta-2
    • ZoneName String Availability zone description, such as Guangzhou Zone 3.
    ZoneId String Availability zone ID.
    ZoneState String Availability zone status. Valid values: AVAILABLE: available; UNAVAILABLE: unavailable.
    Was this page helpful?
    You can also Contact Sales or Submit a Ticket for help.
    Yes
    No

    Feedback