数据结构

最近更新时间: 2024-10-18 10:38:40

InstanceFamilyConfig

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

被如下接口引用:DescribeInstanceFamilyConfigs

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

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 可用区。

HostOrder

cdh实例相关的订单信息

被如下接口引用:SwitchParameterAllocateHosts、SwitchParameterRenewHosts

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

Address

描述 EIP 信息

被如下接口引用:DescribeAddresses

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

TagSpecification

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

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

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

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,在账户余额充足的情况下,实例到期后将按月自动续费。

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,表示取不到有效值。

ProductInfoItem

产品描述信息项

被如下接口引用:SwitchParameterAllocateHosts、SwitchParameterRenewHosts

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

LocalDiskType

本地磁盘规格

被如下接口引用:DescribeZoneInstanceConfigInfos

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

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支持镜像情况

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,在账户余额充足的情况下,实例到期后将按月自动续费。

ResourceForInstanceType

实例类型的资源

被如下接口引用:InquiryResourceResetInstancesType

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

LaunchTemplateVersionInfo

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

被如下接口引用:

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

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。

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 实例备注信息。

SharePermissionSet

镜像分享信息结构

被如下接口引用:

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

AccountAttribute

账户属性对象

被如下接口引用:DescribeAccountAttributes

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

ImportImageOsListSupported

导入镜像支持os列表

被如下接口引用:DescribeImportImageOs

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

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 结束时间

InstanceRefundsSet

描述退款详情。

被如下接口引用:InquiryPriceTerminateInstances

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

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

HostForSellZoneStatus

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

被如下接口引用:

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

InstanceFamilyItemArchitecture

带CPU架构的实例族信息。

被如下接口引用:DescribeInstanceConfigInfos

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

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 本地存储块

InstanceReturnable

实例可退还信息。

被如下接口引用:DescribeInstancesReturnable

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

InstanceDeniedActions

实例操作限制列表

被如下接口引用:DescribeInstancesDeniedActions

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

DeniedActions

限制操作列表

被如下接口引用:DescribeInstancesDeniedActions

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

InternetChargeTypeConfig

描述了网络计费

被如下接口引用:DescribeInternetChargeTypeConfigs

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

ZoneCpuQuota

可用区CPU配额信息

被如下接口引用:DescribeZoneCpuQuota

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

HostPrice

cdh相关价格信息

被如下接口引用:InquiryPriceAllocateHosts、InquiryPriceRenewHosts

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

KeyQuota

描述用户可用区下配额

被如下接口引用:DescribeUserInstanceQuota

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

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 开启云安全服务。若不指定该参数,则默认开启云监控服务。

AvailabilityZone

描述可用区信息。

被如下接口引用:

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

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 数据盘大小

InstanceTypeQuota

描述实例机型配额信息

被如下接口引用:DescribeInstanceTypeQuota

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

InstanceConfigInfoItemArchitecture

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

被如下接口引用:DescribeInstanceConfigInfos

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

InstanceStatus

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

被如下接口引用:DescribeInstancesStatus

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

KeyBill

描述实例订单Id

被如下接口引用:DescribeInstancesAttribute

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

InternetAccessibleModifyChargeType

描述了网络计费

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

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

AvailableZoneSet

可用区详情

被如下接口引用:DescribeUserAvailableZones

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

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 配额数量

ZoneInfo

可用区信息

被如下接口引用:DescribeZones

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

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 标签

KeyPair

描述密钥对信息

被如下接口引用:DescribeKeyPairs

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

InstancesRecentFailedOperationSet

实例最新失败操作

被如下接口引用:DescribeInstancesRecentFailedOperation

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

InstanceConnectivity

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

被如下接口引用:CheckInstancesConnectivity

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

Filter

