数据结构

AutoSnapshotPolicy

描述自动快照策略的相关信息。

被如下接口引用:DescribeAutoSnapshotPolicies

参数名称
类型
描述

autoSnapshotPolicyId

String

自动快照策略ID。

zoneId

String

可用区ID。

autoSnapshotPolicyName

String

自动快照策略的名称。

repeatWeekDays

Array of Integer

自动快照的重复日期。

单位为天,周期为星期,例如 1 表示周一。

可选值范围:[1, 7]。

hours

Array of Integer

指定定期快照策略的触发时间。

使用 UTC 时间,单位为小时。

00:00 ~ 23:00 共 24 个时间点可选,1表示 01:00,依此类推。

可选值范围:[0, 23]。

retentionDays

Integer

自动快照的保留时间,单位为天。

如果该值设置-1,则代表永久保留。

可选值范围:[-, 65535]。

diskNum

Integer

关联的云盘数量。

createTime

String

策略创建时间。

resourceGroup

资源组信息。

diskIdSet

Array of String

关联的云盘ID。

BandwidthClusterInfo

描述带宽组的基本信息。

被如下接口引用:DescribeNetworkInterfacePublicIPv6, DescribeEips

参数名称
类型
描述

bandwidthClusterId

String

共享带宽包ID。

bandwidthClusterName

String

共享带宽包名称。

BindType

描述EIP绑定类型的值

被如下接口引用:ChangeEipBindType, CreateZecInstances, DescribeEips, AssociateEipAddress

值说明

FullNat

普通NAT模式。

Passthrough

高速模式。

CidrCreateSource

描述CIDR来源的值。

被如下接口引用:DescribeCidrs

值说明

CONSOLE

归属于Zenlayer创建的IP。

BYOIP

客户自带IP(bring your own IP)。

CidrInfo

CIDR信息详情。

被如下接口引用:DescribeCidrs

参数名称
类型
描述

cidrId

String

CIDR ID。

regionId

String

CIDR所属的区域节点ID。

name

String

CIDR的名称。

cidrBlock

String

CIDR地址块,例如:10.0.0.0/16。

totalCount

Integer

CIDR中IP地址的总数量。

usedCount

Integer

CIDR中已被使用的IP地址数量。

source

CIDR的来源。

如CONSOLE(属于zenlayer)或 BYOIP(客户自带IP)。

eipV4Type

EIP网络类型。

表示该CIDR支持的公网IP线路类型。

netmask

Integer

子网掩码。

表示CIDR的网络位长度。

poolId

String

Pool的ID。

表示该CIDR所属的公网IP池。

createTime

String

CIDR的创建时间。

expiredTime

String

CIDR的到期时间。

resourceGroupId

String

该CIDR所属的资源组。

resourceGroupName

String

该CIDR所属资源组的名称。

status

CIDR的状态。

CidrStatus

描述CIDR的状态值。

被如下接口引用:DescribeCidrs

值说明

CREATING

创建中。

AVAILABLE

正常可用。

RECYCLING

回收中。

RECYCLED

处于回收站。

DELETING

删除中。

FAILED

创建失败。

DataDisk

描述了数据盘的信息。

被如下接口引用:CreateZecInstances, DescribeInstances, InquiryPriceCreateInstance

参数名称
类型
必选
描述

diskId

String

数据盘ID。

该参数目前仅用于DescribeInstances等查询类接口的返回参数,不可用于CreateInstances等写接口的入参。

diskName

String

云盘的名称。

该参数目前仅用于DescribeInstances等查询类接口的返回参数。

diskSize

Integer

数据盘大小。

单位:GiB。

可选值范围:[1, +)。

diskAmount

Integer

数据盘数量。

该参数仅用于CreateInstances,InquiryPriceCreateInstance等接口的入参使用。

可选值范围:[1, +)。

默认值:1。

portable

Boolean

是否可拆卸。

该参数仅用于查询的回参,不用于入参。

true代表不会随着实例删除而删除。

false代表会随着实例删除而删除。

diskCategory

String

云硬盘种类。

Basic NVMe SSD: 经济型 NVMe SSD。

Standard NVMe SSD: 标准型 NVMe SSD。

默认为Standard NVMe SSD。

默认值:Standard NVMe SSD。

DescribeDiskCategoryItem

描述可用区支持的云盘类型的信息。

被如下接口引用:DescribeDiskCategory

参数名称
类型
描述

zoneId

String

可用区ID。

categorySet

Array of String

支持的云硬盘类型。

DiskInfo

描述云盘的基本信息。

被如下接口引用:DescribeDisks

参数名称
类型
描述

diskId

String

云盘的 ID。

