数据结构

Zone

可用区信息， 包含可用区所在的城市等信息。

名称	类型	必选	描述
zoneId	String	是	可用区ID。 例如：SEL-A
zoneName	String	是	可用区的名称。
cityName	String	是	可用区的城市名称。
areaName	String	是	可用区所在的大区名称。

ChargePrepaid

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

名称	类型	必选	描述
period	Integer	是	购买实例的时长。 单位：月。

RaidConfig

实例磁盘阵列配置， 包括自定义raid的配置。

名称	类型	必选	描述
raidType	Integer	否	Raid类型。 该配置进行快捷raid配置，支持0, 1, 5, 10。 raidType和customRaids只能指定其中一个参数。
customRaids	Array of CustomRaid	否	自定义Raid配置。 自定义磁盘进行raid的配置。 raidType和customRaids只能指定其中一个参数。

CustomRaid

进行自定义Raid配置时需要的raid级别和指定的磁盘序号。

名称	类型	必选	描述
raidType	Integer	是	Raid类型。 支持0, 1, 5, 10。
diskSequence	Array of Integer	是	磁盘序号。 根据机型里的磁盘从1开始顺序编号。如果是多个磁盘序号，则必须连续。

Partition

分区配置信息。包括文件类型, 分区大小等。

名称	类型	必选	描述
fsType	Integer	是	分区的文件类型。 linux系统：支持的值ext2,ext3, ext4, ext类型必须要有。 windows系统: 只能为NTFS。
fsPath	String	是	分区盘符。 linux系统：必须为/开头，且第一个为系统分区必须为/。 windows系统：支持C~H，第一个系统分区必须指定为C。
size	Integer	是	分区大小。 单位为GB。

Nic

网卡的相关配置，目前包括公网和内网的网卡名称。

名称	类型	必选	描述
wanName	String	否	公网网卡名称。 只能是数字和大小写字母，且必须以字母开头，长度限制为4-10。 非高可用机型，默认的公网网卡名称为wan0。且不能为lan开头。 高可用机型，默认的公网网卡名称为bond0。 公网名称和内网名称不能相同。
lanName	String	否	内网网卡名称。 只能是数字和大小写字母，且必须以字母开头，长度限制为4-10。 非高可用机型，默认的内网网卡名称为lan0。且不能为wan开头。 高可用机型，默认的内网网卡名称为bond1。 公网名称和内网名称不能相同。

InstanceType

机型的配置信息。包括机型的cpu、内存、是否支持组内网等等。

参数名称	类型	描述
instanceTypeId	String	实例机型ID。
description	String	机型描述。 一般包括内存大小，硬盘。
cpuCoreCount	Integer	CPU内核数目。
memorySize	Integer	内存大小。 单位：GB。
supportRaids	Array of Integer	机型支持的raid。
supportSubnet	Boolean	是否支持内网组网。
maximumBandwidth	Integer	机型支持的最大出口带宽。 单位：Mbps。
diskInfo	InstanceDiskInfo	硬盘配置。 单位：GB。
imageIds	Array of String	机型支持的镜像ID。
isHA	Boolean	是否是高可用机型。

InstanceDiskInfo

机型硬盘信息。

参数名称	类型	描述
totalDiskSize	Integer	机型的硬盘总大小。 单位：GB。 totalDiskSize的大小一般小于描述的信息，系统为了分区能够成功预留了一小部分。如果采用自定义分区，最后的一个分区将会获得剩余的所有磁盘大小。
diskDescription	String	机型硬盘的描述信息。
disks	Array of Disk	可用于raid和分区的磁盘信息。 按顺序标号。比如880 x 2、 220 x2，其磁盘序号1,2,3,4 分别对应的磁盘大小为880，880，220，220。

AvailableResource

可售卖的实例资源信息。描述了哪些可用区有哪些机型可以售卖。

参数名称	类型	描述
zoneId	String	可用区ID。
sellStatus	String	售卖的状态。 SELL：表示实例可购买，且库存>10。 SELL_SHORTAGE: 表示可购买，但是库存<10台。 SOLD_OUT：表示实例已售罄。
internetChargeTypes	Array of String	网络计费类型。 取值范围请看InternetChargeType。
instanceTypeId	String	机型ID。
maximumBandwidthOut	Integer	最大的公网出口带宽限制。 单位：Mbps。
defaultBandwidthOut	Integer	固定带宽计费方式时默认赠送公网带宽。 单位：GB。
defaultTrafficPackageSize	Float	流量包计费方式时默认增送的流量包大小。 单位：TB。
qty	Integer	库存数量。

Disk

硬盘块信息。

参数名称	类型	描述
diskSize	Integer	硬盘的大小。 单位：GB。
diskCount	Integer	该硬盘大小的硬盘的数量。

InstanceStatus

实例状态。

状态值	状态说明
PENDING	待创建
CREATING	创建中
CREATE_FAILED	创建失败
INSTALLING	安装中
INSTALL_FAILED	安装失败
RUNNING	运行中
STOPPED	关机
BOOTING	启动中
STOPPING	关机中
RECYCLE	在回收站中

InternetChargeType

网络计费类型。

类型	说明
ByBandwidth	按固定带宽计费
ByTrafficPackage	购买流量包计费
ByInstanceBandwidth95	单个实例95计费
ByClusterBandwidth95	合并95计费

EipAddress

Eip信息。

参数名称	类型	描述
eipId	String	EIP唯一ID。
zoneId	String	EIP所属的可用区ID。
ipAddress	String	IP地址。
instanceId	String	实例ID。
instanceName	String	实例名称。
eipChargeType	String	付费类型。 PREPAID：预付费，即包年包月。POSTPAID：后付费。
period	Integer	购买EIP的时长。 单位：月。 后付费EIP该字段为null。
createTime	Timestamp	创建时间。 按照ISO8601标准表示，并且使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。
expiredTime	Timestamp	到期时间。 按照ISO8601标准表示，并且使用UTC时间。格式为：YYYY-MM-ddThh:mm:ssZ。 注意：后付费模式本项为null。
eipStatus	String	EIP状态。
resourceGroupId	String	资源组ID。
resourceGroupName	String	资源组名称。

EipAvailable

购买EIP资源区域。

名称	类型	描述
zoneId	String	EIP所属的可用区ID。
status	String	EIP是否售卖。 取值范围： SELL：表示EIP可购买，且库存>10台。 SELL_SHORTAGE: 表示可购买，但是库存<10台。 SOLD_OUT：表示EIP已售罄。

InstanceAvailableEip

EIP信息。

名称	类型	描述
eipId	String	一个EIP ID。 可通过DescribeEipAddresses接口返回值中的eipId获取。
ipAddress	String	IP地址。

DdosIpAddress

Ddos IP信息。

参数名称	类型	描述
ddosIpId	String	Ddos IP唯一ID。
zoneId	String	Ddos IP所属的可用区ID。
ipAddress	String	IP地址。
instanceId	String	实例ID。
instanceName	String	实例名称。
ddosIpChargeType	String	付费类型。 PREPAID：预付费，即包年包月。 POSTPAID：后付费。
period	Integer	购买Ddos IP的时长。 单位：月。 后付费Ddos IP该字段为null。
createTime	Timestamp	创建时间。 按照ISO8601标准表示，并且使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。
expiredTime	Timestamp	到期时间。 按照ISO8601标准表示，并且使用UTC时间。格式为：YYYY-MM-ddThh:mm:ssZ。 注意：后付费模式本项为null。
ddosIpStatus	String	Ddos IP状态。
resourceGroupId	String	资源组ID。
resourceGroupName	String	资源组名称。

DdosIpAvailable

购买Ddos IP资源区域。

名称	类型	描述
zoneId	String	Ddos IP所属的可用区ID。
status	String	Ddos IP是否售卖。 取值范围： SELL：表示Ddos IP可购买，且库存>10台。 SELL_SHORTAGE: 表示可购买，但是库存<10台。 SOLD_OUT：表示Ddos IP已售罄。

InstanceAvailableDdosIp

Ddos IP信息。

名称	类型
ddosIpId	String	一个Ddos IP ID。 可通过DescribeDdosIpAddresses接口返回值中的ddosIpId获取。
ipAddress	String	IP地址。

Price

价格。描述了购买资源的预付费或后付费价格信息。

名称	类型	描述
originalPrice	Float	预付费的原价。 预付费模式使用，后付费该值为 null。
discountPrice	Float	预付费的折扣价。 预付费模式使用，后付费该值为 null。
discount	Float	折扣大小。 如80.0代表8折。
unitPrice	Float	后付费的单元原始价格。 后付费模式使用，如果价格为阶梯价格，该项为null。
discountUnitPrice	Float	后付费的单元折后价格。 后付费模式使用，如果价格为阶梯价格，该项为null。
chargeUnit	String	后付费计价单元。 后付费模式使用，可取值范围： HOUR: 表示计价单元是按每小时来计算。 DAY: 表示计价单元是按天来计算。 MONTH: 表示计价单元是按月来计算，95计费则是这种。
stepPrices	Array of StepPrice	后付费阶梯价格。 后付费模式使用，如果非阶梯价格，该项为null。

StepPrice

后付费阶梯价格。描述了价格的一个阶梯的信息。

名称	类型	描述
stepStart	Float	阶梯用量的开始。
stepEnd	Float	阶梯用量的结束。
unitPrice	Float	当前阶梯的单元原始价格。 后付费模式使用。
discountUnitPrice	Float	当前阶梯的单元折后价格。 后付费模式使用。

ImageInfo

镜像相关信息。

名称	类型	描述
imageId	String	镜像ID。
imageName	String	镜像名称。
catalog	String	镜像所属分类。 可能值： centos windows ubuntu debian esxi
imageType	String	镜像类型。 PUBLIC_IMAGE: 公共镜像。 CUSTOM_IMAGE：自定义镜像。 目前不支持自主的创建自定义镜像，可联系support沟通。
osType	String	操作系统类型。 可能值： windows linux

InstanceInfo

实例相关信息。

名称	类型	描述
instanceId	String	实例唯一ID。
zoneId	String	实例所属的可用区ID。
instanceName	String	实例显示名称。
hostname	String	实例的主机名。
instanceTypeId	String	实例机型ID。
imageId	String	镜像ID。
imageName	String	镜像名称。
ipxeUrl	String	IpxeUrl。
instanceChargeType	String	实例计费类型。 PREPAID：预付费，即包年包月。 POSTPAID：后付费。
bandwidthOutMbps	Integer	公网出口带宽。 单位：Mbps。 0 代表无限制，但是不会超过机型的最大上限。
internetChargeType	String	网络计费类型。 取值范围请看InternetChargeType。
period	Integer	购买实例的时长。 单位：月。 后付费实例该字段为null。
publicIpAddresses	Array of String	实例公网IPv4列表。 如果机器的主IP未加入到公网组网接口，那么主IP将无法使用，且该字段也不会返回该IP。
privateIpAddresses	Array of String	实例内网IP列表。
ipv6Addresses	Array of String	实例的IPv6地址。 注意：此字段可能返回null，表示取不到有效值。
subnetIds	Array of String	实例所属的内网组网ID列表。
createTime	Timestamp	创建时间。 格式为：YYYY-MM-DDThh:mm:ssZ。
expiredTime	Timestamp	到期时间。 格式为：YYYY-MM-DDThh:mm:ssZ。
resourceGroupId	String	实例所属资源组的ID。
resourceGroupName	String	实例所属资源组的名称。
instanceStatus	String	实例状态。 状态类型详见实例状态。
primaryPublicIpAddress	String	实例的母IP。
trafficPackageSize	Float	流量包订购大小。 单位为TB。
raidConfig	RaidConfig	磁盘阵列配置。
partitions	Array of Partition	分区配置。
nic	Nic	网卡配置。
autoRenew	Boolean	是否自动续费。 对于预付费实例，取消订阅后，该字段值将返回 false

EipStatus

EIP状态。

状态值	状态说明
CREATING	创建中
CREATE_FAILED	创建失败
ASSOCIATING	绑定中
UNASSOCIATING	解绑中
ASSOCIATED	已分配
AVAILABLE	可用
RECYCLING	回收中
RECYCLE	在回收站中

DdosIpStatus

Ddos IP状态。

状态值	状态说明
CREATING	创建中
CREATE_FAILED	创建失败
ASSOCIATING	绑定中
UNASSOCIATING	解绑中
ASSOCIATED	已分配
AVAILABLE	可用
RECYCLING	回收中
RECYCLE	在回收站中

CidrBlockInfo

名称	类型	描述
cidrBlockId	String	Cidr Block唯一ID。
cidrBlockType	String	CIDR的类型。 取值范围：IPV4、IPV6。
cidrBlockName	String	Cidr Block名称。
zoneId	String	Cidr Block所属的可用区ID。
cidrBlock	String	CIDR。
gateway	String	网关地址。
availableIpStart	String	可用IP的开头。
availableIpEnd	String	可用IP的结尾。
availableIpCount	Integer	可用IP的数量。
instanceIds	Array of String	已绑定的实例ID列表。
status	String	Cidr Block状态。
chargeType	String	计费类型。 PREPAID：预付费，即包年包月。 POSTPAID：后付费。
createTime	Timestamp	创建时间。 格式为：YYYY-MM-DDThh:mm:ssZ。
expireTime	Timestamp	到期时间。 格式为：YYYY-MM-DDThh:mm:ssZ。
resourceGroupId	String	所属资源组的ID。
resourceGroupName	String	所属资源组的名称。

CidrBlockStatus

Cidr Block的状态。

状态值	状态说明
CREATING	创建中
CREATE_FAILED	创建失败
RECYCLING	回收中
RECYCLE	在回收站中
AVAILABLE	可用

AvailableIpv4Resource

可用的Ipv4 Cidr Block资源。

名称	类型	描述
zoneId	String	Cidr Block所属的可用区ID。
netmask	Integer	掩码。
sellStatus	String	售卖的状态。 SELL：表示实例可购买，且库存>10。 SELL_SHORTAGE: 表示可购买，但是库存<10台。 SOLD_OUT：表示实例已售罄。

AvailableIpv6Resource

可用的Ipv6 Cidr Block资源。

名称	类型	描述
zoneId	String	Cidr Block所属的可用区ID。
sellStatus	String	售卖的状态。 SELL：表示实例可购买，且库存>10。 SELL_SHORTAGE: 表示可购买，但是库存<10台。 SOLD_OUT：表示实例已售罄。

InstanceAvailableCidrBlock

实例可用的Cidr Block。

名称	类型	描述
cidrBlockId	String	Cidr Block唯一ID。
zoneId	String	Cidr Block所属的可用区ID。
cidrBlockIpType	String	CIDR的类型。 取值范围：IPV4、IPV6。
cidrBlock	String	CIDR。
availableIps	Array of String	可用的IP列表。
availableIpCount	Integer	可用的IP数量。

CidrBlockIp

名称	类型	描述
cidrBlockId	String	Cidr Block唯一ID。
cidrBlockType	String	CIDR的类型。 取值范围：IPV4、IPV6。
ip	String	IP。
instanceId	String	绑定的实例ID。
status	String	IP的状态。

CidrBlockIpStatus

Cidr Block的IP状态。

状态值	状态说明
BOUND	已绑定
BINDING	绑定中
UNBINDING	解绑中
AVAILABLE	可用

VpcRegionInfo

VPC 节点的信息。

名称	类型	描述
vpcRegionId	String	VPC的节点ID。
vpcRegionName	String	VPC的节点名称。
zoneIds	Array of String	Zone ID 列表。

VpcInfo

Vpc Info的信息。

名称	类型	描述
vpcId	String	VPC唯一ID。
vpcRegionId	String	VPC的节点ID。
vpcRegionName	String	VPC的节点名称。
vpcName	String	VPC的名称。
cidrBlock	String	VPC的CIDR。
createTime	Timestamp	创建时间。 格式为：YYYY-MM-DDThh:mm:ssZ。
resourceGroupId	String	资源组ID。
resourceGroupName	String	资源组名称。
vpcStatus	String	VPC的状态。

VpcStatus

Vpc 状态。

状态值	状态说明
CREATING	创建中
CREATE_FAILED	创建失败
AVAILABLE	可用
DELETING	删除中

SubnetStatus

Subnet 状态。

状态值	状态说明
CREATING	创建中
CREATE_FAILED	创建失败
AVAILABLE	可用
DELETING	删除中

VpcSubnetStatus

Vpc subnet状态。

状态值	状态说明
BOUND	已绑定
BINDING	绑定中

SubnetInfo

Subnet Info的信息。

名称	类型	描述
subnetId	String	Subnet唯一ID。
subnetName	String	Subnet的名称。
zoneId	String	Subnet所属的可用区ID。
availableIpCount	Integer	Subnet下可用的IP数量。
cidrBlock	String	Subnet的CIDR。
subnetStatus	String	Subnet的状态。
createTime	Timestamp	创建时间。按照ISO8601标准表示，并且使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。
vpcSubnetStatus	String	VPC与Subnet的绑定状态。
vpcId	String	VPC唯一ID。
vpcName	String	VPC的名称。
resourceGroupId	String	资源组ID。
resourceGroupName	String	资源组名称。
subnetInstanceSet	Array of SubnetInstance	Subnet下实例集合。

SubnetInstance

Subnet Instance信息。

名称	类型	描述
instanceId	String	实例ID。
privateIpAddress	String	私网IP。
privateIpStatus	String	私网IP与实例的绑定状态。

PrivateIpStatus

状态值	状态说明
BOUND	已绑定
BINDING	绑定中
UNBINDING	解绑中

IpBindParam

Cidr Block Ip绑定参数。

名称	类型	描述
instanceId	String	实例ID。
ip	String	IP。 可通过DescribeInstanceAvailableCidrBlock接口返回值中的availableIps获取。

AssociateSubnetInstance

Subnet绑定实例。

名称	类型	描述
instanceId	String	实例ID。
privateIpAddress	String	内网IPv4地址。该地址必须在子网的CIDR范围内。 如果不指定内网地址，系统会会寻找CIDR中未用的内网地址下发到实例。

InstanceTrafficData

实例带宽数据。

名称	类型	描述
internetRX	Integer	入口带宽。单位：bps。
internetTX	Integer	出口带宽。单位：bps。
time	String	数据时间。 格式为：YYYY-MM-DDThh:mm:ssZ。

InstanceHealth

实例状态信息。

名称	类型	描述
instanceId	String	实例ID。
cpuStatus	String	CPU状态。 OK：硬件状态正常。 WARNING：硬件原生告警。 UNKNOWN：数据未采集到。
diskStatus	String	Disk状态。 OK：硬件状态正常。 WARNING：硬件原生告警。 UNKNOWN：数据未采集到。
ipmiPing	String	Ipmi IP状态。 OK：ICMP探测正常。 CRITICAL：ICMP探测失败。 UNKNOWN：数据未采集到。
ipmiStatus	String	Ipmi状态。 OK：ICMP探测正常。 WARNING：硬件原生告警。 UNKNOWN：数据未采集到。
memoryStatus	String	Memory状态。 OK：硬件状态正常。 WARNING：硬件原生告警。 UNKNOWN：数据未采集到。
psuStatus	String	Power Supply状态。 OK：硬件状态正常。 WARNING：硬件原生告警。 UNKNOWN：数据未采集到。
wanPortStatus	String	服务器公网口连接的交换机端口的状态。 OK：硬件状态正常。 WARNING：硬件原生告警。 UNKNOWN：数据未采集到。
fanStatus	String	风扇状态。 OK：硬件状态正常。 WARNING：硬件原生告警。 UNKNOWN：数据未采集到。
serverBrand	String	服务器供应商品牌。
serverModel	String	服务器供应商型号。
cpuTemp	Integer	超微 Supermicro 对于刀片机单 CPU 的温度，范围[0-100]，为空代表取不到值。
cpu0Temp	Integer	CPU0 的温度，范围[0-100]，为空代表取不到值。
cpu1Temp	Integer	CPU1 的温度，范围[0-100]，为空代表取不到值。
cpu2Temp	Integer	CPU2 的温度，范围[0-100]，为空代表取不到值。
inletTemp	Integer	进入服务器的空气温度，可简单认为是服务器所在机房的温度。
tempUnit	String	温度单位，目前只有Celsius，即摄氏温度。