数据结构

最近更新时间: 2024-09-03 18:49:49

ChargePrepaid

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

被如下接口引用:AllocateHosts、InquiryPriceAllocateHosts、InquiryPriceRenewHosts、RenewHosts、SwitchParameterAllocateHosts、SwitchParameterRenewHosts

名称 必选 允许NULL 类型 描述
Period 是 否 Uint64 购买实例的时长,单位:月。取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36。
RenewFlag 否 否 String 自动续费标识。取值范围:<br><li>NOTIFY_AND_AUTO_RENEW:通知过期且自动续费<br><li>NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费<br><li>DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费<br><br>默认取值:NOTIFY_AND_AUTO_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。

InstanceTypeQuota

描述实例机型配额信息

被如下接口引用:DescribeInstanceTypeQuota

名称 必选 允许NULL 类型 描述
Zone 是 否 String 可用区。
InstanceType 是 否 String 实例机型。
InstanceQuota 是 否 Int64 实例机型配额。
InstanceChargeType 是 否 String 实例计费模式。取值范围: <br>PREPAID:表示预付费,即包年包月 <br> POSTPAID_BY_HOUR:表示后付费,即按量计费 * CDHPAID:CDH付费,即只对CDH计费,不对CDH上的实例计费。
DeviceClass 否 否 String 实例类型。
CPU 否 否 Int64 实例的CPU核数,单位:核。
Memory 否 否 Int64 实例内存容量,单位:GB。
GPU 否 否 Int64 实例的GPU核数,单位:核。

ReportDetailSet

ReportDetailSet

被如下接口引用:DescribeDiagnosticReports

名称 必选 允许NULL 类型 描述
Category 否 否 String 检测类型
CategoryName 否 否 String 检测类型名
Code 否 否 String 检测编码
CodeName 否 否 String 编码名称
IsAuthorized 否 否 Bool 已授权
Message 否 否 String 信息
Severity 否 否 String 检测状态
Status 否 否 String 状态

HostTypeConfigSetPrice

价格信息

被如下接口引用:DescribeZoneHostConfigInfos

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

ItemPrice

描述了单项的价格信息

被如下接口引用:DescribeZoneInstanceConfigInfos、InquiryPriceAllocateHosts、InquiryPriceModifyInstancesChargeType、InquiryPriceRenewHosts、InquiryPriceRenewInstances、InquiryPriceResetInstance、InquiryPriceResetInstancesInternetMaxBandwidth、InquiryPriceResetInstancesType、InquiryPriceResizeInstanceDisks、InquiryPriceRunInstances

名称 必选 允许NULL 类型 描述
UnitPrice 否 是 Float 后续单价,单位:元。
ChargeUnit 否 是 String 后续计价单元,可取值范围: <br><li>HOUR:表示计价单元是按每小时来计算。当前涉及该计价单元的场景有:实例按小时后付费(POSTPAID_BY_HOUR)、带宽按小时后付费(BANDWIDTH_POSTPAID_BY_HOUR):<br><li>GB:表示计价单元是按每GB来计算。当前涉及该计价单元的场景有:流量按小时后付费(TRAFFIC_POSTPAID_BY_HOUR)。
OriginalPrice 否 是 Float 预支费用的原价,单位:元。
DiscountPrice 否 是 Float 预支费用的折扣价,单位:元。
Discount 否 是 Float 折扣,如20.0代表2折
UnitPriceDiscount 否 是 Float 后续合计费用的折扣价,后付费模式使用,单位:元<br><li>如返回了其他时间区间项,如UnitPriceDiscountSecondStep,则本项代表时间区间在(0, 96)小时;若未返回其他时间区间项,则本项代表全时段,即(0, ∞)小时
UnitPriceSecondStep 否 是 Float 使用时间区间在(96, 360)小时的后续合计费用的原价,后付费模式使用,单位:元。
UnitPriceDiscountSecondStep 否 是 Float 使用时间区间在(96, 360)小时的后续合计费用的折扣价,后付费模式使用,单位:元
UnitPriceThirdStep 否 是 Float 使用时间区间在(360, ∞)小时的后续合计费用的原价,后付费模式使用,单位:元。
UnitPriceDiscountThirdStep 否 是 Float 使用时间区间在(360, ∞)小时的后续合计费用的折扣价,后付费模式使用,单位:元
DetailPrices 否 是 DetailPrices 详细价格
DiscountThirdStep 否 是 Float 使用时间区间在(360, ∞)小时的后续合计费用的折扣价,后付费模式使用,单位:元<br>注意:此字段可能返回 null,表示取不到有效值。

HostTypeQuotaSet

专用宿主机机型配置和售卖状态信息

被如下接口引用:

名称 必选 允许NULL 类型 描述
CPU 是 否 Uint64 CPU核数,单位:核。
CpuModelName 是 否 String CPU型号。
DiskSize 是 否 Uint64 磁盘大小,单位:GB。
DiskType 是 否 String 磁盘类型。
HostFamily 是 否 String 专用宿主机机型系列。
HostType 是 否 String 专用宿主机类型。
Memory 是 否 Uint64 内存大小,单位:GB。
Price 是 否 Price 售价。
Status 是 否 String 售卖状态,“ SOLD_OUT”:售罄,“SELL”:售卖中
Zone 是 否 String 可用区。

InstanceTypeConfig

描述实例机型配置信息

被如下接口引用:DescribeInstanceTypeConfigs、DescribeInstancesModification

名称 必选 允许NULL 类型 描述
Zone 否 否 String 可用区。
InstanceType 否 否 String 实例机型。
InstanceFamily 否 否 String 实例机型系列。
GPU 否 否 Int64 GPU核数,单位:核。
CPU 否 否 Int64 CPU核数,单位:核。
Memory 否 否 Int64 内存容量,单位:GB。
FPGA 是 否 Uint64 FPGA核数,单位:核。

InstanceReturnable

实例可退还信息。

被如下接口引用:DescribeInstancesReturnable

名称 必选 允许NULL 类型 描述
InstanceId 是 否 String 实例ID。
IsReturnable 是 否 Bool 实例是否可退还。
ReturnFailCode 是 否 Int64 实例退还失败错误码。
ReturnFailMessage 是 否 String 实例退还失败错误信息。

RunSecurityServiceEnabled

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

被如下接口引用:CreateLaunchTemplate、DescribeLaunchTemplatesInfo、InquiryPriceResetInstance、InquiryPriceRunInstances、ModifyLaunchTemplate、ResetInstance、RunInstances、SwitchParameterResetInstance、SwitchParameterRunInstances

名称 必选 允许NULL 类型 描述
Enabled 否 否 Bool 是否开启云安全服务。取值范围:<br><li>TRUE:表示开启云安全服务<br><li>FALSE:表示不开启云安全服务<br><br>默认取值:TRUE。

OfflineMigrateUserTaskData

离线迁移任务数据类型,包含实例迁移和数据迁移

被如下接口引用:DescribeUserMigrateTasks

名称 必选 允许NULL 类型 描述
JobId 是 是 String 任务id
JobName 是 是 String 任务名称
AppId 是 是 Uint64 云平台应用ID,一般来说与Uin存在一一对应的关系。
Uin 是 是 String 用户uin
Uuid 是 是 String 实例uuid
InstanceId 是 是 String 实例id
ImageUrl 是 是 String 系统盘镜像cos url
DataSize 是 是 Uint64 辅助数据盘大小
Region 是 是 String 地域。
Status 是 是 String 任务状态
Progress 是 是 Uint64 迁移任务的进度
CreateTime 是 是 String 创建时间
EndTime 是 是 String 结束时间
SnapshotUrl 是 是 String 数据盘镜像url
DiskId 是 是 String 数据盘id
DiskSize 是 是 Uint64 数据盘大小

UserMigrateTaskData

用户迁移任务详情

被如下接口引用:DescribeUserMigrateTasks

名称 必选 允许NULL 类型 描述
JobId 是 是 String 任务id
JobName 是 是 String 任务名称
AppId 是 是 Uint64 云平台应用ID,一般来说与Uin存在一一对应的关系。
Uin 是 是 String 用户uin
Uuid 是 是 String 实例uuid
InstanceId 是 是 String 实例id
ImageUrl 是 是 String 数据盘镜像cos url
DataSize 是 是 Uint64 数据大小
Region 是 是 String 地域。
Status 是 是 String 任务状态
Progress 是 是 Uint64 迁移任务的进度
CreateTime 是 是 String 创建时间
EndTime 是 是 String 结束时间

RegionInfo

地域信息

被如下接口引用:DescribeRegions

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

ActionTimers

ActionTimers返回值

被如下接口引用:QueryInstancesActionTimer