diskName

String

云盘的名称。

regionId

String

云盘所在的节点ID。

zoneId

String

云盘所在节点的可用区ID。

diskType

云盘的类型。

portable

Boolean

是否可卸载。

diskCategory

String

云盘的类别。

diskSize

Integer

云盘的大小。

单位:GiB。

diskStatus

云盘的状态。

instanceId

String

云盘绑定实例的ID。

instanceName

String

云盘绑定实例的名称。

createTime

String

创建时间。

expiredTime

String

到期时间。

period

Integer

周期。

resourceGroupId

String

云盘所属的资源组ID。

resourceGroupName

String

云盘所属的资源组名称。

serial

String

云盘序号。

可能为null,表示取不到值。

snapshotAbility

Boolean

是否具体快照能力。

autoSnapshotPolicyId

String

云盘关联的自动快照策略ID。

DiskStatus

描述云盘状态的值。

被如下接口引用:DescribeDisks

值说明

CREATING

创建中。

IN_USE

挂载使用中。

AVAILABLE

未挂载。

CHANGING

变更大小中。

ATTACHING

云盘挂载实例中。

DETACHING

云盘解绑实例中。

DELETING

销毁中。

RECYCLED

处于回收状态,等待销毁。

RECYCLING

回收中。

FAILED

创建失败。

SNAPSHOT_CREATING

快照创建过程中。

ROLLING_BACK

云盘使用快照回滚过程中。

DiskType

描述云盘的类型的值。

被如下接口引用:DescribeSnapshots, DescribeDisks

值说明

SYSTEM

代表系统盘。

DATA

代表数据盘。

DiskWithInstance

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

被如下接口引用:CreateZecInstances

参数名称
类型
描述

instanceId

String

实例ID。

diskIdSet

Array of String

随机器创建的数据盘ID集合。

DnatEntry

描述DNAT规则的信息。

被如下接口引用:DescribeNatGatewayDetail

参数名称
类型
描述

dnatEntryId

String

DNAT规则 ID。

status

String

DNAT规则状态。

privateIp

String

DNAT规则的内网IP地址。

eipId

String

DNAT规则添加的eip ID。

protocol

DNAT规则的协议类型。

listenerPort

String

DNAT规则端口转发的外部端口或端口段,取值范围1-65535。

internalPort

String

DNAT规则端口转发的内部端口或端口段,取值范围1-65535。

DnatEntryProtocol

Dnat规则协议。

被如下接口引用:CreateDnatEntry, DescribeNatGatewayDetail, ModifyDnatEntry

值说明

TCP

TCP 协议。

UDP

UDP 协议。

Any

Any 所有协议。

EipBindResourceType

EIP 绑定的资源类型说明。

被如下接口引用:DescribeEips

值说明

NIC

网卡类型。

NAT

NAT网关类型。

LB

负载均衡类型。

EipGeoInfo

基于DB-IP/ipdata/... 第三方IP数据库服务商查询到的 IP 地理信息结果。

被如下接口引用:DescribeEips

参数名称
类型
描述

dbIp

String

从DB-IP(db-ip.com)查询的地理信息。

ipData

String

从ipData(ipdata.co)查询的地理信息。

ipInfo

String

从IPinfo(ipinfo.io)查询的地理信息。

maxMind

String

从MaxMind查询的地理信息。

standard

String

需要查询EIP的所在的地理信息。

isConsistent

Boolean

查询地理信息是否和所在的地理信息一致。

EipInfo

描述公网弹性IP的基本信息,包括IPv4地址,IP绑定的关系。

被如下接口引用:DescribeEips

参数名称
类型
描述

eipId

String

EIP 的唯一 ID。

name

String

EIP 的名称。

regionId

String

节点ID。

peerRegionId

String

对端节点ID。

仅当IP为Remote IP时该字段有效。

isDefault

Boolean

是否是默认类型。

status

EIP 的状态。

publicIpAddresses

Array of String

公网IP地址。

privateIpAddress

String

EIP 绑定的内网IP地址。

eipV4Type

String

EIP 的类型。

internetChargeType

EIP 的网络计费方式。

cidrId

String

EIP 来自的CIDR地址段ID。

nicId

String

EIP 关联的网卡ID。

该字段已废弃,请使用 associatedId 字段。

associatedId

String

EIP 绑定的资源ID。

可能为实例ID、网卡ID或者NAT网关ID。

associatedType

EIP 资源类型。

可能为实例ID、网卡ID或者NAT网关ID。

bindType

EIP 绑定类型。

flowPackage

Float

EIP 流量包大小。

仅当网络计费方式为流量计费时可取到值。

该字段可能为null。

