附录
更新时间:2026-07-22
Model对象定义
AlarmRule
| 参数名称 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| id | int | 否 | 报警规则id |
| index | int | 否 | 报警规则的索引,当多个规则共同组成同一报警规则,它们的索引相同 |
| metric | String | 否 | 监控指标名称,如:vCPUUsagePercent |
| periodInSecond | int | 否 | 多长时间计算一次是否满足各个报警规则,即单个评估周期时长,单位s |
| statistics | String | 否 | 统计方式,可选值为:maximum(最大值)、minimum(最小值)、sum(和值)、average(平均值) |
| threshold | String | 否 | 报警规则的阈值 |
| comparisonOperator | String | 否 | 和阈值比较的算符,取值为>=、>、=、<、<= |
| evaluationPeriodCount | int | 否 | 触发报警所需连续发生次数 |
| metricDimensions | List<Dimension> | 是 | 指标维度 |
AsAlarmRule
| 参数名称 | 类型 | 描述 |
|---|---|---|
| id | long | 策略ID |
| scope | String | 策略归属产品 |
| monitorObject | MonitorObject | 策略实例信息 |
| rules | List<List<AlarmRule>> | 创建伸缩组的规则时,传入具体的判断规则,支持且规则、或规则。 |
| alarmName | String | BCM策略ID,使用BCM已有策略时候,传入对应策略的唯一id |
| aliasName | String | BCM策略别名 |
| insufficientCycle | int | 无数据状态触发的持续时间,单位s |
| policyEnabled | Boolean | 策略状态 |
| ruleContents | List<String> | 报警规则的内容描述 |
| ruleContentsEn | List<String> | 报警规则的英文描述 |
| source | String | 报警策略创建来源 |
| componentType | String | 表示报警策略来自于哪个业务组件 |
| alarmActions | List<String> | 报警动作 |
| okActions | List<String> | 当报警恢复时执行的动作列表 |
| insufficientActions | List<String> | 当数据不足时执行的动作列表 |
AsEip
| 参数名称 | 类型 | 描述 |
|---|---|---|
| bandwidthInMbps | int | 最大带宽 |
| address | String | 公网IP |
| eipId | String | EIP的ID |
| eipStatus | String | EIP状态 |
| eipAllocationId | String | 弹性公网IP-实例ID |
AsGroup
| 参数名称 | 类型 | 描述 |
|---|---|---|
| groupId | String | 伸缩组id |
| groupName | String | 伸缩组名称 |
| region | String | 分区 |
| status | String | 状态 |
| tags | List<TagInfo> | 标签信息 |
| relationTag | Boolean | 是否绑定标签 |
| vpcId | String | vpc的id |
| zoneInfo | List<String> | 伸缩组所在可用区 |
| config | GroupConfig | 伸缩组边界配置 |
| blb | List<BlbInfo> | 伸缩组绑定BLB,可绑定多个 |
| nodeNum | int | 节点数量 |
| ruleCount | int | 规则数量 |
| createTime | String | 创建时间 |
| healthCheckState | HealthCheckState | 健康检查状态 |
AsRecord
| 参数名称 | 类型 | 描述 |
|---|---|---|
| groupId | String | 伸缩组ID |
| recordId | String | 记录ID |
| startTime | String | 开始时间 |
| result | String | 执行结果 |
| actualScaleNode | List<String> | 实际操作的节点列表 |
| actualScaleBandwidth | int | 实际扩容后的带宽值 |
| currentBandwidth | int | 当前带宽值 |
| remainedNode | List<String> | 剩余的节点列表 |
| action | String | 动作 |
| scaleCondition | ScaleCondition | 伸缩条件 |
| ruleId | String | 规则 ID |
| message | String | 消息 |
| expectAction | ExpectAction | 预期的行为 |
| executeType | String | 执行类型 |
| dagId | String | DAG编号 |
| resource | Resource | EIP资源信息,网络资源伸缩时有效 |
AssignTagInfo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| resourceId | String | 资源id |
| relationTag | Boolean | 是否绑定标签 |
| tags | List<TagInfo> | 标签信息 |
BccNameConfig
| 参数名称 | 类型 | 描述 |
|---|---|---|
| bccName | String | 虚拟机名字(可选)。默认都不指定name。如果指定name:批量时name作为名字的前缀。后端将加上后缀 |
| bccHostname | String | 虚拟机主机名(可选)。默认都不指定hostname。如果指定hostname:批量时hostname作为名字的前缀。后端将加上后缀 |
| autoSeqSuffix | Boolean | 是否自动生成name和hostname有序后缀(可选参数) 是:true 否:false |
| openHostnameDomain | Boolean | 是否自动生成hostname domain(可选参数) 是:true 否:false |
BillingInfo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| paymentTiming | String | 伸缩组Billing,后付费:postpay,抢占式:bidding |
| reservation | Reservation | 支付方式为后支付时不需要设置,预支付时必须设置 |
BlbInfo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| blbId | String | BLB实例ID |
| blbName | String | BLB实例名称 |
| blbType | String | blbType类型:Blb-普通型BLB,AppBLb-应用型BLB,Ipv6Blb-ipv6型BLB |
| sgIds | List<String> | 当blb类型为应用型BLB时,服务器组必填,可选多个。其他类型BLB不需要填写该值。 |
CdsInfo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| volumeType | String | 磁盘类型 |
| sizeInGB | int | 磁盘大小 |
| snapshotId | String | 磁盘快照ID |
| snapshotName | String | 磁盘快照名称 |
CheckDetail
| 参数名称 | 类型 | 描述 |
|---|---|---|
| resourceId | String | 资源id |
| detail | String | 详细信息 |
| advice | String | 系统建议 |
CheckEntity
| 参数名称 | 类型 | 描述 |
|---|---|---|
| label | String | 标签 |
| status | String | 检查状态 |
| result | CheckDetail | 检查结果 |
CmdConfig
| 参数名称 | 类型 | 描述 |
|---|---|---|
| hasDecreaseCmd | Boolean | 是否配置缩容脚本 |
| decCmdStrategy | String | 缩容策略,不可为空,失败暂停缩容、失败继续缩容:Proceed、Pause |
| decCmdData | String | 缩容脚本 |
| decCmdTimeout | int | 缩容脚本超时时间 |
| decCmdManual | Boolean | 手动移出是否执行缩容脚本 |
| hasIncreaseCmd | Boolean | 是否配置扩容脚本 |
| incCmdStrategy | String | 扩容策略,不可为空、失败继续扩容:Proceed、Pause |
| incCmdData | String | 扩容脚本 |
| incCmdTimeout | int | 扩容脚本超时时间 |
| incCmdManual | Boolean | 手动移入是否执行扩容脚本 |
DagModel
| 参数名称 | 类型 | 描述 |
|---|---|---|
| id | String | DAG 的唯一标识符 |
Dimension
| 参数名称 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| name | String | 是 | 名称 |
| value | String | 是 | 值 |
EipConfig
| 参数名称 | 类型 | 描述 |
|---|---|---|
| eipGroupBindStrategy | String | 共享带宽扩容时与BCC绑定策略 |
| eipGroupUnbindStrategy | String | 共享带宽缩容时策略 |
| eipGroupIdList | List<String> | 共享带宽组id列表 |
| increase | EipGroupIncrease | 共享带宽扩容配置 |
| decrease | EipGroupDecrease | 共享带宽缩容配置 |
| bandwidth | EipGroupBandwidth | 共享带宽带宽限制 |
EipGroupBandwidth
| 参数名称 | 类型 | 描述 |
|---|---|---|
| max | int | 最大限制 |
| min | int | 最小限制 |
| standard | int | 标准值 |
EipGroupDecrease
| 参数名称 | 类型 | 描述 |
|---|---|---|
| enabled | Boolean | 是否开启 |
EipGroupIncrease
| 参数名称 | 类型 | 描述 |
|---|---|---|
| enabled | Boolean | 是否开启 |
| strategy | String | 扩容策略 |
EipInfo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ifBindEip | Boolean | 是否绑定EIP |
| bandwidthInMbps | int | EIP带宽 |
| eipProductType | String | EIP公网带宽计费类型,按带宽计费:bandwidth,按流量计费:netraffic |
| purchaseType | String | 购买线路类型,标准型:BGP,增强型:BGP_S |
EphemeralDisk
| 参数名称 | 类型 | 描述 |
|---|---|---|
| storageType | String | 本地盘类型 |
| sizeInGB | int | 本地盘大小 |
ExpectAction
| 参数名称 | 类型 | 描述 |
|---|---|---|
| actionType | String | 动作类型。包括:INCREASE(扩容),DECREASE(缩容),ADJUST(调整至) |
| actionNum | int | 动作数量 |
| adjustToNum | int | 调整到的数量 |
GroupConfig
| 参数名称 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| minNodeNum | int | 是 | 最小节点数量 |
| maxNodeNum | int | 是 | 最大节点数量 |
| cooldownInSec | int | 是 | 冷却时间 |
| expectNum | int | 是 | 期望节点数,默认为-1,开启期望节点数后,健康检查任务会自动巡检,如果当前节点数和期望不一致会自动扩缩容保持一致 |
| initNum | int | 否 | 初始节点数,默认为-1 |
HealthCheckConfig
| 参数名称 | 类型 | 描述 |
|---|---|---|
| healthCheckInterval | int | 健康检查间隔 |
| graceTime | int | 健康检查时间 |
HealthCheckState
| 参数名称 | 类型 | 描述 |
|---|---|---|
| checkId | String | 检查id |
| groupId | String | 伸缩组id |
| accountId | String | 账号id |
| state | String | 检查状态(CHECKING-正在检查、CHECK_SUCCESS-检查通过、CHECK_FAILED-检查失败) |
| checkEntities | List<CheckEntity> | 检查项列表 |
| createTime | String | 创建时间 |
MonitorObject
| 参数名称 | 类型 | 描述 |
|---|---|---|
| type | String | 类型 |
| names | List<String> | 名称列表 |
| resources | List<PolicyResource> | 关联的策略资源列表 |
| typeName | String | 监控类型的可读名称 |
Node
| 参数名称 | 类型 | 描述 |
|---|---|---|
| instanceId | String | 实例ID |
| instanceUuid | String | 实例UUID |
| instanceName | String | 实例名称 |
| floatingIp | String | 浮动IP |
| internalIp | String | 内网IP |
| status | String | 状态 |
| payment | String | 付费方式 |
| cpuCount | int | cpu数量 |
| memoryCapacityInGB | int | 内存大小 |
| instanceType | String | 实例类型 |
| sysDiskInGB | int | 系统盘大小 |
| createTime | String | 创建时间 |
| eip | AsEip | |
| subnetType | String | 子网类型 |
| isProtected | Boolean | 是否受保护节点 |
| nodeType | String | 节点类型 |
| tags | List<TagInfo> | 标签列表 |
| groupId | String | 分组ID |
| isManaged | Boolean | 是否由系统托管 |
| internalSpec | String | 内部规格标识 |
| logicalZone | String | 逻辑区域标识 |
NodeInfo
| 参数名称 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| spec | String | 否 | 套餐规格 |
| cpuCount | int | 是 | CPU数量 |
| memoryCapacityInGB | int | 是 | 磁盘容量 |
| sysDiskType | String | 是 | 系统盘类型 |
| sysDiskInGB | int | 是 | 系统盘大小 |
| billing | BillingInfo | 否 | 伸缩组Billing,后付费-post,抢占式-bidding |
| bidModel | String | 否 | 抢占式实例释放策略:市场价释放-market,自定义释放价格-custom |
| bidPrice | String | 否 | 自定义释放时,价格值 |
| ephemeralDisks | List<EphemeralDisk> | 否 | 本地盘信息 |
| instanceType | String | 是 | 实例类型 |
| gpuCard | String | 否 | gpu卡属性 |
| gpuCount | int | 否 | gpu数量 |
| fpgaCard | String | 否 | fpga卡属性 |
| fpgaCount | int | 否 | fpga卡数量 |
| containsFpga | Boolean | 否 | 是否包含fpga卡 |
| kunlunCard | String | 否 | 昆仑卡属性 |
| kunlunCount | int | 否 | 昆仑卡数量 |
| imageType | String | 否 | 实例镜像类型 |
| imageId | String | 是 | 实例镜像ID |
| imageName | String | 否 | 实例镜像名称 |
| osType | String | 否 | 操作系统类型 |
| osName | String | 否 | 操作系统名称 |
| osVersion | String | 否 | 操作系统版本 |
| osArch | String | 否 | 操作系统架构 |
| securityGroupId | String | 是 | 安全组ID |
| adminPass | String | 否 | 密码 |
| adminPassType | String | 否 | 密码类型: "0"(随机); "1"(用户自定义) |
| securityGroupName | String | 否 | 安全组名称 |
| totalCount | int | 是 | 总数量 |
| aspId | String | 否 | 子网类型 |
| cds | List<CdsInfo> | 否 | 本地存储信息 |
| zoneSubnet | String | 是 | zone subnet 信息json, 对应类为List. 格式:[{"zone": "zoneA","subnetId": "subnetA"},...] |
| userData | String | 否 | 用户高级配置能力 |
| priorities | int | 是 | 模板顺序 |
| templateId | String | 否 | 所属模板的ID |
PolicyResource
| 参数名称 | 类型 | 描述 |
|---|---|---|
| identifiers | List<Dimension> | 实例维度 |
| metricDimensions | List<Dimension> | 指标维度 |
Reservation
| 参数名称 | 类型 | 描述 |
|---|---|---|
| reservationLengthInMonth | int | 时长,[1,2,3,4,5,6,7,8,9,12,24,36] |
Resource
| 参数名称 | 类型 | 描述 |
|---|---|---|
| type | String | 资源类型 |
| id | String | 资源标识,结构由资源类型决定 |
Rule
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ruleId | String | 规则ID |
| ruleName | String | 规则名称 |
| groupId | String | 伸缩组ID |
| accountId | String | 用户ID |
| state | String | 规则的状态 |
| type | String | 规则的类型 |
| cronTime | String | 定时规则或周期规则:当日执行时间。如12:30。 |
| actionType | String | 动作类型。包括:INCREASE(扩容),DECREASE(缩容),ADJUST(调整至) |
| actionNum | int | 动作数量 |
| cooldownInSec | int | 冷却时间(秒) |
| createTime | String | 规则创建时间 |
| lastExecutionTime | String | 规则最后修改时间 |
| lastScheduleTime | String | 规则最后执行时间 |
| periodStartTime | String | 周期规则:周期有效期开始时间。如:2023-12-10T12:00:00Z |
| periodEndTime | String | 周期规则:周期有效期结束时间。如:2023-12-11T12:00:00Z |
| periodType | String | 周期规则:周期单位,可选值为DAY/WEEK/MONTH/CronExpression |
| periodValue | int | 周期规则:周期触发日期,1-7标识周1-周日,1-31表示1号到31号,与periodType相关 |
| asAlarmRule | AsAlarmRule | 报警类规则:报警规则信息,详情见附录 |
ScaleCondition
| 参数名称 | 类型 | 描述 |
|---|---|---|
| targetType | String | 指标类型,如伸缩组指标为ASG |
| targetId | String | 报警监控实例,如伸缩组ID:asg-CClxxxxx |
| indicator | String | 监控指标。如伸缩组CPU使用率均值为CPUUsagePercent_Average |
| threshold | String | 阈值 |
| unit | String | 单位 |
| comparisonOperator | String | 比较运算符,支持'>','<','=' |
| cronTime | String | 定时规则或周期规则:当日执行时间。如12:30 |
| triggerTime | String | 不重复触发时间 |
| type | String | 包括:CRONTAB(定时伸缩),ALARM(报警触发伸缩),PERIOD(周期伸缩) |
| periodType | String | 周期单位,可选值为DAY/WEEK/MONTH/CronExpression |
| periodValue | int | 周期触发日期,1-7标识周1-周日,1-31表示1号到31号,与periodType相关 |
| alarmRule | String | 报警类规则 |
TagInfo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| tagKey | String | 键 |
| tagValue | String | 值 |
VpcInfo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| vpcName | String | 子网名称 |
| vpcId | String | 子网id |
| vpcUuid | String | 子网uuid |
ZoneInfo
| 参数名称 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| zone | String | 是 | 可用区 |
| subnetId | String | 是 | 子网ID |
| subnetUuid | String | 否 | 子网UUID |
| subnetName | String | 否 | 子网名称 |
| subnetType | int | 否 | 子网类型 |
| nodeCount | int | 否 | 节点数量 |
评价此篇文章