名称 必选 允许NULL 类型 描述
ActionTimerId 是 否 String ActionTimerId
AppId 是 否 Uint64 AppId
InstanceId 是 否 String InstanceId
TimerAction 是 否 String TimerAction
ActionTime 是 否 String ActionTime
Status 是 否 String Status
Externals 是 否 Externals Externals

InstanceConfigInfoItemArchitecture

带有CPU架构的实例静态配置信息。

被如下接口引用:DescribeInstanceConfigInfos

名称 必选 允许NULL 类型 描述
type 是 否 String 实例规格。
typeName 是 否 String 实例规格名称。
order 是 否 Int64 优先级。
instanceFamilies 是 否 Array of InstanceFamilyItemArchitecture 实例族信息列表。

KeyPairInstancesinternetaccessible

描述密钥对和实例的关联关系

被如下接口引用:

名称 必选 允许NULL 类型 描述
KeyId 否 否 String 密钥对的ID,是密钥对的唯一标识。
AssociatedInstanceIdSet 否 否 Array of String 密钥对关联的实例ID列表。

Address

描述 EIP 信息

被如下接口引用:DescribeAddresses

名称 必选 允许NULL 类型 描述
AddressId 否 否 String EIP的ID,是EIP的唯一标识。
AddressName 否 否 String EIP名称。
AddressState 否 否 String EIP状态。
AddressIp 否 否 String 弹性外网IP
BindedResourceId 否 否 String 绑定的资源实例ID。可能是一个CVM,NAT,或是弹性网卡。
CreatedTime 否 否 Datetime_iso 创建时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。

InstanceFamilyConfig

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

被如下接口引用:DescribeInstanceFamilyConfigs

名称 必选 允许NULL 类型 描述
InstanceFamilyName 是 否 String 机型族名称的中文全称。
InstanceFamily 是 否 String 机型族名称的英文简称。

ClientSysInfo

用于热迁移时传递客户端系统信息。

被如下接口引用:LiveMigrateInstance

名称 必选 允许NULL 类型 描述
OsType 是 否 String 操作系统
OsVersion 是 否 String 操作系统版本
DiskSize 是 否 Array of Uint64 需要导入的系统盘数据盘信息
ExtraInfo 否 否 String 额外信息

AccountAttribute

账户属性对象

被如下接口引用:DescribeAccountAttributes

名称 必选 允许NULL 类型 描述
AttributeName 是 否 String 付费类型:后付费(PostPaidInstanceCountLimit),预付费(PrePaidInstanceCountLimit)
AttributeValues 是 否 String 单次最大购买数量

ImageAttribute

unImgId 到 deviceImageId的映射

被如下接口引用:

名称 必选 允许NULL 类型 描述
ImageId 是 否 String unImgId
InnerImageId 是 否 String deviceImageId

InstanceDisasterMap

实例Id对应置放群组对

被如下接口引用:RemoveInstancesDisasterRecoverGroup

名称 必选 允许NULL 类型 描述
InstanceId 否 否 String 实例id
DisasterIds 否 否 Array of String 置放群组id

InstanceOrder

实例订单详情信息。

被如下接口引用:SwitchParameterModifyInstanceInternetChargeType、SwitchParameterModifyInstancesChargeType、SwitchParameterRenewInstances、SwitchParameterResetInstance、SwitchParameterResetInstancesInternetMaxBandwidth、SwitchParameterResetInstancesType、SwitchParameterResizeInstanceDisks、SwitchParameterRunInstances

名称 必选 允许NULL 类型 描述

InstanceTypeConfigStatusSet

(跨机型)调整配置返回的机型实例及状态列表

被如下接口引用:DescribeInstancesModification

名称 必选 允许NULL 类型 描述
Status 否 否 String 状态
Message 否 否 String 描述信息
InstanceTypeConfig 否 否 InstanceTypeConfig 机型列表

HostTypeQuota

专用宿主机机型配置和售卖状态信息

被如下接口引用:

名称 必选 允许NULL 类型 描述
CPU 是 否 Uint64 CPU核数,单位:核。
CpuModelName 是 否 String CPU型号。
DiskSize 是 否 Uint64 磁盘大小,单位:GB。
DiskType 是 否 String 磁盘类型。
HostFamily 是 否 String 专用宿主机机型系列。
HostType 是 否 String 专用宿主机类型。
Memory 是 否 Uint64 内存大小,单位:GB。
Price 是 否 PriceForHostTypeQuota 售价。
Status 是 否 String 售卖状态,“ SOLD_OUT”:售罄,“SELL”:售卖中
Zone 是 否 String 可用区。

ProjectSpecification

平台项目ID

被如下接口引用:RunInstances

名称 必选 允许NULL 类型 描述
ResourceType 是 否 String 资源类型,默认instance
PlatformProjectId 是 否 String 项目Id

HostForSellZoneStatus

专用宿主机在可用区的可售卖情况。

被如下接口引用:

名称 必选 允许NULL 类型 描述
Zone 是 否 String 可用区
Status 是 否 String 可售卖情况, (SELL: 正常售卖,SOLD_OUT: 售罄)。

DiagnosticReportDataSet

DiagnosticReportDataSet

被如下接口引用:DescribeDiagnosticReports

名称 必选 允许NULL 类型 描述
CreateTime 否 否 Datetime 开始时间
DiagnosticReportId 否 否 String 报告id
FinishTime 否 否 Datetime 结束时间
InstanceId 否 否 String 实例id
InstanceName 否 否 String 实例名称
ReportDetailSet 否 否 ReportDetailSet ReportDetailSet
Severity 否 否 String 检测状态
Status 否 否 String 状态
Uuid 否 否 String uuid

KvType

键值类型

被如下接口引用:DescribeUserGlobalConfigs、ModifyUserGlobalConfigs

名称 必选 允许NULL 类型 描述
Name 是 否 String 键的名称
Value 是 否 String 键所对应的值

QuerySystemDisk

查询的系统盘

被如下接口引用:

名称 必选 允许NULL 类型 描述
DiskSize 是 否 Int64 系统盘大小
DiskType 是 否 String 系统盘类型:LOCAL_BASIC、CLOUD_BASIC、LOCAL_SSD、CLOUD_SSD、CLOUD_PREMIUM、CLOUD_ENHANCEDSSD

AvailabilityZone

描述可用区信息。

被如下接口引用:

名称 必选 允许NULL 类型 描述
RegionId 否 否 String 地域ID。
Zone 否 否 String 可用区ID。
ZoneName 否 否 String 可用区名称。
ZoneState 否 否 String 可用区状态。

StorageBlock

HDD的本地存储信息 <br>被如下接口引用:CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeZoneInstanceConfigInfos, RunInstances。

被如下接口引用:DescribeInstanceConfigInfos、DescribeInstancesActionTimer、DescribeLaunchTemplatesInfo、DescribeZoneInstanceConfigInfos、ImportInstancesActionTimer、ModifyInstancesActionTimer、QueryInstancesActionTimer、SwitchParameterRunInstances、UpdateInstancesActionTimer

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

ImportImageOsListSupported

导入镜像支持os列表

被如下接口引用:DescribeImportImageOs

名称 必选 允许NULL 类型 描述
Linux 是 否 Array of String linux系统列表
Windows 是 否 Array of String windows系统列表

LocalDiskType

本地磁盘规格

被如下接口引用:DescribeZoneInstanceConfigInfos

名称 必选 允许NULL 类型 描述
Type 是 否 String 本地磁盘类型。
PartitionType 是 否 String 本地磁盘属性。
MinSize 是 否 Int64 本地磁盘最小值。
MaxSize 是 否 Int64 本地磁盘最大值。
Required 是 否 String 购买时本地盘是否为必选。取值范围:<br><li>REQUIRED:表示必选<br><li>OPTIONAL:表示可选。

HostOrder

cdh实例相关的订单信息

被如下接口引用:SwitchParameterAllocateHosts、SwitchParameterRenewHosts

名称 必选 允许NULL 类型 描述
appId 否 否 Uint64 订单所属帐号的应用id
uin 否 否 String 创建订单的帐号uin
ownerUin 否 否 String 订单所属帐号的所有者uin
goods 否 否 Array of HostGoodsItem 订单发货的资源信息列表

InternetChargeTypeConfig

描述了网络计费

被如下接口引用:DescribeInternetChargeTypeConfigs

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

MonitorServiceItem

监控服务

被如下接口引用:DescribeInstanceConfigInfos、DescribeInstancesActionTimer、DescribeLaunchTemplatesInfo、DescribeZoneInstanceConfigInfos、ImportInstancesActionTimer、ModifyInstancesActionTimer、QueryInstancesActionTimer、SwitchParameterRunInstances、UpdateInstancesActionTimer

