帮你快速理解、总结文档立即下载

数据结构

最近更新时间:2026-09-17 17:29:18
我的收藏

FailedInstance

操作失败的实例信息

被如下接口引用:TerminateInstances。

名称 类型 描述
InstanceId String 实例ID。
示例值:bms-abcd1234
ErrorCode String 错误码。
示例值:UnsupportedOperation.InvalidInstanceState
ErrorMessage String 错误信息。
示例值:Instance bms-abcd1234 operate status is normal, cannot start

Instance

描述物理机实例信息

被如下接口引用:DescribeInstances。

名称 类型 描述
InstanceId String

实例ID


示例值:bms-abcd1234
InstanceName String

实例名称


示例值:my-epm-instance
MachineId String

绑定的物理机ID


示例值:srv-abcd1234
InstanceType String

机型规格


示例值:BM.S5.LARGE8
Zone String

可用区代码


示例值:ap-guangzhou-1
ImageId String

镜像ID


示例值:img-centos-7.9
InstanceStatus String

实例状态,可选值:allocating、running、isolating、isolated、terminating、error


示例值:running
OperateStatus String

操作状态,可选值:normal、starting、stopping、stopped、rebooting


示例值:normal
PrivateNetworkId String

私有网络ID


示例值:net-private-001
PrivateIp String

私有IPv4地址


示例值:10.0.0.1
PrivateIpV6 String

私有IPv6地址


示例值:fd00::1
PublicNetworkId String

公网网络ID


示例值:net-public-001
PublicIp String

公网IPv4地址


示例值:203.0.113.10
PublicIpV6 String

公网IPv6地址


示例值:2001:db8::1
FileSystemType String

文件系统类型


示例值:ext3
CreatedTime Timestamp ISO8601

创建时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。


示例值:2026-01-13T10:00:00Z
InstanceFamily String

机型族标识


示例值:S
InstanceFamilyName String

机型族名称


示例值:标准型S5
CpuType String

CPU 型号


示例值:Intel Xeon Platinum 8255C
Cpu Integer

CPU 核数


示例值:8
Memory Integer

内存大小


示例值:32

InstanceTypeQuota

账号在可用区下的机型配额信息,包含可用区、机型详情和配额数量。

被如下接口引用:DescribeInstanceTypes。

名称 类型 描述
Zone String 可用区代码。
示例值:ap-guangzhou-1
InstanceType String 机型规格。
示例值:BMS5.MEDIUM8
InstanceFamily String 机型家族。
示例值:BM.S5
InstanceFamilyName String 机型族名称
示例值:标准型
CpuCores Integer CPU核数。
示例值:8
CpuType String CPU类型。
示例值:6231C*2
MemoryGb Integer 内存大小(GB)。
示例值:32
SystemDiskType String 系统盘类型。
示例值:SSD
SystemDiskSize Integer 系统盘大小(GB)。
示例值:480
SystemDiskCount Integer 系统盘数量。
示例值:2
DataDiskType String 数据盘类型。
示例值:SSD
DataDiskSize Integer 数据盘大小(GB)。
示例值:960
DataDiskCount Integer 数据盘数量。
示例值:4
SecondaryDataDiskType String 第二组数据盘类型
示例值:SSD
SecondaryDataDiskSize Integer 第二组数据盘大小(GB)
示例值:10
SecondaryDataDiskCount Integer 第二组数据盘数量
示例值:2
DiskType String 磁盘描述字符串(向后兼容)。
示例值:SSD-480G2, SSD-960G4
NetworkInterfaceType String 网络接口类型。
示例值:25G*2
GpuType String GPU类型,无GPU时为空字符串。
示例值:NVIDIA H20*8
Quota Integer 配额数量
示例值:10

IpInfo

公网Ip信息

被如下接口引用:DescribePublicIps。

名称 类型 必选 描述
Ip String 10.100.0.20
示例值:公网IP
NetworkInstanceId String epn-asdfghjkl
示例值:公网实例ID
InstanceId String epm-asdfghjkl
示例值:物理服务器实例ID
State String Unbound
示例值:IP使用状态状态,Unbound或InUse
Type String Ipv4
示例值:IP类型,Ipv4或Ipv6
CreatedAt String 2026-04-07T00:00:00
示例值:申请时间
UpdatedAt String 2026-04-07T00:00:00
示例值:更新时间

PrivateNetworkInstanceInfo

私网实例信息

被如下接口引用:DescribePrivateNetworkInstances。

名称 类型 描述
NetworkInstanceId String 私网实例ID
示例值:ein-a1b2c3d4
NetworkInstanceName String 私网实例名称
示例值:test-pri-instance
ZoneId String 可用区ID
示例值:ap-beijing
Network String 网络地址
示例值:10.0.0.0
Mask Integer 网络掩码
示例值:8
ServerCount Integer 关联物理机数量
示例值:10
AvailableIpCount Integer 可用Ip数量
示例值:255
CreatedAt String 创建时间
示例值:2026-04-07T00:00:00
UpdatedAt String 更新时间
示例值:2026-04-07T00:00:00

PublicNetworkInstanceInfo

公网实例信息,包含实例ID、可用区ID、实例名称、线路、路由模式等信息

被如下接口引用:DescribePublicNetworkInstances。

名称 类型 描述
NetworkInstanceId String 公网实例ID
示例值:epn-dfghjkl
ZoneId String 可用区ID
示例值:ap-beijing
NetworkInstanceName String 公网实例名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:北京测试公网实例
Bandwidth Integer 带宽,单位Mbps
注意:此字段可能返回 null,表示取不到有效值。
示例值:100
Line String 线路信息
示例值:BGP
RouteMode String 路由模式,枚举值:STATIC、BGP、OSPF
示例值:BGP
ServerCount Integer 关联的物理服务器数量
示例值:10
Ipv4Count Integer 已申请的Ipv4数量
示例值:10
Ipv6Count Integer 已申请的Ipv6数量
示例值:100
Ipv4CidrSet Array of PublicNetworkSegment 关联的Ipv4网段
注意:此字段可能返回 null,表示取不到有效值。
Ipv6CidrSet Array of PublicNetworkSegment 关联的Ipv6网段
注意:此字段可能返回 null,表示取不到有效值。
CreatedAt String 公网实例创建时间
示例值:2026-04-07T00:00:00
UpdatedAt String 公网实例修改时间
示例值:2026-04-07T00:00:00

PublicNetworkSegment

公网网段信息,包含网段cidr和网关ip

被如下接口引用:DescribePublicNetworkInstances。

名称 类型 描述
Cidr String 网段Cidr
示例值:224.16.14.0/24
Gateway String 网关Ip
示例值:224.16.14.1

SwitchData

交换机数据

被如下接口引用:DescribeZoneData。

名称 类型 描述
Time String UTC时间
示例值:2026-04-13T00:00:00Z
Value Float 统计值
示例值:1.11

ZoneInfo

跨地域聚合后的可用区信息。

被如下接口引用:DescribeZones。

名称 类型 描述
ZoneId Integer 可用区ID。
示例值:100001
Zone String 可用区代码。
示例值:ap-guangzhou-1
ZoneName String 可用区中文名称。
示例值:广州一区
ZoneNameEn String 可用区英文名称。
示例值:Guangzhou Zone 1
Region String 地域代码。
示例值:ap-guangzhou
Location String 区域代码。
示例值:asia_pacific_1
LocationName String 区域名称。
示例值:亚太1