# 数据结构

## AssociateSubnetInstance

Subnet绑定实例。

被如下接口引用：AssociateSubnetInstances

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

## AvailableIpv4Resource

可用的Ipv4 Cidr Block资源。

被如下接口引用：DescribeAvailableIpv4Resources

| 参数名称       | 类型                              | 描述                                                                                                                     |
| ---------- | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| zoneId     | String                          | Cidr Block所属的可用区ID。                                                                                                    |
| netmask    | Integer                         | 掩码。                                                                                                                    |
| sellStatus | [SellStatus](#sellstatus)       | <p>售卖的状态。</p><ul><li>SELL：表示实例可购买，且库存>10。</li><li>SELL\_SHORTAGE: 表示可购买，但是库存<10台。</li><li>SOLD\_OUT：表示实例已售罄。</li></ul> |
| cidrType   | [CidrBlockType](#cidrblocktype) | CIDR地址块的类型。                                                                                                            |

## AvailableIpv6Resource

可用的Ipv6 Cidr Block资源。

被如下接口引用：DescribeAvailableIpv6Resources

| 参数名称       | 类型                        | 描述                                                                                                                     |
| ---------- | ------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| zoneId     | String                    | Cidr Block所属的可用区ID。                                                                                                    |
| sellStatus | [SellStatus](#sellstatus) | <p>售卖的状态。</p><ul><li>SELL：表示实例可购买，且库存>10。</li><li>SELL\_SHORTAGE: 表示可购买，但是库存<10台。</li><li>SOLD\_OUT：表示实例已售罄。</li></ul> |

## AvailableResource

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

被如下接口引用：DescribeAvailableResources

| 参数名称                      | 类型                                                 | 描述                                                                                                                     |
| ------------------------- | -------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| zoneId                    | String                                             | 可用区ID。                                                                                                                 |
| sellStatus                | [SellStatus](#sellstatus)                          | <p>售卖的状态。</p><ul><li>SELL：表示实例可购买，且库存>10。</li><li>SELL\_SHORTAGE: 表示可购买，但是库存<10台。</li><li>SOLD\_OUT：表示实例已售罄。</li></ul> |
| internetChargeTypes       | Array of [InternetChargeType](#internetchargetype) | 网络计费类型。                                                                                                                |
| instanceTypeId            | String                                             | 机型ID。                                                                                                                  |
| maximumBandwidthOut       | Integer                                            | <p>最大的公网出口带宽限制。</p><p>单位：Mbps。</p>                                                                                     |
| defaultBandwidthOut       | Integer                                            | <p>固定带宽计费方式时默认赠送公网带宽。</p><p>单位：GB。</p>                                                                                 |
| defaultTrafficPackageSize | Float                                              | <p>流量包计费方式时默认增送的流量包大小。</p><p>单位：TB。</p>                                                                                |
| qty                       | Integer                                            | 库存数量。                                                                                                                  |

## BackendInfo

BackendInfo 信息

被如下接口引用：DescribeLoadBalancers, DescribeBackends

| 参数名称         | 类型                                          | 描述                                                           |
| ------------ | ------------------------------------------- | ------------------------------------------------------------ |
| listenerId   | String                                      | Listener的ID。                                                 |
| backendId    | String                                      | Backend的ID。                                                  |
| backendName  | String                                      | Backend的名称。                                                  |
| status       | String                                      | 状态。                                                          |
| port         | String                                      | 端口。                                                          |
| weight       | Integer                                     | 权重。                                                          |
| instanceId   | String                                      | 实例ID。                                                        |
| instanceType | [InstanceProductType](#instanceproducttype) | 实例类型。                                                        |
| instanceName | String                                      | 实例名称。                                                        |
| createTime   | String                                      | 创建时间。按照`ISO8601`标准表示，并且使用`UTC`时间。格式为：`YYYY-MM-ddTHH:mm:ssZ`。 |

## ChargePrepaid

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

被如下接口引用：CreateLoadBalancer, InquiryPriceCreateEipAddress, CreateInstances, InquiryPriceCreateIpv4Block, AllocateEipAddresses, InquiryPriceCreateInstance, CreateIpv4Block

| 参数名称   | 类型      | 必选 | 描述                                              |
| ------ | ------- | -- | ----------------------------------------------- |
| period | Integer | 是  | <p>购买实例的时长。</p><p>单位：月。</p><p>可选值范围：\[1, +)</p> |

## ChargeType

付费类型。

被如下接口引用：DescribeAvailableResources, DescribeLoadBalancerSpecs, InquiryPriceCreateEipAddress, DescribeAvailableIpv4Resources, InquiryPriceCreateIpv4Block, DescribeEipAvailableResources, DescribeCidrBlocks, InquiryPriceCreateInstance, CreateIpv4Block, CreateLoadBalancer, DescribeLoadBalancerZones, CreateInstances, DescribeInstances, AllocateEipAddresses, DescribeEipAddresses

| 值        | 值说明        |
| -------- | ---------- |
| PREPAID  | 预付费。       |
| POSTPAID | 后付费。即按量付费。 |

## CidrBlockInfo

CIDR 地址快的信息。

被如下接口引用：DescribeCidrBlocks

| 参数名称              | 类型                                  | 描述                                                        |
| ----------------- | ----------------------------------- | --------------------------------------------------------- |
| cidrBlockId       | String                              | Cidr Block唯一ID。                                           |
| cidrBlockType     | [IpType](#iptype)                   | CIDR的类型。                                                  |
| cidrType          | [CidrBlockType](#cidrblocktype)     | CIDR地址块的类型。                                               |
| 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            | [CidrBlockStatus](#cidrblockstatus) | Cidr Block状态。                                             |
| chargeType        | [ChargeType](#chargetype)           | <p>计费类型。</p><p>PREPAID：预付费，即包年包月。</p><p>POSTPAID：后付费。</p> |
| createTime        | String                              | <p>创建时间。</p><p>格式为：YYYY-MM-ddTHH:mm:ssZ。</p>              |
| expireTime        | String                              | <p>到期时间。</p><p>格式为：YYYY-MM-ddTHH:mm:ssZ。</p>              |
| resourceGroupId   | String                              | 所属资源组的ID。                                                 |
| resourceGroupName | String                              | 所属资源组的名称。                                                 |
| tags              | [Tags](#tags)                       | 资源关联的标签信息。                                                |

## CidrBlockIp

CIDR 地址块里的IP的信息。

被如下接口引用：DescribeCidrBlockIps

| 参数名称          | 类型                                      | 描述              |
| ------------- | --------------------------------------- | --------------- |
| cidrBlockId   | String                                  | Cidr Block唯一ID。 |
| cidrBlockType | [IpType](#iptype)                       | CIDR的类型。        |
| ip            | String                                  | IP。             |
| instanceId    | String                                  | 绑定的实例ID。        |
| status        | [CidrBlockIpStatus](#cidrblockipstatus) | IP的状态。          |

## CidrBlockIpStatus

Cidr Block的IP状态。

被如下接口引用：DescribeCidrBlockIps

| 值         | 值说明 |
| --------- | --- |
| BINDING   | 绑定中 |
| UNBINDING | 解绑中 |
| BOUND     | 已绑定 |
| AVAILABLE | 可用  |

## CidrBlockStatus

Cidr Block的状态。

被如下接口引用：DescribeCidrBlocks

| 值              | 值说明   |
| -------------- | ----- |
| CREATING       | 创建中   |
| CREATE\_FAILED | 创建失败  |
| RECYCLING      | 回收中   |
| RECYCLE        | 在回收站中 |
| AVAILABLE      | 可用    |

## CidrBlockType

CIDR地址块的类型。

被如下接口引用：DescribeAvailableIpv4Resources, InquiryPriceCreateIpv4Block, DescribeCidrBlocks, DescribeInstanceAvailableCidrBlock, CreateIpv4Block

| 值     | 值说明     |
| ----- | ------- |
| BGP   | BGP IP。 |
| Local | 本地 IP。  |

## CustomRaid

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

被如下接口引用：CreateInstances

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

## Disk

硬盘块信息。

被如下接口引用：DescribeInstanceTypes

| 参数名称      | 类型      | 描述                         |
| --------- | ------- | -------------------------- |
| diskSize  | Integer | <p>硬盘的大小。</p><p>单位：GB。</p> |
| diskCount | Integer | 该硬盘大小的硬盘的数量。               |

## EipAddress

Eip信息。

被如下接口引用：DescribeEipAddresses

| 参数名称              | 类型            | 描述                                                                                          |
| ----------------- | ------------- | ------------------------------------------------------------------------------------------- |
| eipId             | String        | EIP唯一ID。                                                                                    |
| zoneId            | String        | EIP所属的可用区ID。                                                                                |
| ipAddress         | String        | IP地址。                                                                                       |
| netmask           | Integer       | IP掩码。                                                                                       |
| instanceId        | String        | 实例ID。                                                                                       |
| instanceName      | String        | 实例名称。                                                                                       |
| eipChargeType     | String        | <p>付费类型。</p><p>PREPAID：预付费，即包年包月。POSTPAID：后付费。</p>                                          |
| period            | Integer       | <p>购买EIP的时长。</p><p>单位：月。</p><p>后付费EIP该字段为null。</p>                                          |
| createTime        | String        | <p>创建时间。</p><p>按照ISO8601标准表示，并且使用UTC时间。格式为：YYYY-MM-ddTHH:mm:ssZ。</p>                        |
| expiredTime       | String        | <p>到期时间。</p><p>按照ISO8601标准表示，并且使用UTC时间。格式为：YYYY-MM-ddTHH:mm:ssZ。</p><p>注意：后付费模式本项为null。</p> |
| resourceGroupId   | String        | 资源组ID。                                                                                      |
| resourceGroupName | String        | 资源组名称。                                                                                      |
| eipStatus         | String        | EIP状态                                                                                       |
| tags              | [Tags](#tags) | 资源关联的标签信息。                                                                                  |

## EipAvailable

购买EIP资源区域。

被如下接口引用：DescribeEipAvailableResources

| 参数名称    | 类型      | 描述                                                                                                                                      |
| ------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| zoneId  | String  | EIP所属的可用区ID。                                                                                                                            |
| status  | String  | <p>EIP是否售卖。</p><p>取值范围：</p><ul><li>SELL：表示EIP可购买，且库存>10台。</li><li>SELL\_SHORTAGE: 表示可购买，但是库存<10台。</li><li>SOLD\_OUT：表示EIP已售罄。</li></ul> |
| netmask | Integer | IP掩码。                                                                                                                                   |

## EipStatus

EIP状态。

被如下接口引用：DescribeEipAddresses

| 值              | 值说明   |
| -------------- | ----- |
| CREATING       | 创建中   |
| CREATE\_FAILED | 创建失败  |
| ASSOCIATING    | 绑定中   |
| UNASSOCIATING  | 解绑中   |
| ASSOCIATED     | 已分配   |
| AVAILABLE      | 可用    |
| RECYCLING      | 回收中   |
| RECYCLE        | 在回收站中 |

## HealthCheck

HealthCheck 信息

被如下接口引用：CreateListener, ModifyListenerAttribute, DescribeLoadBalancers

| 参数名称                  | 类型      | 必选 | 描述        |
| --------------------- | ------- | -- | --------- |
| checkEnabled          | Boolean | 否  | 检查开关。     |
| checkType             | String  | 否  | 检查类型。     |
| checkConnectTimeout   | Integer | 否  | 连接时间。     |
| checkRetry            | Integer | 否  | 重试次数。     |
| checkDelayBeforeRetry | Integer | 否  | 超时时间。     |
| checkIntervalTime     | Integer | 否  | 重试间隔。     |
| checkPort             | Integer | 否  | 检查端口。     |
| httpVersion           | String  | 否  | Http版本。   |
| httpCheckPath         | String  | 否  | Http地址。   |
| httpCheckDigest       | Integer | 否  | Http摘要认证。 |
| httpCode              | Integer | 否  | 状态码。      |
| miscCheckPath         | String  | 否  | Misc地址。   |
| miscTimeout           | Integer | 否  | Misc超时时间。 |

## ImageInfo

镜像相关信息。

被如下接口引用：DescribeImages

| 参数名称      | 类型                      | 描述                                                                                                           |
| --------- | ----------------------- | ------------------------------------------------------------------------------------------------------------ |
| imageId   | String                  | 镜像ID。                                                                                                        |
| imageName | String                  | 镜像名称。                                                                                                        |
| catalog   | String                  | <p>镜像所属分类。</p><p>可能值：</p><ul><li>centos</li><li>windows</li><li>ubuntu</li><li>debian</li><li>esxi</li></ul> |
| imageType | [ImageType](#imagetype) | <p>镜像类型。</p><p>PUBLIC\_IMAGE: 公共镜像。</p><p>CUSTOM\_IMAGE：自定义镜像。</p><p>目前不支持自主的创建自定义镜像，可联系support沟通。</p>       |
| osType    | [OsType](#ostype)       | <p>操作系统类型。</p><p>可能值：</p><ul><li>windows</li><li>linux</li></ul>                                             |

## ImageType

镜像类型

被如下接口引用：DescribeImages

| 值             | 值说明    |
| ------------- | ------ |
| PUBLIC\_IMAGE | 公共镜像。  |
| CUSTOM\_IMAGE | 自定义镜像。 |

## InstanceAvailableCidrBlock

实例可用的CIDR地址块。

被如下接口引用：DescribeInstanceAvailableCidrBlock

| 参数名称             | 类型                              | 描述                  |
| ---------------- | ------------------------------- | ------------------- |
| cidrBlockId      | String                          | Cidr Block唯一ID。     |
| zoneId           | String                          | Cidr Block所属的可用区ID。 |
| cidrBlockType    | [IpType](#iptype)               | CIDR的类型。            |
| cidrType         | [CidrBlockType](#cidrblocktype) | CIDR地址块的类型。         |
| cidrBlock        | String                          | CIDR。               |
| availableIps     | Array of String                 | 可用的IP列表。            |
| availableIpCount | Integer                         | 可用的IP数量。            |

## InstanceAvailableEip

EIP信息。

被如下接口引用：DescribeInstanceAvailableEipResources

| 参数名称      | 类型      | 描述                                                            |
| --------- | ------- | ------------------------------------------------------------- |
| eipId     | String  | <p>一个EIP ID。</p><p>可通过DescribeEipAddresses接口返回值中的eipId获取。</p> |
| ipAddress | String  | IP地址。                                                         |
| netmask   | Integer | IP掩码。                                                         |

## InstanceDiskInfo

机型硬盘信息。

被如下接口引用：DescribeInstanceTypes

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

## InstanceHealth

实例状态信息。

被如下接口引用：DescribeInstancesMonitorHealth

| 参数名称          | 类型      | 描述                                                                                                    |
| ------------- | ------- | ----------------------------------------------------------------------------------------------------- |
| instanceId    | String  | 实例ID。                                                                                                 |
| cpuStatus     | String  | <p>CPU状态。</p><ul><li>OK：硬件状态正常。</li><li>WARNING：硬件原生告警。</li><li>UNKNOWN：数据未采集到。</li></ul>             |
| diskStatus    | String  | <p>Disk状态。</p><ul><li>OK：硬件状态正常。</li><li>WARNING：硬件原生告警。</li><li>UNKNOWN：数据未采集到。</li></ul>            |
| ipmiPing      | String  | <p>Ipmi IP状态。</p><ul><li>OK：ICMP探测正常。</li><li>CRITICAL：ICMP探测失败。</li><li>UNKNOWN：数据未采集到。</li></ul>    |
| ipmiStatus    | String  | <p>Ipmi状态。</p><ul><li>OK：ICMP探测正常。</li><li>WARNING：硬件原生告警。</li><li>UNKNOWN：数据未采集到。</li></ul>          |
| memoryStatus  | String  | <p>Memory状态。</p><ul><li>OK：硬件状态正常。</li><li>WARNING：硬件原生告警。</li><li>UNKNOWN：数据未采集到。</li></ul>          |
| psuStatus     | String  | <p>Power Supply状态。</p><ul><li>OK：硬件状态正常。</li><li>WARNING：硬件原生告警。</li><li>UNKNOWN：数据未采集到。</li></ul>    |
| wanPortStatus | String  | <p>服务器公网口连接的交换机端口的状态。</p><ul><li>OK：硬件状态正常。</li><li>WARNING：硬件原生告警。</li><li>UNKNOWN：数据未采集到。</li></ul> |
| fanStatus     | String  | <p>风扇状态。</p><ul><li>OK：硬件状态正常。</li><li>WARNING：硬件原生告警。</li><li>UNKNOWN：数据未采集到。</li></ul>              |
| 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，即摄氏温度。                                                                               |

## InstanceInfo

实例相关信息。

被如下接口引用：DescribeInstances

| 参数名称                     | 类型                                        | 描述                                                                   |
| ------------------------ | ----------------------------------------- | -------------------------------------------------------------------- |
| instanceId               | String                                    | 实例唯一ID。                                                              |
| zoneId                   | String                                    | 实例所属的可用区ID。                                                          |
| instanceName             | String                                    | 实例显示名称。                                                              |
| hostname                 | String                                    | 实例的主机名。                                                              |
| instanceTypeId           | String                                    | 实例机型ID。                                                              |
| instanceType             | [InstanceType](#instancetype)             | 实例机型配置信息。                                                            |
| imageId                  | String                                    | 镜像ID。                                                                |
| imageName                | String                                    | 镜像名称。                                                                |
| ipxeUrl                  | String                                    | IpxeUrl。                                                             |
| instanceChargeType       | [ChargeType](#chargetype)                 | <p>实例计费类型。</p><p>PREPAID：预付费，即包年包月。 POSTPAID：后付费。</p>                |
| bandwidthOutMbps         | Integer                                   | <p>公网出口带宽。</p><p>单位：Mbps。</p><p>0 代表无限制，但是不会超过机型的最大上限。</p>           |
| internetChargeType       | [InternetChargeType](#internetchargetype) | 网络计费类型。                                                              |
| period                   | Integer                                   | <p>购买实例的时长。</p><p>单位：月。</p><p>后付费实例该字段为null。</p>                     |
| primaryPublicIpAddress   | String                                    | 实例的母IP。                                                              |
| primaryPublicIPv6Address | String                                    | 实例的主IPv6地址。                                                          |
| publicIpAddresses        | Array of String                           | <p>实例公网IPv4列表。</p><p>如果机器的主IP未加入到公网组网接口，那么主IP将无法使用，且该字段也不会返回该IP。</p> |
| privateIpAddresses       | Array of String                           | 实例内网IP列表。                                                            |
| ipv6Addresses            | Array of String                           | <p>实例的IPv6地址。</p><p>注意：此字段可能返回null，表示取不到有效值。</p>                     |
| subnetIds                | Array of String                           | 实例所属的内网组网ID列表。                                                       |
| createTime               | String                                    | <p>创建时间。</p><p>格式为：YYYY-MM-ddTHH:mm:ssZ。</p>                         |
| expiredTime              | String                                    | <p>到期时间。</p><p>格式为：YYYY-MM-ddTHH:mm:ssZ。</p>                         |
| resourceGroupId          | String                                    | 实例所属资源组的ID。                                                          |
| resourceGroupName        | String                                    | 实例所属资源组的名称。                                                          |
| instanceStatus           | [InstanceStatus](#instancestatus)         | <p>实例状态。</p><p>状态类型详见实例状态。</p>                                       |
| trafficPackageSize       | Float                                     | <p>流量包订购大小。</p><p>单位为TB。</p>                                         |
| raidConfig               | [RaidConfig](#raidconfig)                 | 磁盘阵列配置。                                                              |
| partitions               | Array of [Partition](#partition)          | 分区配置。                                                                |
| nic                      | [Nic](#nic)                               | 网卡配置。                                                                |
| autoRenew                | Boolean                                   | <p>是否自动续费。</p><p>对于预付费实例，取消订阅后，该字段值将返回 false</p>                     |
| keyId                    | String                                    | 安装的SSH密钥ID。                                                          |
| tags                     | [Tags](#tags)                             | 资源关联的标签信息。                                                           |
| enableGatewayMode        | Boolean                                   | 网关模式是否开启。                                                            |

## InstanceProductType

实例类型。

被如下接口引用：DescribeLoadBalancers, DescribeBackends, RegisterBackend

| 值  | 值说明 |
| -- | --- |
| BM | 裸金属 |
| VM | VM  |

## InstanceStatus

实例状态。

被如下接口引用：DescribeInstances

| 值               | 值说明   |
| --------------- | ----- |
| PENDING         | 待创建   |
| CREATING        | 创建中   |
| CREATE\_FAILED  | 创建失败  |
| INSTALLING      | 安装中   |
| INSTALL\_FAILED | 安装失败  |
| RUNNING         | 运行中   |
| STOPPED         | 关机    |
| BOOTING         | 启动中   |
| STOPPING        | 关机中   |
| RECYCLE         | 在回收站中 |

## InstanceTrafficData

实例带宽数据。

被如下接口引用：DescribeInstanceTraffic, DescribeManagedInstanceTraffic

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

## InstanceType

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

被如下接口引用：DescribeInstances, DescribeInstanceTypes

| 参数名称             | 类型                                    | 描述                                                |
| ---------------- | ------------------------------------- | ------------------------------------------------- |
| imageIds         | Array of String                       | <p>机型支持的镜像ID。</p><p>仅在DescribeInstanceType可取值</p> |
| instanceTypeId   | String                                | 实例机型ID。                                           |
| description      | String                                | <p>机型描述。</p><p>一般包括内存大小，硬盘。</p>                   |
| cpuCoreCount     | Integer                               | CPU数量。                                            |
| cpuDetail        | String                                | CPU详情。                                            |
| cpuCores         | Integer                               | CPU核心数。                                           |
| cpuThreads       | Integer                               | CPU线程。                                            |
| baseFrequency    | String                                | CPU基础频率。                                          |
| memorySize       | Integer                               | <p>内存大小。</p><p>单位：GB。</p>                         |
| maximumBandwidth | Integer                               | <p>机型支持的最大出口带宽。</p><p>单位：Mbps。</p>                |
| supportRaids     | Array of Integer                      | 机型支持的raid。                                        |
| supportSubnet    | Boolean                               | 是否支持内网组网。                                         |
| isHA             | Boolean                               | 是否是高可用机型。                                         |
| diskInfo         | [InstanceDiskInfo](#instancediskinfo) | <p>硬盘配置。</p><p>单位：GB。</p>                         |
| vpuVendor        | String                                | VPU 供应商                                           |
| vpuCard          | String                                | VPU 型号。示例：T1U                                     |
| vpuCount         | Integer                               | VPU 数量                                            |

## InternetChargeType

网络计费类型。

被如下接口引用：DescribeAvailableResources, CreateInstances, DescribeInstances, InquiryPriceCreateInstance

| 值                     | 值说明            |
| --------------------- | -------------- |
| ByBandwidth           | 按固定带宽计费        |
| ByTrafficPackage      | 购买流量包计费        |
| ByInstanceBandwidth95 | 单实例95计费方式。     |
| ByClusterBandwidth95  | 单产品合并95计费城市带宽组 |
| ByBandwidthCluster    | 跨产品合并95计费的带宽包  |

## IpBindParam

Cidr Block Ip绑定参数。

被如下接口引用：BindCidrBlockIps

| 参数名称       | 类型     | 必选 | 描述                                                                           |
| ---------- | ------ | -- | ---------------------------------------------------------------------------- |
| instanceId | String | 是  | 实例ID。                                                                        |
| ip         | String | 是  | <p>IP。</p><p>可通过DescribeInstanceAvailableCidrBlock接口返回值中的availableIps获取。</p> |

## IpType

描述IP类型的值。

被如下接口引用：DescribeCidrBlockIps, DescribeCidrBlocks, DescribeInstanceAvailableCidrBlock, CreateByoip

| 值    | 值说明   |
| ---- | ----- |
| IPV4 | IPv4。 |
| IPV6 | IPv6。 |

## LbKind

流量转发模式。

被如下接口引用：CreateListener, ModifyListenerAttribute, DescribeLoadBalancers

| 值    | 值说明                   |
| ---- | --------------------- |
| DR   | 直接路由（Direct Routing)。 |
| FNAT | 全局网络地址转换(Full NAT)。   |

## ListenerInfo

ListenerInfo 信息

被如下接口引用：DescribeLoadBalancers, DescribeListeners

| 参数名称            | 类型                          | 描述                                                           |
| --------------- | --------------------------- | ------------------------------------------------------------ |
| loadBalancerId  | String                      | LoadBalancerId唯一ID。                                          |
| listenerId      | String                      | Listener的ID。                                                 |
| listenerName    | String                      | Listener的名称。                                                 |
| status          | String                      | 状态。                                                          |
| port            | String                      | 监听端口。                                                        |
| protocol        | String                      | 监听协议。                                                        |
| backendProtocol | String                      | 后段服务器协议。                                                     |
| scheduler       | String                      | 调度算法。                                                        |
| kind            | [LbKind](#lbkind)           | 流量转发模式。                                                      |
| healthCheck     | [HealthCheck](#healthcheck) | 健康检查。                                                        |
| notify          | [Notify](#notify)           | 通知地址。                                                        |
| createTime      | String                      | 创建时间。按照`ISO8601`标准表示，并且使用`UTC`时间。格式为：`YYYY-MM-ddTHH:mm:ssZ`。 |

## LoadBalancerInfo

LoadBalancerInfo 信息

被如下接口引用：DescribeLoadBalancers

| 参数名称              | 类型                                         | 描述                                                           |
| ----------------- | ------------------------------------------ | ------------------------------------------------------------ |
| loadBalancerId    | String                                     | LoadBalancerId唯一ID。                                          |
| zoneId            | String                                     | LoadBalancer所属的可用区ID。                                        |
| loadBalancerName  | String                                     | LoadBalancer的名称。                                             |
| specName          | String                                     | <p>规格名称。</p><p>默认值：Unlimited LoadBalancer</p>                |
| vipList           | Array of [LoadBalancerIp](#loadbalancerip) | LoadBalancer的VIP集合。                                          |
| chargeType        | String                                     | 计费方式。                                                        |
| period            | Integer                                    | 周期。                                                          |
| createTime        | String                                     | 创建时间。按照`ISO8601`标准表示，并且使用`UTC`时间。格式为：`YYYY-MM-ddTHH:mm:ssZ`。 |
| expiredTime       | String                                     | 过期时间。                                                        |
| status            | String                                     | LoadBalancer的状态。                                             |
| resourceGroupId   | String                                     | 资源组ID。                                                       |
| resourceGroupName | String                                     | 资源组名称。                                                       |
| masterIp          | String                                     | 主IP。                                                         |
| backupIp          | String                                     | 备IP。                                                         |
| ipType            | String                                     | IPv4。                                                        |
| bandwidth         | Integer                                    | <p>带宽。</p><p>默认值：0</p>                                       |
| isWorking         | Boolean                                    | 是否工作。                                                        |
| listenerList      | Array of [ListenerInfo](#listenerinfo)     | 监听器集合。                                                       |
| backendList       | Array of [BackendInfo](#backendinfo)       | 后端服务器集合。                                                     |
| tags              | [Tags](#tags)                              | 资源关联的标签信息。                                                   |

## LoadBalancerIp

LoadBalancerIp 信息

被如下接口引用：DescribeLoadBalancers

| 参数名称      | 类型     | 描述                              |
| --------- | ------ | ------------------------------- |
| vipId     | String | VIP的ID。                         |
| ipAddress | String | IP地址。                           |
| type      | String | <p>IP类型</p><p>DEFAULT、EXTRA</p> |
| status    | String | 状态。                             |

## LoadBalancerSpec

LoadBalancerSpec 信息

被如下接口引用：DescribeLoadBalancerSpecs

| 参数名称          | 类型      | 描述     |
| ------------- | ------- | ------ |
| specName      | String  | 规格名称。  |
| maxConnection | Integer | 最大连接数。 |
| cps           | Integer | CPS。   |
| qps           | Integer | QPS。   |

## ManagedInstanceInfo

托管实例信息。

被如下接口引用：DescribeManagedInstances

| 参数名称         | 类型              | 描述      |
| ------------ | --------------- | ------- |
| instanceId   | String          | 实例ID。   |
| instanceName | String          | 实例名称。   |
| facName      | String          | 地域名称。   |
| ips          | Array of String | 公网IP列表。 |
| lanIps       | Array of String | 内网IP列表。 |
| createTime   | String          | 创建时间。   |

## MarketingInfo

市场营销活动相关信息

被如下接口引用：CreateLoadBalancer, CreateInstances, AllocateEipAddresses, CreateIpv4Block

| 参数名称          | 类型      | 必选 | 描述                                                |
| ------------- | ------- | -- | ------------------------------------------------- |
| discountCode  | String  | 否  | <p>使用市场发放的折扣码。</p><p>如果折扣码不存在，最终折扣将不会生效。</p>      |
| usePocVoucher | Boolean | 否  | <p>是否使用POC代金券。</p><p>如果系统不存在POC代金券，相关创建流程会失败。</p> |

## Nic

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

被如下接口引用：ReinstallInstance, CreateInstances, DescribeInstances

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

## Notify

Notify 信息

被如下接口引用：CreateListener, ModifyListenerAttribute, DescribeLoadBalancers

| 参数名称       | 类型      | 必选 | 描述    |
| ---------- | ------- | -- | ----- |
| enable     | Boolean | 否  | 通知开关。 |
| apiAddress | String  | 否  | 地址。   |

## OsType

操作系统类型。

被如下接口引用：DescribeImages

| 值       | 值说明      |
| ------- | -------- |
| windows | Windows。 |
| linux   | Linux。   |

## Partition

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

被如下接口引用：ReinstallInstance, CreateInstances, DescribeInstances

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

## PriceCategory

描述价格类型。

被如下接口引用：InquiryPriceCreateInstance

| 值          | 值说明   |
| ---------- | ----- |
| STANDARD   | 标准价格。 |
| CUSTOMIZED | 一口价格。 |

## PriceItem

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

被如下接口引用：InquiryPriceInstanceBandwidth, InquiryPriceInstanceTrafficPackage, InquiryPriceCreateEipAddress, InquiryPriceCreateIpv4Block, InquiryPriceCreateInstance

| 参数名称                    | 类型                               | 描述                                                                                                                            |
| ----------------------- | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| discount                | Float                            | <p>折扣大小。</p><p>如80.0代表8折。</p>                                                                                                 |
| discountPrice           | Float                            | <p>预付费的折扣价。</p><p>预付费模式使用，后付费该值为 null。</p>                                                                                    |
| originalPrice           | Float                            | <p>预付费的原价。</p><p>预付费模式使用，后付费该值为 null。</p>                                                                                     |
| unitPrice               | Float                            | <p>后付费的单元原始价格。</p><p>后付费模式使用，如果价格为阶梯价格，该项为null。</p>                                                                           |
| discountUnitPrice       | Float                            | <p>后付费的单元折后价格。</p><p>后付费模式使用，如果价格为阶梯价格，该项为null。</p>                                                                           |
| chargeUnit              | String                           | <p>后付费计价单元。</p><p>后付费模式使用，可取值范围：</p><p>HOUR: 表示计价单元是按每小时来计算。</p><p>DAY: 表示计价单元是按天来计算。</p><p>MONTH: 表示计价单元是按月来计算，95计费则是这种。</p> |
| stepPrices              | Array of [StepPrice](#stepprice) | <p>后付费阶梯价格。</p><p>后付费模式使用，如果非阶梯价格，该项为null。</p>                                                                                |
| amountUnit              | String                           | <p>用量单位。</p><p>比如Mbps, LCU等。</p><p>如果为null, 代表取不到值。</p>                                                                       |
| excessUnitPrice         | Float                            | 超量原始价格。                                                                                                                       |
| excessDiscountUnitPrice | Float                            | 超量折扣后价格。                                                                                                                      |
| excessAmountUnit        | String                           | <p>超量用量单位。</p><p>如果为null, 代表取不到值。</p>                                                                                         |
| category                | [PriceCategory](#pricecategory)  | 价格所属类别。                                                                                                                       |

## RaidConfig

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

被如下接口引用：ReinstallInstance, CreateInstances, DescribeInstances

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

## SellStatus

售卖的状态。

被如下接口引用：DescribeAvailableResources, DescribeAvailableIpv4Resources, DescribeAvailableIpv6Resources

| 值              | 值说明              |
| -------------- | ---------------- |
| SOLD\_OUT      | 已售罄。             |
| SELL\_SHORTAGE | 可购买，但是库存小于等于10台。 |
| SELL           | 实例可购买，且库存大于10。   |

## StepPrice

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

被如下接口引用：InquiryPriceCreateInstance

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

## SubnetInfo

Subnet Info的信息。

被如下接口引用：DescribeSubnets

| 参数名称              | 类型                                         | 描述                                                           |
| ----------------- | ------------------------------------------ | ------------------------------------------------------------ |
| subnetId          | String                                     | Subnet唯一ID。                                                  |
| subnetName        | String                                     | Subnet的名称。                                                   |
| zoneId            | String                                     | Subnet所属的可用区ID。                                              |
| availableIpCount  | Integer                                    | Subnet下可用的IP数量。                                              |
| cidrBlock         | String                                     | Subnet的CIDR。                                                 |
| subnetStatus      | String                                     | Subnet的状态。                                                   |
| createTime        | String                                     | 创建时间。按照`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](#subnetinstance) | Subnet下实例集合。                                                 |

## SubnetInstance

Subnet Instance信息。

被如下接口引用：DescribeSubnets

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

## SubnetStatus

描述子网的状态。

被如下接口引用：DescribeSubnets

| 值              | 值说明   |
| -------------- | ----- |
| CREATING       | 创建中。  |
| CREATE\_FAILED | 创建失败。 |
| AVAILABLE      | 可用。   |
| DELETING       | 删除中。  |

## Tag

描述一个标签键值对的信息。

被如下接口引用：DescribeVpcs, CreateInstances, DescribeInstances, DescribeLoadBalancers, DescribeCidrBlocks, DescribeEipAddresses

| 参数名称  | 类型     | 必选 | 描述                              |
| ----- | ------ | -- | ------------------------------- |
| key   | String | 是  | <p>标签键。</p><p>长度限制：1～128字符。</p> |
| value | String | 否  | <p>标签值。</p><p>长度限制：1～128字符。</p> |

## TagAssociation

描述创建资源时同时绑定的标签对的信息。

被如下接口引用：CreateVpc, CreateLoadBalancer, CreateIpv6Block, CreateInstances, AllocateEipAddresses, CreateIpv4Block

| 参数名称 | 类型                   | 必选 | 描述     |
| ---- | -------------------- | -- | ------ |
| tags | Array of [Tag](#tag) | 是  | 标签对列表。 |

## Tags

描述资源关联的标签信息。

被如下接口引用：DescribeVpcs, DescribeInstances, DescribeLoadBalancers, DescribeCidrBlocks, DescribeEipAddresses

| 参数名称 | 类型                   | 描述     |
| ---- | -------------------- | ------ |
| tags | Array of [Tag](#tag) | 标签对列表。 |

## VpcInfo

Vpc Info的信息。

被如下接口引用：DescribeVpcs

| 参数名称              | 类型            | 描述                                           |
| ----------------- | ------------- | -------------------------------------------- |
| vpcId             | String        | VPC唯一ID。                                     |
| vpcRegionId       | String        | VPC的节点ID。                                    |
| vpcRegionName     | String        | VPC的节点名称。                                    |
| vpcName           | String        | VPC的名称。                                      |
| cidrBlock         | String        | VPC的CIDR。                                    |
| createTime        | String        | <p>创建时间。</p><p>格式为：YYYY-MM-ddTHH:mm:ssZ。</p> |
| vpcStatus         | String        | VPC的状态。                                      |
| resourceGroupId   | String        | 资源组ID。                                       |
| resourceGroupName | String        | 资源组名称。                                       |
| tags              | [Tags](#tags) | 资源关联的标签信息。                                   |

## VpcRegionInfo

VPC 节点的信息。

被如下接口引用：DescribeVpcAvailableRegions

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

## VpcStatus

描述VPC的状态。

被如下接口引用：DescribeVpcs

| 值              | 值说明   |
| -------------- | ----- |
| CREATING       | 创建中。  |
| CREATE\_FAILED | 创建失败。 |
| AVAILABLE      | 可用。   |
| DELETING       | 删除中。  |

## Zone

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

被如下接口引用：DescribeZones

| 参数名称                   | 类型      | 描述                                       |
| ---------------------- | ------- | ---------------------------------------- |
| zoneId                 | String  | <p>可用区ID。</p><p>例如：SEL-A</p>             |
| zoneName               | String  | 可用区的名称。                                  |
| cityName               | String  | 可用区的城市名称。                                |
| areaName               | String  | 可用区所在的大区名称。                              |
| isCloudRouterAvailable | Boolean | <p>可用区是否支持SDN三层网络。</p><p>默认值：false</p>   |
| isByoipEnabled         | Boolean | <p>可用区是否支持BYO IP 宣告。</p><p>默认值：false</p> |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.console.zenlayer.com/api-reference/cn/compute/bmc/datastructure.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.