名称 必选 允许NULL 类型 描述
Enabled 否 是 String 是否启用

ImportImageOsVersion

导入镜像OS版本描述

被如下接口引用:DescribeImportImageOs

名称 必选 允许NULL 类型 描述
Architecture 是 否 Array of String CPU架构
OsName 是 否 String OS名称
OsVersions 是 否 Array of String OS版本号

InstanceConnectivity

实例端口连通性状态,用于表示实例默认远程登录端口和ICMP端口的连通性。

被如下接口引用:CheckInstancesConnectivity

名称 必选 允许NULL 类型 描述
InstanceId 是 否 String 实例ID
DefaultLoginPortConnectivity 是 否 Bool 默认远程登录端口连通性状态
ICMPConnectivity 是 否 Bool ping包是否可达

KeyBill

描述实例订单Id

被如下接口引用:DescribeInstancesAttribute

名称 必选 允许NULL 类型 描述
InstanceId 是 否 String 实例ID形如:ins-11112222。
BillId 是 是 String 订单id

KeyPair

描述密钥对信息

被如下接口引用:DescribeKeyPairs

名称 必选 允许NULL 类型 描述
KeyId 否 否 String 密钥对的ID,是密钥对的唯一标识。
KeyName 否 否 String 密钥对名称。
Description 否 否 String 密钥对描述
PublicKey 否 否 String 密钥对的纯文本公钥。
AssociatedImageCount 否 否 Int64 密钥关联的镜像数。
AssociatedInstanceCount 否 否 Int64 密钥关联的实例数。
AssociatedInstanceIds 否 否 Array of String 密钥关联的实例ID列表。
CreatedTime 是 否 Datetime_iso 密钥对创建日期

HostPrice

cdh相关价格信息

被如下接口引用:InquiryPriceAllocateHosts、InquiryPriceRenewHosts

名称 必选 允许NULL 类型 描述
HostPrice 否 否 ItemPrice 描述了cdh实例相关的价格信息

HostItem

cdh实例详细信息

被如下接口引用:DescribeHosts

名称 必选 允许NULL 类型 描述
Placement 否 否 Placement cdh实例所在的位置。通过该参数可以指定实例所属可用区,所属项目等属性。
HostId 否 否 String cdh实例id
HostType 否 否 String cdh实例类型
HostName 否 否 String cdh实例名称
HostChargeType 否 否 String cdh实例付费模式
RenewFlag 否 否 String cdh实例自动续费标记
CreatedTime 否 否 Datetime_iso cdh实例创建时间
ExpiredTime 否 否 Datetime_iso cdh实例过期时间
InstanceIds 否 否 Array of String cdh实例上已创建云子机的实例id列表
HostState 否 否 String cdh实例状态
HostIp 否 否 String cdh实例ip
HostResource 否 否 HostResource cdh实例资源信息
CageId 否 否 String cage id
OperationMask 否 否 Int64 操作掩码
Tags 否 否 Array of String 标签

ResourceForInstanceType

实例类型的资源

被如下接口引用:InquiryResourceResetInstancesType

名称 必选 允许NULL 类型 描述
Memory 是 否 Uint64 内存大小,单位GB。
CPU 是 否 Uint64 CPU核数
InstanceType 是 否 String 实例机型规格,比如S1.SMALL1、S1.SMALL2等。
Status 是 否 String 实例规格状态

ProductInfoItem

产品描述信息项

被如下接口引用:SwitchParameterAllocateHosts、SwitchParameterRenewHosts

名称 必选 允许NULL 类型 描述
name 是 否 String 信息项名称
value 是 否 String 信息项对应的值

SharePermission

镜像分享信息结构

被如下接口引用:DescribeImageSharePermission

名称 必选 允许NULL 类型 描述
CreatedTime 是 否 Datetime_iso 镜像分享时间
AccountId 是 否 String 镜像分享的账户ID

InstanceDeniedActions

实例操作限制列表

被如下接口引用:DescribeInstancesDeniedActions

名称 必选 允许NULL 类型 描述
InstanceId 否 否 String 实例ID
DeniedActions 否 否 Array of DeniedActions 操作限制列表

KeyPairAttributeSet

密钥对

被如下接口引用:DescribeKeyPairsAttribute

名称 必选 允许NULL 类型 描述
KeyId 是 否 String 密钥ID
InnerKeyId 是 否 String 内部密钥ID

LaunchTemplateInfo

实例启动模板简要信息。<br/>被如下接口引用:DescribeLaunchTemplates。

被如下接口引用:

名称 必选 允许NULL 类型 描述
LatestVersionNumber 否 是 Int64 实例启动模版本号。 注意:此字段可能返回 null,表示取不到有效值。
LaunchTemplateId 否 是 String 实例启动模板ID。 注意:此字段可能返回 null,表示取不到有效值。
LaunchTemplateName 否 是 String 实例启动模板名。 注意:此字段可能返回 null,表示取不到有效值。
DefaultVersionNumber 否 是 Int64 实例启动模板默认版本号。 注意:此字段可能返回 null,表示取不到有效值。
LaunchTemplateVersionCount 否 是 Int64 实例启动模板包含的版本总数量。 注意:此字段可能返回 null,表示取不到有效值。
CreatedBy 否 是 String 创建该模板的用户UIN。 注意:此字段可能返回 null,表示取不到有效值。
CreationTime 否 是 Datetime 创建该模板的时间。 注意:此字段可能返回 null,表示取不到有效值。

TagSpecification

创建云主机实例时同时绑定的标签对说明

被如下接口引用:CreateLaunchTemplate、DescribeLaunchTemplatesInfo、ModifyLaunchTemplate、RunInstances

名称 必选 允许NULL 类型 描述
ResourceType 是 否 String 标签绑定的资源类型
Tags 是 否 Array of Tag 标签对列表

CbsMigrateTask

离线数据迁移任务详情

被如下接口引用:DescribeUserMigrateTasks

名称 必选 允许NULL 类型 描述
JobId 是 否 String 任务id
JobName 是 否 String 任务名称
AppId 是 否 Uint64 云平台应用ID,一般来说与Uin存在一一对应的关系。
Uin 是 否 String 用户uin
SnapshotUrl 是 否 String 快照url
DiskId 是 否 Uint64 磁盘id
Region 是 否 String 地域
DiskSize 是 否 Uint64 数据大小
Status 是 否 String 任务状态
Progress 是 否 Uint64 迁移任务的进度
CreateTime 是 否 String 创建时间
EndTime 是 否 String 结束时间

Instance

描述实例的信息

被如下接口引用:DescribeInstances

名称 必选 允许NULL 类型 描述
Placement 否 否 Placement 实例所在的位置。
InstanceId 否 否 String 实例ID。
InstanceType 否 否 String 实例机型。
CPU 否 否 Int64 实例的CPU核数,单位:核。
Memory 否 否 Int64 实例内存容量,单位:GB。
RestrictState 否 是 String 实例业务状态。取值范围:<br><li>NORMAL:表示正常状态的实例<br><li>EXPIRED:表示过期的实例<br><li>PROTECTIVELY_ISOLATED:表示被安全隔离的实例。
InstanceName 否 否 String 实例名称。
InstanceChargeType 否 否 String 实例计费模式。取值范围:<br><li>PREPAID:表示预付费,即包年包月<br><li>POSTPAID_BY_HOUR:表示后付费,即按量计费<br><li>CDHPAID:CDH付费,即只对CDH计费,不对CDH上的实例计费。
SystemDisk 否 否 SystemDisk 实例系统盘信息。
DataDisks 否 是 Array of DataDisk 实例数据盘信息。只包含随实例购买的数据盘。
PrivateIpAddresses 否 是 Array of String 实例主网卡的内网IP列表。
PublicIpAddresses 否 是 Array of String 实例主网卡的公网IP列表。
InternetAccessible 否 否 InternetAccessible 实例带宽信息。
VirtualPrivateCloud 否 否 VirtualPrivateCloud 实例所属虚拟私有网络信息。
ImageId 否 是 String 生产实例所使用的镜像ID。
RenewFlag 否 是 String 自动续费标识。取值范围:<br><li>NOTIFY_AND_MANUAL_RENEW:表示通知即将过期,但不自动续费<br><li>NOTIFY_AND_AUTO_RENEW:表示通知即将过期,而且自动续费<br><li>DISABLE_NOTIFY_AND_MANUAL_RENEW:表示不通知即将过期,也不自动续费。
CreatedTime 否 否 Datetime_iso 创建时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。
ExpiredTime 否 是 Datetime_iso 到期时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。
InstanceState 是 是 String 实例状态。取值范围:<br><li>PENDING:表示创建中<br></li><li>LAUNCH_FAILED:表示创建失败<br></li><li>RUNNING:表示运行中<br></li><li>STOPPED:表示关机<br></li><li>STARTING:表示开机中<br></li><li>STOPPING:表示关机中<br></li><li>REBOOTING:表示重启中<br></li><li>SHUTDOWN:表示停止待销毁<br></li><li>TERMINATING:表示销毁中。<br></li>
LatestOperation 是 是 String 实例的最新操作。例:StopInstances、ResetInstance。
LatestOperationState 是 是 String 实例的最新操作状态。取值范围:<br><li>SUCCESS:表示操作成功<br><li>OPERATING:表示操作执行中<br><li>FAILED:表示操作失败
LatestOperationRequestId 是 是 String 实例最新操作的唯一请求 ID。
SecurityGroupIds 是 是 Array of String 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。
LoginSettings 是 是 LoginSettings 实例登录设置。目前只返回实例所关联的密钥。
DisasterRecoverGroupId 是 是 String 分散置放群组ID。
Tags 是 是 Array of Tag 实例关联的标签列表。
Uuid 是 否 String 实例的uuid
OsName 是 是 String 实例的os名称
IPv6Addresses 是 是 Array of String 实例的ipv6地址
StopChargingMode 是 是 String 实例的关机计费模式。取值范围:<br><li>KEEP_CHARGING:关机继续收费<br><li>STOP_CHARGING:关机停止收费<li>NOT_APPLICABLE:实例处于非关机状态或者不适用关机停止计费的条件<br>
CamRoleName 是 是 String CAM角色名。
IsolatedSource 是 是 String IsolatedSource
PlatformProjectId 是 是 String 资源所属项目Id
RemainTime 是 是 String 持续时间
HpcClusterId 否 是 String 高性能计算集群ID。
DefaultLoginUser 否 是 String 默认登录用户
DefaultLoginPort 否 是 Uint64 默认登录端口
DedicatedClusterId 否 是 String 实例所在的专用集群ID。
OperatorUin 是 是 String 操作者Uin
RdmaIpAddresses 否 是 Array of String 高性能计算集群IP列表
DeviceId 否 是 Uint64 实例id
InstanceClass 否 是 String 实例类型
IsolatedTime 否 是 Datetime_iso 隔离时间
ErrorKey 否 是 String 错误的key
GPU 否 是 Int64 GPU
NewCreationIdentify 否 是 Bool 新创建识别
OperationMask 否 是 Uint64 操作掩码
ImageType 否 是 String 镜像类型
KeyPairIds 否 是 Array of Uint64 键值对id
RunFlag 否 否 Int64 运行标志
InnerVpcId 否 是 Uint64 内部vpc Id
InstanceFamily 否 是 String 实例的Family
Architecture 否 是 String 架构
ErrorCode 否 是 Int64 错误码
SafeIsolatedInfo 否 是 String 安全隔离信息
IsSafeIsolated 否 是 Bool 是否安全隔离
Hypervisor 否 是 Int64 虚拟化

ActionTimer

定时任务

被如下接口引用:DescribeInstancesActionTimer、DescribeLaunchTemplatesInfo、ImportInstancesActionTimer、ModifyInstancesActionTimer、SwitchParameterRunInstances、UpdateInstancesActionTimer

名称 必选 允许NULL 类型 描述
TimerAction 否 否 String 定时器
ActionTime 否 否 String 执行时间
Externals 是 否 Externals 扩展数据

InstancesRecentFailedOperationSet

实例最新失败操作

被如下接口引用:DescribeInstancesRecentFailedOperation

名称 必选 允许NULL 类型 描述
InstanceId 是 否 String 实例ID
EventType 是 否 String 操作事件类型
CreateTime 是 否 Datetime 操作事件发生时间

QueryInstance

查询接口Instance列表

被如下接口引用:

名称 必选 允许NULL 类型 描述
Placement 是 否 QueryPlacement Placement结构
Memory 是 否 Int64 内存大小
CPU 是 否 Int64 cpu核数
CreatedTime 是 否 Datetime 创建时间
InstanceId 是 否 String 实例ID
AppId 是 否 Int64 实例拥有者AppId
InstanceName 是 否 String 实例Id
Uuid 是 否 String 实例Uuid
PrivateIp 是 否 String 内网Ip
PublicIp 是 是 String 公网Ip
HostIp 是 否 String 所在宿主机ip
IPv6Addresses 是 否 Array of String Ipv6地址
InstanceStatus 是 否 String 当前状态
InstanceState 是 否 String 当前状态
Uin 是 否 String 所有者ownerUin
InstanceType 是 否 String 子机机型规格
InstanceFamily 是 否 String 子机机型类型
NodeQuota 是 否 Array of Int64 Quota使用情况
SystemDisk 是 否 QuerySystemDisk 系统盘详情
DataDisks 是 否 Array of QueryDataDisk 数据盘详情

InstanceRefundsSet

描述退款详情。

被如下接口引用:InquiryPriceTerminateInstances

名称 必选 允许NULL 类型 描述
InstanceId 是 是 String 实例Id。
Refunds 是 是 Float 退款数额。

Externals

扩展数据

被如下接口引用:DescribeInstanceConfigInfos、DescribeInstancesActionTimer、DescribeLaunchTemplatesInfo、DescribeZoneInstanceConfigInfos、ImportInstancesActionTimer、ModifyInstancesActionTimer、QueryInstancesActionTimer、SwitchParameterRunInstances、UpdateInstancesActionTimer

名称 必选 允许NULL 类型 描述
ReleaseAddress 否 是 Bool 释放地址<br>注意:此字段可能返回 null,表示取不到有效值。
UnsupportNetworks 否 是 Array of String 不支持的网络类型,取值范围:<br> <li>BASIC:基础网络<br> <li>VPC1.0:私有网络VPC1.0<br> 注意:此字段可能返回 null,表示取不到有效值。
StorageBlockAttr 否 是 StorageBlock HDD本地存储属性 <br>注意:此字段可能返回 null,表示取不到有效值。
InquiryWithEntireServer 否 是 String 查询整个服务器
RequireNetworkFeatures 否 是 Array of String 需要的网络功能<br>注意:此字段可能返回 null,表示取不到有效值。
RequiredEnhancedService 否 是 RequiredEnhancedService 需要增强的服务<br>注意:此字段可能返回 null,表示取不到有效值。
GpuAttr 否 是 GpuAttr GPU参数<br>注意:此字段可能返回 null,表示取不到有效值。

RequiredEnhancedService

需要增强服务

被如下接口引用:DescribeInstanceConfigInfos、DescribeInstancesActionTimer、DescribeLaunchTemplatesInfo、DescribeZoneInstanceConfigInfos、ImportInstancesActionTimer、ModifyInstancesActionTimer、QueryInstancesActionTimer、SwitchParameterRunInstances、UpdateInstancesActionTimer

名称 必选 允许NULL 类型 描述
MonitorService 否 是 MonitorServiceItem 监控服务

ZoneCpuQuota

可用区CPU配额信息

被如下接口引用:DescribeZoneCpuQuota

名称 必选 允许NULL 类型 描述
Zone 是 否 String 可用区。
InstanceChargeType 是 否 String 实例计费模式。PREPAID:表示预付费,即包年包月 | POSTPAID_BY_HOUR:表示后付费,即按量计费 | CDHPAID:表示CDH付费,即只对CDH计费,不对CDH上的实例计费。
cpuQuota 是 否 Uint64 可用CPU配额。

HostResource

cdh实例的资源信息

被如下接口引用:DescribeHosts

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

Price

价格

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

名称 必选 允许NULL 类型 描述
InstancePrice 否 否 ItemPrice 描述了实例价格。
BandwidthPrice 否 是 ItemPrice 描述了网络价格。

LoginSettings

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

被如下接口引用:CreateLaunchTemplate、DescribeInstances、DescribeLaunchTemplatesInfo、InquiryPriceResetInstance、InquiryPriceRunInstances、ModifyLaunchTemplate、ResetInstance、RunInstances、SwitchParameterResetInstance、SwitchParameterRunInstances

