租户端计算云服务器（CVM）数据结构

数据结构

最近更新时间: 2024-12-21 13:01:32

SharePermission

镜像分享信息结构

被如下接口引用：DescribeImageSharePermission

名称	必选	允许NULL	类型	描述
CreatedTime	是	否	Datetime_iso	镜像分享时间示例值： 2014-08-03T12:00:00+08:00
AccountId	是	否	String	镜像分享的账户ID 示例值： 32344323

ImportImageOsVersion

导入镜像OS版本描述

被如下接口引用：

名称	必选	允许NULL	类型	描述
Architecture	是	否	Array of String	CPU架构示例值： x86_64
OsName	是	否	String	OS名称示例值： Centos
OsVersions	是	否	Array of String	OS版本号示例值： ["7.9"]

InstanceChargeTypeConfig

计费类型配置信息

被如下接口引用：DescribeInstanceChargeTypeConfigs

名称	必选	允许NULL	类型	描述
InstanceChargeType	是	否	String	实例计费类型示例值： PREPAID
Description	是	否	String	实例计费类型描述示例值： jack use

InstanceStatus

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

被如下接口引用：DescribeInstancesStatus

名称	必选	允许NULL	类型	描述
InstanceId	否	否	String	实例`ID`。示例值： ins-61dyt49h
InstanceState	否	否	String	实例状态。示例值： RUNNING

SourceSystemInfo

源机器操作系统信息

被如下接口引用：ExitLiveMigrateInstance

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

AutomationServiceEnabled

描述了 “tat-agent” 相关的信息

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

名称	必选	允许NULL	类型	描述
Enabled	否	否	Bool	是否安装[tat-agent]。取值范围： TRUE：表示安装 FALSE：表示不安装默认取值：TRUE。示例值： true

DetailPrices

详细价格信息

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

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

DisasterRecoverGroups

置放群组信息

被如下接口引用：QueryDisasterRecoverGroup

名称	必选	允许NULL	类型	描述
currentNum	是	是	Uint64	当前用户已经创建的置放群组数量。示例值： 12
uDisasterRecoverGroupId	是	是	String	置放群组id。示例值： ps-l86ok62z
cvmQuotaTotal	是	是	Uint64	置放群组内最大容纳云服务器数量。示例值： 100
uuids	是	是	Array of String	uuid 示例值： ["5b33b986-084c-48e1-8cdb-d2e5ca5d045a"]
owner	是	是	String	帐号的所有者uin 示例值： 125550001
disasterRecoverTag	是	是	String	标签示例值： TAG_HARD_SW_ps-bpsqiuy1
type	是	是	String	类型示例值： HOST
createTime	是	是	String	创建时间示例值： 2018-05-16 10:40:58
name	是	是	String	置放群组名称示例值： alice-1
partitionCount	是	是	Uint64	分区数示例值： 4
strategy	是	是	String	策略示例值： SPREAD
affinity	是	是	Int64	亲和度，匹配度示例值： 1

InstanceOrder

实例订单详情信息。

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

名称	必选	允许NULL	类型	描述

ImageSharedAccount

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

被如下接口引用：

名称	必选	允许NULL	类型	描述
ImageId	否	否	String	镜像ID 示例值： InnerImageId
AccountId	否	否	String	账户ID 示例值： 32432423

KvType

键值类型

被如下接口引用：DescribeUserGlobalConfigs、ModifyUserGlobalConfigs

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

VirtualPrivateCloud

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

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

名称	必选	允许NULL	类型	描述
VpcId	是	否	String	私有网络ID，形如`vpc-xxx`。有效的VpcId可通过登录控制台查询。示例值： vpc-2ij
SubnetId	是	否	String	私有网络子网ID，形如`subnet-xxx`。有效的私有网络子网ID可通过登录控制台查询；也可以调用接口控制台，从接口返回中的`unSubnetId`字段获取。示例值： subnet-2ks
AsVpcGateway	否	否	Bool	是否用作公网网关。公网网关只有在实例拥有公网IP以及处于私有网络下时才能正常使用。取值范围： TRUE：表示用作公网网关 FALSE：表示不用作公网网关默认取值：FALSE。示例值： false
PrivateIpAddresses	否	否	Array of String	私有网络子网 IP 数组，在创建实例、修改实例vpc属性操作中可使用此参数。当前仅批量创建多台实例时支持传入相同子网的多个 IP。示例值： ["10.0.0.1"]
Ipv6AddressCount	否	否	Int64	为弹性网卡指定随机生成的 IPv6 地址数量。示例值： 1
VpcName	否	否	String	vpc名示例值： alice-vpc
SubnetName	否	否	String	子网名示例值： alice subnet

InstanceConfigInfoItem

实例静态配置信息。

被如下接口引用：

名称	必选	允许NULL	类型	描述
type	是	否	String	实例规格。示例值： S2.SMALL1
typeName	是	否	String	实例规格名称。示例值：标准型S2
order	是	否	Int64	优先级。示例值： 1
instanceFamilies	是	否	Array of InstanceFamilyItem	实例族信息列表。示例值：查看

InstanceFamilyItem

实例族信息。

被如下接口引用：

名称	必选	允许NULL	类型	描述
instanceFamily	是	否	String	实例族。示例值： S1
order	是	否	Int64	优先级。示例值： 1
instanceTypes	是	否	Array of InstanceTypeItem	实例类型信息列表。示例值：查看
TypeName	是	否	String	实例类型名称示例值：标准型S2

CreateKeyPair

描述创建密钥对信息

被如下接口引用：CreateKeyPair

名称	必选	允许NULL	类型	描述
KeyId	是	是	String	密钥对的`ID`，是密钥对的唯一标识。示例值： skey-11112222
KeyName	是	是	String	密钥对名称。示例值： alice-key
ProjectId	是	是	Uint64	密钥对所属的项目ID。示例值： 2
PublicKey	是	是	String	密钥对的纯文本公钥。示例值： ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDP0Yw2T4itUKxyz
PrivateKey	是	是	String	密钥对的纯文本私钥。示例值： ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDP0Yw2T4itUKxyz

HostGoodsDetailItem

cdh发货实例详细信息

被如下接口引用：SwitchParameterAllocateHosts、SwitchParameterRenewHosts

名称	必选	允许NULL	类型	描述
transactionId	否	否	String	请求事务id 示例值： f5a23f7d-2262-4933-b544-b0fa1dccc2e4
action	否	否	String	操作名称示例值： ModifyInstanceInternetChargeType
autoRenewFlag	否	否	Uint64	自动续费标记示例值： 1
pid	否	否	Uint64	pid 示例值： 2
timeSpan	否	否	Uint64	购买或续费时长示例值： 60
timeUnit	否	否	String	时间单位示例值： m
resourceId	否	否	String	资源id 示例值： ins-3botj2dn
curDeadline	否	否	Datetime	当前到期时间示例值： 2018-04-27 14:35:57
signature	否	否	String	数字签名示例值： 13af5ff01c878914ec60fca51b097cbc
productInfo	否	否	Array of ProductInfoItem	产品信息项列表示例值：查看