bandwidth

Integer

EIP 的带宽限速。

单位为Mbps。

eipGeoRefs

Array of EipGeoInfo

EIP 的地理位置信息。

createTime

String

EIP 的创建时间。

expiredTime

String

EIP 的到期时间。

该字段可能为null。

resourceGroupId

String

EIP 关联的资源组ID。

resourceGroupName

String

EIP 关联的资源组名称。

bandwidthCluster

EIP 关联的带宽组ID。

EipIsp

描述IP运营商的信息。

被如下接口引用:CreateEips

值说明

CHINA_MOBILE

中国移动。

CHINA_UNICOM

中国联通。

CHINA_TELECOM

中国电信。

EipMetricValue

描述EIP的监控指标数据。

被如下接口引用:DescribeEipMonitorData

参数名称
类型
描述

time

String

数据点时间。

inValue

Float

入方向值。

outValue

Float

入方向值。

loseIn

Float

丢失入方向值。

loseOut

Float

丢失出方向值。

EipMonitorMeta

描述EIP监控类型的值

被如下接口引用:DescribeEipMonitorData

值说明

BANDWIDTH

带宽类型。

单位bps。

PACKETS

数据包类型。

单位pps。

EipNetworkType

描述弹性IP的网络线路信息。

被如下接口引用:CreateEips, DescribeEipPrice, CreateZecInstances, CreateCidr, DescribeEipRemoteRegions, InquiryPriceCreateInstance, DescribeEipInternetChargeTypes, DescribeCidrs, DescribeCidrPrice

值说明

BGPLine

BGP 线路。

CN2Line

CN2 回国优化线路。

LocalLine

本地IP。

ChinaMobile

中国移动线路。

ChinaUnicom

中国联通线路。

ChinaTelecom

中国联通线路。

Cogent

Cogent。

ThreeLine

三线IP。

EipStatus

描述EIP的状态值。

被如下接口引用:DescribeEips

值说明

CREATING

创建过程中。

DELETING

删除过程中。

ASSIGNING

绑定过程中。

BINDED

已绑定资源状态。

RECYCLING

回收状态中。

RECYCLED

处于回收站中。

UNBIND

未绑定状态中。

CREATE_FAILED

创建失败的。

EipTrafficData

描述IP带宽的数据点信息。包括出/入方向的带宽。

被如下接口引用:DescribeEipTraffic

参数名称
类型
描述

internetRX

Integer

入方向带宽值。

单位:bps。

internetTX

Integer

出方向带宽值。

单位:bps。

time

String

数据时间。

按照ISO8601标准表示,并且使用UTC时间。

格式为:YYYY-MM-ddTHH:mm:ssZ。

IPv6Type

描述IPv6的公网或内网类型。

被如下接口引用:CreateSubnet, ModifySubnetStackType

值说明

Private

内网类型。

Public

公网类型。

Image

描述镜像的基本信息。

被如下接口引用:DescribeImages

参数名称
类型
描述

imageId

String

镜像ID。

imageName

String

镜像的名称。

imageType

镜像的类型。

imageSize

String

镜像的大小。

imageDescription

String

镜像描述信息。

imageVersion

String

镜像的版本。

imageStatus

镜像的状态。

nicNetworkType

镜像支持的网卡类型。

category

镜像的分类。

osType

操作系统类型。

ImageCategory

描述镜像分类的值。

被如下接口引用:DescribeImages

值说明

Ubuntu

Ubuntu。

Debian

Debian。

RockyLinux

Rocky。

CentOS

CentOS。

Fedora

Fedora。

FreeBSD

FreeBSD。

AlpineLinux

Alpine。

ArchLinux

ArchLinux。

AlmaLinux

AlmaLinux。

openSUSE

openSUSE。

Gentoo

Gentoo。

Windows

Windows。

Generic

Generic。

OracleLinux

OracleLinux。

TencentOS

TencentOS。

OTHERS

其他。

ImageOsType

描述操作系统类型。

被如下接口引用:DescribeImages

值说明

linux

Linux操作系统。

bsd

BSD操作系统。

windows

Windows操作系统。

android

Android操作系统。

any

任意类型。

ImageSourceType

描述镜像来源的值。

被如下接口引用:DescribeImages

值说明

PUBLIC_IMAGE

公共镜像。

CUSTOM_IMAGE

自定义镜像。

ImageStatus

描述镜像状态的值。

被如下接口引用:DescribeImages

值说明

CREATING

镜像创建中。

AVAILABLE

镜像创建成功。

UNAVAILABLE

镜像下架。

FAILED

镜像创建失败。

DELETING

镜像释放中。

PROCESSING

镜像进行中。

