文档中心控制台

数据结构

MetricValue

监控指标数据

类型值
类型说明

value

监控指标值

timeInSecond

数据时间戳，单位秒

RegionInfo

名称
类型
描述

regionId

String

区域ID

regionName

String

区域名称

regionTitle

String

区域Title

enablePubIpv6

Boolean

是否支持公网IPv6

VpcInfo

名称
类型
描述

vpcId

String

VPC的ID

name

String

VPC的名称

cidrBlock

String

VPC的CIDR

ipv6CidrBlock

String

VPC的IPv6 CIDR

mtu

Integer

VPC的mtu

isDefault

Boolean

VPC是否为默认

createTime

Timestamp

VPC创建时间

usageIpv4Count

Integer

VPC已使用IPv4数量

usageIpv6Count

Integer

VPC已使用IPv6数量

securityGroupId

String

VPC绑定的安全组ID

SubnetInfo

名称
类型
描述

subnetId

String

Subnet的ID

regionId

String

区域ID

name

String

Subnet的名称

cidrBlock

String

Subnet的CIDR

ipv6CidrBlock

String

Subnet的IPv6 CIDR

stackType

String

Subnet堆栈类型 IPv4、IPv4_IPv6、IPv6

ipv6Type

String

Subnet IPv6类型 Public、Private

vpcId

String

Subnet所属VPC的ID

vpcName

String

Subnet所属VPC的名称

usageIpv4Count

Integer

Subnet已使用IPv4数量

usageIpv6Count

Integer

Subnet已使用IPv6数量

createTime

Timestamp

Subnet创建时间

isDefault

Boolean

Subnet是否为默认

RouteInfo

名称
类型
描述

routeId

String

Route的ID

name

String

Route的名称

vpcId

String

VPC的ID

vpcName

String

VPC的名称

ipVersion

String

IP类型 IPv4、IPv6

type

String

Route 类型 RouteTypeSubnet、RouteTypeStatic

cidrBlock

String

Route CIDR

priority

Integer

Route 优先级

nextHopId

String

下一跳ID

nextHopName

String

下一跳名称

nextHopType

String

下一跳类型 VPC、INSTANCE

createTime

Timestamp

Route 创建时间

InstanceInfo

实例相关信息。

名称
类型
描述

instanceId

String

实例唯一ID。

instanceName

String

实例显示名称。

zoneId

String

实例所属的可用区ID。

cpu

Integer

cpu核数，单位：核

memory

Integer

实例内存容量，单位：iGB

imageId

String

镜像ID。

imageName

String

镜像名称。

status

String

实例状态。

systemDisk

实例系统盘信息。

dataDisks

实例数据盘信息。

publicIpAddresses

Array of String

实例公网列表。

如果机器的主IP未加入到公网组网接口，那么主IP将无法使用，且该字段也不会返回该IP。

privateIpAddresses

Array of String

实例内网IP列表。

keyId

String

密钥ID。 注意：此字段可能返回 null，表示取不到有效值。

createTime

Timestamp

创建时间。

格式为：YYYY-MM-DDThh:mm:ssZ。

expiredTime

Timestamp

到期时间。

格式为：YYYY-MM-DDThh:mm:ssZ。

resourceGroupId

String

实例所属资源组的ID。

resourceGroupName

String

实例所属资源组的名称。

InstanceStatus

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

名称
类型
描述

instanceId

String

实例ID。

instanceStatus

String

DiskWithInstance

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

名称
类型
描述

instanceId

String

实例ID。

diskIdSet

Array of String

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

SystemDisk

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

名称
类型
必选
描述

diskId

String

否

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

diskSize

Integer

是

系统盘大小。 单位：GiB。

diskCategory

String

否

云硬盘种类。

  • Basic NVMe SSD: 经济型 NVMe SSD

  • Standard NVMe SSD: 标准型 NVMe SSD

默认为Standard NVMe SSD。

DataDisk

描述了数据盘的信息。

名称
类型
必选
描述

diskId

String

否

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

diskSize

Integer

是

数据盘大小。 单位：GiB。

diskName

String

否

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

diskCategory

String

否

云硬盘种类。

  • Basic NVMe SSD: 经济型 NVMe SSD

  • Standard NVMe SSD: 标准型 NVMe SSD

默认为Standard NVMe SSD。

portable

Boolean

否

是否可拆卸。

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

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

diskAmount

Integer

否

数据盘数量。 该参数仅用于CreateInstances、 InquiryPriceCreateInstance等接口的入参使用。

diskPrice

否

数据盘价格。 该参数仅用于InquiryPriceCreateInstance 接口的返回参数。

InstanceTypeQuotaItem

描述实例机型配额信息。

名称
类型
描述

zoneId

String

可用区ID。

instanceType

String

实例机型。

cpuCount

Integer

实例的CPU核数。

单位：核。

memory

Integer

实例内存容量。

单位：GiB。

frequency

String

实例的CPU主频信息。

internetMaxBandwidthOutLimit

Integer

最大出口带宽限制。

instanceTypeName

String

实例机型名称。

internetChargeTypes

Array of String

支持的网络计费类型。

取值范围请看

KeyPair

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

名称
类型
描述

keyId

String

密钥对ID。

示例值：key-xxxxxxxx。

keyName

String

密钥对名称。

publicKey

String

密钥对的公钥内容。

OpenSSH 格式。

