IDC

云服务器 数据结构 - API 文档

作者:admin 2021-05-09 我要评论

ActionTimer 定时任务 被如下接口引用:RunInstances。 名称 类型 必选 描述 Externals Externals 是 扩展数据 TimerAction String 否 定时器名称,目前仅支持销...

在说正事之前,我要推荐一个福利:你还在原价购买阿里云、腾讯云、华为云服务器吗?那太亏啦!来这里,新购、升级、续费都打折,能够为您省60%的钱呢!2核4G企业级云服务器低至69元/年,点击进去看看吧>>>)

ActionTimer

定时任务

被如下接口引用:RunInstances。

名称 类型 必选 描述
Externals Externals 扩展数据
TimerAction String 定时器名称,目前仅支持销毁一个值:TerminateInstances。
ActionTime String 执行时间,格式形如:2018-5-29 11:26:40,执行时间必须大于当前时间5分钟。

ChargePrepaid

描述预付费模式,即包年包月相关参数。包括购买时长和自动续费逻辑等。

被如下接口引用:AllocateHosts, RenewHosts。

名称 类型 必选 描述
Period Integer 购买实例的时长,单位:月。取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。
RenewFlag String 自动续费标识。取值范围:
  • NOTIFY_AND_AUTO_RENEW:通知过期且自动续费
  • NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费
  • DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费

    默认取值:NOTIFY_AND_AUTO_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。
  • DataDisk

    描述了数据盘的信息

    被如下接口引用:DescribeInstances, InquiryPriceResizeInstanceDisks, InquiryPriceRunInstances, ResizeInstanceDisks, RunInstances。

    名称 类型 必选 描述
    DiskSize Integer 数据盘大小,单位:GB。最小调整步长为10G,不同数据盘类型取值范围不同,具体限制详见:存储概述。默认值为0,表示不购买数据盘。更多限制详见产品文档。
    DiskType String 数据盘类型。数据盘类型限制详见存储概述。取值范围:
  • LOCAL_BASIC:本地硬盘
  • LOCAL_SSD:本地SSD硬盘
  • LOCAL_NVME:本地NVME硬盘,与InstanceType强相关,不支持指定
  • LOCAL_PRO:本地HDD硬盘,与InstanceType强相关,不支持指定
  • CLOUD_BASIC:普通云硬盘
  • CLOUD_PREMIUM:高性能云硬盘
  • CLOUD_SSD:SSD云硬盘
  • CLOUD_HSSD:增强型SSD云硬盘
  • CLOUD_TSSD:极速型SSD云硬盘

    默认取值:LOCAL_BASIC。

    该参数对ResizeInstanceDisk接口无效。
  • DiskId String 数据盘ID。LOCAL_BASIC 和 LOCAL_SSD 类型没有ID,暂时不支持该参数。
    DeleteWithInstance Boolean 数据盘是否随子机销毁。取值范围:
  • TRUE:子机销毁时,销毁数据盘,只支持按小时后付费云盘
  • FALSE:子机销毁时,保留数据盘

    默认取值:TRUE

    该参数目前仅用于 RunInstances 接口。
    注意:此字段可能返回 null,表示取不到有效值。
  • SnapshotId String 数据盘快照ID。选择的数据盘快照大小需小于数据盘大小。
    注意:此字段可能返回 null,表示取不到有效值。
    Encrypt Boolean 数据盘是加密。取值范围:
  • TRUE:加密
  • FALSE:不加密

    默认取值:FALSE

    该参数目前仅用于 RunInstances 接口。
    注意:此字段可能返回 null,表示取不到有效值。
  • KmsKeyId String 自定义CMK对应的ID,取值为UUID或者类似kms-abcd1234。用于加密云盘。

    该参数目前仅用于 RunInstances 接口。
    注意:此字段可能返回 null,表示取不到有效值。
    ThroughputPerformance Integer 云硬盘性能,单位:MB/s
    注意:此字段可能返回 null,表示取不到有效值。
    CdcId String 所属的独享集群ID。
    注意:此字段可能返回 null,表示取不到有效值。

    DisasterRecoverGroup

    容灾组信息

    被如下接口引用:DescribeDisasterRecoverGroups。

    名称 类型 描述
    DisasterRecoverGroupId String 分散置放群组id。
    Name String 分散置放群组名称,长度1-60个字符。
    Type String 分散置放群组类型,取值范围:
  • HOST:物理机
  • SW:交换机
  • RACK:机架
  • CvmQuotaTotal Integer 分散置放群组内最大容纳云服务器数量。
    CurrentNum Integer 分散置放群组内云服务器当前数量。
    InstanceIds Array of String 分散置放群组内,云服务器id列表。
    注意:此字段可能返回 null,表示取不到有效值。
    CreateTime Timestamp 分散置放群组创建时间。
    注意:此字段可能返回 null,表示取不到有效值。

    EnhancedService

    描述了实例的增强服务启用情况与其设置,如云安全,云监控等实例 Agent

    被如下接口引用:InquiryPriceResetInstance, InquiryPriceRunInstances, ResetInstance, RunInstances。

    名称 类型 必选 描述
    SecurityService RunSecurityServiceEnabled 开启云安全服务。若不指定该参数,则默认开启云安全服务。
    MonitorService RunMonitorServiceEnabled 开启云监控服务。若不指定该参数,则默认开启云监控服务。

    Externals

    扩展数据

    被如下接口引用:DescribeReservedInstancesConfigInfos, DescribeZoneInstanceConfigInfos, RunInstances。

    名称 类型 必选 描述
    ReleaseAddress Boolean 释放地址
    注意:此字段可能返回 null,表示取不到有效值。
    UnsupportNetworks Array of String 不支持的网络类型,取值范围:
  • BASIC:基础网络
  • VPC1.0:私有网络VPC1.0
    注意:此字段可能返回 null,表示取不到有效值。
  • StorageBlockAttr StorageBlock HDD本地存储属性
    注意:此字段可能返回 null,表示取不到有效值。

    Filter

    描述键值对过滤器,用于条件过滤查询。例如过滤ID、名称、状态等

    • 若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。
    • 若同一个Filter存在多个Values,同一FilterValues间的关系为逻辑或(OR)关系。

    以DescribeInstances接口的Filter为例。若我们需要查询可用区(zone)为广州一区 并且 实例计费模式(instance-charge-type)为包年包月 或者 按量计费的实例时,可如下实现:

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

    被如下接口引用:DescribeHosts, DescribeImages, DescribeInstanceTypeConfigs, DescribeInstances, DescribeKeyPairs, DescribeReservedInstances, DescribeReservedInstancesConfigInfos, DescribeReservedInstancesOfferings, DescribeZoneInstanceConfigInfos。

    名称 类型 必选 描述
    Name String 需要过滤的字段。
    Values Array of String 字段的过滤值。

    HostItem

    cdh实例详细信息

    被如下接口引用:DescribeHosts。

    名称 类型 描述
    Placement Placement cdh实例所在的位置。通过该参数可以指定实例所属可用区,所属项目等属性。
    HostId String cdh实例id
    HostType String cdh实例类型
    HostName String cdh实例名称
    HostChargeType String cdh实例付费模式
    RenewFlag String cdh实例自动续费标记
    CreatedTime Timestamp ISO8601 cdh实例创建时间
    ExpiredTime Timestamp ISO8601 cdh实例过期时间
    InstanceIds Array of String cdh实例上已创建云子机的实例id列表
    HostState String cdh实例状态
    HostIp String cdh实例ip
    HostResource HostResource cdh实例资源信息
    CageId String 专用宿主机所属的围笼ID。该字段仅对金融专区围笼内的专用宿主机有效。
    注意:此字段可能返回 null,表示取不到有效值。

    HostResource

    cdh实例的资源信息

    被如下接口引用:DescribeHosts。

    名称 类型 描述
    CpuTotal Integer cdh实例总cpu核数
    CpuAvailable Integer cdh实例可用cpu核数
    MemTotal Float cdh实例总内存大小(单位为:GiB)
    MemAvailable Float cdh实例可用内存大小(单位为:GiB)
    DiskTotal Integer cdh实例总磁盘大小(单位为:GiB)
    DiskAvailable Integer cdh实例可用磁盘大小(单位为:GiB)
    DiskType String cdh实例磁盘类型

    Image

    一个关于镜像详细信息的结构体,主要包括镜像的主要状态与属性。

    被如下接口引用:DescribeImages。

    名称 类型 描述
    ImageId String 镜像ID
    OsName String 镜像操作系统
    ImageType String 镜像类型
    CreatedTime Timestamp ISO8601 镜像创建时间
    ImageName String 镜像名称
    ImageDescription String 镜像描述
    ImageSize Integer 镜像大小
    Architecture String 镜像架构
    ImageState String 镜像状态:
    CREATING-创建中
    NORMAL-正常
    CREATEFAILED-创建失败
    USING-使用中
    SYNCING-同步中
    IMPORTING-导入中
    IMPORTFAILED-导入失败
    Platform String 镜像来源平台
    ImageCreator String 镜像创建者
    ImageSource String 镜像来源
    SyncPercent Integer 同步百分比
    注意:此字段可能返回 null,表示取不到有效值。
    IsSupportCloudinit Boolean 镜像是否支持cloud-init
    注意:此字段可能返回 null,表示取不到有效值。
    SnapshotSet Array of Snapshot 镜像关联的快照信息
    注意:此字段可能返回 null,表示取不到有效值。

    ImageOsList

    支持的操作系统类型,根据windows和Linux分类。

    被如下接口引用:DescribeImportImageOs。

    名称 类型 描述
    Windows Array of String 支持的windows操作系统。
    注意:此字段可能返回 null,表示取不到有效值。
    Linux Array of String 支持的linux操作系统
    注意:此字段可能返回 null,表示取不到有效值。

    Instance

    描述实例的信息

    被如下接口引用:DescribeInstances。

    名称 类型 描述
    Placement Placement 实例所在的位置。
    InstanceId String 实例ID
    InstanceType String 实例机型。
    CPU Integer 实例的CPU核数,单位:核。
    Memory Integer 实例内存容量,单位:GB
    RestrictState String 实例业务状态。取值范围:
  • NORMAL:表示正常状态的实例
  • EXPIRED:表示过期的实例
  • PROTECTIVELY_ISOLATED:表示被安全隔离的实例。
  • InstanceName String 实例名称。
    InstanceChargeType String 实例计费模式。取值范围:
  • PREPAID:表示预付费,即包年包月
  • POSTPAID_BY_HOUR:表示后付费,即按量计费
  • CDHPAIDCDH付费,即只对CDH计费,不对CDH上的实例计费。
  • SPOTPAID:表示竞价实例付费。
  • SystemDisk SystemDisk 实例系统盘信息。
    DataDisks Array of DataDisk 实例数据盘信息。只包含随实例购买的数据盘。
    PrivateIpAddresses Array of String 实例主网卡的内网IP列表。
    PublicIpAddresses Array of String 实例主网卡的公网IP列表。
    注意:此字段可能返回 null,表示取不到有效值。
    InternetAccessible InternetAccessible 实例带宽信息。
    VirtualPrivateCloud VirtualPrivateCloud 实例所属虚拟私有网络信息。
    ImageId String 生产实例所使用的镜像ID
    RenewFlag String 自动续费标识。取值范围:
  • NOTIFY_AND_MANUAL_RENEW:表示通知即将过期,但不自动续费
  • NOTIFY_AND_AUTO_RENEW:表示通知即将过期,而且自动续费
  • DISABLE_NOTIFY_AND_MANUAL_RENEW:表示不通知即将过期,也不自动续费。

  • 注意:后付费模式本项为null
  • CreatedTime Timestamp ISO8601 创建时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ
    ExpiredTime Timestamp ISO8601 到期时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。注意:后付费模式本项为null
    OsName String 操作系统名称。
    SecurityGroupIds Array of String 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。
    LoginSettings LoginSettings 实例登录设置。目前只返回实例所关联的密钥。
    InstanceState String 实例状态。取值范围:
  • PENDING:表示创建中
  • LAUNCH_FAILED:表示创建失败
  • RUNNING:表示运行中
  • STOPPED:表示关机
  • STARTING:表示开机中
  • STOPPING:表示关机中
  • REBOOTING:表示重启中
  • SHUTDOWN:表示停止待销毁
  • TERMINATING:表示销毁中。
  • Tags Array of Tag 实例关联的标签列表。
    StopChargingMode String 实例的关机计费模式。
    取值范围:
  • KEEP_CHARGING:关机继续收费
  • STOP_CHARGING:关机停止收费
  • NOT_APPLICABLE:实例处于非关机状态或者不适用关机停止计费的条件
  • Uuid String 实例全局唯一ID
    LatestOperation String 实例的最新操作。例:StopInstances、ResetInstance。
    注意:此字段可能返回 null,表示取不到有效值。
    LatestOperationState String 实例的最新操作状态。取值范围:
  • SUCCESS:表示操作成功
  • OPERATING:表示操作执行中
  • FAILED:表示操作失败
    注意:此字段可能返回 null,表示取不到有效值。
  • LatestOperationRequestId String 实例最新操作的唯一请求 ID。
    注意:此字段可能返回 null,表示取不到有效值。
    DisasterRecoverGroupId String 分散置放群组ID。
    注意:此字段可能返回 null,表示取不到有效值。
    IPv6Addresses Array of String 实例的IPv6地址。
    注意:此字段可能返回 null,表示取不到有效值。
    CamRoleName String CAM角色名。
    注意:此字段可能返回 null,表示取不到有效值。
    HpcClusterId String 高性能计算集群ID
    注意:此字段可能返回 null,表示取不到有效值。
    RdmaIpAddresses Array of String 高性能计算集群IP列表。
    注意:此字段可能返回 null,表示取不到有效值。

    InstanceChargePrepaid

    描述了实例的计费模式

    被如下接口引用:InquiryPriceModifyInstancesChargeType, InquiryPriceRenewInstances, InquiryPriceRunInstances, ModifyInstancesChargeType, RenewInstances, RunInstances。

    名称 类型 必选 描述
    Period Integer 购买实例的时长,单位:月。取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。
    RenewFlag String 自动续费标识。取值范围:
  • NOTIFY_AND_AUTO_RENEW:通知过期且自动续费
  • NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费
  • DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费

    默认取值:NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。
  • InstanceFamilyConfig

    描述实例的机型族配置信息 形如:{'InstanceFamilyName': '标准型S1', 'InstanceFamily': 'S1'}、{'InstanceFamilyName': '网络优化型N1', 'InstanceFamily': 'N1'}、{'InstanceFamilyName': '高IO型I1', 'InstanceFamily': 'I1'}等。

    被如下接口引用:DescribeInstanceFamilyConfigs。

    名称 类型 描述
    InstanceFamilyName String 机型族名称的中文全称。
    InstanceFamily String 机型族名称的英文简称。

    InstanceMarketOptionsRequest

    竞价请求相关选项

    被如下接口引用:InquiryPriceRunInstances, RunInstances。

    名称 类型 必选 描述
    SpotOptions SpotMarketOptions 竞价相关选项
    MarketType String 市场选项类型,当前只支持取值:spot

    InstanceStatus

    描述实例的状态。状态类型详见实例状态表

    被如下接口引用:DescribeInstancesStatus。

    名称 类型 描述
    InstanceId String 实例ID
    InstanceState String 实例状态。取值范围:
  • PENDING:表示创建中
  • LAUNCH_FAILED:表示创建失败
  • RUNNING:表示运行中
  • STOPPED:表示关机
  • STARTING:表示开机中
  • STOPPING:表示关机中
  • REBOOTING:表示重启中
  • SHUTDOWN:表示停止待销毁
  • TERMINATING:表示销毁中。
  • InstanceTypeConfig

    描述实例机型配置信息

    被如下接口引用:DescribeInstanceTypeConfigs。

    名称 类型 描述
    Zone String 可用区。
    InstanceType String 实例机型。
    InstanceFamily String 实例机型系列。
    GPU Integer GPU核数,单位:核。
    CPU Integer CPU核数,单位:核。
    Memory Integer 内存容量,单位:GB
    FPGA Integer FPGA核数,单位:核。

    InstanceTypeQuotaItem

    描述实例机型配额信息。

    被如下接口引用:DescribeZoneInstanceConfigInfos。

    名称 类型 描述
    Zone String 可用区。
    InstanceType String 实例机型。
    InstanceChargeType String 实例计费模式。取值范围:
  • PREPAID:表示预付费,即包年包月
  • POSTPAID_BY_HOUR:表示后付费,即按量计费
  • CDHPAID:表示CDH付费,即只对CDH计费,不对CDH上的实例计费。
  • SPOTPAID:表示竞价实例付费。
  • NetworkCard Integer 网卡类型,例如:25代表25G网卡
    Externals Externals 扩展属性。
    注意:此字段可能返回 null,表示取不到有效值。
    Cpu Integer 实例的CPU核数,单位:核。
    Memory Integer 实例内存容量,单位:GB
    InstanceFamily String 实例机型系列。
    TypeName String 机型名称。
    LocalDiskTypeList Array of LocalDiskType 本地磁盘规格列表。当该参数返回为空值时,表示当前情况下无法创建本地盘。
    Status String 实例是否售卖。取值范围:
  • SELL:表示实例可购买
  • SOLD_OUT:表示实例已售罄。
  • Price ItemPrice 实例的售卖价格。
    SoldOutReason String 售罄原因。
    注意:此字段可能返回 null,表示取不到有效值。
    InstanceBandwidth Float 内网带宽,单位Gbps。
    InstancePps Integer 网络收发包能力,单位万PPS。
    StorageBlockAmount Integer 本地存储块数量。
    CpuType String 处理器型号。
    Gpu Integer 实例的GPU数量。
    Fpga Integer 实例的FPGA数量。
    Remark String 实例备注信息。

    InternetAccessible

    描述了实例的公网可访问性,声明了实例的公网使用计费模式,最大带宽等

    被如下接口引用:DescribeInstanceInternetBandwidthConfigs, DescribeInstances, InquiryPriceResetInstancesInternetMaxBandwidth, InquiryPriceRunInstances, ResetInstancesInternetMaxBandwidth, RunInstances。

    名称 类型 必选 描述
    InternetChargeType String 网络计费类型。取值范围:
  • BANDWIDTH_PREPAID:预付费按带宽结算
  • TRAFFIC_POSTPAID_BY_HOUR:流量按小时后付费
  • BANDWIDTH_POSTPAID_BY_HOUR:带宽按小时后付费
  • BANDWIDTH_PACKAGE:带宽包用户
    默认取值:非带宽包用户默认与子机付费类型保持一致。
  • InternetMaxBandwidthOut Integer 公网出带宽上限,单位:Mbps。默认值:0Mbps。不同机型带宽上限范围不一致,具体限制详见购买网络带宽。
    PublicIpAssigned Boolean 是否分配公网IP。取值范围:
  • TRUE:表示分配公网IP
  • FALSE:表示不分配公网IP

    当公网带宽大于0Mbps时,可自由选择开通与否,默认开通公网IP;当公网带宽为0,则不允许分配公网IP。该参数仅在RunInstances接口中作为入参使用。
  • BandwidthPackageId String 带宽包ID。可通过DescribeBandwidthPackages接口返回值中的BandwidthPackageId获取。该参数仅在RunInstances接口中作为入参使用。

    InternetBandwidthConfig

    描述了按带宽计费的相关信息

    被如下接口引用:DescribeInstanceInternetBandwidthConfigs。

    名称 类型 描述
    StartTime Timestamp ISO8601 开始时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ
    EndTime Timestamp ISO8601 结束时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ
    InternetAccessible InternetAccessible 实例带宽信息。

    InternetChargeTypeConfig

    描述了网络计费

    被如下接口引用:DescribeInternetChargeTypeConfigs。

    名称 类型 必选 描述
    InternetChargeType String 网络计费模式。
    Description String 网络计费模式描述信息。

    ItemPrice

    描述了单项的价格信息

    被如下接口引用:DescribeZoneInstanceConfigInfos, InquiryPriceModifyInstancesChargeType, InquiryPriceRenewInstances, InquiryPriceResetInstance, InquiryPriceResetInstancesInternetMaxBandwidth, InquiryPriceResetInstancesType, InquiryPriceResizeInstanceDisks, InquiryPriceRunInstances。

    名称 类型 描述
    UnitPrice Float 后续合计费用的原价,后付费模式使用,单位:元。
  • 如返回了其他时间区间项,如UnitPriceSecondStep,则本项代表时间区间在(0, 96)小时;若未返回其他时间区间项,则本项代表全时段,即(0, ∞)小时
    注意:此字段可能返回 null,表示取不到有效值。
  • ChargeUnit String 后续计价单元,后付费模式使用,可取值范围:
  • HOUR:表示计价单元是按每小时来计算。当前涉及该计价单元的场景有:实例按小时后付费(POSTPAID_BY_HOUR)、带宽按小时后付费(BANDWIDTH_POSTPAID_BY_HOUR):
  • GB:表示计价单元是按每GB来计算。当前涉及该计价单元的场景有:流量按小时后付费(TRAFFIC_POSTPAID_BY_HOUR)。
    注意:此字段可能返回 null,表示取不到有效值。
  • OriginalPrice Float 预支合计费用的原价,预付费模式使用,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    DiscountPrice Float 预支合计费用的折扣价,预付费模式使用,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    Discount Float 折扣,如20.0代表2折。
    注意:此字段可能返回 null,表示取不到有效值。
    UnitPriceDiscount Float 后续合计费用的折扣价,后付费模式使用,单位:元
  • 如返回了其他时间区间项,如UnitPriceDiscountSecondStep,则本项代表时间区间在(0, 96)小时;若未返回其他时间区间项,则本项代表全时段,即(0, ∞)小时
    注意:此字段可能返回 null,表示取不到有效值。
  • UnitPriceSecondStep Float 使用时间区间在(96, 360)小时的后续合计费用的原价,后付费模式使用,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    UnitPriceDiscountSecondStep Float 使用时间区间在(96, 360)小时的后续合计费用的折扣价,后付费模式使用,单位:元
    注意:此字段可能返回 null,表示取不到有效值。
    UnitPriceThirdStep Float 使用时间区间在(360, ∞)小时的后续合计费用的原价,后付费模式使用,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    UnitPriceDiscountThirdStep Float 使用时间区间在(360, ∞)小时的后续合计费用的折扣价,后付费模式使用,单位:元
    注意:此字段可能返回 null,表示取不到有效值。
    OriginalPriceThreeYear Float 预支三年合计费用的原价,预付费模式使用,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    注意:此字段可能返回 null,表示取不到有效值。
    DiscountPriceThreeYear Float 预支三年合计费用的折扣价,预付费模式使用,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    注意:此字段可能返回 null,表示取不到有效值。
    DiscountThreeYear Float 预支三年应用的折扣,如20.0代表2折。
    注意:此字段可能返回 null,表示取不到有效值。
    注意:此字段可能返回 null,表示取不到有效值。
    OriginalPriceFiveYear Float 预支五年合计费用的原价,预付费模式使用,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    注意:此字段可能返回 null,表示取不到有效值。
    DiscountPriceFiveYear Float 预支五年合计费用的折扣价,预付费模式使用,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    注意:此字段可能返回 null,表示取不到有效值。
    DiscountFiveYear Float 预支五年应用的折扣,如20.0代表2折。
    注意:此字段可能返回 null,表示取不到有效值。
    注意:此字段可能返回 null,表示取不到有效值。
    OriginalPriceOneYear Float 预支一年合计费用的原价,预付费模式使用,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    注意:此字段可能返回 null,表示取不到有效值。
    DiscountPriceOneYear Float 预支一年合计费用的折扣价,预付费模式使用,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    注意:此字段可能返回 null,表示取不到有效值。
    DiscountOneYear Float 预支一年应用的折扣,如20.0代表2折。
    注意:此字段可能返回 null,表示取不到有效值。
    注意:此字段可能返回 null,表示取不到有效值。

    KeyPair

    描述密钥对信息

    被如下接口引用:CreateKeyPair, DescribeKeyPairs。

    名称 类型 描述
    KeyId String 密钥对的ID,是密钥对的唯一标识。
    KeyName String 密钥对名称。
    ProjectId Integer 密钥对所属的项目ID
    Description String 密钥对描述信息。
    PublicKey String 密钥对的纯文本公钥。
    PrivateKey String 密钥对的纯文本私钥。腾讯云不会保管私钥,请用户自行妥善保存。
    AssociatedInstanceIds Array of String 密钥关联的实例ID列表。
    CreatedTime Timestamp ISO8601 创建时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ

    LocalDiskType

    本地磁盘规格

    被如下接口引用:DescribeZoneInstanceConfigInfos。

    名称 类型 描述
    Type String 本地磁盘类型。
    PartitionType String 本地磁盘属性。
    MinSize Integer 本地磁盘最小值。
    MaxSize Integer 本地磁盘最大值。
    Required String 购买时本地盘是否为必选。取值范围:
  • REQUIRED:表示必选
  • OPTIONAL:表示可选。
  • LoginSettings

    描述了实例登录相关配置与信息。

    被如下接口引用:DescribeInstances, InquiryPriceResetInstance, InquiryPriceRunInstances, ResetInstance, RunInstances。

    名称 类型 必选 描述
    Password String 实例登录密码。不同操作系统类型密码复杂度限制不一样,具体如下:
  • Linux实例密码必须8到30位,至少包括两项[a-z],[A-Z]、[0-9] 和 [( ) ` ~ ! @ # $ % ^ & - + = | { } [ ] : ; ' , . ? / ]中的特殊符号。
  • Windows实例密码必须12到30位,至少包括三项[a-z],[A-Z],[0-9] 和 [( ) ` ~ ! @ # $ % ^ & - + = | { } [ ] : ; ' , . ? /]中的特殊符号。

    若不指定该参数,则由系统随机生成密码,并通过站内信方式通知到用户。
    注意:此字段可能返回 null,表示取不到有效值。
  • KeyIds Array of String 密钥ID列表。关联密钥后,就可以通过对应的私钥来访问实例;KeyId可通过接口DescribeKeyPairs获取,密钥与密码不能同时指定,同时Windows操作系统不支持指定密钥。当前仅支持购买的时候指定一个密钥。
    注意:此字段可能返回 null,表示取不到有效值。
    KeepImageLogin String 保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为TRUE。取值范围:
  • TRUE:表示保持镜像的登录设置
  • FALSE:表示不保持镜像的登录设置

    默认取值:FALSE。
    注意:此字段可能返回 null,表示取不到有效值。
  • OperationCountLimit

    描述了单台实例操作次数限制

    被如下接口引用:DescribeInstancesOperationLimit。

    名称 类型 描述
    Operation String 实例操作。取值范围:
  • INSTANCE_DEGRADE:降配操作
  • INTERNET_CHARGE_TYPE_CHANGE:修改网络带宽计费模式
  • InstanceId String 实例ID。
    CurrentCount Integer 当前已使用次数,如果返回值为-1表示该操作无次数限制。
    LimitCount Integer 操作次数最高额度,如果返回值为-1表示该操作无次数限制,如果返回值为0表示不支持调整配置。

    OsVersion

    操作系统支持的类型。

    被如下接口引用:DescribeImportImageOs。

    名称 类型 描述
    OsName String 操作系统类型
    OsVersions Array of String 支持的操作系统版本
    Architecture Array of String 支持的操作系统架构

    Placement

    描述了实例的抽象位置,包括其所在的可用区,所属的项目,宿主机(仅CDH产品可用),母机ip等

    被如下接口引用:AllocateHosts, DescribeHosts, DescribeInstances, InquiryPriceRunInstances, RunInstances。

    名称 类型 必选 描述
    Zone String 实例所属的可用区ID。该参数可以通过调用 DescribeZones 的返回值中的Zone字段来获取。
    ProjectId Integer 实例所属项目ID。该参数可以通过调用 DescribeProject 的返回值中的 projectId 字段来获取。不填为默认项目。
    HostIds Array of String 实例所属的专用宿主机ID列表,仅用于入参。如果您有购买专用宿主机并且指定了该参数,则您购买的实例就会随机的部署在这些专用宿主机上。
    HostIps Array of String 指定母机ip生产子机
    HostId String 实例所属的专用宿主机ID,仅用于出参。

    Price

    价格

    被如下接口引用:InquiryPriceModifyInstancesChargeType, InquiryPriceRenewInstances, InquiryPriceResetInstance, InquiryPriceResetInstancesInternetMaxBandwidth, InquiryPriceResetInstancesType, InquiryPriceResizeInstanceDisks, InquiryPriceRunInstances。

    名称 类型 描述
    InstancePrice ItemPrice 描述了实例价格。
    BandwidthPrice ItemPrice 描述了网络价格。

    RegionInfo

    地域信息

    被如下接口引用:DescribeRegions。

    名称 类型 描述
    Region String 地域名称,例如,ap-guangzhou
    RegionName String 地域描述,例如,华南地区(广州)
    RegionState String 地域是否可用状态

    ReservedInstanceConfigInfoItem

    预留实例静态配置信息。预留实例当前只针对国际站白名单用户开放。

    被如下接口引用:DescribeReservedInstancesConfigInfos。

    名称 类型 描述
    Type String 实例规格。
    TypeName String 实例规格名称。
    Order Integer 优先级。
    InstanceFamilies Array of ReservedInstanceFamilyItem 实例族信息列表。

    ReservedInstanceFamilyItem

    预留实例相关实例族信息。预留实例当前只针对国际站白名单用户开放。

    被如下接口引用:DescribeReservedInstancesConfigInfos。

    名称 类型 描述
    InstanceFamily String 实例族。
    Order Integer 优先级。
    InstanceTypes Array of ReservedInstanceTypeItem 实例类型信息列表。

    ReservedInstancePrice

    预留实例相关价格信息。预留实例当前只针对国际站白名单用户开放。

    被如下接口引用:InquirePricePurchaseReservedInstancesOffering。

    名称 类型 描述
    OriginalFixedPrice Float 预支合计费用的原价,单位:元。
    DiscountFixedPrice Float 预支合计费用的折扣价,单位:元。
    OriginalUsagePrice Float 后续合计费用的原价,单位:元/小时
    DiscountUsagePrice Float 后续合计费用的折扣价,单位:元/小时

    ReservedInstancePriceItem

    基于付费类型的预留实例相关价格信息。预留实例当前只针对国际站白名单用户开放。

    被如下接口引用:DescribeReservedInstancesConfigInfos。

    名称 类型 描述
    OfferingType String 付费类型,如:"All Upfront","Partial Upfront","No Upfront"
    FixedPrice Float 预支合计费用,单位:元。
    UsagePrice Float 后续合计费用,单位:元/小时
    ReservedInstancesOfferingId String 预留实例配置ID
    Zone String 预留实例计费可购买的可用区。
    Duration Integer 预留实例计费【有效期】即预留实例计费购买时长。形如:31536000。
    计量单位:秒
    ProductDescription String 预留实例计费的平台描述(即操作系统)。形如:linux。
    返回项: linux 。

    ReservedInstanceTypeItem

    预留实例类型信息。预留实例当前只针对国际站白名单用户开放。

    被如下接口引用:DescribeReservedInstancesConfigInfos。

    名称 类型 描述
    InstanceType String 实例类型。
    Cpu Integer CPU核数。
    Memory Integer 内存大小。
    Gpu Integer GPU数量。
    Fpga Integer FPGA数量。
    StorageBlock Integer 本地存储块数量。
    NetworkCard Integer 网卡数。
    MaxBandwidth Float 最大带宽。
    Frequency String 主频。
    CpuModelName String CPU型号名称。
    Pps Integer 包转发率。
    Externals Externals 外部信息。
    Remark String 备注信息。
    Prices Array of ReservedInstancePriceItem 预留实例配置价格信息。

    RunMonitorServiceEnabled

    描述了 “云监控” 服务相关的信息

    被如下接口引用:InquiryPriceResetInstance, InquiryPriceRunInstances, ResetInstance, RunInstances。

    名称 类型 必选 描述
    Enabled Boolean 是否开启云监控服务。取值范围:
  • TRUE:表示开启云监控服务
  • FALSE:表示不开启云监控服务

    默认取值:TRUE。
  • RunSecurityServiceEnabled

    描述了 “云安全” 服务相关的信息

    被如下接口引用:InquiryPriceResetInstance, InquiryPriceRunInstances, ResetInstance, RunInstances。

    名称 类型 必选 描述
    Enabled Boolean 是否开启云安全服务。取值范围:
  • TRUE:表示开启云安全服务
  • FALSE:表示不开启云安全服务

    默认取值:TRUE。
  • SharePermission

    镜像分享信息结构

    被如下接口引用:DescribeImageSharePermission。

    名称 类型 描述
    CreatedTime Timestamp ISO8601 镜像分享时间
    AccountId String 镜像分享的账户ID

    Snapshot

    描述镜像关联的快照信息

    被如下接口引用:DescribeImages。

    名称 类型 描述
    SnapshotId String 快照Id。
    DiskUsage String 创建此快照的云硬盘类型。取值范围:
    SYSTEM_DISK:系统盘
    DATA_DISK:数据盘。
    DiskSize Integer 创建此快照的云硬盘大小,单位GB。

    SpotMarketOptions

    竞价相关选项

    被如下接口引用:InquiryPriceRunInstances, RunInstances。

    名称 类型 必选 描述
    MaxPrice String 竞价出价
    SpotInstanceType String 竞价请求类型,当前仅支持类型:one-time

    StorageBlock

    HDD的本地存储信息

    被如下接口引用:DescribeReservedInstancesConfigInfos, DescribeZoneInstanceConfigInfos, RunInstances。

    名称 类型 描述
    Type String HDD本地存储类型,值为:LOCAL_PRO.
    注意:此字段可能返回 null,表示取不到有效值。
    MinSize Integer HDD本地存储的最小容量
    注意:此字段可能返回 null,表示取不到有效值。
    MaxSize Integer HDD本地存储的最大容量
    注意:此字段可能返回 null,表示取不到有效值。

    SystemDisk

    描述了操作系统所在块设备即系统盘的信息

    被如下接口引用:DescribeInstances, InquiryPriceResetInstance, InquiryPriceRunInstances, ResetInstance, RunInstances。

    名称 类型 必选 描述
    DiskType String 系统盘类型。系统盘类型限制详见存储概述。取值范围:
  • LOCAL_BASIC:本地硬盘
  • LOCAL_SSD:本地SSD硬盘
  • CLOUD_BASIC:普通云硬盘
  • CLOUD_SSD:SSD云硬盘
  • CLOUD_PREMIUM:高性能云硬盘

    默认取值:当前有库存的硬盘类型。
  • DiskId String 系统盘ID。LOCAL_BASIC 和 LOCAL_SSD 类型没有ID。暂时不支持该参数。
    DiskSize Integer 系统盘大小,单位:GB。默认值为 50
    CdcId String 所属的独享集群ID。

    Tag

    标签键值对

    被如下接口引用:AllocateHosts, DescribeInstances, InquiryPriceRunInstances, RunInstances。

    名称 类型 必选 描述
    Key String 标签键
    Value String 标签值

    TagSpecification

    创建资源实例时同时绑定的标签对说明

    被如下接口引用:AllocateHosts, InquiryPriceRunInstances, RunInstances。

    名称 类型 必选 描述
    ResourceType String 标签绑定的资源类型,云服务器为“instance”,专用宿主机为“host”
    Tags Array of Tag 标签对列表

    VirtualPrivateCloud

    描述了VPC相关信息,包括子网,IP信息等

    被如下接口引用:DescribeInstances, InquiryPriceRunInstances, ModifyInstancesVpcAttribute, RunInstances。

    名称 类型 必选 描述
    VpcId String 私有网络ID,形如vpc-xxx。有效的VpcId可通过登录控制台查询;也可以调用接口 DescribeVpcEx ,从接口返回中的unVpcId字段获取。若在创建子机时VpcId与SubnetId同时传入DEFAULT,则强制使用默认vpc网络。
    SubnetId String 私有网络子网ID,形如subnet-xxx。有效的私有网络子网ID可通过登录控制台查询;也可以调用接口 DescribeSubnets ,从接口返回中的unSubnetId字段获取。若在创建子机时SubnetId与VpcId同时传入DEFAULT,则强制使用默认vpc网络。
    AsVpcGateway Boolean 是否用作公网网关。公网网关只有在实例拥有公网IP以及处于私有网络下时才能正常使用。取值范围:
  • TRUE:表示用作公网网关
  • FALSE:表示不用作公网网关

    默认取值:FALSE。
  • PrivateIpAddresses Array of String 私有网络子网 IP 数组,在创建实例、修改实例vpc属性操作中可使用此参数。当前仅批量创建多台实例时支持传入相同子网的多个 IP。
    Ipv6AddressCount Integer 为弹性网卡指定随机生成的 IPv6 地址数量。

    ZoneInfo

    可用区信息

    被如下接口引用:DescribeZones。

    名称 类型 描述
    Zone String 可用区名称,例如,ap-guangzhou-3
    全网可用区名称如下:
  • ap-chongqing-1
  • ap-seoul-1
  • ap-seoul-2
  • 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(售罄)
  • ap-guangzhou-2(售罄)
  • ap-guangzhou-3
  • ap-guangzhou-4
  • ap-guangzhou-6
  • ap-tokyo-1
  • ap-singapore-1
  • ap-singapore-2
  • ap-shanghai-fsi-1
  • ap-shanghai-fsi-2
  • ap-shanghai-fsi-3
  • ap-bangkok-1
  • ap-shanghai-1(售罄)
  • ap-shanghai-2
  • ap-shanghai-3
  • ap-shanghai-4
  • ap-shanghai-5
  • ap-mumbai-1
  • ap-mumbai-2
  • eu-moscow-1
  • ap-beijing-1
  • 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
  • na-toronto-1
  • na-ashburn-1
  • na-ashburn-2
  • ap-nanjing-1
  • ap-nanjing-2
  • ZoneName String 可用区描述,例如,广州三区
    ZoneId String 可用区ID
    ZoneState String 可用区状态,包含AVAILABLE和UNAVAILABLE。AVAILABLE代表可用,UNAVAILABLE代表不可用。

    版权声明:本文转载自网络,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。本站转载出于传播更多优秀技术知识之目的,如有侵权请联系QQ/微信:153890879删除

    相关文章
    腾讯云代理商
    精彩导读
    海外云服务器
    热门资讯
    腾讯云代理商