InstanceTypeNameConfig

实例类型名称配置

被如下接口引用：DescribeInstanceTypeNameConfigs

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

InstanceReturnable

实例可退还信息。

被如下接口引用：DescribeInstancesReturnable

名称	必选	允许NULL	类型	描述
InstanceId	是	否	String	实例`ID`。示例值： ins-61dyt49h
IsReturnable	是	否	Bool	实例是否可退还。示例值： true
ReturnFailCode	是	否	Int64	实例退还失败错误码。示例值： 0
ReturnFailMessage	是	否	String	实例退还失败错误信息。示例值： success

HostOrder

cdh实例相关的订单信息

被如下接口引用：SwitchParameterAllocateHosts、SwitchParameterRenewHosts

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

RunSecurityServiceEnabled

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

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

AddressChargePrepaid

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

被如下接口引用：RenewAddresses

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

ImportImageOsListSupported

导入镜像支持os列表

被如下接口引用：

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

ReportDetailSet

被如下接口引用：DescribeDiagnosticReports

名称	必选	允许NULL	类型	描述
Category	否	否	String	检测类型示例值： Expense
CategoryName	否	否	String	检测类型名示例值：账户费用检测
Code	否	否	String	检测编码示例值： Instance.Deadline
CodeName	否	否	String	编码名称示例值： utf-8
IsAuthorized	否	否	Bool	已授权示例值： false
Message	否	否	String	信息示例值： success
Severity	否	否	String	检测状态示例值： Normal
Status	否	否	String	状态示例值： Finished

AvailabilityZone

描述可用区信息。

被如下接口引用：

名称	必选	允许NULL	类型	描述
RegionId	否	否	String	地域ID。示例值： 1
Zone	否	否	String	可用区ID。示例值： 800001
ZoneName	否	否	String	可用区名称。示例值： BeiJing
ZoneState	否	否	String	可用区状态。示例值： UNAVAILABLE

Filter

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

若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。

若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。

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

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

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

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

TagSpecification

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

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

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

InstanceConnectivity

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

被如下接口引用：CheckInstancesConnectivity

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

InstanceDeniedActions

实例操作限制列表

被如下接口引用：DescribeInstancesDeniedActions

名称	必选	允许NULL	类型	描述
InstanceId	否	否	String	实例ID 示例值： ins-61dyt49h
DeniedActions	否	否	Array of DeniedActions	操作限制列表示例值：查看

ImageAttributeSet

unImgId到deviceImageId的映射的数组

被如下接口引用：DescribeImagesAttribute

名称	必选	允许NULL	类型	描述
ImageId	是	否	String	镜像id 示例值： img-c1otssej
InnerImageId	是	否	Uint64	内部镜像id 示例值： 53242

KeyPairInstancesinternetaccessible

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

被如下接口引用：

名称	必选	允许NULL	类型	描述
KeyId	否	否	String	密钥对的`ID`，是密钥对的唯一标识。示例值： skey-mk5eqeu6
AssociatedInstanceIdSet	否	否	Array of String	密钥对关联的实例`ID`列表。示例值： ["ins-61dyt49hx"]

LoginSettings

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

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

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

ProductInfoItem

产品描述信息项

被如下接口引用：SwitchParameterAllocateHosts、SwitchParameterRenewHosts

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

HostTypeQuotaSet

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

被如下接口引用：

名称	必选	允许NULL	类型	描述
CPU	是	否	Uint64	CPU核数，单位：核。示例值： 2
CpuModelName	是	否	String	CPU型号。示例值： Intel(R) Xeon(R) CPU E5-2670 v3 @ 2.30GHz
DiskSize	是	否	Uint64	磁盘大小，单位：GB。示例值： 50
DiskType	是	否	String	磁盘类型。示例值：本地硬盘
HostFamily	是	否	String	专用宿主机机型系列。示例值： Balance
HostType	是	否	String	专用宿主机类型。示例值： HS1
Memory	是	否	Uint64	内存大小，单位：GB。示例值： 2048
Price	是	否	Price	售价。示例值：查看
Status	是	否	String	售卖状态，“ SOLD_OUT”：售罄，“SELL”：售卖中示例值： SOLD_OUT
Zone	是	否	String	可用区。示例值： chongqing

RunMonitorServiceEnabled

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

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

SharePermissionSet

镜像分享信息结构

被如下接口引用：

名称	必选	允许NULL	类型	描述
CreateTime	是	否	Datetime_iso	镜像分享时间示例值： 2014-08-03T12:00:00+08:00
Account	是	否	String	镜像分享的账户ID 示例值： 32344323

AvailableZoneSet

可用区详情

被如下接口引用：DescribeUserAvailableZones

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

InstanceConfigInfoItemArchitecture

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

被如下接口引用：DescribeInstanceConfigInfos

名称	必选	允许NULL	类型	描述
type	是	否	String	实例规格。示例值： S2.SMALL1
typeName	是	否	String	实例规格名称。示例值：标准型S2
order	是	否	Int64	优先级。示例值： 1
instanceFamilies	是	否	Array of InstanceFamilyItemArchitecture	实例族信息列表。示例值：查看

InstanceRefundsSet

描述退款详情。

被如下接口引用：InquiryPriceTerminateInstances

名称	必选	允许NULL	类型	描述
InstanceId	是	是	String	实例Id。示例值： ins-61dyt49h
Refunds	是	是	Float	退款数额。示例值： 1.0

ActionTimers

ActionTimers返回值

被如下接口引用：QueryInstancesActionTimer

名称	必选	允许NULL	类型	描述
ActionTimerId	是	否	String	ActionTimerId 示例值： 4904ffac-02e4-4161-9636-cca0a687e841
AppId	是	否	Uint64	AppId 示例值： 125550001
InstanceId	是	否	String	InstanceId 示例值： ins-61dyt49h
TimerAction	是	否	String	TimerAction 示例值： TerminateInstances
ActionTime	是	否	String	ActionTime 示例值： 2018-08-01 20:00:00
Status	是	否	String	Status 示例值： SUCCESS
Externals	是	否	Externals	Externals 示例值：查看

HostTypeConfigSetPrice

价格信息

被如下接口引用：DescribeZoneHostConfigInfos

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

DataDisk

描述了数据盘的信息

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

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

QueryInstance

查询接口Instance列表

被如下接口引用：

名称	必选	允许NULL	类型	描述
Placement	是	否	QueryPlacement	Placement结构示例值：查看
Memory	是	否	Int64	内存大小示例值： 1024
CPU	是	否	Int64	cpu核数示例值： 1
CreatedTime	是	否	Datetime	创建时间示例值： 2014-08-03 12:00:00
InstanceId	是	否	String	实例ID 示例值： ins-61dyt49h
AppId	是	否	Int64	实例拥有者AppId 示例值： 125550001
InstanceName	是	否	String	实例Id 示例值： alice_1
Uuid	是	否	String	实例Uuid 示例值： 0ee11ed4-1ed2-4a4a-ad03-a17c5ecb59ca
PrivateIp	是	否	String	内网Ip 示例值： 10.21.1.11
PublicIp	是	是	String	公网Ip 示例值： 133.21.1.11
HostIp	是	否	String	所在宿主机ip 示例值： 133.21.1.11
IPv6Addresses	是	否	Array of String	Ipv6地址示例值： 3402:4e00:20:1202:0:8d01:ee9c:3e22
InstanceStatus	是	否	String	当前状态示例值： RUNNING
InstanceState	是	否	String	当前状态示例值： RUNNING
Uin	是	否	String	所有者ownerUin 示例值： 4323232
InstanceType	是	否	String	子机机型规格示例值： S3.SMALL1
InstanceFamily	是	否	String	子机机型类型示例值： S3
NodeQuota	是	否	Array of Int64	Quota使用情况示例值： 40
SystemDisk	是	否	QuerySystemDisk	系统盘详情示例值：查看
DataDisks	是	否	Array of QueryDataDisk	数据盘详情示例值：查看

InstanceTypeQuotaItemArchitecture

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

被如下接口引用：DescribeZoneInstanceConfigInfos

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

QuerySystemDisk

查询的系统盘

被如下接口引用：

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

CbsMigrateTask

离线数据迁移任务详情

被如下接口引用：DescribeUserMigrateTasks

名称	必选	允许NULL	类型	描述
JobId	是	否	String	任务id 示例值： migrate-2d43254d
JobName	是	否	String	任务名称示例值： onejob
AppId	是	否	Uint64	云平台应用ID，一般来说与Uin存在一一对应的关系。示例值： 125550001
Uin	是	否	String	用户uin 示例值： 1243244232
SnapshotUrl	是	否	String	快照url 示例值： http://kiki-1255000041.cos.chongqing.csp.yfm4.fsphere.cn/Windows%20Server%202008%20R2%20x64a.vmdk
DiskId	是	否	Uint64	磁盘id 示例值： 2
Region	是	否	String	地域示例值： chongqing
DiskSize	是	否	Uint64	数据大小示例值： 512
Status	是	否	String	任务状态示例值： SUCCESS
Progress	是	否	Uint64	迁移任务的进度示例值： 5
CreateTime	是	否	String	创建时间示例值： 2019-12-04T16:44:55+08:00
EndTime	是	否	String	结束时间示例值： 2019-12-04T16:44:55+08:00

DeniedActions

限制操作列表

被如下接口引用：DescribeInstancesDeniedActions

名称	必选	允许NULL	类型	描述
Action	是	否	String	操作名示例值： AllocateHosts
Code	是	否	String	返回值示例值： AddressQuotaLimitExceeded_DailyAllocate
Message	是	否	String	返回信息示例值：申购次数不足，每个账户每个地域每天申购次数为配额数*2 次

KeyPairAttributeSet

密钥对

被如下接口引用：DescribeKeyPairsAttribute

名称	必选	允许NULL	类型	描述
KeyId	是	否	String	密钥ID 示例值： skey-mv9yzyjj
InnerKeyId	是	否	String	内部密钥ID 示例值： 83723

InstanceChargePrepaid

描述了实例的计费模式

被如下接口引用：CloneInstance、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。示例值： 1
RenewFlag	否	否	String	自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费默认取值：NOTIFY_AND_AUTO_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。示例值： NOTIFY_AND_MANUAL_RENEW

InstanceTypeQuotaItem

描述实例机型配额信息。

被如下接口引用：

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

DataDisks

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

被如下接口引用：ImportFullCvmImage

名称	必选	允许NULL	类型	描述
ImageUrl	是	否	String	数据盘镜像cos url 示例值： http://kiki-1255000041.cos.chongqing.csp.yfm4.fsphere.cn/xxx
Size	是	否	Uint64	数据盘大小示例值： 22
Device	是	否	String	数据盘对应设备名，目前是DiskId 示例值： disk-61dyt49h

Placement

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

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

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

ProjectSpecification

平台项目ID

被如下接口引用：CloneInstance、RunInstances

名称	必选	允许NULL	类型	描述
ResourceType	是	否	String	资源类型,默认instance 示例值： instance
PlatformProjectId	是	否	String	项目Id 示例值： pr-46fbb87b

InstanceOperationLimitSet

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

被如下接口引用：DescribeInstancesOperationLimit

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

PriceForHostTypeQuota

专用宿主机的价格。

被如下接口引用：

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

KeyQuota

描述用户可用区下配额

被如下接口引用：DescribeUserInstanceQuota

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

StorageBlock

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

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

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

Quota

描述了配额信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
QuotaId	否	否	String	配额名称，取值范围： `TOTAL_EIP_QUOTA`：用户当前地域下EIP的配额数； `DAILY_EIP_APPLY`：用户当前地域下今日申购次数； `DAILY_PUBLIC_IP_ASSIGN`：用户当前地域下，重新分配公网 IP次数。示例值： TOTAL_EIP_QUOTA
QuotaCurrent	否	否	Int64	当前数量示例值： 10
QuotaLimit	否	否	Int64	配额数量示例值： 20

HpcClusterInfo

高性能计算集群

被如下接口引用：CreateHpcCluster、DescribeHpcClusters

名称	必选	允许NULL	类型	描述
HpcClusterId	是	否	String	高性能计算集群ID 示例值： hpc-g9zbwc5o
Name	是	是	String	高性能计算集群名示例值： jack
Remark	是	是	String	高性能计算集群备注示例值：测试
CvmQuotaTotal	是	否	Uint64	集群下设备容量示例值： 20
Zone	是	否	String	集群所在可用区示例值： chongqing
CurrentNum	是	否	Uint64	集群当前已有设备量示例值： 2
CreateTime	是	是	Datetime_iso	集群创建时间示例值： 2014-08-03T12:00:00+08:00
InstanceIds	是	是	Array of String	集群内实例ID列表示例值： ["ins-61dyt49h"]

InternetAccessible

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

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

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

QueryDataDisk

数据盘

被如下接口引用：

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

UserMigrateTaskData

用户迁移任务详情

被如下接口引用：DescribeUserMigrateTasks

名称	必选	允许NULL	类型	描述
JobId	是	是	String	任务id 示例值： migrate-qwer1353
JobName	是	是	String	任务名称示例值： onejob
AppId	是	是	Uint64	云平台应用ID，一般来说与Uin存在一一对应的关系。示例值： 125000111
Uin	是	是	String	用户uin 示例值： 32431223
Uuid	是	是	String	实例uuid 示例值： 5b33b986-084c-48e1-8cdb-d2e5ca5d045a
InstanceId	是	是	String	实例id 示例值： ins-61dyt49h
ImageUrl	是	是	String	数据盘镜像cos url 示例值： http://111-1251433127.cosd.myqcloud.com/Windows%20Server%202008%20R2%20x64a.vmdk.
DataSize	是	是	Uint64	数据大小示例值： 500
Region	是	是	String	地域。示例值： chongqing
Status	是	是	String	任务状态示例值： RUNNING
Progress	是	是	Uint64	迁移任务的进度示例值： 3
CreateTime	是	是	String	创建时间示例值： 2019-04-20 22:00:00
EndTime	是	是	String	结束时间示例值： 2019-04-20 22:00:00

RegionInfo

地域信息

被如下接口引用：DescribeRegions

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

Externals

扩展数据

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

LaunchTemplatesInfo

实例启动模板信息。
被如下接口引用：DescribeLaunchTemplatesInfo。

被如下接口引用：DescribeLaunchTemplatesInfo

名称	必选	允许NULL	类型	描述
LaunchTemplateId	否	是	String	实例启动模板ID。注意：此字段可能返回 null，表示取不到有效值。示例值： lt-k8wrok8e
LaunchTemplateName	否	是	String	实例启动模板名。注意：此字段可能返回 null，表示取不到有效值。示例值： jack lt
LaunchTemplateVersionData	否	是	LaunchTemplateVersionData	实例启动模版本信息。注意：此字段可能返回 null，表示取不到有效值。示例值：查看
LaunchTemplateVersionDescription	否	是	String	实例启动模板描述。注意：此字段可能返回 null，表示取不到有效值。示例值： alice use
CreatedBy	否	是	String	创建该模板的用户UIN。注意：此字段可能返回 null，表示取不到有效值。示例值： 32341324
CreationTime	否	是	String	创建该模板的时间。注意：此字段可能返回 null，表示取不到有效值。示例值： 2014-08-03 12:00:00

InstancesRecentFailedOperationSet

实例最新失败操作

被如下接口引用：DescribeInstancesRecentFailedOperation

名称	必选	允许NULL	类型	描述
InstanceId	是	否	String	实例ID 示例值： ins-61dyt49h
EventType	是	否	String	操作事件类型示例值： Modify
CreateTime	是	否	Datetime	操作事件发生时间示例值： 2014-08-03 12:00:00

HostGoodsItem

cdh发货实例的详细信息

被如下接口引用：SwitchParameterAllocateHosts、SwitchParameterRenewHosts

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

HostTypeQuota

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

被如下接口引用：

名称	必选	允许NULL	类型	描述
CPU	是	否	Uint64	CPU核数，单位：核。示例值： 2
CpuModelName	是	否	String	CPU型号。示例值： Intel(R) Xeon(R) CPU E5-2670 v3 @ 2.30GHz
DiskSize	是	否	Uint64	磁盘大小，单位：GB。示例值： 60
DiskType	是	否	String	磁盘类型。示例值： 1
HostFamily	是	否	String	专用宿主机机型系列。示例值： Balance
HostType	是	否	String	专用宿主机类型。示例值： M10
Memory	是	否	Uint64	内存大小，单位：GB。示例值： 1024
Price	是	否	PriceForHostTypeQuota	售价。示例值：查看
Status	是	否	String	售卖状态，“ SOLD_OUT”：售罄，“SELL”：售卖中示例值： SOLD_OUT
Zone	是	否	String	可用区。示例值： chongqing

InstanceFamilyConfig

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

被如下接口引用：DescribeInstanceFamilyConfigs

名称	必选	允许NULL	类型	描述
InstanceFamilyName	是	否	String	机型族名称的中文全称。示例值：标准型S1
InstanceFamily	是	否	String	机型族名称的英文简称。示例值： S1

MonitorServiceItem

监控服务

名称	必选	允许NULL	类型	描述
Enabled	否	是	String	是否启用示例值： FALSE

ImageAttribute

unImgId 到 deviceImageId的映射

被如下接口引用：

名称	必选	允许NULL	类型	描述
ImageId	是	否	String	unImgId 示例值： img-c1otssej
InnerImageId	是	否	String	deviceImageId 示例值： img-adggyzhh

LaunchTemplateVersionData

实例启动模板版本信息
被如下接口引用：DescribeLaunchTemplateVersions。

被如下接口引用：DescribeLaunchTemplatesInfo

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

ChargePrepaid

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

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

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

GpuAttr

Gpu参数

名称	必选	允许NULL	类型	描述
Type	否	是	String	类型注意：此字段可能返回 null，表示取不到有效值。示例值： {"Type": "wx"}

HostForSellZoneStatus

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

被如下接口引用：

名称	必选	允许NULL	类型	描述
Zone	是	否	String	可用区示例值： ap-guangzhou-2
Status	是	否	String	可售卖情况, (SELL: 正常售卖，SOLD_OUT: 售罄)。示例值： PENDING

Instance

描述实例的信息

被如下接口引用：DescribeInstances