InstanceApiMonitorMeta

描述实例监控类型的值

被如下接口引用:DescribeInstanceMonitorData

值说明

CPU_UTILIZATION

CPU 利用率。

单位百分比。

HYPERVISOR_IO_WAIT_TIME

虚拟化层 I/O 等待时间。

单位百分比。

HYPERVISOR_QUEUE_TIME

虚拟化层 CPU 队列时间。

单位百分比。

PROC_CPU_USER

CPU 用户态的比例类型。

单位百分比。

PROC_CPU_SYSTEM

CPU 内核态的比例类型。

单位百分比。

PROC_CPU_IOWAIT

CPU IOWAIT的比例类型。

单位百分比。

PROC_CPU_SOFTIRQ

CPU SOFTIRQ的比例类型。

单位百分比。

PROC_CPU_IDLE

CPU 空闲的比例类型。

单位百分比。

PROC_CPU_OTHER

CPU 其他的比例类型。

单位百分比。

PROC_CPU_ALL

CPU 总览的比例类型。

单位百分比。

LOAD1

系统负载平均值 - 最近 1 分钟。

LOAD5

系统负载平均值 - 最近 5 分钟。

LOAD15

系统负载平均值 - 最近 15 分钟。

MEM_UTIL

利用率。

单位百分比。

REALMEM_UTIL

真实利用率。

单位百分比。

TCP_ESTABLISHED

TCP连接数。

单位个。

SWAP_TOTAL

虚拟机系统配置的swap总容量。

用于评估系统支持的最大交换空间容量。

单位KiB。

SWAP_FREE

当前剩余可用的swap空间大小。

用于评估交换区剩余可用资源。

单位KiB。

SWAP_IN

系统启动以来从swap空间读入内存的页面总数 单位页。

SWAP_OUT

系统启动以来从内存写入swap空间的页面总数 单位页。

KSWAPD_STEAL

由kswapd内核线程回收的页面总数 单位页。

KSWAPD_LHWM

kswapd刚完成内存回收后,系统快速再次触发低水位线的次数。

单位次。

RX_PACKETS

虚拟机VF网卡的每秒接收包量。

单位Packets。

TX_PACKETS

虚拟机VF网卡的每秒发送包量。

单位Packets。

RX_DROPPED

该Nic的VF网卡+Virtio网卡入方向相加的每秒丢包数量。

单位Packets。

TX_DROPPED

该Nic的VF网卡+Virtio网卡出方向相加的每秒丢包数量。

单位Packets。

RX_ERRORS

该Nic的VF网卡+Virtio网卡入方向相加的每秒错误包数量。

单位Packets。

TX_ERRORS

该Nic的VF网卡+Virtio网卡出方向相加的每秒错误包数量。

单位Packets。

InstanceInfo

描述虚拟机实例的信息。包括规格,状态,网卡等。

被如下接口引用:DescribeInstances

参数名称
类型
描述

instanceId

String

实例唯一ID。

instanceName

String

实例显示名称。

zoneId

String

实例所属的可用区ID。

instanceType

String

CPU 规格。

如果是GPU实例,该字段取值为null。

cpu

Integer

CPU 核数。

单位:个。

memory

Integer

内存容量。

单位:GiB。

imageId

String

镜像ID。

imageName

String

镜像名称。

timeZone

String

设置的系统时区信息。

nicNetworkType

网卡模式。

status

实例状态。

systemDisk

系统盘信息。

dataDisks

Array of DataDisk

实例上挂在的数据盘信息。

publicIpAddresses

Array of String

实例上公网IPv4列表。

privateIpAddresses

Array of String

实例上内网IP列表。

keyId

String

安装的SSH密钥ID。

subnetId

String

实例主网卡关联的子网ID。

enableAgent

Boolean

是否开启QGA Agent。

enableAgentMonitor

Boolean

是否开启QGA 监控采集。

enableIpForward

Boolean

是否开启IP转发。

createTime

String

创建时间。

expiredTime

String

到期时间。

resourceGroupId

String

实例所属的资源组ID。

resourceGroupName

String

实例所属的资源组名称。

nics

Array of NicInfo

实例上绑定的网卡信息。

InstanceStatus

描述实例状态的信息。

被如下接口引用:DescribeInstancesStatus

参数名称
类型
描述

instanceId

String

实例的ID。

instanceStatus

实例的状态。

InstanceStatusValue

描述实例状态的相关值。

被如下接口引用:DescribeInstancesStatus, DescribeInstances

值说明

DEPLOYING

创建部署中。

REBUILDING

重装系统中。

REBOOT

系统重启中。

RUNNING

运行开机。

STOPPED

