# 数据结构

## AttackEventInfo

攻击事件的信息。

被如下接口引用：DescribeDDosAllEventList

| 参数名称               | 类型                                    | 描述                          |
| ------------------ | ------------------------------------- | --------------------------- |
| eventId            | String                                | 攻击事件唯一ID。                   |
| status             | [DdosAttackStatus](#ddosattackstatus) | 攻击状态。                       |
| ipAddress          | String                                | 被攻击的IP。                     |
| protecting         | Boolean                               | IP是否正在防护中。                  |
| startTime          | String                                | 攻击开始时间。                     |
| endTime            | String                                | 攻击结束时间。                     |
| endBlackholeTime   | String                                | 从黑洞解封时间。                    |
| attackBandwidthMax | Float                                 | <p>攻击峰值流量。</p><p>单位bps。</p> |
| attackPackageMax   | Float                                 | <p>攻击峰值包量。</p><p>单位pps。</p> |
| regionId           | String                                | 事件发生所在区域ID。                 |

## AutoSnapshotPolicy

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

被如下接口引用：DescribeAutoSnapshotPolicies

| 参数名称                   | 类型                                      | 描述                                                                                                                 |
| ---------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| autoSnapshotPolicyId   | String                                  | 自动快照策略ID。                                                                                                          |
| zoneId                 | String                                  | 可用区ID。                                                                                                             |
| autoSnapshotPolicyName | String                                  | 自动快照策略的名称。                                                                                                         |
| repeatWeekDays         | Array of Integer                        | <p>自动快照的重复日期。</p><p>单位为天，周期为星期，例如 1 表示周一。</p><p>可选值范围：\[1, 7]</p>                                                  |
| hours                  | Array of Integer                        | <p>指定定期快照策略的触发时间。</p><p>使用 UTC 时间，单位为小时。</p><p>00:00 \~ 23:00 共 24 个时间点可选，1表示 01:00，依此类推。</p><p>可选值范围：\[0, 23]</p> |
| diskNum                | Integer                                 | 关联的云盘数量。                                                                                                           |
| createTime             | String                                  | 策略创建时间。                                                                                                            |
| resourceGroup          | [ResourceGroupInfo](#resourcegroupinfo) | 资源组信息。                                                                                                             |
| diskIdSet              | Array of String                         | 关联的云盘ID。                                                                                                           |
| retentionDays          | Integer                                 | <p>自动快照的保留时间，单位为天。</p><p>如果该值设置-1，则代表永久保留。</p><p>取值范围：-1或\[1,65535]。</p>                                           |
| tags                   | [Tags](#tags)                           | 自动快照策略关联的标签。                                                                                                       |

## BandwidthClusterInfo

描述带宽组的基本信息。

被如下接口引用：DescribeNetworkInterfacePublicIPv6, DescribeEips

| 参数名称                 | 类型     | 描述       |
| -------------------- | ------ | -------- |
| bandwidthClusterId   | String | 共享带宽包ID。 |
| bandwidthClusterName | String | 共享带宽包名称。 |

## BandwidthIpType

QoS策略组成员IP类型。

被如下接口引用：DescribeQosPolicyGroups

| 值                 | 值说明          |
| ----------------- | ------------ |
| Eip               | 弹性公网IP（EIP）。 |
| Ipv6              | IPv6地址。      |
| UnmanagedEgressIp | 非托管出口IP。     |

## BindType

描述EIP绑定类型的值

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

| 值           | 值说明      |
| ----------- | -------- |
| FullNat     | 普通NAT模式。 |
| Passthrough | 高速模式。    |

## BlockInfo

ip封堵信息详情

被如下接口引用：DescribeEips

| 参数名称   | 类型      | 描述        |
| ------ | ------- | --------- |
| ip     | String  | ip。       |
| bps    | Integer | 单位bps。    |
| pps    | Integer | 单位pps。    |
| inCps  | Integer | 单位个。      |
| outCps | Integer | 单位个。      |
| enable | Boolean | 是否启用特定阈值。 |

## ByoipCreateItem

创建 BYOIP 单项。

被如下接口引用：CreateByoip

| 参数名称             | 类型                                  | 必选 | 描述                                                                                                                                                                     |
| ---------------- | ----------------------------------- | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| cidrBlock        | String                              | 是  | 宣告IPv4或IPv6地址段。                                                                                                                                                        |
| networkType      | [NetworkLineType](#networklinetype) | 是  | <p>线路类型。</p><p>IPv6仅支持PremiumBGP。</p>                                                                                                                                  |
| regionId         | String                              | 是  | 区域id。                                                                                                                                                                  |
| asn              | Integer                             | 是  | ASN号。                                                                                                                                                                  |
| subnetMaskLength | Integer                             | 否  | <p>该参数仅在<code>cidrBlock</code>字段为IPv6地址段时生效。</p><p>分配给子网的掩码长度。</p><p>必须大于或等于CIDR的掩码长度。</p><p>与CIDR的掩码长度范围差值小于等于4, 最大值为64。</p><p>默认为CIDR的掩码长度。</p><p>可选值范围：\[-, 64]</p> |

## ByoipPriceItem

BYOIP 询价单项。

被如下接口引用：DescribeByoipPrice

| 参数名称        | 类型                                  | 必选 | 描述     |
| ----------- | ----------------------------------- | -- | ------ |
| cidrBlock   | String                              | 是  | 宣告ip段。 |
| networkType | [NetworkLineType](#networklinetype) | 是  | 线路类型。  |
| regionId    | String                              | 是  | 区域id。  |

## CidrCreateSource

描述CIDR来源的值。

被如下接口引用：DescribeIpv6Cidrs, DescribeCidrs

| 值         | 值说明                        |
| --------- | -------------------------- |
| CONSOLE   | 归属于Zenlayer创建的IP。          |
| BYOIP     | 客户自带IP(bring your own IP)。 |
| SDN\_RIPT | SDN 场景创建的 CIDR。            |

## 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            | [CidrCreateSource](#cidrcreatesource) | <p>CIDR的来源。</p><p>如CONSOLE（属于zenlayer）或 BYOIP（客户自带IP）。</p>                           |
| eipV4Type \[已废弃]  | [EipNetworkType](#eipnetworktype)     | <p>EIP网络类型。</p><p>表示该CIDR支持的公网IP线路类型。</p><p>已废弃，请参考<code>networkLineType</code>。</p> |
| networkLineType   | [NetworkLineType](#networklinetype)   | <p>EIP网络类型。</p><p>表示该CIDR支持的公网IP线路类型。</p>                                            |
| netmask           | Integer                               | <p>子网掩码。</p><p>表示CIDR的网络位长度。</p>                                                     |
| poolId            | String                                | <p>Pool的ID。</p><p>表示该CIDR所属的公网IP池。</p>                                               |
| createTime        | String                                | CIDR的创建时间。                                                                           |
| expiredTime       | String                                | CIDR的到期时间。                                                                           |
| resourceGroupId   | String                                | 该CIDR所属的资源组。                                                                         |
| resourceGroupName | String                                | 该CIDR所属资源组的名称。                                                                       |
| status            | [CidrStatus](#cidrstatus)             | CIDR的状态。                                                                             |
| asn               | Integer                               | <p>ASN编号。</p><p>仅当CIDR来源为BYOIP时存在。</p>                                               |
| tags              | [Tags](#tags)                         | 该CIDR地址段关联的标签。                                                                       |

## CidrStatus

描述CIDR的状态值。

被如下接口引用：DescribeIpv6Cidrs, DescribeCidrs

| 值                | 值说明    |
| ---------------- | ------ |
| CREATING         | 创建中。   |
| AVAILABLE        | 正常可用。  |
| CHANGING         | 变更中。   |
| RECYCLING \[已废弃] | 回收中。   |
| RECYCLED         | 处于回收站。 |
| DELETING         | 删除中。   |
| FAILED           | 创建失败。  |

## CrossRegionBandwidthApiMonitorMeta

描述内网跨区域带宽监控类型的值。

被如下接口引用：DescribeCrossRegionBandwidthMonitorData

| 值         | 值说明                        |
| --------- | -------------------------- |
| BANDWIDTH | <p>带宽类型。</p><p>单位bps。</p>  |
| PACKETS   | <p>数据包类型。</p><p>单位pps。</p> |

## CrossRegionBandwidthInfo

描述内网跨区域带宽的基本信息。

被如下接口引用：DescribeCrossRegionBandwidth

| 参数名称                     | 类型                                                    | 描述                                     |
| ------------------------ | ----------------------------------------------------- | -------------------------------------- |
| crossRegionBandwidthId   | String                                                | 内网跨区域带宽的唯一ID。                          |
| crossRegionBandwidthName | String                                                | 内网跨区域带宽的名称。                            |
| status                   | [VpcRegionBandwidthStatus](#vpcregionbandwidthstatus) | 内网跨区域带宽的状态。                            |
| vpcId                    | String                                                | 内网跨区域带宽所属的VPC ID。                      |
| regionA                  | String                                                | 内网跨区域带宽的其中一端的区域连接点（A）。                 |
| regionZ                  | String                                                | 内网跨区域带宽的另一端的区域连接点（Z）。                  |
| bandwidth                | Integer                                               | 内网跨区域带宽的带宽                             |
| bandwidthCap             | Integer                                               | <p>内网跨区域带宽的突发带宽。</p><p>该字段可能为null。</p> |
| createTime               | String                                                | 内网跨区域带宽的创建时间。                          |
| internetChargeType       | [InternetChargeType](#internetchargetype)             | 内网跨区域带宽的网络模型。                          |
| expiredTime              | String                                                | <p>内网跨区域带宽的到期时间。</p><p>该字段可能为null。</p> |
| resourceGroupId          | String                                                | 内网跨区域带宽的所属的资源组。                        |
| resourceGroupName        | String                                                | 内网跨区域带宽的所属资源组的名称。                      |

## CrossRegionBandwidthMetricValue

描述内网跨区域带宽的监控指标数据。

被如下接口引用：DescribeCrossRegionBandwidthMonitorData

| 参数名称     | 类型     | 描述     |
| -------- | ------ | ------ |
| time     | String | 数据点时间。 |
| inValue  | Float  | 入方向值。  |
| outValue | Float  | 入方向值。  |

## CustomImage

描述自定义镜像的基本信息。

被如下接口引用：DescribeCustomImages

| 参数名称              | 类型                                         | 描述             |
| ----------------- | ------------------------------------------ | -------------- |
| regionIdList      | Array of String                            | 镜像当前可用的区域ID列表。 |
| resourceGroupId   | String                                     | 资源组ID。         |
| resourceGroupName | String                                     | 资源组名称。         |
| imageId           | String                                     | 镜像ID。          |
| imageName         | String                                     | 镜像的名称。         |
| imageType         | [ImageType](#imagetype)                    | 镜像的类型。         |
| imageSource       | [ImageSource](#imagesource)                | 镜像的来源。         |
| imageSize         | String                                     | 镜像的大小。         |
| imageDescription  | String                                     | 镜像描述信息。        |
| imageVersion      | String                                     | 镜像的版本。         |
| imageStatus       | [ImageStatus](#imagestatus)                | 镜像的状态。         |
| nicNetworkType    | Array of [NicNetworkType](#nicnetworktype) | 镜像支持的网卡类型。     |
| category          | String                                     | 镜像的分类。         |
| osType            | [ImageOsType](#imageostype)                | 操作系统类型。        |
| tags              | [Tags](#tags)                              | 实例关联的标签。       |

## DataDisk

描述了数据盘的信息。

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

| 参数名称            | 类型      | 必选 | 描述                                                                                                                                               |
| --------------- | ------- | -- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| diskSize        | Integer | 是  | <p>数据盘大小。</p><p>单位：GiB。</p><p>可选值范围：\[1, +)</p>                                                                                                  |
| diskId          | String  | 否  | <p>数据盘ID。</p><p>该参数目前仅用于<code>DescribeInstances</code>等查询类接口的返回参数，不可用于<code>CreateInstances</code>等写接口的入参。</p>                                   |
| diskName        | String  | 否  | <p>云盘的名称。</p><p>该参数目前仅用于DescribeInstances等查询类接口的返回参数。</p>                                                                                        |
| diskAmount      | Integer | 否  | <p>数据盘数量。</p><p>该参数仅用于<code>CreateInstances</code>,<code>InquiryPriceCreateInstance</code>等接口的入参使用。</p><p>可选值范围：\[1, +)</p><p>默认值：1</p>          |
| portable        | Boolean | 否  | <p>是否可拆卸。</p><p>该参数仅用于查询的回参，不用于入参。</p><p>true代表不会随着实例删除而删除。</p><p>false代表会随着实例删除而删除。</p>                                                         |
| burstingEnabled | Boolean | 否  | <p>是否开启性能突发。</p><p>默认值：false</p>                                                                                                                 |
| diskCategory    | String  | 否  | <p>云硬盘种类。</p><p>Basic NVMe SSD: 经济型 NVMe SSD。</p><p>Standard NVMe SSD: 标准型 NVMe SSD。</p><p>默认为Standard NVMe SSD。</p><p>默认值：Standard NVMe SSD</p> |

## DdosAction

DDoS防护动作。

被如下接口引用：CreatePolicy

| 值    | 值说明      |
| ---- | -------- |
| Drop | 丢弃：丢弃流量。 |

## DdosAttackStatus

DDoS攻击事件状态。

被如下接口引用：DescribeDDosAllEventList, DescribeDDosEventDetail

| 值         | 值说明   |
| --------- | ----- |
| ATTACKING | 攻击中。  |
| ATTACKED  | 攻击结束。 |
| BLOCKING  | 封堵中。  |

## DdosFingerprintRule

DDoS 指纹过滤的相关配置

被如下接口引用：CreatePolicy, DescribePolicyDetail, ModifyPolicy

| 参数名称         | 类型                        | 必选 | 描述                                                                             |
| ------------ | ------------------------- | -- | ------------------------------------------------------------------------------ |
| protocol     | [Protocol](#protocol)     | 是  | 设置指纹的协议。                                                                       |
| srcPortStart | Integer                   | 是  | <p>指纹源端口的范围起始值。</p><p>可选值范围：\[0, 65535]</p>                                    |
| srcPortEnd   | Integer                   | 是  | <p>指纹源端口的范围结束值。</p><p>可选值范围：\[0, 65535]</p>                                    |
| dstPortStart | Integer                   | 是  | <p>指纹目的端口的范围起始值。</p><p>可选值范围：\[0, 65535]</p>                                   |
| dstPortEnd   | Integer                   | 是  | <p>指纹目的端口的范围结束值。</p><p>可选值范围：\[0, 65535]</p>                                   |
| minPktLength | Integer                   | 是  | <p>需要过滤出的最小包长。</p><p>可选值范围：\[1, 1500]</p>                                      |
| maxPktLength | Integer                   | 是  | <p>需要过滤出的最大包长。</p><p>可选值范围：\[1, 1500]</p>                                      |
| matchBytes   | String                    | 是  | <p>检测载荷。</p><p>不含0x 的16进制 小写 补足2位。</p>                                         |
| action       | [DdosAction](#ddosaction) | 是  | 设置指纹匹配后的动作。                                                                    |
| offset       | Integer                   | 否  | <p>报文载荷特征的偏移量。</p><p>TCP/UDP payload 的偏移 \[0-1500]。</p><p>可选值范围：\[0, 1500]</p> |

## DdosPolicyPort

DDoS端口封禁规则。

被如下接口引用：CreatePolicy, DescribePolicyDetail, ModifyPolicy

| 参数名称         | 类型                        | 必选 | 描述                                                               |
| ------------ | ------------------------- | -- | ---------------------------------------------------------------- |
| protocol     | [Protocol](#protocol)     | 是  | <p>协议类型。</p><p>只支持 <code>UDP</code> / <code>TCP</code> 两种协议。</p> |
| srcPortStart | Integer                   | 是  | <p>源端口范围的起始值。</p><p>可选值范围：\[0, 65535]</p>                        |
| srcPortEnd   | Integer                   | 是  | <p>源端口范围的结束值。</p><p>可选值范围：\[0, 65535]</p>                        |
| dstPortStart | Integer                   | 是  | <p>目的端口范围的起始值。</p><p>可选值范围：\[0, 65535]</p>                       |
| dstPortEnd   | Integer                   | 是  | <p>目的端口范围的结束值。</p><p>可选值范围：\[0, 65535]</p>                       |
| action       | [DdosAction](#ddosaction) | 是  | 匹配后的动作。                                                          |

## DdosProtectedType

DDoS防护类型。

被如下接口引用：DescribeDDosEventDetail

| 值    | 值说明   |
| ---- | ----- |
| DDOS | ddos。 |

## DdosReflectUdpPort

DDoS 反射攻击相关信息。

被如下接口引用：CreatePolicy, DescribePolicyDetail, ModifyPolicy

| 参数名称 | 类型      | 必选 | 描述                                          |
| ---- | ------- | -- | ------------------------------------------- |
| port | Integer | 是  | <p>反射攻击防护过滤的端口。</p><p>可选值范围：\[0, 65535]</p> |

## DdosTrafficControl

DDoS源限速相关设置

被如下接口引用：CreatePolicy, DescribePolicyDetail, ModifyPolicy

| 参数名称          | 类型      | 必选 | 描述                                                  |
| ------------- | ------- | -- | --------------------------------------------------- |
| bpsEnabled    | Boolean | 否  | 是否开启 bps 限速。                                        |
| bps           | Integer | 否  | <p>bps 限速值。</p><p>可选值范围：\[8192, 2147483648]</p>     |
| ppsEnabled    | Boolean | 否  | 是否开启 pps 限速。                                        |
| pps           | Integer | 否  | <p>pps 限速值。</p><p>可选值范围：\[32, 50000]</p>            |
| synBPSEnabled | Boolean | 否  | 是否开启 sync bps 限速。                                   |
| synBPS        | Integer | 否  | <p>syn bps 限速值。</p><p>可选值范围：\[8192, 2147483648]</p> |
| synPPSEnabled | Boolean | 否  | 是否开启 sync pps 限速。                                   |
| synPPS        | Integer | 否  | <p>syn pps 限速值。</p><p>可选值范围：\[1, 100000]</p>        |

## DescribeDiskCategoryItem

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

被如下接口引用：DescribeDiskCategory

| 参数名称        | 类型              | 描述        |
| ----------- | --------------- | --------- |
| zoneId      | String          | 可用区ID。    |
| categorySet | Array of String | 支持的云硬盘类型。 |

## DhcpOptionsSet

描述DHCP选项集的信息。

被如下接口引用：DescribeDhcpOptionsSets

| 参数名称                  | 类型            | 描述                                                                      |
| --------------------- | ------------- | ----------------------------------------------------------------------- |
| dhcpOptionsSetId      | String        | DHCP 选项集ID。                                                             |
| dhcpOptionsSetName    | String        | <p>DHCP 选项集的名称。</p><p>长度为1～64个字符。</p><p>可选值范围：\[1.0, +)</p>             |
| domainNameServers     | String        | <p>DNS 服务器 IP。</p><p>最多传入 4 个 DNS 服务器 Ipv4，DNS 服务器 IP 之间用半角逗号（,）隔开。</p> |
| ipv6DomainNameServers | String        | <p>DNS 服务器 IP。</p><p>最多传入 4 个 DNS 服务器 Ipv6，DNS 服务器 IP 之间用半角逗号（,）隔开。</p> |
| leaseTime             | String        | <p>IPv4 DHCP 选项集的租赁时间。</p><p>单位：h。</p>                                  |
| ipv6LeaseTime         | String        | <p>IPv6 DHCP 选项集的租赁时间。</p><p>单位：h。</p>                                  |
| createTime            | String        | <p>创建时间。</p><p>按照ISO8601标准表示，并且使用UTC时间, 格式为：YYYY-MM-ddTHH:mm:ssZ。</p>   |
| description           | String        | DHCP选项集 描述信息。                                                           |
| resourceGroupId       | String        | 实例所属的资源组ID。                                                             |
| resourceGroupName     | String        | 实例所属的资源组名称。                                                             |
| tags                  | [Tags](#tags) | 实例关联的标签。                                                                |

## DiskInfo

描述云盘的基本信息。

被如下接口引用：DescribeDisks

| 参数名称                 | 类型                        | 描述                                 |
| -------------------- | ------------------------- | ---------------------------------- |
| diskId               | String                    | 云盘的 ID。                            |
| diskName             | String                    | 云盘的名称。                             |
| regionId             | String                    | 云盘所在的节点ID。                         |
| zoneId               | String                    | 云盘所在节点的可用区ID。                      |
| diskType             | [DiskType](#disktype)     | 云盘的类型。                             |
| portable             | Boolean                   | 是否可卸载。                             |
| diskCategory         | String                    | 云盘的类别。                             |
| diskSize             | Integer                   | <p>云盘的大小。</p><p>单位：GiB。</p>        |
| diskStatus           | [DiskStatus](#diskstatus) | 云盘的状态。                             |
| instanceId           | String                    | 云盘绑定实例的ID。                         |
| instanceName         | String                    | 云盘绑定实例的名称。                         |
| createTime           | String                    | 创建时间。                              |
| expiredTime          | String                    | 到期时间。                              |
| period               | Integer                   | 周期。                                |
| resourceGroupId      | String                    | 云盘所属的资源组ID。                        |
| resourceGroupName    | String                    | 云盘所属的资源组名称。                        |
| serial               | String                    | <p>云盘序号。</p><p>可能为null，表示取不到值。</p> |
| snapshotAbility      | Boolean                   | 是否具体快照能力。                          |
| autoSnapshotPolicyId | String                    | 云盘关联的自动快照策略ID。                     |
| tags                 | [Tags](#tags)             | 该云盘关联的标签。                          |
| burstingEnabled      | Boolean                   | 是否开启 Burst。                        |

## DiskMetricData

描述云硬盘监控类型的值

被如下接口引用：DescribeDiskMonitorData

| 值                  | 值说明                            |
| ------------------ | ------------------------------ |
| DISK\_WRITE\_BYTES | <p>云硬盘写吞吐量。</p><p>单位KiB/s。</p> |
| DISK\_READ\_BYTES  | <p>云硬盘读吞吐量。</p><p>单位KiB/s。</p> |
| DISK\_READ\_OPS    | <p>云硬盘读数量。</p><p>单位IOPS。</p>   |
| DISK\_WRITE\_OPS   | <p>云硬盘写数量。</p><p>单位IOPS。</p>   |
| DISK\_UTIL         | <p>云硬盘利用率。</p><p>单位%。</p>      |

## 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     | [DnatEntryProtocol](#dnatentryprotocol) | 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    | 负载均衡类型。    |
| HAVIP | 高可用虚拟IP类型。 |

## EipGeoInfo

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

被如下接口引用：DescribeEips

| 参数名称          | 类型      | 描述                         |
| ------------- | ------- | -------------------------- |
| maxMind       | String  | 从MaxMind查询的地理信息。           |
| ipInfo        | String  | 从IPinfo(ipinfo.io)查询的地理信息。 |
| dbIp          | String  | 从DB-IP(db-ip.com)查询的地理信息。  |
| ipData        | String  | 从ipData(ipdata.co)查询的地理信息。 |
| ipGeoLocation | String  | 从IpGeoLocation查询的地理信息。     |
| standard      | String  | 需要查询EIP的所在的地理信息。           |
| isConsistent  | Boolean | 查询地理信息是否和所在的地理信息一致。        |

## EipInfo

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

被如下接口引用：DescribeEips

| 参数名称               | 类型                                            | 描述                                                                                   |
| ------------------ | --------------------------------------------- | ------------------------------------------------------------------------------------ |
| eipId              | String                                        | EIP 的唯一 ID。                                                                          |
| name               | String                                        | EIP 的名称。                                                                             |
| regionId           | String                                        | 节点ID。                                                                                |
| peerRegionId       | String                                        | <p>对端节点ID。</p><p>仅当IP为Remote IP时该字段有效。</p>                                           |
| isDefault          | Boolean                                       | 是否是默认类型。                                                                             |
| status             | [EipStatus](#eipstatus)                       | EIP 的状态。                                                                             |
| publicIpAddresses  | Array of String                               | 公网IP地址。                                                                              |
| privateIpAddress   | String                                        | EIP 绑定的内网IP地址。                                                                       |
| eipV4Type \[已废弃]   | [EipNetworkType](#eipnetworktype)             | <p>EIP网络类型。</p><p>表示该CIDR支持的公网IP线路类型。</p><p>已废弃，请参考<code>networkLineType</code>。</p> |
| networkLineType    | [NetworkLineType](#networklinetype)           | <p>EIP网络类型。</p><p>表示该CIDR支持的公网IP线路类型。</p>                                            |
| internetChargeType | [InternetChargeType](#internetchargetype)     | EIP 的网络计费方式。                                                                         |
| cidrId             | String                                        | EIP 来自的CIDR地址段ID。                                                                    |
| nicId \[已废弃]       | String                                        | <p>EIP 关联的网卡ID。</p><p>该字段已废弃，请使用 <code>associatedId</code> 字段。</p>                   |
| associatedId       | String                                        | <p>EIP 绑定的资源ID。</p><p>可能为负载均衡ID、网卡ID或者NAT网关ID。</p>                                   |
| associatedType     | [EipBindResourceType](#eipbindresourcetype)   | <p>EIP 资源类型。</p><p>可能为负载均衡ID、网卡ID或者NAT网关ID。</p>                                      |
| instanceId         | String                                        | <p>EIP 绑定的实例ID。</p><p>当且仅当<code>associatedType</code>字段为<code>NIC</code>时可能有值。</p>   |
| bindType           | [BindType](#bindtype)                         | EIP 绑定类型。                                                                            |
| flowPackage        | Float                                         | <p>EIP 流量包大小。</p><p>仅当网络计费方式为流量计费时可取到值。</p><p>该字段可能为null。</p>                        |
| bandwidth          | Integer                                       | <p>EIP 的带宽限速。</p><p>单位为Mbps。</p>                                                     |
| rateLimitMode      | [RateLimitMode](#ratelimitmode)               | <p>限速模式。</p><p>默认值：LOOSE</p>                                                         |
| eipGeoRefs         | Array of [EipGeoInfo](#eipgeoinfo)            | EIP 的地理位置信息。                                                                         |
| blockInfoList      | Array of [BlockInfo](#blockinfo)              | EIP的封堵阈值。                                                                            |
| createTime         | String                                        | EIP 的创建时间。                                                                           |
| expiredTime        | String                                        | <p>EIP 的到期时间。</p><p>该字段可能为null。</p>                                                  |
| resourceGroupId    | String                                        | EIP 关联的资源组ID。                                                                        |
| resourceGroupName  | String                                        | EIP 关联的资源组名称。                                                                        |
| bandwidthCluster   | [BandwidthClusterInfo](#bandwidthclusterinfo) | EIP 关联的带宽组ID。                                                                        |
| tags               | [Tags](#tags)                                 | EIP关联的标签。                                                                            |

## 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 | <p>带宽类型。</p><p>单位bps。</p>  |
| PACKETS   | <p>数据包类型。</p><p>单位pps。</p> |

## EipNetworkType

描述弹性IP的网络线路信息。另详见`NetworkLineType`

被如下接口引用：CreateEips, CreateZecInstances, DescribeEipPrice, CreateCidr, DescribeEipRemoteRegions, InquiryPriceCreateInstance, DescribeEips, DescribeCidrs, DescribeEipInternetChargeTypes, 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 | <p>入方向带宽值。</p><p>单位：bps。</p>                                                |
| internetTX | Integer | <p>出方向带宽值。</p><p>单位：bps。</p>                                                |
| time       | String  | <p>数据时间。</p><p>按照ISO8601标准表示，并且使用UTC时间。</p><p>格式为：YYYY-MM-ddTHH:mm:ssZ。</p> |

## HaVipEipAttachment

HaVip关联EIP信息。

被如下接口引用：DescribeHaVips

| 参数名称       | 类型     | 描述         |
| ---------- | ------ | ---------- |
| eipId      | String | 弹性公网IP的ID。 |
| eipAddress | String | 弹性公网IP地址。  |

## HaVipInfo

高可用虚拟IP信息。

被如下接口引用：DescribeHaVips

| 参数名称                | 类型                                                 | 描述                      |
| ------------------- | -------------------------------------------------- | ----------------------- |
| haVipId             | String                                             | 高可用虚拟IP的ID。             |
| name                | String                                             | 高可用虚拟IP名称。              |
| regionId            | String                                             | 地域ID。                   |
| vpcId               | String                                             | 所属VPC的ID。               |
| subnetId            | String                                             | 所属子网ID。                 |
| securityGroupId     | String                                             | 安全组ID。                  |
| ipAddress           | String                                             | 高可用虚拟IP的私网IPv4地址。       |
| associatedInstances | Array of String                                    | 关联的实例ID列表。              |
| masterInstanceId    | String                                             | 当前主实例ID，未绑定实例时为null。    |
| associatedEips      | Array of [HaVipEipAttachment](#havipeipattachment) | 关联的弹性公网IP信息列表，未绑定时为空列表。 |
| createTime          | String                                             | 创建时间。                   |
| tags                | [Tags](#tags)                                      | 标签列表。                   |

## IPv6Type

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

被如下接口引用：CreateSubnet, ModifySubnetStackType

| 值       | 值说明   |
| ------- | ----- |
| Private | 内网类型。 |
| Public  | 公网类型。 |

## Image

描述镜像的基本信息。

被如下接口引用：DescribeImages

| 参数名称             | 类型                                         | 描述         |
| ---------------- | ------------------------------------------ | ---------- |
| imageId          | String                                     | 镜像ID。      |
| imageName        | String                                     | 镜像的名称。     |
| imageType        | [ImageType](#imagetype)                    | 镜像的类型。     |
| imageSource      | [ImageSource](#imagesource)                | 镜像的来源。     |
| imageSize        | String                                     | 镜像的大小。     |
| imageDescription | String                                     | 镜像描述信息。    |
| imageVersion     | String                                     | 镜像的版本。     |
| imageStatus      | [ImageStatus](#imagestatus)                | 镜像的状态。     |
| nicNetworkType   | Array of [NicNetworkType](#nicnetworktype) | 镜像支持的网卡类型。 |
| category         | String                                     | 镜像的分类。     |
| osType           | [ImageOsType](#imageostype)                | 操作系统类型。    |
| tags             | [Tags](#tags)                              | 实例关联的标签。   |

## ImageOsType

描述操作系统类型。

被如下接口引用：DescribeImages, DescribeCustomImages

| 值       | 值说明          |
| ------- | ------------ |
| linux   | Linux操作系统。   |
| bsd     | BSD操作系统。     |
| windows | Windows操作系统。 |
| android | Android操作系统。 |
| any     | 任意类型。        |

## ImageSource

描述镜像来源的值。

被如下接口引用：DescribeImages, DescribeCustomImages

| 值         | 值说明    |
| --------- | ------ |
| OFFICIAL  | 官方镜像。  |
| MARKETING | 市场镜像。  |
| CUSTOM    | 自定义镜像。 |

## ImageStatus

描述镜像状态的值。

被如下接口引用：DescribeImages, DescribeCustomImages

| 值           | 值说明     |
| ----------- | ------- |
| CREATING    | 镜像创建中。  |
| AVAILABLE   | 镜像创建成功。 |
| UNAVAILABLE | 镜像下架。   |
| SYNCING     | 镜像复制中。  |
| FAILED      | 镜像创建失败。 |
| DELETING    | 镜像释放中。  |
| PROCESSING  | 镜像进行中。  |

## ImageType

描述镜像类型的值。

被如下接口引用：DescribeImages, DescribeCustomImages

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

## InstanceApiMonitorMeta

描述实例监控类型的值

被如下接口引用：DescribeInstanceMonitorData

| 值                          | 值说明                                                                                                                                                            |
| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| CPU\_UTILIZATION           | <p>CPU 利用率。</p><p>单位百分比。</p>                                                                                                                                   |
| HYPERVISOR\_IO\_WAIT\_TIME | <p>虚拟化层 I/O 等待时间。</p><p>单位百分比。</p>                                                                                                                             |
| HYPERVISOR\_QUEUE\_TIME    | <p>虚拟化层 CPU 队列时间。</p><p>单位百分比。</p>                                                                                                                             |
| HYPERVISOR\_CPU\_USER      | <p>虚拟机对应进程在物理机上的CPU用户态使用率。</p><p>单位百分比。</p>                                                                                                                    |
| HYPERVISOR\_CPU\_TIME      | <p>虚拟机对应进程在物理机上的CPU使用率。</p><p>单位百分比。</p>                                                                                                                       |
| HYPERVISOR\_CPU\_SYSTEM    | <p>虚拟机对应进程在物理机上的CPU内核态使用率。</p><p>单位百分比。</p>                                                                                                                    |
| PROC\_CPU\_USER            | <p>CPU 用户态的比例类型。</p><p>单位百分比。</p>                                                                                                                              |
| PROC\_CPU\_SYSTEM          | <p>CPU 内核态的比例类型。</p><p>单位百分比。</p>                                                                                                                              |
| PROC\_CPU\_IOWAIT          | <p>CPU IOWAIT的比例类型。</p><p>单位百分比。</p>                                                                                                                           |
| PROC\_CPU\_SOFTIRQ         | <p>CPU SOFTIRQ的比例类型。</p><p>单位百分比。</p>                                                                                                                          |
| PROC\_CPU\_IDLE            | <p>CPU 空闲的比例类型。</p><p>单位百分比。</p>                                                                                                                               |
| PROC\_CPU\_OTHER           | <p>CPU 其他的比例类型。</p><p>单位百分比。</p>                                                                                                                               |
| LOAD1                      | 系统负载平均值 - 最近 1 分钟。                                                                                                                                             |
| LOAD5                      | 系统负载平均值 - 最近 5 分钟。                                                                                                                                             |
| LOAD15                     | 系统负载平均值 - 最近 15 分钟。                                                                                                                                            |
| MEM\_UTIL                  | <p>利用率。</p><p>单位百分比。</p>                                                                                                                                       |
| REALMEM\_UTIL              | <p>真实利用率。</p><p>单位百分比。</p>                                                                                                                                     |
| TCP\_ESTABLISHED           | <p>TCP连接数。</p><p>单位个。</p>                                                                                                                                      |
| SWAP\_TOTAL                | <p>虚拟机系统配置的swap总容量。</p><p>用于评估系统支持的最大交换空间容量。</p><p>单位KiB。</p>                                                                                                  |
| SWAP\_FREE                 | <p>当前剩余可用的swap空间大小。</p><p>用于评估交换区剩余可用资源。</p><p>单位KiB。</p>                                                                                                      |
| SWAP\_IN                   | 系统启动以来从swap空间读入内存的页面总数 单位页。                                                                                                                                    |
| SWAP\_OUT                  | 系统启动以来从内存写入swap空间的页面总数 单位页。                                                                                                                                    |
| KSWAPD\_STEAL              | 由kswapd内核线程回收的页面总数 单位页。                                                                                                                                        |
| KSWAPD\_LHWM               | <p>kswapd刚完成内存回收后，系统快速再次触发低水位线的次数。</p><p>单位次。</p>                                                                                                              |
| RX\_PACKETS                | <p>虚拟机VF网卡的每秒接收包量。</p><p>单位Packets。</p>                                                                                                                        |
| TX\_PACKETS                | <p>虚拟机VF网卡的每秒发送包量。</p><p>单位Packets。</p>                                                                                                                        |
| RX\_DROPPED                | <p>该Nic的VF网卡+Virtio网卡入方向相加的每秒丢包数量。</p><p>单位Packets。</p>                                                                                                        |
| TX\_DROPPED                | <p>该Nic的VF网卡+Virtio网卡出方向相加的每秒丢包数量。</p><p>单位Packets。</p>                                                                                                        |
| RX\_ERRORS                 | <p>该Nic的VF网卡+Virtio网卡入方向相加的每秒错误包数量。</p><p>单位Packets。</p>                                                                                                       |
| TX\_ERRORS                 | <p>该Nic的VF网卡+Virtio网卡出方向相加的每秒错误包数量。</p><p>单位Packets。</p>                                                                                                       |
| RX\_BITS                   | <p>虚拟机VF网卡的每秒接收比特数。</p><p>单位bits。</p>                                                                                                                          |
| TX\_BITS                   | <p>虚拟机VF网卡的每秒发送比特数。</p><p>单位bits。</p>                                                                                                                          |
| CPU\_PSI\_SOME\_AVG60      | <p>CPU PSI（Some / 60s Avg）。</p><p>过去 60 秒内，至少有一个任务因等待 CPU 而暂停的时间占比。</p><p>数值越高，表示任务等待 CPU 的情况越明显。</p><p>无需开启 QGA 采集。</p><p>windows、BSD镜像暂不支持。</p><p>单位百分比。</p> |
| MEM\_PSI\_SOME\_AVG60      | <p>Memory PSI（Some / 60s Avg）。</p><p>过去 60 秒内，至少有一个任务因等待内存回收、分页或 swap 而暂停的时间占比。</p><p>无需开启 QGA 采集。</p><p>windows、BSD镜像暂不支持。</p><p>单位百分比。</p>                   |
| MEM\_PSI\_FULL\_AVG60      | <p>Memory PSI（Full / 60s Avg）。</p><p>过去 60 秒内，所有任务同时因等待内存而暂停的时间占比。</p><p>持续非 0 通常表示内存压力较高。</p><p>无需开启 QGA 采集。</p><p>windows、BSD镜像暂不支持。</p><p>单位百分比。</p>        |
| IO\_PSI\_SOME\_AVG60       | <p>IO PSI（Some / 60s Avg）。</p><p>过去 60 秒内，至少有一个任务因等待磁盘或存储 IO 而暂停的时间占比。</p><p>无需开启 QGA 采集。</p><p>windows、BSD镜像暂不支持。</p><p>单位百分比。</p>                            |
| IO\_PSI\_FULL\_AVG60       | <p>IO PSI（Full / 60s Avg）。</p><p>过去 60 秒内，所有任务同时因等待磁盘或存储 IO 而暂停的时间占比。</p><p>持续非 0 表示 IO 等待较严重。</p><p>无需开启 QGA 采集。</p><p>windows、BSD镜像暂不支持。</p><p>单位百分比。</p>    |
| UPTIME                     | <p>实例运行时长。</p><p>单位秒。</p>                                                                                                                                      |
| GPU\_UTILIZATION           | <p>GPU 使用率。</p><p>单位百分比。</p>                                                                                                                                   |
| GPU\_TEMPERATURE           | <p>GPU 温度。</p><p>单位摄氏度。</p>                                                                                                                                    |
| GPU\_MEMORY\_USED          | <p>GPU 显存使用量。</p><p>单位MiB。</p>                                                                                                                                 |
| GPU\_MEMORY\_UTILIZATION   | <p>GPU 显存使用率。</p><p>单位百分比。</p>                                                                                                                                 |
| GPU\_POWER\_DRAW           | <p>GPU 功耗。</p><p>单位瓦特(W)。</p>                                                                                                                                  |
| GPU\_FAN\_SPEED            | <p>GPU 风扇速率。</p><p>单位百分比。</p>                                                                                                                                  |

## InstanceInfo

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

被如下接口引用：DescribeInstances

| 参数名称               | 类型                                          | 描述                                        |
| ------------------ | ------------------------------------------- | ----------------------------------------- |
| instanceId         | String                                      | 实例唯一ID。                                   |
| instanceName       | String                                      | 实例显示名称。                                   |
| zoneId             | String                                      | 实例所属的可用区ID。                               |
| instanceType       | String                                      | <p>CPU 规格。</p><p>如果是GPU实例，该字段取值为null。</p> |
| cpu                | Integer                                     | <p>CPU 核数。</p><p>单位：个。</p>                |
| memory             | Integer                                     | <p>内存容量。</p><p>单位：GiB。</p>                |
| imageId            | String                                      | 镜像ID。                                     |
| imageName          | String                                      | 镜像名称。                                     |
| timeZone           | String                                      | 设置的系统时区信息。                                |
| nicNetworkType     | [NicNetworkType](#nicnetworktype)           | 网卡模式。                                     |
| status             | [InstanceStatusValue](#instancestatusvalue) | 实例状态。                                     |
| systemDisk         | [SystemDisk](#systemdisk)                   | 系统盘信息。                                    |
| dataDisks          | Array of [DataDisk](#datadisk)              | 实例上挂载的数据盘信息。                              |
| publicIpAddresses  | Array of String                             | 实例上公网IPv4列表。                              |
| privateIpAddresses | Array of String                             | 实例上内网IP列表。                                |
| keyId              | String                                      | 安装的SSH密钥ID。                               |
| subnetId           | String                                      | 实例主网卡关联的子网ID。                             |
| securityGroupId    | 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](#nicinfo)                | 实例上绑定的网卡信息。                               |
| tags               | [Tags](#tags)                               | 实例关联的标签。                                  |
| loadBalancerIds    | Array of String                             | 实例上绑定的负载均衡ID列表。                           |
| placementGroupId   | String                                      | 实例所属的置放组ID。                               |
| instanceOptions    | [InstanceOptions](#instanceoptions)         | 实例选项配置。                                   |

## InstanceOptions

描述实例选项相关配置。

被如下接口引用：CreateZecInstances, DescribeInstances

| 参数名称                 | 类型      | 必选 | 描述                                                       |
| -------------------- | ------- | -- | -------------------------------------------------------- |
| nestedVirtualization | Boolean | 否  | <p>是否启用嵌套虚拟化。</p><p>如果要开启嵌套虚拟化，需要联系Support开通,否则设置无效。</p> |

## InstanceStatus

描述实例状态的信息。

被如下接口引用：DescribeInstancesStatus

| 参数名称           | 类型                                          | 描述     |
| -------------- | ------------------------------------------- | ------ |
| instanceId     | String                                      | 实例的ID。 |
| instanceStatus | [InstanceStatusValue](#instancestatusvalue) | 实例的状态。 |

## InstanceStatusValue

描述实例状态的相关值。

被如下接口引用：DescribeInstancesStatus, DescribeInstances

| 值              | 值说明      |
| -------------- | -------- |
| DEPLOYING      | 创建部署中。   |
| REBUILDING     | 重装系统中。   |
| REBOOT         | 系统重启中。   |
| RUNNING        | 运行开机。    |
| STOPPED        | 已关机状态。   |
| BOOTING        | 系统启动中。   |
| RELEASING      | 实例释放中。   |
| STOPPING       | 系统关机中。   |
| RECYCLE        | 实例处于回收站。 |
| RECYCLING      | 实例回收中。   |
| CREATE\_FAILED | 创建失败。    |
| IMAGING        | 镜像制作中。   |
| RESIZING       | 变更规格大小中。 |

## InstanceTypeCapacityItem

实例类型库存容量明细。

被如下接口引用：DescribeVmInventoryCapacity

| 参数名称         | 类型                                          | 描述                                                           |
| ------------ | ------------------------------------------- | ------------------------------------------------------------ |
| instanceType | String                                      | CPU 实例类型，如 z2a、z2i、z4a。                                      |
| gpuSpec      | String                                      | <p>GPU 型号，如 z4a.g.C49。</p><p>仅 GPU 实例返回此字段。</p>              |
| capacity     | [VmInventoryCapacity](#vminventorycapacity) | <p>该实例类型的库存容量级别。</p><p>库存容量根据所有机型可售核数定义，不包含内存、存储或其他资源因素。</p> |

## InstanceTypeQuotaItem

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

被如下接口引用：DescribeZoneInstanceConfigInfos

| 参数名称                         | 类型                                                 | 描述                           |
| ---------------------------- | -------------------------------------------------- | ---------------------------- |
| zoneId                       | String                                             | 可用区ID。                       |
| instanceType                 | String                                             | 实例规格ID。                      |
| instanceTypeName             | String                                             | 实例规格的名称。                     |
| cpuCount                     | Integer                                            | <p>CPU核数。</p><p>单位：核。</p>    |
| memory                       | Integer                                            | <p>实例内存容量。</p><p>单位：GiB。</p> |
| bps                          | Integer                                            | 单张网卡的带宽上限。单位：比特/秒。           |
| pps                          | Integer                                            | 单张网卡的收发包上限。单位：个/秒。           |
| internetMaxBandwidthOutLimit | Integer                                            | 最大出口带宽限制。                    |
| withStock                    | Boolean                                            | 是否有库存。                       |
| internetChargeTypes          | Array of [InternetChargeType](#internetchargetype) | 支持的网络计费类型。                   |

## InternetChargeType

描述IP网络的计费模式。

被如下接口引用：CreateNetworkInterface, CreateEips, DescribeZoneInstanceConfigInfos, DescribeUnmanagedEgressIps, InquiryPriceCreateInstance, DescribeEips, DescribeEipInternetChargeTypes, AssignNetworkInterfaceIpv6, CreateCrossRegionBandwidth, CreateZecInstances, DescribeEipPrice, DescribeNetworkInterfacePublicIPv6, InquiryPriceCreateCrossRegionBandwidth, DescribeCrossRegionBandwidth, ChangeEipInternetChargeType

| 值                | 值说明        |
| ---------------- | ---------- |
| ByBandwidth      | 固定带宽计费方式。  |
| ByTrafficPackage | 流量包计费方式。   |
| BandwidthCluster | 共享带宽包计费方式。 |

## IpType

IP类型。

被如下接口引用：CreateRoute, DescribeByoipRegions, DescribeRoutes

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

## Ipv6CidrInfo

IPv6 CIDR信息详情。

被如下接口引用：DescribeIpv6Cidrs

| 参数名称            | 类型                                      | 描述                                                         |
| --------------- | --------------------------------------- | ---------------------------------------------------------- |
| cidrId          | String                                  | CIDR ID。                                                   |
| regionId        | String                                  | CIDR所属的区域节点ID。                                             |
| name            | String                                  | CIDR的名称。                                                   |
| cidrBlock       | String                                  | CIDR地址块，例如：2400:8a00::/28。                                 |
| source          | [CidrCreateSource](#cidrcreatesource)   | <p>CIDR的来源。</p><p>如CONSOLE（属于zenlayer）或 BYOIP（客户自带IP）。</p> |
| networkLineType | [NetworkLineType](#networklinetype)     | <p>CIDR网络类型。</p><p>表示该CIDR支持的公网IP线路类型。</p>                 |
| subnetIds       | Array of String                         | 子网ID集合。                                                    |
| nicIds          | Array of String                         | 网卡ID集合。                                                    |
| netmask         | Integer                                 | <p>子网掩码。</p><p>表示CIDR的网络位长度。</p>                           |
| poolId          | String                                  | <p>Pool的ID。</p><p>表示该CIDR所属的公网IP池。</p>                     |
| createTime      | String                                  | CIDR的创建时间。                                                 |
| expiredTime     | String                                  | CIDR的到期时间。                                                 |
| resourceGroup   | [ResourceGroupInfo](#resourcegroupinfo) | 该CIDR所属的资源组。                                               |
| status          | [CidrStatus](#cidrstatus)               | CIDR的状态。                                                   |
| asn             | Integer                                 | <p>ASN编号。</p><p>仅当CIDR来源为BYOIP时存在。</p>                     |
| tags            | [Tags](#tags)                           | 该CIDR地址段关联的标签。                                             |

## MarketingInfo

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

被如下接口引用：CreateCrossRegionBandwidth, CreateNetworkInterface, CreateEips, CreateZecInstances, CreateDisks, CreateCidr, InquiryPriceCreateCrossRegionBandwidth, CreateByoip

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

## MetricValue

描述监控指标的数据值。

被如下接口引用：DescribeInstanceMonitorData, DescribeDiskMonitorData, DescribeNetworkInterfaceMonitorData

| 参数名称  | 类型     | 描述                                       |
| ----- | ------ | ---------------------------------------- |
| time  | String | 数据点时间。                                   |
| value | Float  | <p>数据点的值。</p><p>如果该值为null,表示取不到相应的值。</p> |

## NatGateway

描述NAT网关的信息。

被如下接口引用：DescribeNatGateways

| 参数名称              | 类型                      | 描述                                                                    |
| ----------------- | ----------------------- | --------------------------------------------------------------------- |
| natGatewayId      | String                  | NAT网关唯一ID。                                                            |
| vpcId             | String                  | NAT网关所属的VPC网络ID。                                                      |
| regionId          | String                  | 区域节点ID。                                                               |
| status            | [NatStatus](#natstatus) | NAT网关的状态。                                                             |
| name              | String                  | NAT网关的名称。                                                             |
| subnetIds         | Array of String         | NAT网关所属的Subnet子网ID集合。                                                 |
| eipIds            | Array of String         | NAT网关所关联的EIP ID集合。                                                    |
| zbgId             | String                  | 边界网关ID。                                                               |
| resourceGroupId   | String                  | 资源组ID。                                                                |
| resourceGroupName | String                  | 资源组名称。                                                                |
| isAllSubnets      | Boolean                 | 是否节点内所有子网关联了NAT网关。                                                    |
| icmpReplyEnabled  | Boolean                 | 是否开启ICMP代回。                                                           |
| securityGroupId   | String                  | 边界网关关联的安全组ID。                                                         |
| 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> |
| tags              | [Tags](#tags)           | 该CIDR地址段关联的标签。                                                        |

## NatStatus

描述NAT网关的状态。

被如下接口引用：DescribeNatGateways

| 值              | 值说明         |
| -------------- | ----------- |
| CREATING       | NAT网关创建中。   |
| RUNNING        | NAT网关运行。    |
| RECYCLED       | NAT网关处于回收站。 |
| CREATE\_FAILED | NAT网关创建失败。  |
| RELEASING      | NAT网关释放中。   |

## NetmaskInfo

描述CIDR掩码的信息。

被如下接口引用：CreateCidr, DescribeCidrPrice

| 参数名称    | 类型      | 必选 | 描述                                  |
| ------- | ------- | -- | ----------------------------------- |
| netmask | Integer | 是  | <p>掩码大小。</p><p>可选值范围：\[27, 32]</p>  |
| amount  | Integer | 是  | <p>CIDR的数量。</p><p>可选值范围：\[0, +)</p> |

## NetworkLineType

描述IP网络类型的方式。

被如下接口引用：DescribeByoipPrice, CreateEips, DescribeIpv6Cidrs, DescribeByoipRegions, DescribeEipRemoteRegions, CreateByoip, DescribeUnmanagedEgressIps, InquiryPriceCreateInstance, DescribeEips, DescribeCidrs, DescribeEipInternetChargeTypes, CreateZecInstances, DescribeEipPrice, CreateCidr, DescribeCidrPrice

| 值           | 值说明                             |
| ----------- | ------------------------------- |
| PremiumBGP  | <p>优质 BGP。</p><p>高性能网络。</p>     |
| CN2         | 回国优化线路。                         |
| LocalLine   | 本地IP。                           |
| StandardBGP | <p>标准 BGP。</p><p>通用网络，成本优化。</p> |
| CMI         | 中国移动。                           |
| CUG         | 中国联通。                           |
| CTG         | 中国电信。                           |

## NextHopType

下一跳的类型相关值。

被如下接口引用：DescribeRoutes

| 值   | 值说明    |
| --- | ------ |
| NIC | 虚拟网卡。  |
| VPC | 全球VPC。 |
| NAT | NAT网关。 |
| ZBG | 边界网关。  |

## NicApiMonitorMeta

描述网卡监控类型的值

被如下接口引用：DescribeNetworkInterfaceMonitorData

| 值           | 值说明                                                      |
| ----------- | -------------------------------------------------------- |
| RX\_BITS    | <p>虚拟机VF网卡的每秒接收比特数。</p><p>单位bits。</p>                    |
| TX\_BITS    | <p>虚拟机VF网卡的每秒发送比特数。</p><p>单位bits。</p>                    |
| RX\_PACKETS | <p>虚拟机VF网卡的每秒接收包量。</p><p>单位Packets。</p>                  |
| TX\_PACKETS | <p>虚拟机VF网卡的每秒发送包量。</p><p>单位Packets。</p>                  |
| RX\_DROPPED | <p>该Nic的VF网卡+Virtio网卡入方向相加的每秒丢包数量。</p><p>单位Packets。</p>  |
| TX\_DROPPED | <p>该Nic的VF网卡+Virtio网卡出方向相加的每秒丢包数量。</p><p>单位Packets。</p>  |
| RX\_ERRORS  | <p>该Nic的VF网卡+Virtio网卡入方向相加的每秒错误包数量。</p><p>单位Packets。</p> |
| TX\_ERRORS  | <p>该Nic的VF网卡+Virtio网卡出方向相加的每秒错误包数量。</p><p>单位Packets。</p> |

## NicInfo

描述网卡的相关信息。

被如下接口引用：DescribeInstances, DescribeNetworkInterfaces

| 参数名称            | 类型                                      | 描述                                          |
| --------------- | --------------------------------------- | ------------------------------------------- |
| nicId           | String                                  | 网卡的ID。                                      |
| name            | String                                  | 网卡的名称。                                      |
| status          | [NicStatus](#nicstatus)                 | 网卡状态。                                       |
| nicType         | [NicType](#nictype)                     | 网卡类型。                                       |
| regionId        | String                                  | 所属节点ID。                                     |
| nicSubnetType   | [SubnetStackType](#subnetstacktype)     | 网卡的IP堆栈类型。                                  |
| publicIpList    | Array of String                         | 关联的公网IP。                                    |
| privateIpList   | Array of String                         | 关联的内网IP。                                    |
| primaryIpv4     | String                                  | 主的内网IPv4地址。                                 |
| primaryIpv6     | String                                  | <p>网卡上的主IPv6地址。</p><p>如果堆栈类型是V4,该值取值为空。</p> |
| ipv6Cidr        | String                                  | <p>网卡上的IPv6地址。</p><p>如果堆栈类型是V4,该值取值为空。</p>  |
| secondaryIpv4s  | Array of String                         | 网卡上的辅助 IPv4 地址。                             |
| macAddress      | String                                  | 网卡的MAC地址。                                   |
| instanceId      | String                                  | 所绑定的实例ID。                                   |
| vpcId           | String                                  | 所关联VPC ID。                                  |
| subnetId        | String                                  | 所关联的子网ID。                                   |
| createTime      | String                                  | 网卡的创建时间。                                    |
| updateTime      | String                                  | 网卡的更新时间。                                    |
| resourceGroup   | [ResourceGroupInfo](#resourcegroupinfo) | 网卡所属的资源组信息。                                 |
| securityGroupId | String                                  | 网卡关联的安全组ID。                                 |
| tags            | [Tags](#tags)                           | 该网卡关联的标签。                                   |

## NicNetworkType

网卡模式的相关值。

被如下接口引用：DescribeImages, CreateZecInstances, DescribeInstances, ChangeNicNetworkType, DescribeCustomImages

| 值          | 值说明          |
| ---------- | ------------ |
| Auto       | 默认模式(镜像自适应)。 |
| FailOver   | 故障转移模式。      |
| VirtioOnly | 软件模拟模式。      |
| VfOnly     | 物理直通模式。      |

## NicStatus

描述网卡创建的状态。

被如下接口引用：DescribeInstances, DescribeNetworkInterfaces

| 值              | 值说明       |
| -------------- | --------- |
| PENDING        | 网卡创建中。    |
| AVAILABLE      | 可用未绑定实例的。 |
| ATTACHING      | 绑定实例过程中。  |
| DETACHING      | 解绑实例过程中。  |
| DELETING       | 删除中。      |
| CREATE\_FAILED | 创建失败的。    |
| USED           | 已经绑定实例的。  |

## NicType

描述网卡的类型相关值。

被如下接口引用：DescribeInstances, DescribeNetworkInterfaces

| 值         | 值说明     |
| --------- | ------- |
| Primary   | 主网卡类型。  |
| Secondary | 辅助网卡类型。 |

## PlacementGroupConstraintStatus

置放组约束满足状态。

被如下接口引用：DescribePlacementGroups

| 值           | 值说明        |
| ----------- | ---------- |
| Satisfied   | 已满足放置策略约束。 |
| Unsatisfied | 未满足放置策略约束。 |

## PlacementGroupInfo

描述置放组的详细信息。

被如下接口引用：DescribePlacementGroups

| 参数名称             | 类型                                                                | 描述                                            |
| ---------------- | ----------------------------------------------------------------- | --------------------------------------------- |
| placementGroupId | String                                                            | 置放组ID。                                        |
| name             | String                                                            | 置放组名称。                                        |
| zoneId           | String                                                            | 置放组所属可用区ID。                                   |
| partitionNum     | Integer                                                           | <p>置放组的分区数。</p><p>取值范围为2到5，决定置放组最大可关联实例数。</p> |
| affinity         | Integer                                                           | <p>置放组的亲和度。</p><p>取值范围为1到分区数向下取整除以2。</p>      |
| instanceCount    | Integer                                                           | 置放组内的实例数量。                                    |
| instanceIds      | Array of String                                                   | 置放组内关联的实例ID列表。                                |
| constraintStatus | [PlacementGroupConstraintStatus](#placementgroupconstraintstatus) | 置放组约束满足状态。                                    |
| createTime       | String                                                            | 置放组的创建时间。                                     |
| resourceGroup    | [ResourceGroupInfo](#resourcegroupinfo)                           | 置放组所属的资源组信息。                                  |
| tags             | [Tags](#tags)                                                     | 置放组的标签。                                       |

## PolicyInfo

描述防护策略的信息。

被如下接口引用：DescribePolicys

| 参数名称              | 类型            | 描述            |
| ----------------- | ------------- | ------------- |
| policyId          | String        | 防护策略唯一ID。     |
| policyName        | String        | 防护策略名称。       |
| createTime        | String        | 创建时间。         |
| resourceGroupId   | String        | 防护策略所属的资源组ID。 |
| resourceGroupName | String        | 防护策略所属的资源组名称。 |
| tags              | [Tags](#tags) | 防护策略关联的标签。    |

## PolicyRegion

区域的基本信息。

被如下接口引用：DescribePolicyRegions

| 参数名称       | 类型     | 描述    |
| ---------- | ------ | ----- |
| regionId   | String | 区域ID。 |
| regionName | String | 国家名称。 |
| areaName   | String | 地域名称。 |

## PolicyUpdateType

DDoS 更新相关配置的类型。

被如下接口引用：ModifyPolicy

| 值              | 值说明            |
| -------------- | -------------- |
| UdpReflect     | 更新反射攻击防护过滤的端口。 |
| TrafficControl | 更新源IP限速限制。     |
| Port           | 更新端口封禁规则。      |
| BlockProtocol  | 更新封禁的协议。       |
| IpList         | 更新黑白名单IP。      |
| BlockRegion    | 更新区域封禁的区域。     |
| Fingerprint    | 更新指纹过滤规则。      |

## PoolInfo

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

被如下接口引用：DescribePools

| 参数名称          | 类型      | 描述            |
| ------------- | ------- | ------------- |
| poolId        | String  | 公网IP池的ID。     |
| regionId      | String  | 公网IP池所在的节点ID。 |
| name          | String  | 公网IP池的名称。     |
| createTime    | String  | 公网IP池的创建时间。   |
| ipv4CidrCount | Integer | CIDR IPv4的数量。 |
| ipv6CidrCount | Integer | CIDR IPv6的数量。 |

## PriceCategory

描述价格类型。

被如下接口引用：InquiryPriceCreateInstance

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

## PriceItem

描述价格的信息。

被如下接口引用：InquiryPriceModifyCrossRegionBandwidth, InquiryPriceCreateDisks, DescribeByoipPrice, InquiryPricePublicIpv6, DescribeEipPrice, InquiryPriceCreateCrossRegionBandwidth, InquiryPriceCreateNatGateway, InquiryPriceCreateInstance, DescribeCidrPrice

| 参数名称                    | 类型                               | 描述                                                                                                                         |
| ----------------------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| 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>后付费模式使用，可取值范围：<br>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)  | 价格所属类别。                                                                                                                    |

## PrivateIpInfo

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

被如下接口引用：AvailableLanIp

| 参数名称         | 类型     | 描述                                                    |
| ------------ | ------ | ----------------------------------------------------- |
| lanIp        | String | 该 vNIC 上已分配的内网 IPv4 地址，可用于与指定 EIP 进行绑定。               |
| nicId        | String | 弹性网卡（vNIC）的 ID。                                       |
| nicName      | String | 弹性网卡（vNIC）的名称。                                        |
| instanceId   | String | <p>vNIC 所挂载实例的 ID。</p><p>若 vNIC 未挂载至任何实例，则为 null。</p> |
| instanceName | String | <p>vNIC 所挂载实例的名称。</p><p>若 vNIC 未挂载至任何实例，则为 null。</p>  |

## Protocol

描述Ddos协议。

被如下接口引用：CreatePolicy, DescribePolicyDetail, ModifyPolicy

| 值    | 值说明                               |
| ---- | --------------------------------- |
| TCP  | TCP 协议。                           |
| UDP  | UDP 协议。                           |
| ICMP | <p>ICMP 协议。</p><p>端口封禁不支持该协议。</p> |

## PublicIpv6CidrAddress

公网IPv6的基本信息。

被如下接口引用：DescribeNetworkInterfacePublicIPv6

| 参数名称               | 类型                                            | 描述                                 |
| ------------------ | --------------------------------------------- | ---------------------------------- |
| ipv6CidrId         | String                                        | IPv6 CIDR的ID。                      |
| ipv6Cidr           | String                                        | IPv6 CIDR的地址。                      |
| primaryIpv6Address | String                                        | 网卡的主IPv6地址。                        |
| internetChargeType | [InternetChargeType](#internetchargetype)     | IPv6的网络计费类型。                       |
| bandwidth          | Integer                                       | <p>IPv6的公网带宽限速。</p><p>单位：Mbps。</p> |
| rateLimitMode      | [RateLimitMode](#ratelimitmode)               | <p>限速模式。</p><p>默认值：LOOSE</p>       |
| trafficPackageSize | Float                                         | <p>IPv6的流量包大小。</p><p>单位：TB。</p>    |
| bandwidthCluster   | [BandwidthClusterInfo](#bandwidthclusterinfo) | 关联的带宽组信息。                          |

## QosPolicyGroup

QoS策略组信息。

被如下接口引用：DescribeQosPolicyGroups

| 参数名称             | 类型                                                     | 描述           |
| ---------------- | ------------------------------------------------------ | ------------ |
| qosPolicyGroupId | String                                                 | QoS策略组ID。    |
| name             | String                                                 | QoS策略组名称。    |
| regionId         | String                                                 | 地域ID。        |
| bandwidthLimit   | Integer                                                | 带宽限制，单位Mbps。 |
| rateLimitMode    | [RateLimitMode](#ratelimitmode)                        | 限速模式。        |
| memberCount      | Integer                                                | 成员数量。        |
| members          | Array of [QosPolicyGroupMember](#qospolicygroupmember) | 成员列表。        |
| createTime       | String                                                 | 创建时间。        |
| resourceGroup    | [ResourceGroupInfo](#resourcegroupinfo)                | 所属资源组信息。     |
| tags             | [Tags](#tags)                                          | 标签列表。        |

## QosPolicyGroupMember

QoS策略组成员信息。

被如下接口引用：DescribeQosPolicyGroups, AddQosPolicyGroupMembers

| 参数名称       | 类型                                  | 必选 | 描述         |
| ---------- | ----------------------------------- | -- | ---------- |
| resourceId | String                              | 是  | IP 资源 的ID。 |
| ipType     | [BandwidthIpType](#bandwidthiptype) | 是  | IP类型。      |

## RateLimitMode

QoS策略组的限速模式。

被如下接口引用：CreateQosPolicyGroup, CreateEips, DescribeNetworkInterfacePublicIPv6, ModifyNetworkInterfacePublicIPv6BandwidthLimitMode, ModifyUnmanagedEgressIpBandwidthLimitMode, DescribeQosPolicyGroups, DescribeUnmanagedEgressIps, DescribeEips, ModifyEipBandwidthLimitMode, ModifyQosPolicyGroup, AssignNetworkInterfaceIpv6

| 值      | 值说明                |
| ------ | ------------------ |
| LOOSE  | 宽松模式：允许短时间突发超出限制。  |
| STRICT | 严格模式：严格限制，不允许任何突发。 |

## ReflectUdpPortPolicy

UDP反射源端口

被如下接口引用：DescribeReflectUdpPortOptions

| 参数名称 | 类型      | 描述      |
| ---- | ------- | ------- |
| name | String  | 反射攻击类型。 |
| port | Integer | 反射源端口。  |

## Region

支持售卖 ByoIP CIDR 的区域。

被如下接口引用：DescribeByoipRegions

| 参数名称     | 类型                                  | 描述       |
| -------- | ----------------------------------- | -------- |
| netmask  | Integer                             | 支持的网段。   |
| regionId | String                              | 支持售卖的区域。 |
| network  | [NetworkLineType](#networklinetype) | 支持的网络类型。 |
| ipType   | [IpType](#iptype)                   | 支持的IP类型。 |

## RegionInfo

节点信息。

被如下接口引用：DescribeSubnetRegions

| 参数名称          | 类型      | 描述        |
| ------------- | ------- | --------- |
| regionId      | String  | 节点ID。     |
| regionName    | String  | 节点名称。     |
| regionTitle   | String  | 节点标题。     |
| enablePubIpv6 | Boolean | 是否支持IPv6。 |

## ReplaceIp

替换的公网IP信息。

被如下接口引用：ReplaceEipAddress

| 参数名称     | 类型     | 必选 | 描述                                                              |
| -------- | ------ | -- | --------------------------------------------------------------- |
| eipId    | String | 否  | 需要替换的弹性公网IP ID。                                                 |
| ownIp    | String | 否  | <p>原IP。</p><p>当IP是三线IP(IP线路类型为<code>ThreeLine</code>)时需要指定。</p> |
| targetIp | String | 否  | <p>需要变更的目标IP。</p><p>如果未指定，将由系统随机分配。</p>                         |

## ResourceGroupInfo

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

被如下接口引用：DescribeAutoSnapshotPolicies, DescribeVpcs, DescribeIpv6Cidrs, DescribeInstances, DescribeQosPolicyGroups, DescribeSnapshots, DescribePlacementGroups

| 参数名称              | 类型     | 描述     |
| ----------------- | ------ | ------ |
| resourceGroupId   | String | 资源组ID。 |
| resourceGroupName | String | 资源组名称。 |

## RouteInfo

描述路由的相关信息。

被如下接口引用：DescribeRoutes

| 参数名称                 | 类型                          | 描述                                                                                              |
| -------------------- | --------------------------- | ----------------------------------------------------------------------------------------------- |
| vpcId                | String                      | 路由关联的VPC的ID。                                                                                    |
| vpcName              | String                      | 路由关联的VPC的名称。                                                                                    |
| ipVersion            | [IpType](#iptype)           | <p>IP类型。</p><p>支持<code>IPv4</code>和<code>IPv6</code>两种类型。</p>                                   |
| type                 | [RouteType](#routetype)     | 路由类型。                                                                                           |
| destinationCidrBlock | String                      | <p>IPv4或IPv6的目标网段。</p><p>例如：10.0.1.0/24。</p>                                                    |
| cidrBlock            | String                      | <p>IPv4或IPv6的目标网段。</p><p>例如：10.0.1.0/24。</p><p>该字段已废弃，请使用<code>destinationCidrBlock</code>。</p> |
| nextHopId            | String                      | 下一跳资源ID。                                                                                        |
| nextHopName          | String                      | 下一跳资源名称。                                                                                        |
| routeId              | String                      | 路由ID。                                                                                           |
| name                 | String                      | 路由的名称。                                                                                          |
| sourceCidrBlock      | String                      | <p>源IP地址。</p><p>当<code>路由类型</code>是<code>RouteTypePolicy(策略路由)</code>时可取值。</p>                  |
| priority             | Integer                     | 路由优先级。                                                                                          |
| nextHopType          | [NextHopType](#nexthoptype) | 下一跳的类型。                                                                                         |
| createTime           | String                      | 路由的创建时间。                                                                                        |

## RouteType

描述路由类型的值。

被如下接口引用：CreateRoute, DescribeRoutes

| 值                | 值说明                             |
| ---------------- | ------------------------------- |
| RouteTypeSubnet  | <p>子网路由。</p><p>该路由为系统生成的路由。</p> |
| RouteTypeStatic  | <p>静态路由。</p><p>可以通过创建自定义路由。</p> |
| RouteTypePolicy  | <p>策略路由。</p><p>可以通过创建自定义路由。</p> |
| RouteTypeNatGw   | NAT 网关路由。                       |
| RouteTypeTransit | 动态路由。                           |

## RoutingMode

描述路由级别的枚举值。

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

| 值        | 值说明      |
| -------- | -------- |
| Regional | 节点级别路由。  |
| Global   | 全节点级别路由。 |

## SecurityGroupInfo

描述安全组的基本信息。

被如下接口引用：DescribeSecurityGroups

| 参数名称               | 类型              | 描述                                              |
| ------------------ | --------------- | ----------------------------------------------- |
| securityGroupId    | String          | 安全组ID。                                          |
| securityGroupName  | String          | 安全组名称。                                          |
| scope              | String          | <p>范围。</p><p>目前只有全球范围(<code>Global</code>)。</p> |
| createTime         | String          | 创建时间。                                           |
| vpcIds             | Array of String | 关联的VPC ID列表。                                    |
| isDefault          | Boolean         | 是否是默认安全组。                                       |
| nicIdList          | Array of String | 关联安全组的网卡ID列表。                                   |
| natIdList          | Array of String | 关联安全组的NAT网关ID列表。                                |
| loadBalancerIdList | Array of String | 关联安全组的负载均衡ID列表。                                 |
| haVipIdList        | Array of String | 关联安全组的高可用虚拟IP ID列表。                             |

## SecurityGroupRuleInfo

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

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

| 参数名称       | 类型      | 必选 | 描述                                                                                                     |
| ---------- | ------- | -- | ------------------------------------------------------------------------------------------------------ |
| direction  | String  | 是  | <p>规则方向。</p><p>ingress: 入方向。</p><p>egress：出方向。</p>                                                     |
| policy     | String  | 是  | <p>设置访问权限。</p><p>accept：接受访问。</p><p>deny: 拒绝访问。</p>                                                    |
| priority   | Integer | 是  | <p>规则优先级。</p><p>可选值范围：\[1, 999]</p>                                                                    |
| ipProtocol | String  | 是  | <p>传输层协议。</p><p>取值大小写敏感, 取值范围：<br>tcp：TCP协议。</p><p>udp：UDP协议。</p><p>icmp：ICMP协议。</p><p>all：支持所有协议。</p> |
| portRange  | String  | 是  | <p>目的端安全组开放的传输层协议相关的端口范围。</p><p>取值范围：<br>TCP/UDP协议：取值范围为1\~65535。</p><p>ICMP协议：-1。</p><p>all：-1。</p>   |
| cidrIp     | String  | 是  | <p>源端IP地址范围。</p><p>支持CIDR格式和IPv4格式的IP地址范围。</p><p>默认值：0.0.XX.XX/0。</p>                                  |
| desc       | String  | 否  | 备注,长度在255个以内。                                                                                          |

## SnapshotInfo

描述快照的信息。

被如下接口引用：DescribeSnapshots

| 参数名称          | 类型                                          | 描述                                        |
| ------------- | ------------------------------------------- | ----------------------------------------- |
| snapshotId    | String                                      | 快照唯一ID。                                   |
| snapshotName  | String                                      | 快照显示名称。                                   |
| zoneId        | String                                      | 快照所属的可用区ID。                               |
| status        | [SnapshotStatusValue](#snapshotstatusvalue) | 快照的状态。                                    |
| snapshotType  | [SnapshotType](#snapshottype)               | 快照的类型。                                    |
| retentionTime | String                                      | <p>快照的保留到期时间。</p><p>如果取不到值，说明快照为永久保留。</p> |
| diskId        | String                                      | 云盘ID。                                     |
| createTime    | String                                      | 创建时间。                                     |
| diskAbility   | Boolean                                     | 是否具备创建disk的能力。                            |
| resourceGroup | [ResourceGroupInfo](#resourcegroupinfo)     | 所属的资源组信息。                                 |

## SnapshotStatusValue

描述快照状态的相关值。

被如下接口引用：DescribeSnapshots

| 值             | 值说明      |
| ------------- | -------- |
| CREATING      | 创建中。     |
| AVAILABLE     | 创建成功。    |
| FAILED        | 创建失败。    |
| ROLLING\_BACK | 回滚到此快照中。 |
| DELETING      | 释放中。     |

## SnapshotType

快照类型的可选值。

被如下接口引用：DescribeSnapshots

| 值      | 值说明     |
| ------ | ------- |
| Auto   | 自动创建快照。 |
| Manual | 手动创建快照。 |

## SnatEntry

描述SNAT规则的信息。

被如下接口引用：DescribeNatGatewayDetail

| 参数名称        | 类型                                 | 描述                                                                                        |
| ----------- | ---------------------------------- | ----------------------------------------------------------------------------------------- |
| snatEntryId | String                             | SNAT规则 ID。                                                                                |
| eipIds      | Array of String                    | SNAT规则添加的弹性公网IP ID集合。                                                                     |
| snatSubnets | Array of [SnatSubnet](#snatsubnet) | SNAT规则添加的subnet ID集合。                                                                     |
| cidrs       | Array of String                    | <p>CIDR网段，不传默认是0.0.0.0/0。</p><p><code>cidrs</code> 和 <code>snatSubnets</code> 不会同时存在。</p> |
| isAllEip    | Boolean                            | 弹性公网IP是否为所有的NAT网关上的公网弹性IP。                                                                |

## SnatSubnet

Snat规则添加的子网集合。

被如下接口引用：DescribeNatGatewayDetail

| 参数名称     | 类型     | 描述       |
| -------- | ------ | -------- |
| subnetId | String | 子网的ID。   |
| cidr     | String | 子网的CIDR。 |

## StepPrice

描述阶梯价格的信息。

被如下接口引用：InquiryPriceCreateInstance

| 参数名称              | 类型    | 描述                                  |
| ----------------- | ----- | ----------------------------------- |
| stepStart         | Float | 阶梯的起始值。                             |
| stepEnd           | Float | <p>阶梯的到达值。</p><p>为null代表最后一级阶梯。</p> |
| unitPrice         | Float | 阶梯单价。                               |
| discountUnitPrice | Float | 阶梯折后价。                              |

## SubnetInfo

描述子网的基本信息。

被如下接口引用：DescribeSubnets

| 参数名称                 | 类型      | 描述                                                      |
| -------------------- | ------- | ------------------------------------------------------- |
| subnetId             | String  | 子网的ID。                                                  |
| regionId             | String  | 子网所在节点的ID。                                              |
| name                 | String  | 子网的名称。                                                  |
| cidrBlock            | String  | 子网的CIDR地址。                                              |
| gatewayIpAddress     | String  | 网关地址。                                                   |
| ipv6CidrBlock        | String  | <p>子网的IPv6 CIDR地址段。</p><p>如果子网的IP堆栈类型不包括V6,该字段取不到值。</p> |
| ipv6GatewayIpAddress | String  | IPv6的网关地址。                                              |
| stackType            | String  | 子网的IP堆栈类型。                                              |
| ipv6Type             | String  | <p>子网上IPv6类型。</p><p>如果子网的IP堆栈类型不包括V6,该字段取不到值。</p>       |
| vpcId                | String  | 子网所属VPC的ID。                                             |
| vpcName              | String  | 子网所属VPC的名称。                                             |
| usageIpv4Count       | Integer | 子网已使用IPv4数量。                                            |
| usageIpv6Count       | Integer | 子网已使用IPv6数量。                                            |
| createTime           | String  | 子网的创建时间。                                                |
| isDefault            | Boolean | 子网是否为默认。                                                |
| dhcpOptionsSetId     | String  | DHCP选项集ID。                                              |
| ipv6MaskLength       | Integer | <p>分配给网卡的IPv6掩码长度。</p><p>如果子网的IP堆栈类型不包括V6,该字段取不到值。</p>  |

## SubnetStackType

描述堆栈类型的值。

被如下接口引用：CreateNetworkInterface, CreateZecInstances, CreateSubnet, DescribeInstances, ModifySubnetStackType

| 值          | 值说明        |
| ---------- | ---------- |
| IPv4       | 仅IPv4。     |
| IPv4\_IPv6 | IPv4和IPv6。 |
| IPv6       | 仅IPv6。     |

## SystemDisk

描述系统盘的基本信息。

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

| 参数名称            | 类型      | 必选 | 描述                                                                                                                                               |
| --------------- | ------- | -- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| diskSize        | Integer | 是  | <p>系统盘大小。</p><p>单位：GiB。</p><p>可选值范围：\[1, +)</p>                                                                                                  |
| diskId          | String  | 否  | <p>系统盘ID。</p><p>该参数目前仅用于<code>DescribeInstances</code>等查询类接口的返回参数，不可用于<code>CreateInstances</code>等写接口的入参。</p>                                   |
| diskCategory    | String  | 否  | <p>云硬盘种类。</p><p>Basic NVMe SSD: 经济型 NVMe SSD。</p><p>Standard NVMe SSD: 标准型 NVMe SSD。</p><p>默认为Standard NVMe SSD。</p><p>默认值：Standard NVMe SSD</p> |
| burstingEnabled | Boolean | 否  | <p>是否开启性能突发。</p><p>默认值：false</p>                                                                                                                 |

## Tag

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

被如下接口引用：DescribePolicys, DescribeAutoSnapshotPolicies, DescribeImages, DescribeNatGateways, DescribeIpv6Cidrs, DescribeQosPolicyGroups, DescribeNetworkInterfaces, DescribeDisks, DescribeEips, DescribeCidrs, DescribeDhcpOptionsSets, DescribeVpcs, CreateZecInstances, DescribeInstances, DescribeCustomImages, DescribeHaVips

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

## TagAssociation

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

被如下接口引用：CreateNetworkInterface, CreatePlacementGroup, CreateDhcpOptionsSet, CreatePolicy, CreateEips, CreateDisks, CreateByoip, CreateQosPolicyGroup, CreateVpc, CreateAutoSnapshotPolicy, CreateNatGateway, CreateZecInstances, CreateCidr, CreateHaVip, ModifyPolicy, CreateImage

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

## Tags

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

被如下接口引用：DescribePolicys, DescribeAutoSnapshotPolicies, DescribeImages, DescribeNatGateways, DescribeIpv6Cidrs, DescribeQosPolicyGroups, DescribeDisks, DescribeEips, DescribeCidrs, DescribeDhcpOptionsSets, DescribeVpcs, DescribeInstances, DescribePlacementGroups, DescribeCustomImages, DescribeHaVips

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

## TopPort

攻击端口。

被如下接口引用：DescribeDDosEventDetail

| 参数名称     | 类型      | 描述   |
| -------- | ------- | ---- |
| protocol | String  | 协议。  |
| port     | Integer | 端口号。 |

## TrafficDataPoint

流量监控数据点。

被如下接口引用：DescribeQosPolicyGroupTraffic

| 参数名称         | 类型      | 描述                                             |
| ------------ | ------- | ---------------------------------------------- |
| timestamp    | String  | <p>数据点时间。</p><p>时间格式：yyyy-MM-ddTHH:mm:ssZ。</p> |
| bandwidthIn  | Integer | 入向带宽，单位bps。                                    |
| bandwidthOut | Integer | 出向带宽，单位bps。                                    |

## UnmanagedEgressIpInfo

描述非托管出口IP的信息。

被如下接口引用：DescribeUnmanagedEgressIps

| 参数名称                | 类型                                                  | 描述                                 |
| ------------------- | --------------------------------------------------- | ---------------------------------- |
| unmanagedEgressIpId | String                                              | 非托管出口IP的唯一ID。                      |
| ip                  | String                                              | 公网IP地址。                            |
| regionId            | String                                              | 节点ID。                              |
| vpcId               | String                                              | 所属VPC的唯一ID。                        |
| status              | [UnmanagedEgressIpStatus](#unmanagedegressipstatus) | 资源状态。                              |
| networkLineType     | [NetworkLineType](#networklinetype)                 | 网络类型。                              |
| internetChargeType  | [InternetChargeType](#internetchargetype)           | 网络计费方式。                            |
| bandwidthCap        | Integer                                             | 带宽上限，单位 Mbps。资源未单独配置带宽时返回团队默认带宽上限。 |
| rateLimitMode       | [RateLimitMode](#ratelimitmode)                     | <p>限速模式。</p><p>默认值：LOOSE</p>       |
| createTime          | String                                              | 创建时间。                              |

## UnmanagedEgressIpStatus

描述非托管出口IP的状态值。

被如下接口引用：DescribeUnmanagedEgressIps

| 值         | 值说明    |
| --------- | ------ |
| CREATING  | 创建中。   |
| AVAILABLE | 正常可用。  |
| RECYCLED  | 处于回收站。 |
| DELETING  | 删除中。   |
| FAILED    | 创建失败。  |

## VmInventoryCapacity

描述库存容量的信息。

被如下接口引用：DescribeVmInventoryCapacity

| 值          | 值说明                  |
| ---------- | -------------------- |
| LIMITED    | 库存有限，可售核数 < 1000。    |
| NORMAL     | 库存一般，可售核数 1000–2000。 |
| SUFFICIENT | 库存充足，可售核数 2000–5000。 |
| ABUNDANT   | 库存富余，可售核数 ≥ 5000。    |

## VmRegionCapacityItem

节点库存容量信息。

被如下接口引用：DescribeVmInventoryCapacity

| 参数名称          | 类型                                                             | 描述                                                          |
| ------------- | -------------------------------------------------------------- | ----------------------------------------------------------- |
| regionId      | String                                                         | 节点 ID，格式如 asia-north-1。                                     |
| capacity      | [VmInventoryCapacity](#vminventorycapacity)                    | <p>该节点整体库存容量级别。</p><p>库存容量根据所有机型可售核数定义，不包含内存、存储或其他资源因素。</p> |
| instanceTypes | Array of [InstanceTypeCapacityItem](#instancetypecapacityitem) | 各实例类型的库存容量明细，不含库存为 0 的条目。                                   |

## VpcInfo

描述VPC的基本信息。

被如下接口引用：DescribeVpcs

| 参数名称            | 类型                                      | 描述                                               |
| --------------- | --------------------------------------- | ------------------------------------------------ |
| vpcId           | String                                  | VPC的ID。                                          |
| name            | String                                  | VPC的名称。                                          |
| cidrBlock       | String                                  | VPC的IPv4 CIDR。                                   |
| ipv6CidrBlock   | String                                  | <p>VPC的内网IPv6 CIDR。</p><p>如果为null,说明未开启IPv6。</p> |
| mtu             | Integer                                 | mtu值。                                            |
| isDefault       | Boolean                                 | 是否为默认VPC。                                        |
| createTime      | String                                  | 创建时间。                                            |
| usageIpv4Count  | Integer                                 | VPC里已使用IPv4数量。                                   |
| usageIpv6Count  | Integer                                 | VPC里已使用IPv6数量。                                   |
| securityGroupId | String                                  | 关联的安全组ID。                                        |
| dnsZoneIds      | Array of String                         | VPC关联的DNS内网权威域名ID。                               |
| resourceGroup   | [ResourceGroupInfo](#resourcegroupinfo) | VPC关联的资源组信息。                                     |
| tags            | [Tags](#tags)                           | 该VPC关联的标签。                                       |

## VpcRegionBandwidthStatus

描述内网跨区域带宽的状态值。

被如下接口引用：DescribeCrossRegionBandwidth

| 值                | 值说明    |
| ---------------- | ------ |
| CREATING         | 创建中。   |
| AVAILABLE        | 正常可用。  |
| CHANGING         | 变更中。   |
| RECYCLING \[已废弃] | 回收中。   |
| RECYCLED         | 处于回收站。 |
| DELETING         | 删除中。   |
| CREATE\_FAILED   | 创建失败。  |

## 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                                      | 创建时间。        |
| routingMode        | [RoutingMode](#routingmode)                 | 路由模式。        |
| natId              | String                                      | NAT的ID。      |
| cloudRouterIds     | Array of String                             | 关联的三层网络ID集合。 |
| advertisedSubnet   | [ZbgAdvertisedSubnet](#zbgadvertisedsubnet) | 子网控制。        |
| advertisedCidrs    | Array of String                             | IPv4 Cidr集合。 |
| advertisedRouteIds | Array of String                             | 自定义路由集合。     |

## ZoneInfo

可用区的基本信息。

被如下接口引用：DescribeZones

| 参数名称                        | 类型      | 描述                                                           |
| --------------------------- | ------- | ------------------------------------------------------------ |
| zoneId                      | String  | 可用区ID。                                                       |
| regionId                    | String  | 可用区所在的节点ID。                                                  |
| zoneName                    | String  | 可用区名称。                                                       |
| supportSecurityGroup \[已废弃] | Boolean | <p>可用区是否支持安全组。</p><p>该字段已废弃，当前所有节点均支持安全组。</p><p>默认值：true</p> |
| timeZone                    | String  | 可用区所在的时区。                                                    |
| cityName                    | String  | 可用区所在的城市名称。                                                  |
| cityCode                    | String  | 城市三字码。                                                       |
| countryCode                 | String  | 可用区所在的国家，ISO 3166-1 alpha-2 两字母代码（如 US、JP）。                  |
| countryName                 | String  | 可用区所在的国家名称。                                                  |
| supportHaVip                | Boolean | 可用区是否支持高可用虚拟IP（HaVip）。                                       |


---

# 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/zec/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.