名称	必选	允许NULL	类型	描述
Placement	否	否	Placement	实例所在的位置。示例值：查看
InstanceId	否	否	String	实例`ID`。示例值： ins-9bxebleo
InstanceType	否	否	String	实例机型。示例值： S1.SMALL1
CPU	否	否	Int64	实例的CPU核数，单位：核。示例值： 1
Memory	否	否	Int64	实例内存容量，单位：`GB`。示例值： 1
RestrictState	否	是	String	实例业务状态。取值范围： NORMAL：表示正常状态的实例 EXPIRED：表示过期的实例 PROTECTIVELY_ISOLATED：表示被安全隔离的实例。示例值： NORMAL
InstanceName	否	否	String	实例名称。示例值：测试实例
InstanceChargeType	否	否	String	实例计费模式。取值范围： `PREPAID`：表示预付费，即包年包月 `POSTPAID_BY_HOUR`：表示后付费，即按量计费 `CDHPAID`：`CDH`付费，即只对`CDH`计费，不对`CDH`上的实例计费。示例值： PREPAID
SystemDisk	否	否	SystemDisk	实例系统盘信息。示例值：查看
DataDisks	否	是	Array of DataDisk	实例数据盘信息。只包含随实例购买的数据盘。示例值：查看
PrivateIpAddresses	否	是	Array of String	实例主网卡的内网`IP`列表。示例值： ["172.16.32.78"]
PublicIpAddresses	否	是	Array of String	实例主网卡的公网`IP`列表。示例值： ["122.207.11.190"]
InternetAccessible	否	否	InternetAccessible	实例带宽信息。示例值：查看
VirtualPrivateCloud	否	否	VirtualPrivateCloud	实例所属虚拟私有网络信息。示例值：查看
ImageId	否	是	String	生产实例所使用的镜像`ID`。示例值： img-9qabwvbn
RenewFlag	否	是	String	自动续费标识。取值范围： `NOTIFY_AND_MANUAL_RENEW`：表示通知即将过期，但不自动续费 `NOTIFY_AND_AUTO_RENEW`：表示通知即将过期，而且自动续费 `DISABLE_NOTIFY_AND_MANUAL_RENEW`：表示不通知即将过期，也不自动续费。示例值： NOTIFY_AND_MANUAL_RENEW
CreatedTime	否	否	Datetime_iso	创建时间。按照`ISO8601`标准表示，并且使用`UTC`时间。格式为：`YYYY-MM-DDThh:mm:ssZ`。示例值： 2020-03-10T02:43:51Z
ExpiredTime	否	是	Datetime_iso	到期时间。按照`ISO8601`标准表示，并且使用`UTC`时间。格式为：`YYYY-MM-DDThh:mm:ssZ`。示例值： 2020-04-10T02:47:36Z
InstanceState	是	是	String	实例状态。取值范围： PENDING：表示创建中 LAUNCH_FAILED：表示创建失败 RUNNING：表示运行中 STOPPED：表示关机 STARTING：表示开机中 STOPPING：表示关机中 REBOOTING：表示重启中 SHUTDOWN：表示停止待销毁 TERMINATING：表示销毁中。示例值： RUNNING
LatestOperation	是	是	String	实例的最新操作。例：StopInstances、ResetInstance。示例值： RenewInstances
LatestOperationState	是	是	String	实例的最新操作状态。取值范围： SUCCESS：表示操作成功 OPERATING：表示操作执行中 FAILED：表示操作失败示例值： SUCCESS
LatestOperationRequestId	是	是	String	实例最新操作的唯一请求 ID。示例值： 3554eb5b-1cfa-471a-ae76-dc436c9d43e8
SecurityGroupIds	是	是	Array of String	实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。示例值： ["sg-p1ezv4wz"]
LoginSettings	是	是	LoginSettings	实例登录设置。目前只返回实例所关联的密钥。示例值：查看
DisasterRecoverGroupId	是	是	String	分散置放群组ID。示例值： null
Tags	是	是	Array of Tag	实例关联的标签列表。示例值：查看
Uuid	是	否	String	实例的uuid 示例值： 68b510db-b4c1-4630-a62b-73d0c7c970f9
OsName	是	是	String	实例的os名称示例值： CentOS 7.6 64bit
IPv6Addresses	是	是	Array of String	实例的ipv6地址示例值： null
StopChargingMode	是	是	String	实例的关机计费模式。取值范围： KEEP_CHARGING：关机继续收费 STOP_CHARGING：关机停止收费 NOT_APPLICABLE：实例处于非关机状态或者不适用关机停止计费的条件示例值： NOT_APPLICABLE
CamRoleName	是	是	String	CAM角色名。示例值： null
IsolatedSource	是	是	String	IsolatedSource 示例值： NOTISOLATED
PlatformProjectId	是	是	String	资源所属项目Id 示例值： 0
RemainTime	是	是	String	持续时间示例值： 10
HpcClusterId	否	是	String	高性能计算集群`ID`。示例值： null
DefaultLoginUser	否	是	String	默认登录用户示例值： root
DefaultLoginPort	否	是	Uint64	默认登录端口示例值： 22
DedicatedClusterId	否	是	String	实例所在的专用集群`ID`。示例值： cluster-du3jken
OperatorUin	是	是	String	操作者Uin 示例值： 34232423
RdmaIpAddresses	否	是	Array of String	高性能计算集群`IP`列表示例值： 10.34.23.4
DeviceId	否	是	Uint64	实例id 示例值： 12
InstanceClass	否	是	String	实例类型示例值： S
IsolatedTime	否	是	Datetime_iso	隔离时间示例值： 2014-08-03T12:00:00+08:00
ErrorKey	否	是	String	错误的key 示例值： 12
GPU	否	是	Int64	GPU 示例值： 2
NewCreationIdentify	否	是	Bool	新创建识别示例值： false
OperationMask	否	是	Uint64	操作掩码示例值： 64
ImageType	否	是	String	镜像类型示例值： PUBLIC_IMAGE
KeyPairIds	否	是	Array of String	密钥id, 数据来源为MC、BATCH、AS、tke、VPC_CGW，或者【请求里即没有Token又没有CamContext】时，会返回KeyPairIds字段，其他数据来源不会返回KeyPairIds字段示例值： ['skey-e7qf43n']
RunFlag	否	否	Int64	运行标志示例值： 1
InnerVpcId	否	是	Uint64	内部vpc Id 示例值： 2
InstanceFamily	否	是	String	实例的Family 示例值： S1
Architecture	否	是	String	架构示例值： x86_64
ErrorCode	否	是	Int64	错误码示例值： SUCCESS
SafeIsolatedInfo	否	是	String	安全隔离信息示例值： null
IsSafeIsolated	否	是	Bool	是否安全隔离示例值： true
Hypervisor	否	是	Int64	虚拟化示例值： 1

ZoneCpuQuota

可用区CPU配额信息

被如下接口引用：DescribeZoneCpuQuota

名称	必选	允许NULL	类型	描述
Zone	是	否	String	可用区。示例值： chongqing
InstanceChargeType	是	否	String	实例计费模式。PREPAID：表示预付费，即包年包月
cpuQuota	是	否	Uint64	可用CPU配额。示例值： 10

HostResource

cdh实例的资源信息

被如下接口引用：DescribeHosts

名称	必选	允许NULL	类型	描述
CpuTotal	否	否	Uint64	cdh实例总cpu核数示例值： 32
CpuAvailable	否	否	Uint64	cdh实例可用cpu核数示例值： 32
MemTotal	否	否	Float	cdh实例总内存大小（单位为:GiB）示例值： 96
MemAvailable	否	否	Float	cdh实例可用内存大小（单位为:GiB）示例值： 96
DiskTotal	否	否	Uint64	cdh实例总磁盘大小（单位为:GiB）示例值： 1000
DiskAvailable	否	否	Uint64	cdh实例可用磁盘大小（单位为:GiB）示例值： 1000
DiskType	否	否	String	cdh实例磁盘类型示例值： "LOCAL_SSD"

QueryPlacement

查询的地址

被如下接口引用：

名称	必选	允许NULL	类型	描述
Zone	是	否	Int64	可用区名称示例值： chongqing
VpcId	是	否	Int64	VpcId 示例值： 1
SubnetId	是	否	Int64	子网Id 示例值： 1
SubnetName	是	否	String	子网名称示例值： alice_subnet
VpcName	是	否	String	Vpc名称示例值： alice vpc

HostTypeConfigSet

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

被如下接口引用：DescribeZoneHostConfigInfos

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

DiagnosticReportDataSet

被如下接口引用：DescribeDiagnosticReports

名称	必选	允许NULL	类型	描述
CreateTime	否	否	Datetime	开始时间示例值： 2014-08-03 12:00:00
DiagnosticReportId	否	否	String	报告id 示例值： dr-61dyt49h
FinishTime	否	否	Datetime	结束时间示例值： 2014-08-03 12:00:00
InstanceId	否	否	String	实例id 示例值： ins-61dyt49h
InstanceName	否	否	String	实例名称示例值： jack-use
ReportDetailSet	否	否	ReportDetailSet	ReportDetailSet 示例值：查看
Severity	否	否	String	检测状态示例值： Normal
Status	否	否	String	状态示例值： Finished
Uuid	否	否	String	uuid 示例值： 4904ffac-02e4-4161-9636-cca0a687e841

AccountAttributeSet

账户属性设置

被如下接口引用：DescribeAccountAttributes

名称	必选	允许NULL	类型	描述
AttributeClass	是	是	String	属性类型示例值： PostPaidInstanceCountLimit
AttributeValueSet	是	是	Array of AccountAttribute	属性值示例值：查看

LaunchTemplateInfo

实例启动模板简要信息。
被如下接口引用：DescribeLaunchTemplates。

被如下接口引用：

名称	必选	允许NULL	类型	描述
LatestVersionNumber	否	是	Int64	实例启动模版本号。注意：此字段可能返回 null，表示取不到有效值。示例值： 10
LaunchTemplateId	否	是	String	实例启动模板ID。注意：此字段可能返回 null，表示取不到有效值。示例值： lt-rf6ogz49
LaunchTemplateName	否	是	String	实例启动模板名。注意：此字段可能返回 null，表示取不到有效值。示例值： foobar
DefaultVersionNumber	否	是	Int64	实例启动模板默认版本号。注意：此字段可能返回 null，表示取不到有效值。示例值： 5
LaunchTemplateVersionCount	否	是	Int64	实例启动模板包含的版本总数量。注意：此字段可能返回 null，表示取不到有效值。示例值： 8
CreatedBy	否	是	String	创建该模板的用户UIN。注意：此字段可能返回 null，表示取不到有效值。示例值： 1255000041
CreationTime	否	是	Datetime	创建该模板的时间。注意：此字段可能返回 null，表示取不到有效值。示例值： 2020-12-17T01:54:31Z

OfflineMigrateUserTaskData

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

被如下接口引用：DescribeUserMigrateTasks

名称	必选	允许NULL	类型	描述
JobId	是	是	String	任务id 示例值： migrate-qwer1343
JobName	是	是	String	任务名称示例值： onejob
AppId	是	是	Uint64	云平台应用ID，一般来说与Uin存在一一对应的关系。示例值： 1255000041
Uin	是	是	String	用户uin 示例值： 32432442
Uuid	是	是	String	实例uuid 示例值： 5b33b986-084c-48e1-8cdb-d2e5ca5d045a
InstanceId	是	是	String	实例id 示例值： ins-61dyt49h
ImageUrl	是	是	String	系统盘镜像cos url 示例值： https://kaijian-gz-1251783334.cos.ap-guangzhou.myqcloud.com/image_m-wz95mjeh07vy3d48fcj9_system.raw
DataSize	是	是	Uint64	辅助数据盘大小示例值： 50
Region	是	是	String	地域。示例值： chongqing
Status	是	是	String	任务状态示例值： SUCCESS
Progress	是	是	Uint64	迁移任务的进度示例值： 2
CreateTime	是	是	String	创建时间示例值： 2019-12-04T16:44:55+08:00
EndTime	是	是	String	结束时间示例值： 2019-12-04T16:44:55+08:00
SnapshotUrl	是	是	String	数据盘镜像url 示例值： https://kaijian-gz-1251783334.cos.ap-guangzhou.myqcloud.com/image_m-wz95mjeh07vy3d48fcj9_system.raw
DiskId	是	是	String	数据盘id 示例值： disk-adggyzhh
DiskSize	是	是	Uint64	数据盘大小示例值： 50

InstanceCreateImageAttributeSet

实例创建镜像列表

被如下接口引用：DescribeInstancesCreateImageAttributes

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

LocalDiskType

本地磁盘规格

被如下接口引用：DescribeZoneInstanceConfigInfos

名称	必选	允许NULL	类型	描述
Type	是	否	String	本地磁盘类型。示例值： LOCAL_BASIC
PartitionType	是	否	String	本地磁盘属性。示例值： ROOT
MinSize	是	否	Int64	本地磁盘最小值。示例值： 20
MaxSize	是	否	Int64	本地磁盘最大值。示例值： 100
Required	是	否	String	购买时本地盘是否为必选。取值范围： REQUIRED：表示必选 OPTIONAL：表示可选。示例值： REQUIRED

Image

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

被如下接口引用：DescribeImages

名称	必选	允许NULL	类型	描述
ImageId	否	否	String	镜像ID 示例值： img-19mu3fy3
OsName	否	否	String	镜像操作系统示例值： CentOS 8.0 64位
ImageType	否	否	String	镜像类型示例值： PRIVATE_IMAGE
CreatedTime	是	是	Datetime_iso	镜像创建时间示例值： 2022-03-21T08:41:45Z
ImageName	是	否	String	镜像名称示例值： centos
ImageDescription	是	否	String	镜像描述示例值： alice use
ImageSize	是	否	Int64	镜像大小示例值： 50
Architecture	是	否	String	镜像架构示例值： x86_64
ImageState	是	否	String	镜像状态示例值： NORMAL
Platform	否	否	String	镜像来源平台示例值： CentOS
ImageCreator	否	是	String	镜像创建者示例值： 1255000041
ImageSource	否	否	String	镜像来源示例值： CREATE_IMAGE
SyncPercent	是	是	Int64	同步百分比示例值： null
IsSupportCloudinit	是	是	Bool	镜像是否支持cloud-init 示例值： true
SnapshotSet	否	是	Array of Snapshot	镜像关联的快照信息示例值：查看
IsSupportAutoInstallGPUDriver	是	是	Bool	镜像是否支持自动安装GPU驱动示例值： true
OsKey	是	否	String	镜像名称示例值： centos7.9
ProductCode	否	是	String	产品码示例值： image-zero
GPUDriverList	是	否	Array of String	GPU驱动列表示例值： []
ImageFormat	是	否	String	镜像格式示例值： qcow2
OperationMask	是	否	Int64	镜像操作掩码示例值： 64
Flags	是	否	Array of String	镜像标记示例值： centos
DeviceImageId	是	是	Int64	自定义镜像id 示例值： img-c1otssej
IsSupportTat	否	否	Bool	TAT支持镜像情况示例值： true

InstanceDisasterMap

实例Id对应置放群组对

被如下接口引用：RemoveInstancesDisasterRecoverGroup

名称	必选	允许NULL	类型	描述
InstanceId	否	否	String	实例id 示例值： ins-61dyt49h
DisasterIds	否	否	Array of String	置放群组id 示例值： ["ps-l86ok62z"]

ItemPrice

描述了单项的价格信息

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

KeyBill

描述实例订单Id

被如下接口引用：DescribeInstancesAttribute

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

InternetChargeTypeConfig

描述了网络计费

被如下接口引用：DescribeInternetChargeTypeConfigs