已关机状态。

BOOTING

系统启动中。

RELEASING

实例释放中。

STOPPING

系统关机中。

RECYCLE

实例处于回收站。

RECYCLING

实例回收中。

CREATE_FAILED

创建失败。

IMAGING

镜像制作中。

RESIZING

变更规格大小中。

InstanceTypeQuotaItem

描述实例规格的售卖信息。

被如下接口引用:DescribeZoneInstanceConfigInfos

参数名称
类型
描述

zoneId

String

可用区ID。

instanceType

String

实例规格ID。

instanceTypeName

String

实例规格的名称。

cpuCount

Integer

CPU核数。

单位:核。

memory

Integer

实例内存容量。

单位:GiB。

internetMaxBandwidthOutLimit

Integer

最大出口带宽限制。

withStock

Boolean

是否有库存。

internetChargeTypes

支持的网络计费类型。

InternetChargeType

描述IP网络的计费模式。

被如下接口引用:CreateNetworkInterface, CreateEips, DescribeEipPrice, CreateZecInstances, DescribeNetworkInterfacePublicIPv6, DescribeZoneInstanceConfigInfos, DescribeEips, ChangeEipInternetChargeType, InquiryPriceCreateInstance, DescribeEipInternetChargeTypes, AssignNetworkInterfaceIpv6

值说明

ByBandwidth

固定带宽计费方式。

ByTrafficPackage

流量包计费方式。

BandwidthCluster

共享带宽包计费方式。

IpType

IP类型。

被如下接口引用:CreateRoute, DescribeRoutes

值说明

IPv4

IPv4。

IPv6

IPv6。

MarketingInfo

描述市场活动的相关信息。

被如下接口引用:CreateNetworkInterface, CreateEips, CreateZecInstances, CreateDisks, CreateCidr

参数名称
类型
必选
描述

discountCode

String

使用市场发放的折扣码。

如果折扣码不存在,最终折扣将不会生效。

usePocVoucher

Boolean

是否使用POC代金券。

如果系统不存在POC代金券,相关创建流程会失败。

MetricValue

描述实例监控指标的数据值。

被如下接口引用:DescribeInstanceMonitorData

参数名称
类型
描述

time

String

数据点时间。

value

Float

数据点的值。

如果该值为null,表示取不到相应的值。

NatGateway

描述NAT网关的信息。

被如下接口引用:DescribeNatGateways

参数名称
类型
描述

natGatewayId

String

NAT网关唯一ID。

vpcId

String

NAT网关所属的VPC网络ID。

regionId

String

区域节点ID。

status

NAT网关的状态。

name

String

NAT网关的名称。

subnetIds

Array of String

NAT网关所属的Subnet子网ID集合。

isAllSubnets

Boolean

是否节点内所有子网关联了NAT网关。

eipIds

Array of String

NAT网关所关联的EIP ID集合。

zbgId

String

边界网关ID。

icmpReplyEnabled

Boolean

是否开启ICMP代回。

resourceGroupId

String

资源组ID。

resourceGroupName

String

资源组名称。

createTime

String

创建时间。

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

expiredTime

String

到期时间。

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

NatStatus

描述NAT网关的状态。

被如下接口引用:DescribeNatGateways

值说明

CREATING

NAT网关创建中。

RUNNING

NAT网关运行。

RECYCLED

NAT网关处于回收站。

CREATE_FAILED

NAT网关创建失败。

RELEASING

NAT网关释放中。

NetmaskInfo

描述CIDR掩码的信息。

被如下接口引用:CreateCidr, DescribeCidrPrice

参数名称
类型
必选
描述

netmask

Integer

掩码大小。

可选值范围:[27, 32]。

amount

Integer

CIDR的数量。

可选值范围:[0, +)。

NextHotType

下一跳的类型相关值。

被如下接口引用:DescribeRoutes

值说明

NIC

虚拟网卡。

VPC

全球VPC。

NAT

NAT网关。

ZBG

边界网关。

NicInfo

描述网卡的相关信息。

被如下接口引用:DescribeInstances, DescribeNetworkInterfaces

参数名称
类型
描述

nicId

String

网卡的ID。

name

String

网卡的名称。

status

网卡状态。

nicType

网卡类型。

regionId

String

所属节点ID。

nicSubnetType

网卡的IP堆栈类型。

publicIpList

Array of String

关联的公网IP。

privateIpList

Array of String

关联的内网IP。

primaryIpv4

String

主的内网IPv4地址。

primaryIpv6

String

网卡上的主IPv6地址。

如果堆栈类型是V4,该值取值为空。

ipv6Cidr

String

网卡上的IPv6地址。