名称 必选 允许NULL 类型 描述
Password 否 是 String 实例登录密码。不同操作系统类型密码复杂度限制不一样,具体如下:<br><li>Linux机器密码需10到30位,至少包括三项([a-z],[A-Z],[0-9]和[()~!@#$%^&amp;*-+=_|{}[]:;&#39;&lt;&gt;,.?/]的特殊符号)。&lt;br&gt;&lt;li&gt;Windows机器密码需12到30位,至少包括三项([a-z],[A-Z],[0-9]和[()~!@#$%^&*-+=_|{}[]:;'<>,.?/]的特殊符号),密码不允许包含用户名密码不允许以/符号开头。<br><li>如果实例即包含Linux实例又包含Windows实例,则密码复杂度限制按照Windows实例的限制
KeyIds 否 是 Array of String 密钥ID列表。关联密钥后,就可以通过对应的私钥来访问实例;KeyId可通过接口DescribeKeyPairs获取,密钥与密码不能同时指定,同时Windows操作系统不支持指定密钥。当前仅支持购买的时候指定一个密钥。
KeepImageLogin 否 是 String 保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为TRUE。取值范围:<br><li>TRUE:表示保持镜像的登录设置<br><li>FALSE:表示不保持镜像的登录设置<br><br>默认取值:FALSE。

DisasterRecoverGroup

容灾组信息

被如下接口引用:DescribeDisasterRecoverGroups

名称 必选 允许NULL 类型 描述
DisasterRecoverGroupId 是 否 String 分散置放群组id。
Name 是 否 String 分散置放群组名称,长度1-60个字符。
Type 是 否 String 分散置放群组类型,取值范围:<br><li>HOST:物理机<br><li>SW:交换机<br><li>RACK:机架
CvmQuotaTotal 是 否 Int64 分散置放群组内最大容纳云服务器数量。
CurrentNum 是 否 Int64 分散置放群组内云服务器当前数量。
InstanceIds 是 是 Array of String 分散置放群组内,云服务器id列表。
CreateTime 是 是 Datetime_iso 分散置放群组创建时间。

InstanceTypeNameConfig

实例类型名称配置

被如下接口引用:DescribeInstanceTypeNameConfigs

名称 必选 允许NULL 类型 描述
ShowInMenu 是 否 Bool 是否显示到实例类型列表
InstanceFamilyName 是 否 String 实例类型中文名
InstanceFamily 是 否 String 实例类型

HostTypeConfigSet

获取专用宿主机的机型配置信息,以及售罄状态信息列表。

被如下接口引用:DescribeZoneHostConfigInfos

名称 必选 允许NULL 类型 描述
Zone 是 是 String 可用区
HostType 是 是 String 机型注意:此字段可能返回 null,表示取不到有效值。
HostChargeType 是 是 String cdh实例付费模式
HostFamily 是 是 String cdh类型
CPU 是 是 Uint64 实例的CPU核数,单位:核。
Memory 是 是 Uint64 实例内存容量,单位:GB。
DiskSize 是 是 Uint64 创建此快照的云硬盘大小,单位GB。
DiskType 是 是 String 系统盘类型
HostQuota 是 是 Uint64 cdh配额
Price 是 是 HostTypeConfigSetPrice 价格信息
CpuModeLName 是 是 String CPU型号名称。
Status 是 是 String 实例是否售卖。取值范围:SELL:表示实例可购买SOLD_OUT:表示实例已售罄。

InstanceFamilyItem

实例族信息。

被如下接口引用:

名称 必选 允许NULL 类型 描述
instanceFamily 是 否 String 实例族。
order 是 否 Int64 优先级。
instanceTypes 是 否 Array of InstanceTypeItem 实例类型信息列表。
TypeName 是 否 String 实例类型名称

InstanceChargePrepaid

描述了实例的计费模式

被如下接口引用:CreateLaunchTemplate、InquiryPriceModifyInstancesChargeType、InquiryPriceRenewInstances、InquiryPriceRunInstances、ModifyInstancesChargeType、ModifyLaunchTemplate、RunInstances、SwitchParameterModifyInstancesChargeType、SwitchParameterRenewInstances、SwitchParameterRunInstances

名称 必选 允许NULL 类型 描述
Period 是 否 Int64 购买实例的时长,单位:月。取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。
RenewFlag 否 否 String 自动续费标识。取值范围:<br><li>NOTIFY_AND_AUTO_RENEW:通知过期且自动续费<br><li>NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费<br><li>DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费<br><br>默认取值:NOTIFY_AND_AUTO_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。

InternetAccessible

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

被如下接口引用:CreateLaunchTemplate、DescribeInstanceInternetBandwidthConfigs、DescribeInstances、DescribeLaunchTemplatesInfo、InquiryPriceRenewInstances、InquiryPriceResetInstancesInternetMaxBandwidth、InquiryPriceRunInstances、ModifyLaunchTemplate、ResetInstancesInternetMaxBandwidth、RunInstances、SwitchParameterRenewInstances、SwitchParameterResetInstancesInternetMaxBandwidth、SwitchParameterRunInstances

名称 必选 允许NULL 类型 描述
InternetChargeType 否 是 String 网络计费类型。取值范围:<br><li>BANDWIDTH_PREPAID:预付费按带宽结算<br><li>TRAFFIC_POSTPAID_BY_HOUR:流量按小时后付费<br><li>BANDWIDTH_POSTPAID_BY_HOUR:带宽按小时后付费<br><li>BANDWIDTH_PACKAGE:带宽包用户<br>默认取值:TRAFFIC_POSTPAID_BY_HOUR。
InternetMaxBandwidthOut 否 否 Int64 公网出带宽上限,单位:Mbps。默认值:0Mbps。不同机型带宽上限范围不一致。
PublicIpAssigned 否 否 Bool 是否分配公网IP。取值范围:<br><li>TRUE:表示分配公网IP<br><li>FALSE:表示不分配公网IP<br><br>公网带宽大于0时必须设置为True,默认开通公网IP;当公网带宽为0,则不允许分配公网IP。
InternetServiceProvider 否 是 String 网络模式: 移动:"CMCC" 、联通:"CTCC" 、电信:"CUCC"、外网CAP: "BGP"。在三网模式下(移动、联通、电信),必须为带宽包计费模式。即:必须携带InternetChargeType参数, 且值必须为 BANDWIDTH_PACKAGE。 BGP模式下无此限制。该接口不支持多运营商模式,即参数InternetServiceProvider参数不能是Multi-operator。

ResourceInfo

用户实例资源详细信息

被如下接口引用:SearchUserInstance

名称 必选 允许NULL 类型 描述
ResourceId 是 否 String 用户资源实例id。
SearchWord 是 否 String 用户资源关键字。
RelationInstanceId 否 否 String 用户资源实例关联的cvm实例id。
Region 否 否 String 地域。
KeyType 否 否 String 该条数据搜索使用的类型,值为实例Id(instance), 实例名称(alias), 实例内网ip(lan),实例公网ip(wan)。

HostGoodsItem

cdh发货实例的详细信息

被如下接口引用:SwitchParameterAllocateHosts、SwitchParameterRenewHosts

名称 必选 允许NULL 类型 描述
goodsCategoryId 否 否 Uint64 goodsCategoryId
payMode 否 否 Uint64 实例付费模式
goodsNum 否 否 Uint64 发货的实例个数
regionId 否 否 Uint64 地域id
uin 否 否 String 发起发货的用户uin
ownerUin 否 否 String 发起发货帐号的所有者uin
appId 否 否 Uint64 发起发货帐号对应的appId
projectId 否 否 Uint64 项目id
zoneId 否 否 Uint64 可用区id
goodsDetail 否 否 HostGoodsDetailItem cdh实例详细信息

DetailPrices

详细价格信息

被如下接口引用:DescribeZoneInstanceConfigInfos、InquiryPriceAllocateHosts、InquiryPriceModifyInstancesChargeType、InquiryPriceRenewHosts、InquiryPriceRenewInstances、InquiryPriceResetInstance、InquiryPriceResetInstancesInternetMaxBandwidth、InquiryPriceResetInstancesType、InquiryPriceResizeInstanceDisks、InquiryPriceRunInstances

名称 必选 允许NULL 类型 描述
ImagePrice 否 是 ItemPrice 镜像价格
DataDisksPrice 否 是 Array of ItemPrice 数据盘价格
CpuMemPrice 否 是 ItemPrice cpu内存价格
SystemDiskPrice 否 是 ItemPrice 系统盘价格

QueryDataDisk

数据盘

被如下接口引用:

名称 必选 允许NULL 类型 描述
DiskSize 是 否 Int64 数据盘大小
DiskType 是 否 String 系统盘类型:LOCAL_BASIC、CLOUD_BASIC、LOCAL_SSD、CLOUD_SSD、CLOUD_PREMIUM、CLOUD_ENHANCEDSSD

EnhancedService

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

被如下接口引用:CreateLaunchTemplate、DescribeLaunchTemplatesInfo、InquiryPriceResetInstance、InquiryPriceRunInstances、ModifyLaunchTemplate、ResetInstance、RunInstances、SwitchParameterResetInstance、SwitchParameterRunInstances

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

HostGoodsDetailItem

cdh发货实例详细信息

被如下接口引用:SwitchParameterAllocateHosts、SwitchParameterRenewHosts

名称 必选 允许NULL 类型 描述
transactionId 否 否 String 请求事务id
action 否 否 String 操作名称
autoRenewFlag 否 否 Uint64 自动续费标记
pid 否 否 Uint64 pid
timeSpan 否 否 Uint64 购买或续费时长
timeUnit 否 否 String 时间单位
resourceId 否 否 String 资源id
curDeadline 否 否 Datetime 当前到期时间
signature 否 否 String 数字签名
productInfo 否 否 Array of ProductInfoItem 产品信息项列表

DisasterRecoverGroups

置放群组信息

被如下接口引用:QueryDisasterRecoverGroup

名称 必选 允许NULL 类型 描述
currentNum 是 是 Uint64 当前用户已经创建的置放群组数量。
uDisasterRecoverGroupId 是 是 String 置放群组id。
cvmQuotaTotal 是 是 Uint64 置放群组内最大容纳云服务器数量。
uuids 是 是 Array of String uuid
owner 是 是 String 帐号的所有者uin
disasterRecoverTag 是 是 String 标签
type 是 是 String 类型
createTime 是 是 String 创建时间
name 是 是 String 置放群组名称
partitionCount 是 是 Uint64 分区数
strategy 是 是 String 策略
affinity 是 是 Int64 亲和度,匹配度

GpuAttr

Gpu参数

被如下接口引用:DescribeInstanceConfigInfos、DescribeInstancesActionTimer、DescribeLaunchTemplatesInfo、DescribeZoneInstanceConfigInfos、ImportInstancesActionTimer、ModifyInstancesActionTimer、QueryInstancesActionTimer、SwitchParameterRunInstances、UpdateInstancesActionTimer

名称 必选 允许NULL 类型 描述
Type 否 是 String 类型 <br>注意:此字段可能返回 null,表示取不到有效值。

VirtualPrivateCloud

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

被如下接口引用:CreateLaunchTemplate、DescribeInstances、DescribeLaunchTemplatesInfo、InquiryPriceRunInstances、ModifyInstancesVpcAttribute、ModifyLaunchTemplate、RunInstances、SwitchParameterRunInstances、UpdateInstanceVpcConfig

名称 必选 允许NULL 类型 描述
VpcId 是 否 String 私有网络ID,形如vpc-xxx。有效的VpcId可通过登录控制台查询。
SubnetId 是 否 String 私有网络子网ID,形如subnet-xxx。有效的私有网络子网ID可通过登录控制台查询;也可以调用接口 [控制台](//console.cloud.sunhongs.com/vpc/a需更新描述,TCE 无此“DescribeSubnetEx”接口?rid=1) ,从接口返回中的unSubnetId字段获取。
AsVpcGateway 否 否 Bool 是否用作公网网关。公网网关只有在实例拥有公网IP以及处于私有网络下时才能正常使用。取值范围:<br><li>TRUE:表示用作公网网关<br><li>FALSE:表示不用作公网网关<br><br>默认取值:FALSE。
PrivateIpAddresses 否 否 Array of String 私有网络子网 IP 数组,在创建实例、修改实例vpc属性操作中可使用此参数。当前仅批量创建多台实例时支持传入相同子网的多个 IP。
Ipv6AddressCount 否 否 Int64 为弹性网卡指定随机生成的 IPv6 地址数量。
VpcName 否 否 String vpc名
SubnetName 否 否 String 子网名

AddressChargePrepaid

用于描述弹性公网IP的费用对象

被如下接口引用:AllocateAddresses、InquiryPriceAllocateAddresses、InquiryPriceRenewAddresses、RenewAddresses

名称 必选 允许NULL 类型 描述
Period 是 否 Int64 购买实例的时长
RenewFlag 否 否 String 自动续费标志

InstanceOperationLimitSet

该参数表示限制次数查询。

被如下接口引用:DescribeInstancesOperationLimit

名称 必选 允许NULL 类型 描述
Operation 是 否 String 实例操作。取值范围:INSTANCE_DEGRADE:降配操作
InstanceId 是 否 String 实例ID。
CurrentCount 是 否 Uint64 当前已使用次数,如果返回值为-1表示该操作无次数限制。
LimitCount 是 否 Uint64 操作次数最高额度,如果返回值为-1表示该操作无次数限制,如果返回值为0表示不支持调整配置。

LaunchTemplatesInfo

实例启动模板信息。<br/>被如下接口引用:DescribeLaunchTemplatesInfo。

被如下接口引用:DescribeLaunchTemplatesInfo

名称 必选 允许NULL 类型 描述
LaunchTemplateId 否 是 String 实例启动模板ID。 注意:此字段可能返回 null,表示取不到有效值。
LaunchTemplateName 否 是 String 实例启动模板名。 注意:此字段可能返回 null,表示取不到有效值。
LaunchTemplateVersionData 否 是 LaunchTemplateVersionData 实例启动模版本信息。 注意:此字段可能返回 null,表示取不到有效值。
LaunchTemplateVersionDescription 否 是 String 实例启动模板描述。 注意:此字段可能返回 null,表示取不到有效值。
CreatedBy 否 是 String 创建该模板的用户UIN。 注意:此字段可能返回 null,表示取不到有效值。
CreationTime 否 是 String 创建该模板的时间。 注意:此字段可能返回 null,表示取不到有效值。

Snapshot

描述镜像关联的快照信息

被如下接口引用:DescribeImages

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

DeniedActions

限制操作列表

被如下接口引用:DescribeInstancesDeniedActions

名称 必选 允许NULL 类型 描述
Action 是 否 String 操作名
Code 是 否 String 返回值
Message 是 否 String 返回信息

SystemDisk

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

被如下接口引用:CreateLaunchTemplate、DescribeInstances、DescribeLaunchTemplatesInfo、InquiryPriceResetInstance、InquiryPriceResizeInstanceDisks、InquiryPriceRunInstances、ModifyLaunchTemplate、ResetInstance、ResizeInstanceDisks、RunInstances、SwitchParameterResetInstance、SwitchParameterRunInstances

名称 必选 允许NULL 类型 描述
DiskType 否 否 String 系统盘类型。取值范围:<br><li>LOCAL_BASIC:本地硬盘<br><li>LOCAL_SSD:本地SSD硬盘<br><li>CLOUD_BASIC:普通云硬盘<br><li>CLOUD_SSD:SSD云硬盘<br><li>CLOUD_PREMIUM:高性能云盘<br><br>默认取值:LOCAL_BASIC。
DiskId 否 是 String 系统盘ID。LOCAL_BASIC 和 LOCAL_SSD 类型没有ID。暂时不支持该参数。
DiskSize 否 否 Int64 系统盘大小,单位:GB。默认值为 50
DiskStoragePoolGroup 否 是 String 系统盘指定的存储池。
AutoSnapshotPolicyId 否 是 String 云盘的自动备份策略id

SourceSystemInfo

源机器操作系统信息

被如下接口引用:ExitLiveMigrateInstance

名称 必选 允许NULL 类型 描述
OsName 是 否 String 源端机器系统名称
KernelVersion 是 否 String 源端机器系统内核版本
Architecture 是 否 String 源端机器系统架构

UserZoneStatusItem

可用区实例计费类型状态。

被如下接口引用:DescribeUserZoneStatus

名称 必选 允许NULL 类型 描述
Zone 是 否 String 可用区
InstanceChargeType 是 否 String 计费类型
Status 是 否 String 售卖状态

KeyQuota

描述用户可用区下配额

被如下接口引用:DescribeUserInstanceQuota

名称 必选 允许NULL 类型 描述
Zone 否 否 String 实例所属的可用区ID,按照可用区过滤。
InstanceChargeType 否 否 String 实例计费模式。支持类型:PREPAID、POSTPAID_BY_HOUR、SPOTPAID. 最大限制为10,value最大限制为5
QuotaCurrent 是 否 Uint64 当前数量
QuotaLimit 是 否 Uint64 配额数量

Placement

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

被如下接口引用:AllocateHosts、CreateLaunchTemplate、DescribeHosts、DescribeInstances、DescribeLaunchTemplatesInfo、InquiryPriceAllocateHosts、InquiryPriceRunInstances、ModifyLaunchTemplate、RunInstances、SwitchParameterAllocateHosts、SwitchParameterRunInstances

名称 必选 允许NULL 类型 描述
Zone 是 否 String 实例所属的可用区ID。该参数也可以通过调用 DescribeZones 的返回值中的Zone字段来获取。
ProjectId 否 否 Int64 实例所属项目ID。该参数可以通过调用 可用区 的返回值中的 projectId 字段来获取。不填为默认项目。
HostId 否 是 String 实例所属的专用宿主机ID列表。如果您有购买专用宿主机并且指定了该参数,则您购买的实例就会随机的部署在这些专用宿主机上。当前暂不支持。
ProjectName 否 否 String 实例所属项目

Tag

标签键值对

被如下接口引用:CreateLaunchTemplate、DescribeInstances、DescribeLaunchTemplatesInfo、ModifyLaunchTemplate、RunInstances

名称 必选 允许NULL 类型 描述
Key 是 否 String 标签键
Value 是 否 String 标签值

AccountAttributeSet

账户属性设置

被如下接口引用:DescribeAccountAttributes

名称 必选 允许NULL 类型 描述
AttributeClass 是 是 String 属性类型
AttributeValueSet 是 是 Array of AccountAttribute 属性值

AvailableZoneSet

可用区详情

被如下接口引用:DescribeUserAvailableZones

名称 必选 允许NULL 类型 描述
ZoneId 是 是 String 可用区id
Status 是 是 String 状态
InstanceType 是 是 Array of Int64 实例类型

DiagnosticReportSet

DiagnosticReportSet

被如下接口引用:CreateDiagnosticReports

名称 必选 允许NULL 类型 描述
InstanceId 否 否 String 实例id
DiagnosticReportId 否 否 String 检测报告id

InstanceStatisticsSet

实例数据数组

被如下接口引用:DescribeInstanceStatistics

名称 必选 允许NULL 类型 描述
Region 是 否 String 区域
TotalCount 是 否 Uint64 机器总量
NewInstanceCount 是 否 Uint64 红点主机总数(刚新建机器)
ExpiredInstanceCount 是 否 Uint64 过期主机总数

Filter

>描述键值对过滤器,用于条件过滤查询。例如过滤ID、名称、状态等 > * 若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。 > * 若同一个Filter存在多个Values,同一Filter下Values间的关系为逻辑或(OR)关系。 > > 以DescribeInstances接口的Filter为例。若我们需要查询可用区(zone)为广州一区 并且 实例计费模式(instance-charge-type)为包年包月 或者 按量计费的实例时,可如下实现:

Filters.1.Name=zone
&amp;Filters.1.Values.1=ap-guangzhou-1
&amp;Filters.2.Name=instance-charge-type
&amp;Filters.2.Values.1=PREPAID
&amp;Filters.3.Values.2=POSTPAID_BY_HOUR

被如下接口引用:DescribeAddresses、DescribeDiagnosticReports、DescribeHosts、DescribeImages、DescribeInstanceConfigInfos、DescribeInstanceOperationLogs、DescribeInstanceStatistics、DescribeInstanceTypeConfigs、DescribeInstanceTypeQuota、DescribeInstances、DescribeInstancesModification、DescribeKeyPairs、DescribeLaunchTemplatesInfo、DescribeMarketImages、DescribeUserAvailableZones、DescribeUserInstanceQuota、DescribeUserMigrateTasks、DescribeUserZoneStatus、DescribeZoneCdhInstanceConfigInfos、DescribeZoneCpuQuota、DescribeZoneHostConfigInfos、DescribeZoneHostForSellStatus、DescribeZoneInstanceConfigInfos

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

Quota

描述了配额信息

被如下接口引用:DescribeAddressQuota

名称 必选 允许NULL 类型 描述
QuotaId 否 否 String 配额名称,取值范围:<br><li>TOTAL_EIP_QUOTA:用户当前地域下EIP的配额数;<br><li>DAILY_EIP_APPLY:用户当前地域下今日申购次数;<br><li>DAILY_PUBLIC_IP_ASSIGN:用户当前地域下,重新分配公网 IP次数。
QuotaCurrent 否 否 Int64 当前数量
QuotaLimit 否 否 Int64 配额数量

InstanceTypeQuotaItem

描述实例机型配额信息。

被如下接口引用:

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

Image

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

被如下接口引用:DescribeImages

名称 必选 允许NULL 类型 描述
ImageId 否 否 String 镜像ID
OsName 否 否 String 镜像操作系统
ImageType 否 否 String 镜像类型
CreatedTime 是 是 Datetime_iso 镜像创建时间
ImageName 是 否 String 镜像名称
ImageDescription 是 否 String 镜像描述
ImageSize 是 否 Int64 镜像大小
Architecture 是 否 String 镜像架构
ImageState 是 否 String 镜像状态
Platform 否 否 String 镜像来源平台
ImageCreator 否 是 String 镜像创建者
ImageSource 否 否 String 镜像来源
SyncPercent 是 是 Int64 同步百分比
IsSupportCloudinit 是 是 Bool 镜像是否支持cloud-init
SnapshotSet 否 是 Array of Snapshot 镜像关联的快照信息
IsSupportAutoInstallGPUDriver 是 是 Bool 镜像是否支持自动安装GPU驱动
OsKey 是 否 String 镜像名称
ProductCode 否 是 String 产品码
GPUDriverList 是 否 Array of String GPU驱动列表
ImageFormat 是 否 String 镜像格式
OperationMask 是 否 Int64 镜像操作掩码
Flags 是 否 Array of String 镜像标记
DeviceImageId 是 是 Int64 自定义镜像id
IsSupportTat 否 否 Bool TAT支持镜像情况

PriceForHostTypeQuota

专用宿主机的价格。

被如下接口引用:

名称 必选 允许NULL 类型 描述
OriginalPrice 是 否 Float 不打折价格。

QueryPlacement

查询的地址

被如下接口引用:

名称 必选 允许NULL 类型 描述
Zone 是 否 Int64 可用区名称
VpcId 是 否 Int64 VpcId
SubnetId 是 否 Int64 子网Id
SubnetName 是 否 String 子网名称
VpcName 是 否 String Vpc名称

SharePermissionSet

镜像分享信息结构

被如下接口引用:

名称 必选 允许NULL 类型 描述
CreateTime 是 否 Datetime_iso 镜像分享时间
Account 是 否 String 镜像分享的账户ID

DataDisks

数据盘镜像描述,包括镜像cos url,数据盘大小,数据盘设备名(DiskId);

被如下接口引用:ImportFullCvmImage

名称 必选 允许NULL 类型 描述
ImageUrl 是 否 String 数据盘镜像cos url
Size 是 否 Uint64 数据盘大小
Device 是 否 String 数据盘对应设备名,目前是DiskId

InternetBandwidthConfig

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

被如下接口引用:DescribeInstanceInternetBandwidthConfigs

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

ImageAttributeSet

unImgId到deviceImageId的映射的数组

被如下接口引用:DescribeImagesAttribute

名称 必选 允许NULL 类型 描述
ImageId 是 否 String 镜像id
InnerImageId 是 否 Uint64 内部镜像id

InstanceTypeQuotaItemArchitecture

带有CPU架构的实例机型配额信息。

被如下接口引用:DescribeZoneInstanceConfigInfos

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

LaunchTemplateVersionInfo

实例启动模板版本集合<br/> 被如下接口引用:DescribeLaunchTemplateVersions。

被如下接口引用:

名称 必选 允许NULL 类型 描述
LaunchTemplateVersion 否 是 Int64 实例启动模板版本号。<br/> 注意:此字段可能返回 null,表示取不到有效值。
LaunchTemplateVersionData 否 是 LaunchTemplateVersionData 实例启动模板版本数据详情。
CreationTime 否 是 Datetime 实例启动模板版本创建时间。
LaunchTemplateId 否 是 String 实例启动模板ID。
IsDefaultVersion 否 是 Bool 是否为默认启动模板版本。
LaunchTemplateVersionDescription 否 是 String 实例启动模板版本描述信息。<br/> 注意:此字段可能返回 null,表示取不到有效值。
CreatedBy 否 是 String 创建者。

DataDisk

描述了数据盘的信息

被如下接口引用:CreateLaunchTemplate、DescribeInstances、DescribeLaunchTemplatesInfo、InquiryPriceRunInstances、ModifyLaunchTemplate、RunInstances、SwitchParameterResizeInstanceDisks、SwitchParameterRunInstances

名称 必选 允许NULL 类型 描述
DiskType 否 否 String 数据盘类型。取值范围:<br><li>LOCAL_BASIC:本地硬盘<br><li>LOCAL_SSD:本地SSD硬盘<br><li>CLOUD_BASIC:普通云硬盘<br><li>CLOUD_PREMIUM:高性能云硬盘<br><li>CLOUD_SSD:SSD云硬盘<br><li>CLOUD_HSSD:增强型SSD云硬盘<br><br>默认取值:LOCAL_BASIC。<br><br>该参数对ResizeInstanceDisk接口无效。
DiskId 否 否 String 系统盘ID。LOCAL_BASIC 和 LOCAL_SSD 类型没有ID。暂时不支持该参数。
DiskSize 是 否 Int64 数据盘大小,单位:GB。最小调整步长为10G,不同数据盘类型取值范围不同。默认值为0,表示不购买数据盘。更多限制详见产品文档。
DeleteWithInstance 否 是 Bool 数据盘是否随子机销毁。取值范围:<li>TRUE:子机销毁时,销毁数据盘,只支持按小时后付费云盘<li>FALSE:子机销毁时,保留数据盘<br>默认取值:TRUE<br>该参数目前仅用于 RunInstances 接口。
DiskStoragePoolGroup 否 是 String 数据盘指定的存储池。
AutoSnapshotPolicyId 否 是 String 云盘的自动备份策略
SnapshotId 否 是 String 云盘的快照id

InstanceFamilyItemArchitecture

带CPU架构的实例族信息。

被如下接口引用:DescribeInstanceConfigInfos

名称 必选 允许NULL 类型 描述
instanceFamily 是 否 String 实例族。
order 是 否 Int64 优先级。
instanceTypes 是 否 Array of InstanceTypeItem 实例类型信息列表。
TypeName 是 否 String 实例类型名称
Architecture 是 否 String CPU架构信息

InstanceStatus

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

被如下接口引用:DescribeInstancesStatus

名称 必选 允许NULL 类型 描述
InstanceId 否 否 String 实例ID。
InstanceState 否 否 String 实例状态。

InstanceChargeTypeConfig

计费类型配置信息

被如下接口引用:DescribeInstanceChargeTypeConfigs

名称 必选 允许NULL 类型 描述
InstanceChargeType 是 否 String 实例计费类型
Description 是 否 String 实例计费类型描述

InternetAccessibleModifyChargeType

描述了网络计费

被如下接口引用:InquiryPriceModifyInstanceInternetChargeType、ModifyInstanceInternetChargeType、SwitchParameterModifyInstanceInternetChargeType

名称 必选 允许NULL 类型 描述
InternetChargeType 是 否 String 网络付费模式
InternetMaxBandwidthOut 是 否 Int64 外网出带宽值

LaunchTemplateVersionData

实例启动模板版本信息<br/>被如下接口引用:DescribeLaunchTemplateVersions。

被如下接口引用:DescribeLaunchTemplatesInfo

名称 必选 允许NULL 类型 描述
Placement 否 是 Placement 实例所在的位置。 注意:此字段可能返回 null,表示取不到有效值。
InstanceType 否 是 String 实例机型。 注意:此字段可能返回 null,表示取不到有效值。
InstanceName 否 是 String 实例名称。 注意:此字段可能返回 null,表示取不到有效值。
InstanceChargeType 否 是 String 实例付费类型。取值范围:<br><li>PREPAID:表示预付费,即包年包月<br><li>POSTPAID_BY_HOUR:表示后付费,即按量计费<br><li>CDHPAID:专用宿主机付费,即只对专用宿主机计费,不对专用宿主机上的实例计费。<br><li>SPOTPAID:表示竞价实例付费。<br>注意:此字段可能返回 null,表示取不到有效值。
SystemDisk 否 是 SystemDisk 实例系统盘信息。 注意:此字段可能返回 null,表示取不到有效值。
DataDisks 否 是 Array of DataDisk 实例数据盘信息。只包含随实例购买的数据盘。 注意:此字段可能返回 null,表示取不到有效值。
InternetAccessible 否 是 InternetAccessible 实例带宽信息。<br/>注意:此字段可能返回 null,表示取不到有效值。
VirtualPrivateCloud 否 是 VirtualPrivateCloud 实例所属虚拟私有网络信息。<br/>注意:此字段可能返回 null,表示取不到有效值。
ImageId 否 是 String 生产实例所使用的镜像ID。<br/>注意:此字段可能返回 null,表示取不到有效值。
SecurityGroupIds 否 是 Array of String 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。 <br/>注意:此字段可能返回 null,表示取不到有效值。
LoginSettings 否 是 LoginSettings 实例登录设置。目前只返回实例所关联的密钥。<br/> 注意:此字段可能返回 null,表示取不到有效值。
CamRoleName 否 是 String CAM角色名。<br/> 注意:此字段可能返回 null,表示取不到有效值。
HpcClusterId 否 是 String 高性能计算集群ID。<br/> 注意:此字段可能返回 null,表示取不到有效值。
InstanceCount 否 是 Int64 购买实例数量。<br/> 注意:此字段可能返回 null,表示取不到有效值。
EnhancedService 否 是 EnhancedService 增强服务。<br/> 注意:此字段可能返回 null,表示取不到有效值。
UserData 否 是 String 提供给实例使用的用户数据,需要以 base64 方式编码,支持的最大数据大小为 16KB。<br/> 注意:此字段可能返回 null,表示取不到有效值。
DisasterRecoverGroupIds 否 是 Array of String 置放群组id,仅支持指定一个。<br/> 注意:此字段可能返回 null,表示取不到有效值。
ActionTimer 否 是 ActionTimer 定时任务。通过该参数可以为实例指定定时任务,目前仅支持定时销毁。<br/> 注意:此字段可能返回 null,表示取不到有效值。
HostName 否 是 String 云服务器的主机名。<br/> 注意:此字段可能返回 null,表示取不到有效值。
ClientToken 否 是 String 用于保证请求幂等性的字符串。<br/> 注意:此字段可能返回 null,表示取不到有效值。
TagSpecification 否 是 Array of TagSpecification 标签描述列表。通过指定该参数可以同时绑定标签到相应的云服务器、云硬盘实例。<br/> 注意:此字段可能返回 null,表示取不到有效值。

ZoneInfo

可用区信息

被如下接口引用:DescribeZones

名称 必选 允许NULL 类型 描述
Zone 是 否 String 可用区名称,例如,ap-guangzhou-3
ZoneName 是 否 String 可用区描述,例如,广州三区
ZoneId 是 否 String 可用区ID
ZoneState 是 否 String 可用区状态

InstanceCreateImageAttributeSet

实例创建镜像列表

被如下接口引用:DescribeInstancesCreateImageAttributes

名称 必选 允许NULL 类型 描述
InstanceId 是 否 String 云主机id
SupportInstanceImage 是 是 Bool 是否支持实例镜像
SupportOnlineCreateImage 是 是 Bool 是否支持在线创建镜像
SupportCloudinit 是 是 Bool 是否支持云初始化
NeedPowerOff 是 是 Bool 是否需要关机

InstanceTypeItem

实例类型信息。

被如下接口引用:DescribeInstanceConfigInfos

名称 必选 允许NULL 类型 描述
InstanceType 是 否 String 实例类型。
Cpu 是 否 Uint64 CPU核数。
Memory 是 否 Uint64 内存大小。
Gpu 是 否 Uint64 GPU核数。
Fpga 是 否 Uint64 FPGA核数。
StorageBlock 是 否 Uint64 存储块数。
NetworkCard 是 否 Uint64 网卡数。
MaxBandwidth 是 否 Float 最大带宽。
Frequency 是 否 String 主频。
CpuModelName 是 否 String CPU型号名称。
Pps 是 否 Uint64 包转发率。
Externals 是 否 Externals 外部信息。
Remark 是 否 String 备注信息。

ImageSharedAccount

描述了指定的账号能够使用该共享镜像

被如下接口引用:

名称 必选 允许NULL 类型 描述
ImageId 否 否 String 镜像ID
AccountId 否 否 String 账户ID

InstanceConfigInfoItem

实例静态配置信息。

被如下接口引用:

名称 必选 允许NULL 类型 描述
type 是 否 String 实例规格。
typeName 是 否 String 实例规格名称。
order 是 否 Int64 优先级。
instanceFamilies 是 否 Array of InstanceFamilyItem 实例族信息列表。

CreateKeyPair

描述创建密钥对信息

被如下接口引用:CreateKeyPair

名称 必选 允许NULL 类型 描述
KeyId 是 是 String 密钥对的ID,是密钥对的唯一标识。
KeyName 是 是 String 密钥对名称。
ProjectId 是 是 Uint64 密钥对所属的项目ID。
PublicKey 是 是 String 密钥对的纯文本公钥。
PrivateKey 是 是 String 密钥对的纯文本私钥。

RunMonitorServiceEnabled

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

被如下接口引用:CreateLaunchTemplate、DescribeLaunchTemplatesInfo、InquiryPriceResetInstance、InquiryPriceRunInstances、ModifyLaunchTemplate、ResetInstance、RunInstances、SwitchParameterResetInstance、SwitchParameterRunInstances

名称 必选 允许NULL 类型 描述
Enabled 否 否 Bool 是否开启云监控服务。取值范围:<br><li>TRUE:表示开启云监控服务<br><li>FALSE:表示不开启云监控服务<br><br>默认取值:TRUE。