tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

Data Types

Last updated: 2024-10-30 19:03:05

    ActionTimer

    Scheduled tasks.

    Used by actions: CreateLaunchTemplateVersion, DescribeLaunchTemplateVersions, RunInstances.

    Name Type Required Description
    TimerAction String No Timer action. Valid value: TerminateInstances.
    Note: This field may return null, indicating that no valid values can be obtained.
    ActionTime String No 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.
    Note: This field may return null, indicating that no valid values can be obtained.
    Externals Externals No Extended data
    Note: This field may return null, indicating that no valid values can be obtained.

    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: DescribeChcHosts.

    Name Type Required Description

    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: CreateLaunchTemplateVersion, DescribeInstances, DescribeLaunchTemplateVersions, InquiryPriceResizeInstanceDisks, InquiryPriceRunInstances, ResizeInstanceDisks, RunInstances.

    Name Type Required Description
    DiskSize Integer Yes 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. The default value is 0, indicating that no data disk is purchased. For more information, see the product documentation.
    DiskType String No 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: premium cloud disk.


  • CLOUD_SSD: cloud SSD.


  • CLOUD_HSSD: enhanced SSD.


  • CLOUD_TSSD: tremendous SSD.


  • CLOUD_BSSD: balanced SSD.

    Default value: LOCAL_BASIC.

    This parameter is invalid for the ResizeInstanceDisk API.









    		•
    DiskId String No Data disk ID. Note that it’s not available for LOCAL_BASIC and LOCAL_SSD disks.
    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.
    DeleteWithInstance Boolean No Whether a data disk is terminated when the associated CVM instance is terminated. Valid values:
  • TRUE: The data disk is terminated when the associated CVM instance is terminated. This only supports pay-as-you-go cloud disks that are billed by hour.

  • FALSE: The data disk is retained when the associated CVM instance is terminated.

    Default value: TRUE.

    This parameter is currently used only in the RunInstances API.

    • Note: This field may return null, indicating that no valid value is found.
    SnapshotId String No Data disk snapshot ID. The size of the selected data disk snapshot must be smaller than that of the data disk.
    Note: This field may return null, indicating that no valid value is found.
    Encrypt Boolean No Whether a data disk is encrypted. Valid values:
  • true: encrypted.

  • false: not encrypted.

    Default value: false.

    This parameter is currently used only in the RunInstances API.

    • Note: This field may return null, indicating that no valid value is found.
    KmsKeyId String No ID of the custom CMK in the format of UUID or “kms-abcd1234”. This parameter is used to encrypt cloud disks.

    Currently, this parameter is only used in the RunInstances API.
    Note: this field may return null, indicating that no valid values can be obtained.
    ThroughputPerformance Integer No Cloud disk performance, in MB/s
    Note: this field may return null, indicating that no valid values can be obtained.
    CdcId String No ID of the dedicated cluster to which the instance belongs.
    Note: this field may return null, indicating that no valid values can be obtained.
    BurstPerformance Boolean No Burst performance.

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

    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.

    EnhancedService

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

    Used by actions: 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: CreateLaunchTemplateVersion, DescribeReservedInstancesConfigInfos, DescribeZoneInstanceConfigInfos, RunInstances.

    Name Type Required Description
    ReleaseAddress Boolean No Release address
    Note: This field may return null, indicating that no valid value is found.
    UnsupportNetworks Array of String No Not supported network. Value:
  • BASIC: classic network
  • VPC1.0: VPC1.0
    Note: This field may return null, indicating that no valid value was found.
    		•
    StorageBlockAttr StorageBlock No Attributes of local HDD storage
    Note: This field may return null, indicating that no valid value is found.

    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, DescribeHosts, DescribeImages, DescribeInstances, DescribeKeyPairs, DescribeLaunchTemplates, 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 Number of GPUs.
    Note: this field may return null, indicating that no valid value can be found.
    GPUId Array of String GPU address
    Note: this field may return null, indicating that no valid value can be found.
    GPUType String GPU type of the instance.
    Note: this field may return null, indicating that no valid value can be found.

    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 Memory capacity; unit: GB.
    RestrictState String Instance status. Valid values:
  • NORMAL: instance is normal.
  • EXPIRED: instance expired.
  • PROTECTIVELY_ISOLATED: instance is protectively isolated.
    		•
    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: notify upon expiration, but do not renew automatically
  • NOTIFY_AND_AUTO_RENEW: notify upon expiration and renew automatically
  • DISABLE_NOTIFY_AND_MANUAL_RENEW: do not notify upon expiration and do not renew automatically.

  • Note: this parameter is null for postpaid instances.
    		•
    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 state. Valid values:
  • PENDING: creating
  • LAUNCH_FAILED: creation failed
  • RUNNING: running
  • STOPPED: shut down
  • STARTING: starting
  • STOPPING: shutting down
  • REBOOTING: rebooting
  • SHUTDOWN: shut down and to be terminated
  • TERMINATING: terminating.
    • Tags Array of Tag List of tags associated with the instance.
    StopChargingMode String Instance billing method after shutdown.
    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: operation succeeded
  • OPERATING: operation in progress
  • FAILED: operation failed
    		•
    LatestOperationRequestId String Unique request ID for the last operation of the instance.
    DisasterRecoverGroupId String ID of a spread placement group.
    Note: this field may return null, indicating that no valid value is obtained.
    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 HPC cluster ID.
    Note: this field may return null, indicating that no valid value was found.
    RdmaIpAddresses Array of String IP list of HPC cluster.
    Note: this field may return null, indicating that no valid value was found.
    DedicatedClusterId String
    IsolatedSource String The isolation status of the instance. Valid values:
  • ARREAR: isolated due to overdue payment;
  • EXPIRE: isolated upon expiration;
  • MANMADE: isolated after manual returning;
  • NOTISOLATED: not isolated

    • Note: this field may return null, indicating that no valid value was found.
    GPUInfo GPUInfo GPU information. This field is only returned for GPU instances.
    Note: this field may return null, indicating that no valid value was found.
    LicenseType String Instance OS license type. Default value: TencentCloud
    DisableApiTermination Boolean Whether the termination protection is enabled. Values:
  • TRUE: Enable instance protection, which means that this instance can not be deleted by an API action.
  • FALSE: Do not enable the instance protection.

    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.

    InstanceChargePrepaid

    Describes the billing method of an instance.

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

    Name Type Required Description
    Period Integer Yes Subscription period (in month). Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48’, 60.<br/>Note: This field may return null`, indicating that no valid values can be obtained.
    RenewFlag String No Auto-renewal flag. Valid values:
  • NOTIFY_AND_AUTO_RENEW: Notify of expiration and automatically renew.

  • NOTIFY_AND_MANUAL_RENEW: Notify of expiration and manually 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, an instance will be automatically renewed monthly after expiration, provided that the account balance is sufficient.
    Note: This field may return null, indicating that no valid value is found.

    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: CreateLaunchTemplateVersion, DescribeLaunchTemplateVersions, InquiryPriceRunInstances, RunInstances.

    Name Type Required Description
    SpotOptions SpotMarketOptions Yes Spot-related options
    Note: This field may return null, indicating that no valid values can be obtained.
    MarketType String No Market type. Valid value: spot.
    Note: This field may return null, indicating that no valid values can be obtained.

    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: 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.
    		•
    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. To obatin the IDs, you can call DescribeBandwidthPackages and look for the BandwidthPackageId fields in the response.

    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, InquiryPriceResetInstance, InquiryPriceResetInstancesInternetMaxBandwidth, InquiryPriceResetInstancesType, InquiryPriceResizeInstanceDisks, InquiryPriceRunInstances.

    Name Type Description
    UnitPrice Float The original unit price for pay-as-you-go mode in USD.
  • When a billing tier is returned, it indicates the price fo the returned billing tier. For example, if UnitPriceSecondStep is returned, it refers to the unit price for the usage between 0 to 96 hours. Otherwise, it refers to that the unit price for unlimited usage.
    Note: this field may return null, indicating that no valid value is obtained.
    		•
    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).
    Note: this field may return null, indicating that no valid value is obtained.
    		•
    OriginalPrice Float The original price of a pay-in-advance instance, in USD.
    Note: this field may return null, indicating that no valid value is obtained.
    DiscountPrice Float Discount price of a prepaid instance, in USD.
    Note: this field may return null, indicating that no valid value is obtained.
    Discount Float Percentage of the original price. For example, if you enter "20.0", the discounted price will be 20% of the original price.
    Note: this field may return null, indicating that no valid values can be obtained.
    UnitPriceDiscount Float The discounted unit price for pay-as-you-go mode in USD.
  • When a billing tier is returned, it indicates the price fo the returned billing tier. For example, if UnitPriceSecondStep is returned, it refers to the unit price for the usage between 0 to 96 hours. Otherwise, it refers to that the unit price for unlimited usage.
    Note: this field may return null, indicating that no valid value is obtained.
    		•
    UnitPriceSecondStep Float Original unit price for the usage between 96 to 360 hours in USD. It's applicable to pay-as-you-go mode.
    Note: this field may return null, indicating that no valid value is obtained.
    UnitPriceDiscountSecondStep Float Discounted unit price for the usage between 96 to 360 hours in USD. It's applicable to pay-as-you-go mode.
    Note: this field may return null, indicating that no valid value is obtained.
    UnitPriceThirdStep Float Original unit price for the usage after 360 hours in USD. It's applicable to pay-as-you-go mode.
    Note: this field may return null, indicating that no valid value is obtained.
    UnitPriceDiscountThirdStep Float Discounted unit price for the usage after 360 hours in USD. It's applicable to pay-as-you-go mode.
    Note: this field may return null, indicating that no valid value is obtained.
    OriginalPriceThreeYear Float Original 3-year payment, in USD. This parameter is only available to upfront payment mode.
    Note: this field may return null, indicating that no valid value was found.
    Note: this field may return null, indicating that no valid value was found.
    DiscountPriceThreeYear Float Discounted 3-year upfront payment, in USD. This parameter is only available to upfront payment mode.
    Note: this field may return null, indicating that no valid value was found.
    Note: this field may return null, indicating that no valid value was found.
    DiscountThreeYear Float Discount for 3-year upfront payment. For example, 20.0 indicates 80% off.
    Note: this field may return null, indicating that no valid value was found.
    Note: this field may return null, indicating that no valid value was found.
    OriginalPriceFiveYear Float Original 5-year payment, in USD. This parameter is only available to upfront payment mode.
    Note: this field may return null, indicating that no valid value was found.
    Note: this field may return null, indicating that no valid value was found.
    DiscountPriceFiveYear Float Discounted 5-year upfront payment, in USD. This parameter is only available to upfront payment mode.
    Note: this field may return null, indicating that no valid value was found.
    Note: this field may return null, indicating that no valid value was found.
    DiscountFiveYear Float Discount for 5-year upfront payment. For example, 20.0 indicates 80% off.
    Note: this field may return null, indicating that no valid value was found.
    Note: this field may return null, indicating that no valid value was found.
    OriginalPriceOneYear Float Original 1-year payment, in USD. This parameter is only available to upfront payment mode.
    Note: this field may return null, indicating that no valid value was found.
    Note: this field may return null, indicating that no valid value was found.
    DiscountPriceOneYear Float Discounted 1-year payment, in USD. This parameter is only available to upfront payment mode.
    Note: this field may return null, indicating that no valid value was found.
    Note: this field may return null, indicating that no valid value was found.
    DiscountOneYear Float Discount for 1-year upfront payment. For example, 20.0 indicates 80% off.
    Note: this field may return null, indicating that no valid value was found.
    Note: this field may return null, indicating that no valid value was 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: CreateLaunchTemplateVersion, DescribeInstances, DescribeLaunchTemplateVersions, InquiryPriceResetInstance, InquiryPriceRunInstances, ResetInstance, RunInstances.

    Name Type Required Description
    Password String No Login password of the instance.
  • For Linux instances, the password must include 8-30 characters, and contain at least two of the following character sets: [a-z], [A-Z], [0-9] and [()`!@#$%^&*-+=|{}[]:;',.?/].
  • For Windows instances, the password must include 12-30 characters, and contain at least three of the following character sets: [a-z], [A-Z], [0-9] and [()`!@#$%^&*-+=|{}[]:;',.?/].

    If it's not specified, the user needs to set the login password using the Reset password option in the CVM console or calling the API ResetInstancesPassword to complete the creation of the CVM instance(s).
    Note: This field may return null, indicating that no valid values can be obtained.
    		•
    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 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:
  • true: indicates that the login settings of the image are maintained
  • false: indicates that the login settings of the image are not maintained
    • Default value: false.
    Note: This field may return null, indicating that no valid value is found.

    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, 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 ID of the project to which the instance belongs. This parameter can be obtained from the projectId returned by DescribeProject. If this is left empty, the default project is used.
    HostIds Array of String No ID list of CDHs from which the instance can be created. If you have purchased CDHs and specify this parameter, the instances you purchase will be randomly deployed on the CDHs.
    HostId String No The ID of the CDH to which the instance belongs, only used as an output parameter.

    Price

    Price.

    Used by actions: 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. Currently, RIs are only offered to beta users.

    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. Currently, RIs are only offered to beta users.

    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. Currently, RIs are only offered to beta users.

    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 Upfront total cost, in USD.
    DiscountFixedPrice Float Discount price for subsequent total cost, in USD/hr.

    ReservedInstanceTypeItem

    Reserved instance specification. Currently, RIs are only offered to beta users.

    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.

    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: 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: CreateLaunchTemplateVersion, InquiryPriceResetInstance, InquiryPriceRunInstances, ResetInstance, RunInstances.

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

    Default value: TRUE.
    		•

    RunSecurityServiceEnabled

    Describes information related to the Cloud Security service.

    Used by actions: 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: CreateLaunchTemplateVersion, InquiryPriceRunInstances, RunInstances.

    Name Type Required Description
    MaxPrice String Yes Bidding price
    SpotInstanceType String No Bidding request type. Currently only "one-time" is supported.

    StorageBlock

    Information on local HDD storage.

    Used by actions: CreateLaunchTemplateVersion, DescribeZoneInstanceConfigInfos, RunInstances.

    Name Type Required Description
    Type String No Local HDD storage type. Value: LOCAL_PRO.
    Note: This field may return null, indicating that no valid value is found.
    MinSize Integer No Minimum capacity of local HDD storage
    Note: This field may return null, indicating that no valid value is found.
    MaxSize Integer No Maximum capacity of local HDD storage
    Note: This field may return null, indicating that no valid value is found.

    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: CreateLaunchTemplateVersion, DescribeInstances, DescribeLaunchTemplateVersions, InquiryPriceResetInstance, InquiryPriceRunInstances, ResetInstance, ResizeInstanceDisks, RunInstances.

    Name Type Required Description
    DiskType String No System disk type. For more information about the limits of system disk types, please see Storage Overview. Valid values:
  • LOCAL_BASIC: local disk
  • LOCAL_SSD: local SSD disk
  • CLOUD_BASIC: HDD cloud disk
  • CLOUD_SSD: SSD cloud disk
  • CLOUD_PREMIUM: Premium cloud storage
  • CLOUD_BSSD: Balanced SSD

    The disk currently in stock will be used by default.
    		•
    DiskId String No System disk ID. System disks whose type is LOCAL_BASIC or LOCAL_SSD do not have an ID and do not support this parameter.
    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.
    DiskSize Integer No System disk size; unit: GB; default value: 50 GB.
    CdcId String No ID of the dedicated cluster to which the instance belongs.

    Tag

    Key-value pair of a tag.

    Used by actions: AllocateHosts, CreateImage, CreateKeyPair, CreateLaunchTemplateVersion, 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, CreateImage, CreateKeyPair, CreateLaunchTemplateVersion, DescribeLaunchTemplateVersions, ImportImage, ImportKeyPair, InquiryPriceRunInstances, RunInstances.

    Name Type Required Description
    ResourceType String Yes Resource type. Valid values: instance (CVM), host (CDH), image (for image), and keypair (for key).
    Note: This field may return null, indicating that no valid values can be obtained.
    Tags Array of Tag Yes Tag pairs
    Note: This field may return null, indicating that no valid values can be obtained.

    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, CreateLaunchTemplateVersion, DescribeChcHosts, DescribeInstances, DescribeLaunchTemplateVersions, InquiryPriceRunInstances, ModifyInstancesVpcAttribute, RunInstances.

    Name Type Required Description
    VpcId String Yes VPC ID in the format of vpc-xxx. To obtain valid VPC IDs, you can log in to the console or call the DescribeVpcEx 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.
    SubnetId String Yes VPC subnet ID in the format subnet-xxx. To obtain valid subnet IDs, you can log in to the console or call DescribeSubnets 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.
    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.

    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy