数据结构

ChargePrepaid

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

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

ZoneInfo

名称	类型	描述
zoneId	String	区域ID。
zoneName	String	区域名称。
supportSecurityGroup	Boolean	是否支持安全组。
supportNetworkType	String	支持的网络类型。CLASSICS：经典网络。VPC: VPC网络。

InstanceStatus

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

名称	类型	描述
instanceId	String	实例ID。
instanceStatus	String	实例状态。取值范围见实例状态表

InternetChargeType

网络计费类型。

类型	说明
ByBandwidth	按固定带宽计费
ByTrafficPackage	购买流量包计费
ByClusterBandwidth95	城市合并95计费
BandwidthCluster	大区合并95计费

DiskWithInstance

随机器创建的数据盘信息。

名称	类型	描述
instanceId	String	实例ID。
diskIdSet	Array of String	随机器创建的数据盘ID集合。

InstanceInfo

实例相关信息。

名称	类型	描述
instanceId	String	实例唯一ID。
zoneId	String	实例所属的可用区ID。
instanceName	String	实例显示名称。
instanceType	String	实例机型ID。
cpuCount	Integer	cpu核数，单位：核
memory	Integer	实例内存容量，单位：iGB
imageId	String	镜像ID。
imageName	String	镜像名称。
instanceChargeType	String	实例计费类型。 PREPAID：预付费，即包年包月。 POSTPAID：后付费。
internetMaxBandwidthOut	Integer	公网出口带宽。 单位：Mbps。 0 代表无限制，但是不会超过机型的最大上限。
internetChargeType	String	网络计费类型。 取值范围请看InternetChargeType。
period	Integer	购买实例的时长。 单位：月。 后付费实例该字段为null。
publicIpAddresses	Array of String	实例公网IPv4列表。 如果机器的主IP未加入到公网组网接口，那么主IP将无法使用，且该字段也不会返回该IP。
privateIpAddresses	Array of String	实例内网IP列表。
subnetId	String	实例所属的内网子网ID。
createTime	Timestamp	创建时间。 格式为：YYYY-MM-DDThh:mm:ssZ。
expiredTime	Timestamp	到期时间。 格式为：YYYY-MM-DDThh:mm:ssZ。
resourceGroupId	String	实例所属资源组的ID。
resourceGroupName	String	实例所属资源组的名称。
instanceStatus	String	实例状态。 状态类型详见实例状态。
trafficPackageSize	Float	流量包订购大小。 单位为TB。
securityGroupIds	Array of String	实例加入的安全组列表。
systemDisk	SystemDisk	实例系统盘信息。
dataDisks	Array of DataDisk	实例数据盘信息。
autoRenew	Boolean	是否自动续费。 对于预付费实例，取消订阅后，该字段值将返回false
keyId	String	密钥ID。 注意：此字段可能返回 null，表示取不到有效值。

KeyPair

描述了密钥对的基本信息。

名称	类型	描述
keyId	String	密钥对ID。 示例值：key-xxxxxxxx。
keyName	String	密钥对名称。
publicKey	String	密钥对的公钥内容。 OpenSSH 格式。 示例值：ssh-rsa XXXXXXXXXXXX key_xxx
keyDescription	String	密钥对描述信息。
createTime	Timestamp	创建时间。 格式为：YYYY-MM-DDTHH:mm:ssZ。

SystemDisk

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

名称	类型	必选	描述
diskId	String	否	系统盘ID。 该参数目前仅用于DescribeInstances等查询类接口的返回参数，不可用于CreateInstances等写接口的入参
diskSize	Integer	是	系统盘大小。 单位：GiB。
diskCategory	String	否	云硬盘种类。 STANDARD: 标准云盘 SSD: 固态硬盘 默认为STANDARD。

DataDisk

描述了数据盘的信息。

名称	类型	必选	描述
diskId	String	否	数据盘ID。 该参数目前仅用于DescribeInstances等查询类接口的返回参数，不可用于CreateInstances等写接口的入参
diskSize	Integer	是	数据盘大小。 单位：GiB。
diskName	String	否	云盘的名称。 该参数目前仅用于DescribeInstances等查询类接口的返回参数。
diskCategory	String	否	云硬盘种类。 STANDARD: 标准云盘 SSD: 固态硬盘 默认为STANDARD。
portable	Boolean	否	是否可拆卸。 该参数仅用于查询的回参，不用于入参。 true代表不会随着实例删除而删除。 false代表会随着实例删除而删除。
diskAmount	Integer	否	数据盘数量。 该参数仅用于CreateInstances、 InquiryPriceCreateInstance等接口的入参使用。
diskPrice	Price	否	数据盘价格。 该参数仅用于InquiryPriceCreateInstance 接口的返回参数。

InstanceTypeQuotaItem

描述实例机型配额信息。

名称	类型	描述
zoneId	String	可用区ID。
instanceType	String	实例机型。
cpuCount	Integer	实例的CPU核数。 单位：核。
memory	Integer	实例内存容量。 单位：GiB。
frequency	String	实例的CPU主频信息。
internetMaxBandwidthOutLimit	Integer	最大出口带宽限制。
instanceTypeName	String	实例机型名称。
internetChargeTypes	Array of String	支持的网络计费类型。 取值范围请看 InternetChargeType

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	当前阶梯的单元折后价格。 后付费模式使用。

InstanceStatusValue

实例的状态。

状态值	状态说明
PENDING	待创建
DEPLOYING	创建中
CREATE_FAILED	创建失败
REBUILDING	重建中
RUNNING	运行中
STOPPED	关机
BOOTING	启动中
STOPPING	关机中
RELEASING	释放中
RECYCLING	正在回收
RECYCLE	在回收站中
RESIZING	变配中
IMAGING	镜像制作中

ImageInfo

镜像相关信息。

名称	类型	描述
imageId	String	镜像ID。
imageName	String	镜像名称。
imageType	String	镜像类型。 PUBLIC_IMAGE: 公共镜像。 CUSTOM_IMAGE: 自定义镜像。
imageSize	String	镜像大小，单位为GB。
imageDescription	String	镜像描述。
imageVersion	String	镜像版本。
imageStatus	String	镜像状态。 CREATING-创建中。 AVAILABLE-可用。 UNAVAILABLE-不可用。
category	String	镜像所属分类。 可能值： CentOS Windows Ubuntu Debian
osType	String	操作系统类型。 可能值： windows linux

ImageQuotaInfo

镜像的配额信息

名称	类型	描述
zoneId	String	支持创建镜像的区域。
count	Integer	当前已配置镜像数。
maxCount	Integer	本区域可配置的最大镜像数。

DiskInfo

云硬盘信息，包含系统盘和数据盘的大小、类别等信息。

名称	类型	描述
diskId	String	云硬盘ID。
diskName	String	云硬盘名称。
zoneId	String	云盘所属区域。
diskType	String	云盘类型。 SYSTEM-系统盘。 DATA-数据盘。
portable	Boolean	是否可拔插。
diskCategory	String	云硬盘种类。 STANDARD: 标准云盘 SSD: 固态硬盘
diskSize	Integer	云盘大小，单位GB。
diskStatus	String	云盘状态。 取值范围详见：DiskStatus
instanceId	String	所绑定的实例ID。
instanceName	String	所绑定的实例名字。
chargeType	String	付费类型。 PREPAID-预付费。 POSTPAID-后付费。
createTime	Timestamp	创建时间。 格式为：YYYY-MM-DDThh:mm:ssZ。
expiredTime	Timestamp	到期时间。 格式为：YYYY-MM-DDThh:mm:ssZ。
period	Integer	购买实例的时长。 单位：月。 后付费实例该字段为null。
autoRenew	Boolean	是否自动续费。 对于预付费实例，取消订阅后，该字段值将返回 false

DiskStatus

描述云硬盘的状态信息。

状态值	状态说明
IN_USE	使⽤中
AVAILABLE	待挂载
ATTACHING	正在挂载
DETACHING	正在卸载
CREATING	创建中
DELETING	释放中
RECYCLING	正在回收
RECYCLED	在回收站中

diskCategory

云硬盘类别信息。

名称	类型	描述
zoneId	String	区域ID。
categorySet	Array of String	支持的云盘类别。

SecurityGroupInfo

描述安全组信息，包括名称创建

名称	类型	描述
securityGroupId	String	安全组ID。
securityGroupName	String	安全组名称。
securityGroupStatus	String	安全组状态。
createTime	Timestamp	创建时间。 格式为：YYYY-MM-DDThh:mm:ssZ。
description	String	安全组描述。
instanceIds	Array of String	已绑定实例ID集合。
ruleInfos	Array of RuleInfo	安全组规则。
isDefault	Boolean	是否默认。

SecurityGroupStatus

安全组的状态信息。

状态值	状态说明
Available	可用
Fail	失败

RuleInfo

安全组规则信息，包括出入方向、端口范围、IP协议等信息。

名称	必选	类型	描述
direction	是	String	规则方向。 ingress: 入方向 egress：出方向
policy	否	String	设置访问权限。取值范围： accept（默认值）：接受访问。 目前只支持accept。
ipProtocol	是	String	传输层协议。取值大小写敏感。取值范围： tcp：TCP协议。 udp：UDP协议。 icmp：ICMP协议。 all：支持所有协议。
portRange	是	String	目的端安全组开放的传输层协议相关的端口范围。取值范围： TCP/UDP协议：取值范围为1~65535。使用斜线（/）隔开起始端口和终止端口。正确示范：1/200；错误示范：200/1。 ICMP协议：-1/-1。 all： -1/-1。
cidrIp	是	String	源端IP地址范围。支持CIDR格式和IPv4格式的IP地址范围。默认值：0.0.XX.XX/0。

InstanceAvailableSecurityGroup

名称	类型	描述
securityGroupId	String	安全组ID。
securityGroupName	String	安全组名称。
isDefault	Boolean	安全组是否默认。

SubnetInfo

描述私有网络子网的基本信息，包括名称、CIDR、实例ID等。

名称	类型	描述
subnetId	String	Subnet的Id。
zoneId	String	Subnet的机房Id。
subnetName	String	Subnet的名称。
subnetStatus	String	Subnet的状态。 取值范围详见：SubnetStatus
subnetDescription	String	Subnet的描述信息。
cidrBlock	String	Subnet的CIDR。
cidrBlockList	Array of String	Subnet的CIDR列表。
usageIpCount	Integer	Subnet的已用IP数。
totalIpCount	Integer	Subnet的总IP数。
createTime	Timestamp	Subnet的创建时间。
instanceIdList	Array of String	Subnet下绑定的实例列表。
isDefault	Boolean	Subnet是否为默认。

VpcNetworkInfo

VPC网络的信息

名称	类型	描述
vpcId	String	VPC的ID。
zoneId	String	VPC的机房Id。
vpcName	String	VPC的名称。
vpctStatus	String	VPC的状态。
cidrBlock	String	VPC的CIDR。
subnetIdList	Array of String	VPC的Subnet列表。
createTime	String	VPC的创建时间。
isDefault	Boolean	VPC是否默认。

VpcSubnetInfo

VPC子网的信息

名称	类型
subnetId	String	Subnet的ID。
vpcId	String	Subnet所属VPC的ID。
subnetName	String	Subnet的名称。
subnetStatus	String	Subnet的状态。
cidrBlock	String	Subnet的CIDR。
instanceIdList	Array of String	Subnet 下绑定的实例列表。
createTime	String	Subnet的创建时间。
usageIpCount	Integer	Subnet 的已用IP数。
totalIpCount	Integer	Subnet 的总IP数。
isDefault	Boolean	Subnet 是否默认。

NetworkStatus

私有网络的状态。

状态值	状态说明
Creating	创建中
Available	可用
Failed	失败

SubnetStatus

私有网络的子网的状态。

状态值	状态说明
Creating	创建中
Available	可用
Failed	失败

VpcStatus

vpc网络的状态

状态值	状态说明
Pending	创建中
Available	可用
Fail	失败
Deleting	删除中

VpcSubnetStatus

vpc网络子网的状态

状态值	状态说明
Pending	创建中
Available	可用
Fail	失败
Deleting	删除中

InstanceTrafficData

实例带宽数据。

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

InstanceCpuMonitorData

实例cpu使用率。

名称	类型	描述
cpu	String	cpu利用率。单位小数。
time	String	数据时间。 格式为：YYYY-MM-DDThh:mm:ssZ。