示例值：ssh-rsa XXXXXXXXXXXX key_xxx

keyDescription

String

密钥对描述信息。

createTime

创建时间。

格式为：YYYY-MM-DDTHH:mm:ssZ。

InternetChargeType

网络计费类型。

类型
说明

ByBandwidth

按固定带宽计费

ByTrafficPackage

购买流量包计费

BandwidthCluster

大区合并95计费

eipV4Type

公网ipv4的网络类型。

类型
说明

BGPLine

bgp

CN2Line

回国专线

LocalLine

本地IP

ChinaTelecom

中国电信

ChinaUnicom

中国联通

ChinaMobile

中国移动

ThreeLine

三线IP组

InstanceStatusValue

实例的状态。

状态值
状态说明

RUNNING

开机

STOPPED

关机

RECYCLE

已回收

STOPPING

关机中

BOOTING

开机中

RELEASING

释放中

REBOOT

重启中

DEPLOYING

部署中

REBUILDING

重装系统中

RECYCLING

回收中

RESIZING

变更规格中

IMAGING

制作镜像中

CREATE_FAILED

创建（重装）失败

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

ZoneInfo

名称
类型
描述

zoneId

String

区域ID。

zoneName

String

区域名称。

supportSecurityGroup

Boolean

是否支持安全组。

ChargePaid

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

名称
类型
必选
描述

period

Integer

是

购买实例的时长。

单位：月。

Price

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

名称
类型
描述

originalPrice

Float

预付费的原价。

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

discountPrice

Float

预付费的折扣价。

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

discount

Float

折扣大小。 如80.0代表8折。

unitPrice

Float

后付费的单元原始价格。 后付费模式使用，如果价格为阶梯价格，该项为null。

discountUnitPrice

Float

后付费的单元折后价格。

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

chargeUnit

String

后付费计价单元。 后付费模式使用，可取值范围： HOUR: 表示计价单元是按每小时来计算。 DAY: 表示计价单元是按天来计算。 MONTH: 表示计价单元是按月来计算，95计费则是这种。

excessUnitPrice

Float

超量原始价格。

excessDiscountUnitPrice

Float

超量折扣后价格。

excessAmountUnit

String

超量单位。

stepPrices

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

StepPrice

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

名称
类型
描述

stepStart

Float

阶梯用量的开始。

stepEnd

Float

阶梯用量的结束。

unitPrice

Float

当前阶梯的单元原始价格。 后付费模式使用。

discountUnitPrice

Float

当前阶梯的单元折后价格。 后付费模式使用。

NetmaskInfo

名称
类型
描述

netmask

Integer

掩码

amount

Integer

数量

CidrUsedIpInfo

名称
类型
描述

publicIp

String

公网IP

lanIp

String

内网IP

nicId

String

网卡ID

nicName

String

网卡名称

instanceId

String

实例ID

instanceName

String

实例名称

OwnCidr

名称
类型
描述

cidrBlock

String

CIDR

ipNum

Integer

数量

networkType

String

EIP网络类型

CidrInfo

名称
类型
描述

cidrId

String

CIDR ID

regionId

String

节点ID

name

String

名称

cidrBlock

String

CIDR

totalCount

Integer

总数量

usedCount

Integer

已用数量

source

String

来源

networkType

String

EIP网络类型

netmask

Integer

掩码

createTime

String

创建时间

expiredTime

String

到期时间

period

Integer

周期

instanceChargeType

String

付费方式

resourceGroupId

String

资源组ID

resourceGroupName

String

资源组名称

PrivateIpInfo

名称
类型
描述

lanIp

String

内网IP

nicId

String

网卡ID

nicName

String

网卡名称

instanceId

String

实例ID

instanceName

String

实例名称

DiskInfo

名称
类型
描述

diskId

String

DISK ID

diskName

String

名称

zoneId

String

可用区ID

diskType

String

类型

portable

boolean

是否可移植

diskCategory

String

类别

diskSize

Integer

大小

diskStatus

String

状态

instanceId

String

实例ID

instanceName

String

实例名称

chargeType

String

付费方式

createTime

String

创建时间

expiredTime

String

到期时间

period

Integer

周期

resourceGroupId

String

资源组ID

resourceGroupName

String

资源组名称

DiskCategory

名称
类型
描述

zoneId

String

可用区ID

categorySet

Array of String

种类集合

SecurityGroupInfo

名称
类型
描述

securityGroupId

String

安全组ID

securityGroupName

String

安全组名称

scope

String

范围

createTime

String

创建时间

vpcIds

Array of String

VPC ID集合

isDefault

Boolean

是否默认

RuleInfo

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

名称
必选
类型
描述

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

NicInfo

名称
类型
描述

nicId

String

网卡的ID

name

String

名称

status

String

nicType

String

类型

regionId

String

区域ID

nicSubnetType

String

网络模式

publicIpList

Array of String

公网IP集合

privateIpList

Array of String

内网IP集合

instanceId

String

实例的ID

vpcId

String

VPC的ID

subnetId

String

Subnet的ID

createTime

String

创建时间

NicStatus

状态值
状态说明

PENDING

创建中

AVAILABLE

可用，未绑定实例的

ATTACHING

绑定中

DETACHING

解绑中

USED

已绑定实例的

CidrIpBind

名称
类型
描述

nicId

String

网卡ID

publicIp

String

公网IP

lanIp

String

内网IP

最后更新于