如果堆栈类型是V4,该值取值为空。

secondaryIpv4s

Array of String

网卡上的辅助 IPv4 地址。

macAddress

String

网卡的MAC地址。

instanceId

String

所绑定的实例ID。

vpcId

String

所关联VPC ID。

subnetId

String

所关联的子网ID。

createTime

String

网卡的创建时间。

updateTime

String

网卡的更新时间。

resourceGroup

网卡所属的资源组信息。

NicNetworkType

网卡模式的相关值。

被如下接口引用:DescribeImages, DescribeInstances, ChangeNicNetworkType

值说明

FailOver

故障转移模式。

VirtioOnly

软件模拟模式。

VfOnly

物理直通模式。

NicStatus

描述网卡创建的状态。

被如下接口引用:DescribeNetworkInterfaces

值说明

PENDING

网卡创建中。

AVAILABLE

可用未绑定实例的。

ATTACHING

绑定实例过程中。

DETACHING

解绑实例过程中。

DELETING

删除中。

CREATE_FAILED

创建失败的。

USED

已经绑定实例的。

NicType

描述网卡的类型相关值。

被如下接口引用:DescribeNetworkInterfaces

值说明

Primary

主网卡类型。

Secondary

辅助网卡类型。

PoolInfo

描述公网IP池的基本信息。

被如下接口引用:DescribePools

参数名称
类型
描述

poolId

String

公网IP池的ID。

regionId

String

公网IP池所在的节点ID。

name

String

公网IP池的名称。

createTime

String

公网IP池的创建时间。

PriceItem

描述价格的信息。

被如下接口引用:InquiryPriceCreateDisks, InquiryPricePublicIpv6, DescribeEipPrice, InquiryPriceCreateNatGateway, InquiryPriceCreateInstance, DescribeCidrPrice

参数名称
类型
描述

discount

Float

折扣大小。

如80.0代表8折。

discountPrice

Float

后付费的单元折后价格。

后付费模式使用,如果价格为阶梯价格,该项为null。

originalPrice

Float

预付费的原价。

预付费模式使用,后付费该值为 null。

unitPrice

Float

后付费的单元原始价格。

后付费模式使用,如果价格为阶梯价格,该项为null。

discountUnitPrice

Float

后付费的单元折后价格。

后付费模式使用,如果价格为阶梯价格,该项为null。

chargeUnit

String

后付费计价单元。

后付费模式使用,可取值范围: HOUR: 表示计价单元是按每小时来计算。

DAY: 表示计价单元是按天来计算。

MONTH: 表示计价单元是按月来计算,95计费则是这种。

stepPrices

Array of StepPrice

后付费阶梯价格。

后付费模式使用,如果非阶梯价格,该项为null。

amountUnit

String

用量单位。

比如Mbps, LCU等。

如果为null, 代表取不到值。

excessUnitPrice

Float

超量原始价格。

excessDiscountUnitPrice

Float

超量折扣后价格。

excessAmountUnit

String

超量用量单位。

如果为null, 代表取不到值。

PrivateIpInfo

公网弹性IP可以绑定的网卡及内网信息

被如下接口引用:AvailableLanIp

参数名称
类型
描述

lanIp

String

网卡上的内网IP地址。

nicId

String

网卡ID。

nicName

String

网卡的名称。

instanceId

String

网卡关联的实例ID。

instanceName

String

网卡关联的实例名称。

PublicIpv6CidrAddress

公网IPv6的基本信息。

被如下接口引用:DescribeNetworkInterfacePublicIPv6

参数名称
类型
描述

ipv6CidrId

String

IPv6 CIDR的ID。

ipv6Cidr

String

IPv6 CIDR的地址。

primaryIpv6Address

String

网卡的主IPv6地址。

internetChargeType

IPv6的网络计费类型。

bandwidth

Integer

IPv6的公网带宽限速。

单位:Mbps。

trafficPackageSize

Float

IPv6的流量包大小。

单位:TB。

bandwidthCluster

关联的带宽组信息。

RegionInfo

节点信息。

被如下接口引用:DescribeSubnetRegions

参数名称
类型
描述

regionId

String

节点ID。

regionName

String

节点名称。

regionTitle

String

节点标题。

enablePubIpv6

Boolean

是否支持IPv6。

ReplaceIp

替换的公网IP信息。

被如下接口引用:ReplaceEipAddress

参数名称
类型
必选
描述

eipId

String

需要替换的弹性公网IP ID。

ownIp

String

原IP。

当IP是三线IP(IP线路类型为ThreeLine)时需要指定。

targetIp

String

需要变更的目标IP。

如果未指定,将由系统随机分配。

ResourceGroupInfo

描述资源所在资源组的相关信息,包括资源组名称和ID。

被如下接口引用:DescribeVpcs, DescribeAutoSnapshotPolicies, DescribeSnapshots, DescribeNetworkInterfaces

参数名称
类型
描述

resourceGroupId

String

资源组ID。

resourceGroupName

String

资源组名称。

RouteInfo

描述路由的相关信息。

被如下接口引用:DescribeRoutes

参数名称
类型
描述

routeId

String

路由ID。

name

String

路由的名称。

vpcId

String

路由关联的VPC的ID。

vpcName

String

路由关联的VPC的名称。

ipVersion

IP类型。

支持IPv4IPv6两种类型。

type

路由类型。

sourceCidrBlock

String

源IP地址。

路由类型RouteTypePolicy(策略路由)时可取值。

destinationCidrBlock

String

IPv4或IPv6的目标网段。

例如:10.0.1.0/24。

cidrBlock

String

IPv4或IPv6的目标网段。

例如:10.0.1.0/24。

该字段已废弃,请使用destinationCidrBlock

priority

Integer

路由优先级。

nextHopId

String

下一跳资源ID。

nextHopName

String

下一跳资源名称。

nextHopType

下一跳的类型。

createTime

String

路由的创建时间。

RouteType

描述路由类型的值。

被如下接口引用:CreateRoute, DescribeRoutes

值说明

RouteTypeSubnet

子网路由。

该路由为系统生成的路由。

RouteTypeStatic

静态路由。

可以通过创建自定义路由。

RouteTypePolicy

策略路由。

可以通过创建自定义路由。

RouteTypeNatGw

NAT 网关路由。

RouteTypeTransit

动态路由。

RoutingMode

描述路由级别的枚举值。

被如下接口引用:ModifyBorderGatewaysAttribute, DescribeBorderGateways, CreateBorderGateway

值说明

Regional

节点级别路由。

Global

全节点级别路由。

SecurityGroupInfo

描述安全组的基本信息。

被如下接口引用:DescribeSecurityGroups

参数名称
类型
描述

securityGroupId

String

安全组ID。

securityGroupName

String

安全组名称。

scope

String

范围。

目前只有全球范围(Global)。

createTime

String

创建时间。

vpcIds

Array of String

关联的VPC ID列表。

isDefault

Boolean

是否是默认安全组。

SecurityGroupRuleInfo

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

被如下接口引用:CreateSecurityGroup, DescribeSecurityGroupRule, ConfigureSecurityGroupRules

参数名称
类型
必选
描述

direction

String

规则方向。

ingress: 入方向。

egress:出方向。

policy

String

设置访问权限。

accept:接受访问。

deny: 拒绝访问。

priority

Integer

规则优先级。

可选值范围:[1, 999]。

ipProtocol

String

传输层协议。

取值大小写敏感, 取值范围: tcp:TCP协议。

udp:UDP协议。

icmp:ICMP协议。

all:支持所有协议。

portRange

String

目的端安全组开放的传输层协议相关的端口范围。

取值范围: TCP/UDP协议:取值范围为1~65535。

ICMP协议:-1。

all:-1。

cidrIp

String

源端IP地址范围。

支持CIDR格式和IPv4格式的IP地址范围。

默认值:0.0.XX.XX/0。

desc

String

备注,长度在255个以内。

SnapshotInfo

描述快照的信息。

被如下接口引用:DescribeSnapshots

参数名称
类型
描述

snapshotId

String

快照唯一ID。

snapshotName

String

快照显示名称。

zoneId

String

快照所属的可用区ID。

status

快照的状态。

snapshotType

快照的类型。

retentionTime

String

快照的保留到期时间。

如果取不到值,说明快照为永久保留。

diskId

String

云盘ID。

createTime

String

创建时间。

diskAbility

Boolean

是否具备创建disk的能力。

resourceGroup

所属的资源组信息。

SnapshotStatusValue

描述快照状态的相关值。

被如下接口引用:DescribeSnapshots

值说明

CREATING

创建中。

AVAILABLE

创建成功。

FAILED

创建失败。

ROLLING_BACK

回滚到此快照中。

DELETING

释放中。

SnapshotType

快照类型的可选值。

被如下接口引用:DescribeSnapshots

值说明

Auto

自动创建快照。

Manual

手动创建快照。

SnatEntry

描述SNAT规则的信息。

被如下接口引用:DescribeNatGatewayDetail

参数名称
类型
描述

snatEntryId

String

SNAT规则 ID。

cidrs

Array of String

CIDR网段,不传默认是0.0.0.0/0。

cidrssnatSubnets 不会同时存在。

eipIds