>描述键值对过滤器,用于条件过滤查询。例如过滤ID、名称、状态等 > * 若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。 > * 若同一个Filter存在多个Values,同一FilterValues间的关系为逻辑或(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、DescribeKeyPairs、DescribeLaunchTemplatesInfo、DescribeMarketImages、DescribeUserAvailableZones、DescribeUserInstanceQuota、DescribeUserMigrateTasks、DescribeUserZoneStatus、DescribeZoneCdhInstanceConfigInfos、DescribeZoneCpuQuota、DescribeZoneHostConfigInfos、DescribeZoneHostForSellStatus、DescribeZoneInstanceConfigInfos

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

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,表示取不到有效值。

ClientSysInfo

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

被如下接口引用:LiveMigrateInstance

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

DetailPrices

详细价格信息

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

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

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:表示实例已售罄。

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,表示取不到有效值。

InstanceStatisticsSet

实例数据数组

被如下接口引用:DescribeInstanceStatistics

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

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>CDHPAIDCDH付费,即只对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 虚拟化

ProjectSpecification

平台项目ID

被如下接口引用:RunInstances

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

RunMonitorServiceEnabled

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

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

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

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,表示取不到有效值。

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 可用区。

InstanceTypeNameConfig

实例类型名称配置

被如下接口引用:DescribeInstanceTypeNameConfigs

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

PriceForHostTypeQuota

专用宿主机的价格。

被如下接口引用:

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

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 实例所属项目

ImageAttributeSet

unImgId到deviceImageId的映射的数组

被如下接口引用:DescribeImagesAttribute

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

MonitorServiceItem

监控服务

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

名称 必选 允许NULL 类型 描述
Enabled 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

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 数据盘详情

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实例详细信息

ImportImageOsVersion

导入镜像OS版本描述

被如下接口引用:DescribeImportImageOs

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

ResourceInfo

用户实例资源详细信息

被如下接口引用:SearchUserInstance

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

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实例磁盘类型

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,表示取不到有效值。

RunSecurityServiceEnabled

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

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

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

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

InstanceOperationLimitSet

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

被如下接口引用:DescribeInstancesOperationLimit

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

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 结束时间

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,表示取不到有效值。

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 产品信息项列表

RegionInfo

地域信息

被如下接口引用:DescribeRegions

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

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.fincloud.tencent.cn/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 子网名

UserZoneStatusItem

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

被如下接口引用:DescribeUserZoneStatus

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

ReportDetailSet

ReportDetailSet

被如下接口引用:DescribeDiagnosticReports

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

DataDisks

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

被如下接口引用:ImportFullCvmImage

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

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 亲和度,匹配度

AccountAttributeSet

账户属性设置

被如下接口引用:DescribeAccountAttributes

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

DiagnosticReportSet

DiagnosticReportSet

被如下接口引用:CreateDiagnosticReports

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

ImageAttribute

unImgId 到 deviceImageId的映射

被如下接口引用:

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

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,表示取不到有效值。

InstanceChargeTypeConfig

计费类型配置信息

被如下接口引用:DescribeInstanceChargeTypeConfigs

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

RequiredEnhancedService

需要增强服务

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

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

AddressChargePrepaid

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

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

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

Tag

标签键值对

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

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

InstanceOrder

实例订单详情信息。

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

名称 必选 允许NULL 类型 描述

CreateKeyPair

描述创建密钥对信息

被如下接口引用:CreateKeyPair

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

ImageSharedAccount

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

被如下接口引用:

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

KvType

键值类型

被如下接口引用:DescribeUserGlobalConfigs、ModifyUserGlobalConfigs

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

Snapshot

描述镜像关联的快照信息

被如下接口引用:DescribeImages

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

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

GpuAttr

Gpu参数

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

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

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。

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 实例带宽信息。

InstanceFamilyItem

实例族信息。

被如下接口引用:

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

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 备注信息。

InstanceConfigInfoItem

实例静态配置信息。

被如下接口引用:

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

InstanceCreateImageAttributeSet

实例创建镜像列表

被如下接口引用:DescribeInstancesCreateImageAttributes

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

KeyPairInstancesinternetaccessible

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

被如下接口引用:

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

KeyPairAttributeSet

密钥对

被如下接口引用:DescribeKeyPairsAttribute

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

ActionTimer

定时任务

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

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

InstanceTypeConfig

描述实例机型配置信息

被如下接口引用:DescribeInstanceTypeConfigs

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

Price

价格

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

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

QueryPlacement

查询的地址

被如下接口引用:

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

QuerySystemDisk

查询的系统盘

被如下接口引用:

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

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 分散置放群组创建时间。

SharePermission

镜像分享信息结构

被如下接口引用:DescribeImageSharePermission

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