名称	必选	允许NULL	类型	描述
InternetChargeType	否	否	String	网络计费模式。示例值： TRAFFIC_POSTPAID_BY_HOUR
Description	否	否	String	网络计费模式描述信息。示例值： alice use

DisasterRecoverGroup

容灾组信息

被如下接口引用：DescribeDisasterRecoverGroups

名称	必选	允许NULL	类型	描述
DisasterRecoverGroupId	是	否	String	置放群组id。示例值： ps-n4becvb9
Name	是	否	String	置放群组名称，长度1-60个字符。示例值： myGroup
Type	是	否	String	置放群组类型，取值范围： HOST：物理机 SW：交换机 RACK：机架示例值： "HOST"
CvmQuotaTotal	是	否	Int64	置放群组内最大容纳云服务器数量。示例值： 50
CurrentNum	是	否	Int64	置放群组内云服务器当前数量。示例值： 2
InstanceIds	是	是	Array of String	置放群组内，云服务器id列表。示例值： ["ins-19029pru"]
CreateTime	是	是	Datetime_iso	置放群组创建时间。示例值： "2021-04-27T08:49:34Z"
Strategy	是	否	String	置放群组策略示例值： PARTITION

SystemDisk

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

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

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

Snapshot

描述镜像关联的快照信息

被如下接口引用：DescribeImages

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

ClientSysInfo

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

被如下接口引用：LiveMigrateInstance

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

InstanceStatisticsSet

实例数据数组

被如下接口引用：DescribeInstanceStatistics

名称	必选	允许NULL	类型	描述
Region	是	否	String	区域示例值： chongqing
TotalCount	是	否	Uint64	机器总量示例值： 20
NewInstanceCount	是	否	Uint64	红点主机总数（刚新建机器）示例值： 20
ExpiredInstanceCount	是	否	Uint64	过期主机总数示例值： 20

InstanceTypeConfig

描述实例机型配置信息

被如下接口引用：DescribeInstanceTypeConfigs、DescribeInstancesModification

名称	必选	允许NULL	类型	描述
Zone	否	否	String	可用区。示例值： ap-guangzhou-2
InstanceType	否	否	String	实例机型。示例值： S2.SMALL1
InstanceFamily	否	否	String	实例机型系列。示例值： S2
GPU	否	否	Int64	GPU核数，单位：核。示例值： 2
CPU	否	否	Int64	CPU核数，单位：核。示例值： 2
Memory	否	否	Int64	内存容量，单位：`GB`。示例值： 2048
FPGA	是	否	Uint64	FPGA核数，单位：核。示例值： 2

Price

价格

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

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

AccountAttribute

账户属性对象

被如下接口引用：DescribeAccountAttributes

名称	必选	允许NULL	类型	描述
AttributeName	是	否	String	付费类型：后付费（PostPaidInstanceCountLimit）,预付费（PrePaidInstanceCountLimit）示例值： jack
AttributeValues	是	否	String	单次最大购买数量示例值： 20

InstanceFamilyItemArchitecture

带CPU架构的实例族信息。

被如下接口引用：DescribeInstanceConfigInfos

名称	必选	允许NULL	类型	描述
instanceFamily	是	否	String	实例族。示例值： S2
order	是	否	Int64	优先级。示例值： 1
instanceTypes	是	否	Array of InstanceTypeItem	实例类型信息列表。示例值：查看
TypeName	是	否	String	实例类型名称示例值：标准型S2
Architecture	是	否	String	CPU架构信息示例值： x86_64

EnhancedService

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

名称	必选	允许NULL	类型	描述
SecurityService	否	否	RunSecurityServiceEnabled	开启云安全服务。若不指定该参数，则默认开启云安全服务。示例值：查看
MonitorService	否	否	RunMonitorServiceEnabled	开启云安全服务。若不指定该参数，则默认开启云监控服务。示例值：查看
AutomationService	否	否	AutomationServiceEnabled	安装tat-agent。若不指定该参数，则默认安装示例值：查看

HostItem

cdh实例详细信息

被如下接口引用：DescribeHosts

名称	必选	允许NULL	类型	描述
Placement	否	否	Placement	cdh实例所在的位置。通过该参数可以指定实例所属可用区，所属项目等属性。示例值：查看
HostId	否	否	String	cdh实例id 示例值： host-61dyt49h
HostType	否	否	String	cdh实例类型示例值： M10
HostName	否	否	String	cdh实例名称示例值： alice-host
HostChargeType	否	否	String	cdh实例付费模式示例值： PREPAID
RenewFlag	否	否	String	cdh实例自动续费标记示例值： DISABLE_NOTIFY_AND_MANUAL_RENEW
CreatedTime	否	否	Datetime_iso	cdh实例创建时间示例值： 2014-08-03 12:00:00
ExpiredTime	否	否	Datetime_iso	cdh实例过期时间示例值： 2014-08-03 12:00:00
InstanceIds	否	否	Array of String	cdh实例上已创建云子机的实例id列表示例值： ["ins-61dyt49hx"]
HostState	否	否	String	cdh实例状态示例值： RUNNING
HostIp	否	否	String	cdh实例ip 示例值： 10.21.0.11
HostResource	否	否	HostResource	cdh实例资源信息示例值：查看
CageId	否	否	String	cage id 示例值： ap-shanghai-2
OperationMask	否	否	Int64	操作掩码示例值： 62
Tags	否	否	Array of String	标签示例值： ["alice-1"]

LaunchTemplateVersionInfo

实例启动模板版本集合
被如下接口引用：DescribeLaunchTemplateVersions。

被如下接口引用：

名称	必选	允许NULL	类型	描述
LaunchTemplateVersion	否	是	Int64	实例启动模板版本号。注意：此字段可能返回 null，表示取不到有效值。示例值： 1
LaunchTemplateVersionData	否	是	LaunchTemplateVersionData	实例启动模板版本数据详情。示例值：查看
CreationTime	否	是	Datetime	实例启动模板版本创建时间。示例值： 2020-12-17T01:54:31Z
LaunchTemplateId	否	是	String	实例启动模板ID。示例值： lt-b8v1kcyq
IsDefaultVersion	否	是	Bool	是否为默认启动模板版本。示例值： true
LaunchTemplateVersionDescription	否	是	String	实例启动模板版本描述信息。注意：此字段可能返回 null，表示取不到有效值。示例值： MyVersion
CreatedBy	否	是	String	创建者。示例值： 1255000041

ResourceInfo

用户实例资源详细信息

被如下接口引用：SearchUserInstance

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

UserZoneStatusItem

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

被如下接口引用：DescribeUserZoneStatus

名称	必选	允许NULL	类型	描述
Zone	是	否	String	可用区示例值： chongqing
InstanceChargeType	是	否	String	计费类型示例值： PREPAID
Status	是	否	String	售卖状态示例值： AVALIBLE

InstanceTypeQuota

描述实例机型配额信息

被如下接口引用：DescribeInstanceTypeQuota

名称	必选	允许NULL	类型	描述
Zone	是	否	String	可用区。示例值： ap-guangzhou-1
InstanceType	是	否	String	实例机型。示例值： I1.MEDIUM4
InstanceQuota	是	否	Int64	实例机型配额。示例值： 20
InstanceChargeType	是	否	String	实例计费模式。取值范围： `PREPAID`：表示预付费，即包年包月 `POSTPAID_BY_HOUR`：表示后付费，即按量计费 * `CDHPAID`：CDH付费，即只对CDH计费，不对CDH上的实例计费。示例值： PREPAID
DeviceClass	否	否	String	实例类型。示例值： S
CPU	否	否	Int64	实例的CPU核数，单位：核。示例值： 2
Memory	否	否	Int64	实例内存容量，单位：`GB`。示例值： 1024
GPU	否	否	Int64	实例的GPU核数，单位：核。示例值： 3

InternetAccessibleModifyChargeType

描述了网络计费

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

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

InstanceTypeConfigStatusSet

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

被如下接口引用：DescribeInstancesModification

名称	必选	允许NULL	类型	描述
Status	否	否	String	状态示例值： SELL
Message	否	否	String	描述信息示例值： success
InstanceTypeConfig	否	否	InstanceTypeConfig	机型列表示例值：查看

Address

描述 EIP 信息

被如下接口引用：DescribeAddresses

名称	必选	允许NULL	类型	描述
AddressId	否	否	String	`EIP`的`ID`，是`EIP`的唯一标识。示例值： eip-61dyt49h
AddressName	否	否	String	`EIP`名称。示例值： alice use
AddressState	否	否	String	`EIP`状态。示例值： Running
AddressIp	否	否	String	弹性外网IP 示例值： 122.121.34.33
BindedResourceId	否	否	String	绑定的资源实例`ID`。可能是一个`CVM`，`NAT`，或是弹性网卡。示例值： ins-61dyt49h
CreatedTime	否	否	Datetime_iso	创建时间。按照`ISO8601`标准表示，并且使用`UTC`时间。格式为：`YYYY-MM-DDThh:mm:ssZ`。示例值： 2014-08-03T12:00:00+08:00

InstanceTypeItem

实例类型信息。

被如下接口引用：DescribeInstanceConfigInfos

名称	必选	允许NULL	类型	描述
InstanceType	是	否	String	实例类型。示例值： S1.SMALL2
Cpu	是	否	Uint64	CPU核数。示例值： 2
Memory	是	否	Uint64	内存大小。示例值： 2048
Gpu	是	否	Uint64	GPU核数。示例值： 2
Fpga	是	否	Uint64	FPGA核数。示例值： 2
StorageBlock	是	否	Uint64	存储块数。示例值： 2
NetworkCard	是	否	Uint64	网卡数。示例值： 2
MaxBandwidth	是	否	Float	最大带宽。示例值： 100.0
Frequency	是	否	String	主频。示例值： 2.5 GHz
CpuModelName	是	否	String	CPU型号名称。示例值： Intel Xeon Skylake 6133
Pps	是	否	Uint64	包转发率。示例值： 10
Externals	是	否	Externals	外部信息。示例值：查看
Remark	是	否	String	备注信息。示例值： alice use

ResourceForInstanceType

实例类型的资源

被如下接口引用：InquiryResourceResetInstancesType

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

HostPrice

cdh相关价格信息

被如下接口引用：InquiryPriceAllocateHosts、InquiryPriceRenewHosts

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

RequiredEnhancedService

需要增强服务

名称	必选	允许NULL	类型	描述
MonitorService	否	是	MonitorServiceItem	监控服务示例值：查看

ZoneInfo

可用区信息

被如下接口引用：DescribeZones

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

ActionTimer

定时任务

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

名称	必选	允许NULL	类型	描述
TimerAction	否	否	String	定时器示例值： TerminateInstances
ActionTime	否	否	String	执行时间示例值： 2024-05-29T11:26:40Z
Externals	是	否	Externals	扩展数据示例值：查看

DiagnosticReportSet

被如下接口引用：CreateDiagnosticReports

名称	必选	允许NULL	类型	描述
InstanceId	否	否	String	实例id 示例值： ins-61dyt49h
DiagnosticReportId	否	否	String	检测报告id 示例值： dr-61dyt49h

KeyPair

描述密钥对信息

被如下接口引用：DescribeKeyPairs

名称	必选	允许NULL	类型	描述
KeyId	否	否	String	密钥对的`ID`，是密钥对的唯一标识。示例值： skey-q29u65hu
KeyName	否	否	String	密钥对名称。示例值： alice-key
Description	否	否	String	密钥对描述示例值： alice use
PublicKey	否	否	String	密钥对的纯文本公钥。示例值： ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC0ran+u+y09bSSoAbHBhJm2ivci0uwTif+/MqoGj5odBuGcDHGIBE7Th74ITXtbuqEXxdOSROi7DOVaTZa1MYe6qKGPAi5/8jlV8c9CKCezXr99A2Dps/eVPVn4yO2NhSXbr0U/voRxTqNprP0YLo25y1lVnN0vg0CfWL8DDYh6DkMMVufGikA7WVPdsHomTLlSPdlSLvCRZPHC7eBhkrznO0rnfM+cJY2fqqSrdI1kqtDRJNpNvPLaRnJsc3uoot2nGqrGD6yiwx2tvdLAqgQT5tASfvtTc3CTMMJRGIqm+CdG2S1y0VlMDmm9XHeVBmZuX5YDJPNGIOcBI2Cgrj5 skey-mk5eqeu6
AssociatedImageCount	否	否	Int64	密钥关联的镜像数。示例值： 0
AssociatedInstanceCount	否	否	Int64	密钥关联的实例数。示例值： 0
AssociatedInstanceIds	否	否	Array of String	密钥关联的实例`ID`列表。示例值： []
CreatedTime	是	否	Datetime_iso	密钥对创建日期示例值： 2022-03-21T08:41:45Z

InternetBandwidthConfig

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

被如下接口引用：DescribeInstanceInternetBandwidthConfigs

名称	必选	允许NULL	类型	描述
StartTime	否	否	Datetime_iso	开始时间。按照`ISO8601`标准表示，并且使用`UTC`时间。格式为：`YYYY-MM-DDThh:mm:ssZ`。示例值： 2014-08-03T12:00:00+08:00
EndTime	否	否	Datetime_iso	结束时间。按照`ISO8601`标准表示，并且使用`UTC`时间。格式为：`YYYY-MM-DDThh:mm:ssZ`。示例值： 2014-08-03T12:00:00+08:00
InternetAccessible	否	否	InternetAccessible	实例带宽信息。示例值：查看

Tag

标签键值对

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

名称	必选	允许NULL	类型	描述
Key	是	否	String	标签键示例值： alice-key
Value	是	否	String	标签值示例值： alice-value