Array of String

SNAT规则添加的eip ID集合。

snatSubnets

Array of SnatSubnet

SNAT规则添加的subnet ID集合。

SnatSubnet

Snat规则添加的子网集合。

被如下接口引用:DescribeNatGatewayDetail

参数名称
类型
描述

subnetId

String

子网的ID。

cidr

String

子网的CIDR。

StepPrice

描述阶梯价格的信息。

被如下接口引用:InquiryPriceCreateDisks

参数名称
类型
描述

stepStart

Float

阶梯的起始值。

stepEnd

Float

阶梯的到达值。

为null代表最后一级阶梯。

unitPrice

Float

阶梯单价。

discountUnitPrice

Float

阶梯折后价。

SubnetInfo

描述子网的基本信息。

被如下接口引用:DescribeSubnets

参数名称
类型
描述

subnetId

String

子网的ID。

regionId

String

子网所在节点的ID。

name

String

子网的名称。

cidrBlock

String

子网的CIDR地址。

ipv6CidrBlock

String

子网的IPv6 CIDR地址段。

如果子网的IP堆栈类型不包括V6,该字段取不到值。

stackType

String

子网的IP堆栈类型。

ipv6Type

String

子网上IPv6类型。

如果子网的IP堆栈类型不包括V6,该字段取不到值。

vpcId

String

子网所属VPC的ID。

vpcName

String

子网所属VPC的名称。

usageIpv4Count

Integer

子网已使用IPv4数量。

usageIpv6Count

Integer

子网已使用IPv6数量。

createTime

String

子网的创建时间。

isDefault

Boolean

子网是否为默认。

SubnetStackType

描述堆栈类型的值。

被如下接口引用:CreateNetworkInterface, CreateSubnet, ModifySubnetStackType, DescribeNetworkInterfaces

值说明

IPv4

仅IPv4。

IPv4_IPv6

IPv4和IPv6。

IPv6

仅IPv6。

SystemDisk

描述系统盘的基本信息。

被如下接口引用:CreateZecInstances, DescribeInstances, InquiryPriceCreateInstance

参数名称
类型
必选
描述

diskId

String

系统盘ID。

该参数目前仅用于DescribeInstances等查询类接口的返回参数,不可用于CreateInstances等写接口的入参。

diskSize

Integer

系统盘大小。

单位:GiB。

可选值范围:[1, +)。

diskCategory

String

云硬盘种类。

Basic NVMe SSD: 经济型 NVMe SSD。

Standard NVMe SSD: 标准型 NVMe SSD。

默认为Standard NVMe SSD。

默认值:Standard NVMe SSD。

VpcInfo

描述VPC的基本信息。

被如下接口引用:DescribeVpcs

参数名称
类型
描述

vpcId

String

VPC的ID。

name

String

VPC的名称。

cidrBlock

String

VPC的IPv4 CIDR。

ipv6CidrBlock

String

VPC的内网IPv6 CIDR。

如果为null,说明未开启IPv6。

mtu

Integer

mtu值。

isDefault

Boolean

是否为默认VPC。

createTime

String

创建时间。

usageIpv4Count

Integer

VPC里已使用IPv4数量。

usageIpv6Count

Integer

VPC里已使用IPv6数量。

securityGroupId

String

关联的安全组ID。

resourceGroup

VPC关联的资源组信息。

ZbgAdvertisedSubnet

描述子网控制枚举值。

被如下接口引用:ModifyBorderGatewaysAttribute, DescribeBorderGateways, CreateBorderGateway

值说明

ALL

全部宣告。

NONE

不宣告。

PART

部分宣告。

ZbgInfo

描述边界网关的基本信息。

被如下接口引用:DescribeBorderGateways

参数名称
类型
描述

zbgId

String

边界网关ID。

name

String

边界网关名称。

vpcId

String

VPC的ID。

regionId

String

节点的ID。

asn

Integer

ASN号。

interConnectCidr

String

互联IP地址段。

createTime

String

创建时间。

cloudRouterIds

Array of String

关联的三层网络ID集合。

routingMode

路由模式。

natId

String

NAT的ID。

advertisedSubnet

子网控制。

advertisedCidrs

Array of String

IPv4 Cidr集合。

advertisedRouteIds

Array of String

自定义路由集合。

ZoneInfo

可用区的基本信息。

被如下接口引用:DescribeZones

参数名称
类型
描述

zoneId

String

可用区ID。

regionId

String

可用区所在的节点ID。

zoneName

String

可用区名称。

supportSecurityGroup

Boolean

可用区是否支持安全组。

该字段已废弃,当前所有节点均支持安全组。

默认值:true。

最后更新于