Data Types

Last updated: 2020-10-22 16:49:23

ActionTimer

Scheduled tasks.

Used by actions: RunInstances.

Name Type Required Description
Externals Externals Yes Additional data
TimerAction String No Timer name. Currently TerminateInstances is the only supported value.
ActionTime String No Execution time, which must be at least 5 minutes later than the current time. For example, 2018-5-29 11:26:40.

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

    Describes data disk information.

    Used by actions: DescribeInstances, 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 more information about limits on different data disk types, see Storage Overview. Valid values:
  • LOCAL_BASIC: local disk
  • LOCAL_SSD: local SSD disk
  • CLOUD_BASIC: HDD cloud disk
  • CLOUD_PREMIUM: Premium Cloud Storage
  • CLOUD_SSD: SSD
  • CLOUD_HSSD: Enhanced SSD

    Default value: LOCAL_BASIC.

    This parameter is invalid for the ResizeInstanceDisk API.
  • DiskId String No Data disk ID. Data disks of the type LOCAL_BASIC or LOCAL_SSD do not have IDs and do not support this parameter.
    DeleteWithInstance Boolean No Whether to terminate the data disk when its CVM is terminated. Valid values:
  • TRUE: terminate the data disk when its CVM is terminated. This value only supports pay-as-you-go cloud disks billed on an hourly basis.
  • FALSE: retain the data disk when its CVM is terminated.

    Default value: TRUE

    Currently this parameter is only used 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 Specifies whether the data disk is encrypted. Valid values:
  • TRUE: encrypted
  • FALSE: not encrypted

    Default value: FALSE

    This parameter is only used with RunInstances.
    Note: this field may return null, indicating that no valid value is obtained.
  • 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.

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

    Externals

    Additional data

    Used by actions: 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: DescribeHosts, DescribeImages, DescribeInstanceTypeConfigs, DescribeInstances, DescribeKeyPairs, DescribeReservedInstances, DescribeReservedInstancesConfigInfos, DescribeReservedInstancesOfferings, DescribeZoneInstanceConfigInfos.

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

    HostItem

    Details about a CDH instance

    Used by actions: DescribeHosts.

    Name Type Description
    Placement Placement Location of the CDH instance. You can use this parameter to specify the attributes of the instance, such as its availability zone and project.
    HostId String CDH instance ID
    HostType String CDH instance type
    HostName String CDH instance name
    HostChargeType String Billing method of the CDH instance
    RenewFlag String Auto renewal flag of the CDH instance
    CreatedTime Timestamp ISO8601 Creation time of the CDH instance
    ExpiredTime Timestamp ISO8601 Expiration time of the CDH instance
    InstanceIds Array of String List of IDs of CVM instances created on the CDH
    HostState String CDH instance state
    HostIp String CDH instance IP
    HostResource HostResource Resource information of the CDH instance
    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 a 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 of the CDH instance; unit: GiB
    MemAvailable Float Available memory of the CDH instance; unit: GiB
    DiskTotal Integer Total disk size of the CDH instance; unit: GiB
    DiskAvailable Integer Avilable disk size of the CDH instance; unit: GiB
    DiskType String CDH instance disk type.

    Image

    Details about an image, including its state and attributes.

    Used by actions: 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.

    ImageOsList

    Supported operating systems 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 value is found.
    Linux Array of String Supported Linux OS
    Note: This field may return null, indicating that no valid value is found.

    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 on the data disks of the instance, which only covers the data disks purchased together with the instance.
    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.

    InstanceChargePrepaid

    Describes the billing method of an instance.

    Used by actions: InquiryPriceRunInstances, RunInstances.

    Name Type Required Description
    Period Integer Yes Subscription period; unit: 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_MANUAL_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.
  • 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: InquiryPriceRunInstances, RunInstances.

    Name Type Required Description
    SpotOptions SpotMarketOptions Yes Options related to bidding
    MarketType String No Market option type. Currently spot is the only supported value.

    InstanceStatus

    Describes instance states. For state types, see here.

    Used by actions: DescribeInstancesStatus.

    Name Type Description
    InstanceId String Instance ID.
    InstanceState String The 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.
  • InstanceTypeConfig

    Describes the configurations of an instance model.

    Used by actions: DescribeInstanceTypeConfigs.

    Name Type Description
    Zone String Availability zone.
    InstanceType String Instance model.
    InstanceFamily String Instance model family.
    GPU Integer Number of GPU cores.
    CPU Integer Number of CPU cores.
    Memory Integer Memory capacity; unit: GB.
    FPGA Integer Number of FPGA cores; unit: core.

    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 model is available. Valid values:
  • SELL: available
  • SOLD_OUT: 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.

    InternetAccessible

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

    Used by actions: DescribeInstances, 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 assign a public IP. Valid values:
  • TRUE: Assign a public IP
  • FALSE: Do not assign a public IP

    If the public network bandwidth is greater than 0 Mbps, you can choose whether to assign a public IP; by default a public IP will be assigned. If the public network bandwidth is 0 Mbps, you will not be able to assign a public IP.
  • 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.

    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.

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

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

    If this parameter is not specified, a random password will be generated and sent to you via the Message Center.
    Note: this field may return null, indicating that no valid value is 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. A key and password cannot be specified at the same time. Windows instances do not support keys. Currently, you can only specify one key when purchasing an instance.
    Note: this field may return null, indicating that no valid value is obtained.
    KeepImageLogin String No Whether to keep the original settings of an image. You cannot specify this parameter and Password or KeyIds.N at the same time. You can specify this parameter as TRUE only when you create an instance using a custom image, a shared image, or an imported image. Valid values:
  • TRUE: keep the login settings of the image
  • FALSE: do not keep the login settings of the image

    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

    Describes the location of an instance, including its availability zone, project, host (for CDH products only), primary host IP, etc.

    Used by actions: AllocateHosts, DescribeHosts, DescribeInstances, InquiryPriceRunInstances, RunInstances.

    Name Type Required Description
    Zone String Yes The ID of availability zone where the instance locates. It can obtained in the Zone field returned by DescribeZones API.
    ProjectId Integer No ID of the project to which the instance belongs. To obtain the project IDs, you can call DescribeProject and look for the projectId fields in the response. If this parameter is not specified, the default project will be 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.
    HostIps Array of String No Master host IP used to create the CVM
    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.

    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.

    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 GPU cores.
    Fpga Integer Number of FPGA cores.
    StorageBlock Integer Number of 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

    Describes the information of the reserved instances the user has purchased

    Used by actions: DescribeReservedInstances.

    Name Type Description
    ReservedInstancesId String The ID of the purchased reserved instance, taking the form 650c138f-ae7e-4750-952a-96841d6e9fc1.
    InstanceType String Reserved instance specification, such as S3.MEDIUM4.
    Valid values: please see Reserved Instance Specifications
    Zone String Availability zones in which the reserved instance can be purchased. For example, "ap-guangzhou-1".
    Returned values: list of availability zones
    StartTime Timestamp Start time of the reserved instance billing, taking the form of 2019-10-23 00:00:00.
    EndTime Timestamp End time of the reserved instance, taking the form of 2019-10-23 00:00:00
    Duration Integer The validity of the reserved instance in seconds, which is the purchased usage period. For example, 31536000.
    Measurement unit: second.
    InstanceCount Integer The number of reserved instances that have been purchased. For example, 10.
    ProductDescription String The operating system of the reserved instance. For example, "linux".
    Returned value: linux.
    State String The status of the reserved instance. For example, "active".
    Returned value: "active" (created) | "pending" (waiting to be created) | "retired" (expired).
    CurrencyCode String The currency in which the reserved instance is billed. The ISO 4217 standard currency codes are used. For example, USD.
    Returned value: USD.
    OfferingType String The payment method of the reserved instance. For example, "All Upfront".
    Returned value: All Upfront.
    InstanceFamily String Reserved instance type, such as S3.
    Valid values: please see Reserved Instance Types

    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 value: Instance Models
    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.

    RunMonitorServiceEnabled

    Describes information related to the Cloud Monitor service.

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

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

    SystemDisk

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

    Used by actions: DescribeInstances, InquiryPriceResetInstance, InquiryPriceRunInstances, ResetInstance, RunInstances.

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

    The disk type 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 currently.
    DiskSize Integer No System disk size; unit: GB; default value: 50 GB.

    Tag

    Key-value pair of a tag.

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

    Name Type Required Description
    ResourceType String Yes Type of the resources associated with the tags. Currently only "instance" and "host" are supported.
    Tags Array of Tag Yes List of tags

    VirtualPrivateCloud

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

    Used by actions: DescribeInstances, 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 to use an instance as a public gateway. An instance can be used as a public gateway only when it has a public IP and resides in a VPC. Valid values:
  • TRUE: use the instance as a public gateway
  • FALSE: do not use the instance 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, such as ap-guangzhou-3.
    The following is a list of all availability zones:
  • ap-chongqing-1
  • ap-seoul-1
  • ap-chengdu-1
  • ap-chengdu-2
  • ap-hongkong-1
  • ap-hongkong-2
  • ap-shenzhen-fsi-1
  • ap-shenzhen-fsi-2
  • ap-shenzhen-fsi-3
  • ap-guangzhou-1 (sold out)
  • ap-guangzhou-2 (sold out)
  • ap-guangzhou-3
  • ap-guangzhou-4
  • ap-tokyo-1
  • ap-singapore-1
  • ap-shanghai-fsi-1
  • ap-shanghai-fsi-2
  • ap-shanghai-fsi-3
  • ap-bangkok-1
  • ap-shanghai-1 (sold out)
  • ap-shanghai-2
  • ap-shanghai-3
  • ap-shanghai-4
  • ap-mumbai-1
  • ap-mumbai-2
  • eu-moscow-1
  • ap-beijing-1
  • ap-beijing-2
  • ap-beijing-3
  • ap-beijing-4
  • ap-beijing-5
  • na-siliconvalley-1
  • na-siliconvalley-2
  • eu-frankfurt-1
  • na-toronto-1
  • na-ashburn-1
  • na-ashburn-2
  • ap-nanjing-1
  • ap-nanjing-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?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help