Appendix
Last Updated：2020-09-21
Cluster and Image
Cluster
| Parameter name | Type | Description |
|---|---|---|
| clusterUuid | String | cluster UUid |
| clusterName | String | Cluster name |
| slaveVmCount | Integer | Number of cluster slave vms |
| maserVmCount | Integer | Number of master vms |
| containerNet | String | Container network |
| status | ClusterStatus | Cluster status |
| region | String | Location |
| createTime | TimeStamp | Creation time |
| deleteTime | TimeStamp | Delete time |
| allInstanceNormal | boolean | If all nodes are normal, an error means false |
| instanceList | List<SimpleNode> | Node list, where SimpleNode is described in Appendix |
| dccUuid | String | dcc instance ID |
| hasPrepay | Boolean | Prepaid or not |
| vpcId | String | VPC ID |
| instanceMode | String | Node type, bcc instance, dcc exclusive instance |
| masterExposed | Boolean | Customize master node or not |
SimpleNode
| Parameter name | Type | Description |
|---|---|---|
| instanceShortId | String | Short id of the instance |
| instanceUuid | String | uuid of instance |
| instanceName | String | Name of the instance |
| clusterUuid | String | Cluster Uuid |
| status | String | Status |
BaseCreateOrderRequestVo
| Parameter name | Type | Description |
|---|---|---|
| items | List<Item> | BCC, CDS, EIP node configuration in the cluster |
| paymentMethod | Set | Container product can be[] |
Item
| Parameter name | Type | Description |
|---|---|---|
| config | BccConfig,CdsConfig,EipConfig | BCC, CDS, EIP node configuration in the cluster |
| purchaseOrder | int | Purchase order |
| paymentMethod | Set | Container product can be[] |
BccConfig
| Parameter name | Type | Description |
|---|---|---|
| name | String | Virtual machine name |
| productType | String | Payment type: post pay, prepaid |
| logicalZone | String | Available zone |
| instanceType | String | 0: normal; 7: Common type 2; 10: common type 3; 9: GPU |
| gpuCard | String | For the GPU card information carried by the instance, see GpuType (it shall be filled in for only GPU instance) |
| gpuCount | Integer | The number of gpu cards, is 1 by default (it shall be filled in for only GPU instance) |
| cpu | Integer | CPU core number |
| memory | Integer | Memory GB |
| imageType | String | Mirror type |
| osType | String | os type |
| osVersion | String | os version |
| diskSize | Integer | Temporary data disk size Positive integer |
| subnetUuid | String | Subnet uuid |
| securityGroupId | String | Security group uuid |
| adminPass | String | Password |
| purchaseLength | Integer | Purchase duration (month) |
| purchaseNum | String | Number of virtual machines purchased |
| autoRenewTimeUnit | String | Automatic renewal time unit ("month") |
| autoRenewTime | TimeStamp | Auto renewal duration (0) |
| createEphemeralList | CreateEphemeralList | Please see the appendix for the description of CreateEphemeralList. This parameter is required for temporary data disk, FPGA, GPU and storage optimized BCC |
| autoRenew | Boolean | Renew automatically or not by default no problem for post-paid |
| imageId | String | Mirror id |
| osName | String | System name |
| serviceType | String | Service type (BCC) |
CdsConfig
| Parameter name | Type | Description |
|---|---|---|
| productType | String | Payment type: post pay, prepaid |
| logicalZone | String | Zone (zoneA) |
| purchaseNum | Integer | Positive integer, number of purchases |
| purchaseLength | Integer | Purchase time, positive integer unit: month |
| autoRenewTime | Integer | Auto renewal time unit: autoRenewTimeUnit |
| autoRenewTimeUnit | String | Automatic renewal time unit, the default is month |
| cdsDiskSize | List<DiskSizeConfig> | To pre-mount the configuration information of CDS disk, it shall be consistent with the configuration in CDS config |
| serviceType | String | Service type (CDS) |
EipConfig
| Parameter name | Type | Description |
|---|---|---|
| productType | String | Payment type: post pay, prepaid |
| bandwidthInMbps | Integer | Bandwidth must be a positive integer, and the default is 1000 |
| subProductType | Integer | bandwidth/nettraffic |
| purchaseNum | Integer | EIP purchase quantity should be the sum of BCC purchase quantity |
| purchaseLength | Integer | Length of purchase |
| autoRenewTime | Integer | Auto renewal time unit: autoRenewTimeUnit |
| autoRenewTimeUnit | String | Automatic renewal time unit, the default is month |
| name | String | EIP name |
| serviceType | String | Service type "EIP" |
CreateEphemeralList
| Parameter name | Type | Description |
|---|---|---|
| storageType | String | Disk storage type When a virtual machine is created from the page, it can be seen that the default request is ssd |
| sizeInGB | Integer | Disk size |
| volumeType | String | Disk type, optional: sata (general cloud disk); ssd (high performance cloud disk); premium_ssd (ssd cloud disk) |
CdsPreMountInfo
| Parameter name | Type | Description |
|---|---|---|
| mountPath | String | Disk mount directory |
| cdsConfig | List<DiskSizeConfig> | To pre-mount the configuration information of CDS disk, it shall be consistent with the configuration in CDS config |
AdvancedOptions
| Parameter name | Type | Description |
|---|---|---|
| kubeProxyMode | String | kube-proxy mode only iptables or ipvs |
| secureContainerEnable | Boolean | If true, switch the runtime of the container to kata-container (implement hard container isolation) |
| setOSSecurity | Boolean | Safe operation mode of container |
DiskSizeConfig
| Parameter name | Type | Description | ||
|---|---|---|---|---|
| size | String | Disk size (unit: GB) | ||
| volumeType | String | Disk type, optional: sata (general cloud disk) | ssd (high performance cloud disk) | Premium [ssd (ssd cloud disk) |
| sizeInGB | Integer | Total disk capacity | ||
| snapshotId | String | Snapshot ID, support creating disk from snapshot | ||
| snapshotName | String | Snapshot name | ||
| storageType | String | CDS disk storage type. The default is hp1 (high performance cloud disk). | ||
| logicalZone | String | Disk available zone | ||
| type | String | Transformation of CDS system disk, "system" mark is system disk |
NodeInfo
| Parameter name | Type | Description |
|---|---|---|
| instanceId | String | Examples are short id |
Node
| Parameter name | Type | Description | |
|---|---|---|---|
| instanceShortId | String | Node short id | |
| instanceUuid | String | Node id | |
| instanceName | String | Node name | |
| clusterUuid | String | Cluster id of node | |
| availableZone | String | Available zone of node | |
| vpcId | String | vpc short id of node | |
| vpcCidr | String | vpc cidr address segment of node | |
| subnetId | String | Subnet id of node | |
| subnetType | String | Subnet type of node | |
| eip | String | Node eip address | |
| eipBandwidth | Integer | eip bandwidth of node | |
| cpu | Integer | CPU cores of node | |
| memory | Integer | Node memory size in GB | |
| diskSize | Integer | Node local disk size in GB | |
| sysDisk | Integer | Node system disk size in GB | |
| instanceType | String | Node type | |
| blb | String | Node load balancing address | |
| floatingIp | String | Node intranet IP | |
| fixIp | String | IP assigned in node vpc | |
| createTime | Timestamp | Node creation time | |
| deleteTime | Timestamp | Node deletion time | |
| status | String | Node current status | |
| expireTime | Timestamp | Node expiration time | |
| paymentMethod | String | Node payment method (prepay; postpay) | |
| runtimeVersion | String | Container runtime |
Namespace
| Parameter name | Type | Description |
|---|---|---|
| name | String | Namespace name |
| createTime | Timestamp | Namespace creation time |
| repositoryNum | int | Number of images under namespace |
| isPublic | boolean | Whether to expose namespace |
| notificationUrl | String | Mirror callback address URL |
Image
| Parameter name | Type | Description |
|---|---|---|
| imageMeta | ImageMeta | Image metadata (ImageMeta type is as follows) |
| createTime | Timestamp | Creation time |
| address | String | Image address format: url/namespace/repository |
| isPublic | boolean | Whether to expose the image |
ImageMeta
| Parameter name | Type | Description |
|---|---|---|
| namespace | String | Domain name |
| repository | String | Repository |
| tag | String | Image tag |
| description | String | Description |
ImageDetails
| Parameter name | Type | Description |
|---|---|---|
| name | String | Image version |
| digest | String | ID of the image |
| description | String | Image description information |
| created_at | String | Image creation time |
| updated_at | String | Mirror update time |
CceNodeInfo
| Parameter name | Type | Description |
|---|---|---|
| instanceId | String | Virtual Machine ID |
| adminPass | String | VM Administrator Password |
ServerForDisplay
| Name | Type | Description |
|---|---|---|
| instanceId | String | Virtual Machine ID |
| name | String | VM name |
| status | String | Virtual machine status |
| payment | String | Payment type |
| internalIp | String | Intranet ip address |