附录
更新时间:2024-06-21
Model对象定义
InstanceModel
| 参数名称 | 类型 | 描述 |
|---|---|---|
| id | String | 实例ID,符合BCE规范,是一个定长字符串,且只允许包含大小写字母、数字、连字号(-)和下划线(_) |
| name | String | 实例名称,支持大小写字母、数字、中文以及-_ /.特殊字符,必须以字母开头,长度1-65 |
| hostname | String | 实例主机名,仅支持小写字母、数字以及- . 特殊字符,必须以字母开头,不可连续使用特殊符号,不支持特殊符号开头或结尾,长度2-64 |
| status | String | 实例状态 |
| desc | String | 实例描述信息 |
| paymentTiming | String | 付费方式,包括Postpaid(后付费),Prepaid(预付费)两种。 |
| createTime | String | 创建时间 |
| expireTime | String | 过期时间 |
| internalIp | String | 内网IP |
| publicIp | String | 外网IP |
| imageId | String | 镜像ID |
| flavorId | String | 套餐ID |
| zone | String | 可用区名称 |
| region | String | 区域名称 |
| networkCapacityInMbps | int | 公网带宽,单位为Mb |
| deploysetId | String | 部署集id |
| hasAlive | int | hasagent状态,1为在活状态,0为失活状态 |
| tags | tag | 标签信息,由Tag组成的集合 |
| autoRenew | Boolean | 是否自动续费,是:“true”,否:“false” |
FlavorModel
| 参数名称 | 类型 | 描述 |
|---|---|---|
| flavorId | String | 套餐ID |
| cpuCount | int | cpu核数 |
| cpuType | String | cpu类型 |
| memoryCapacityInGB | int | 内存容量,单位为GB |
| disk | String | 磁盘信息,包括SSD盘和SATA盘 |
| networkCard | String | 网络设备信息 |
| others | String | 套餐包含的其他信息 |
RaidModel
| 参数名称 | 类型 | 描述 |
|---|---|---|
| raidId | String | RAID的ID |
| raid | String | RAID名称 |
| sysSwapSize | int | 系统盘swap分区默认大小,单位为GIB |
| sysRootSize | int | 系统盘根分区默认大小,单位为GIB |
| sysHomeSize | int | 系统盘/home分区默认大小,单位为GIB |
| sysDiskSize | int | 系统盘总大小,单位为GIB |
| dataDiskSize | int | 数据盘总大小,单位为GIB |
RegionModel
| 参数名称 | 类型 | 描述 |
|---|---|---|
| regionId | String | 地域ID,例:bj |
| regionName | String | 地域名称,例:华北-北京 |
| regionEndpoint | String | 地域对应的接入地址(Endpoint) |
ImageModel
| 参数名称 | 类型 | 描述 |
|---|---|---|
| id | String | 镜像ID |
| name | String | 镜像名称 |
| type | ImageType | 镜像类型 |
| osType | String | 操作系统类型 |
| osVersion | String | 操作系统版本 |
| osArch | String | 操作系统位数 |
| osName | String | 操作系统名称 |
| osBuild | String | 镜像操作系统的构建时间 |
| createTime | String | 镜像的创建时间,符合BCE规范的日期格式 |
| status | ImageStatus | 镜像状态 |
| desc | String | 镜像描述信息 |
ImageType
| 编码 | 描述 |
|---|---|
| System | 系统镜像/公共镜像 |
| Custom | 自定义镜像 |
| Integration | 服务集成镜像 |
OperationLogModel
| 参数名称 | 类型 | 描述 |
|---|---|---|
| operationStatus | boolean | 操作状态,包括true(成功),false(失败)两种 |
| operationTime | String | 操作日期 |
| operationDesc | String | 操作描述 |
| operationIp | String | 操作来源Ip |
BbcNetworkModel
| 参数名称 | 类型 | 描述 |
|---|---|---|
| bbcId | String | bbc实例uuid |
| vpc | VpcModel | Vpc信息 |
| subnet | SubnetModel | subnet信息 |
VpcModel
| 参数名称 | 类型 | 描述 |
|---|---|---|
| vpcId | String | 网络id |
| cidr | String | cidr |
| name | String | 网络名称 |
| isDefault | Boolean | 是否默认网络 |
| description | String | 描述信息 |
SubnetModel
| 参数名称 | 类型 | 描述 |
|---|---|---|
| vpcId | String | 网络id |
| name | String | 子网名称 |
| subnetType | String | 子网类型 |
| subnetId | String | 子网id |
| cidr | String | cidr |
| zoneName | String | 可用区 |
TagModel
| 参数名称 | 类型 | 描述 |
|---|---|---|
| tagKey | String | 标签键 |
| tagValue | String | 标签值 |
RecycledInstanceModel
| 参数名称 | 类型 | 描述 |
|---|---|---|
| serviceType | String | 实例类型,"BBC" |
| serviceName | String | 实例类型名称,"弹性裸金属服务器" |
| name | String | bbc的名称 |
| id | String | bbc的id |
| serialNumber | String | bbc的序列号 |
| recycleTime | String | 进入回收站时间 |
| deleteTime | String | 弹性公网IP-实例ID |
| paymentTiming | String | 付费方式,付费方式,包括Postpaid(后付费),Prepaid(预付费)两种。 |
| configItems | List |
bbc的配置信息 |
状态编码定义
ProductType
| 编码 | 描述 |
|---|---|
| Prepaid | 预付费 |
| Postpaid | 后付费 |
InstanceStatus
| 编码 | 描述 |
|---|---|
| Starting | 启动中 |
| Running | 运行中 |
| Stopping | 停止中 |
| Stopped | 已停止 |
| Deleted | 已释放,该状态为内部状态,API无法查询 |
| Expired | 已过期或欠费 |
| Error | 错误 |
| ImageProcessing | 镜像操作中 |
| Recovering | 恢复计费中 |
| Recycling | 进入回收站中 |
ImageStatus
| 编码 | 描述 |
|---|---|
| Creating | 创建中 |
| CreatedFailed | 创建失败 |
| Available | 可用 |
| NotAvailable | 不可用 |
| Error | 错误 |
介质类型定义
StorageType
| 编码 | 描述 |
|---|---|
| local-ssd | 数据存储于本地SSD盘,延时较低,IO和吞吐能力较好,适用于对读写性能有较高要求的场景业务 |
| local-hdd | 本地HDD磁盘,经济型,大规模归档数据存储,或者其他对读写性能要求不高的场景 |
| local-nvme | 本地NVME磁盘,数据都存储于本地NVME SSD盘,超高性能,数倍于普通SSD磁盘,适用于时延敏感型业务 |
