Appendix

Definition of model object

InstanceModel

Parameter name	Types	Description
id	String	Instance ID, compliant with the BCE specification, is a fixed-length string that may only contain uppercase letters, lowercase letters, digits, hyphens （-） and underscores(_).
name	String	The instance name, which can include uppercase and lowercase letters, numbers, Chinese characters, and the special characters - \ _ /. It must start with a letter and have a length of 1-65 characters.
hostname	String	The instance hostname can only contain lowercase letters, digits, and the special characters - ., must start with a letter, cannot contain consecutive special characters, and cannot begin or end with a special character. Its length should be 2-64 characters.
instanceType	InstanceType	Instance type. For specific optional types, refer to InstanceType. This field is null for DCC (Dedicated Compute Cluster)
status	InstanceStatus	Instance status
repairStatus	String	The instance repair status includes four possible states: normal, wait_authorize, wait_repair, and repairing.
desc	String	Instance description information
paymentTiming	String	The billing type, which includes Postpay (Pay-as-you-go) and Prepay (Subscription).
createTime	String	Creation time
expireTime	String	Expiration time
internalIp	String	Internal IP address
publicIp	String	External IP address
cpuCount	int	CPU (Core) count
gpuCard	String	GPU card information carried by the instance. For details, refer to GpuType
fpgaCard	String	FPGA card information carried by the instance. For details, refer to FpgaType
cardCount	int	The count of GPU, FPGA, or heterogeneous cards carried by the instance is returned to the field only when the gpuCard, fpgaCard, or isomerismCard field is not null
memoryCapacityInGB	int	Memory capacity, in GB
npuVideoMemory	int	NPU memory size
localDiskSizeInGB	int	Local disk size (excluding the system disk, which is provided free of charge), in GB
imageId	String	Image ID
imageName	String	Image name
imageType	String	Image type
serviceComponents	Map<String, String>	Service component, Map<component name, component status>
networkCapacityInMbps	int	Public network bandwidth, in Mb
placementPolicy	String	The instance placement strategy, with values of either default or dedicatedHost.
zoneName	String	Availability zone information
subnetId	String	Subnet ID
vpcId	String	VPC ID
autoRenew	Boolean	Whether to enable auto-renewal: Yes: true, No: false.
enableJumboFrame	Boolean	Whether to enable Jumbo frame: Enable: true; disable: false.
keypairId	String	Key pair ID
keypairName	String	Key pair name
dedicatedHostId	String	Dedicated server ID
ipv6	String	ipv6 address
tags	List<[Tag](BCC/Tag Service API Reference/Appendix 1.md#Tag)>	Tag information
deploysetId	String	Deployment group ID
deploysetList	List<DeploySetModel>	Deployment group information list
osVersion	String	OS version
osArch	String	OS architecture
osName	String	OS name
hosteyeType	String	For hosteye version: enterprise edition, and open (basic edition), null/missing field means unbound hosteye
nicInfo	NicInfo	Network interface card information. For details, see NicInfo
deletionProtection	int	Whether to enable deletion protection: 1: enabled, 0: disabled
volumes	List<VolumeModel>	Disk information. For specific parameters, refer to VolumeModel
isEipAutoRelatedDelete	Boolean	Whether the EIP bound to the instance is automatically released with the spot instance association: Yes: true, No: false.

NicInfo

Parameter name	Types	Description
eniId	String	Network interface card ID
eniUuid	String	Network interface card long ID
name	String	Network interface card name
type	String	Network interface card type, where "primary" indicates the primary network interface card
subnetId	String	Subnet ID
subnetType	String	Subnet type
az	String	Availability zone information
description	string	Description
deviceId	string	Virtual machine long ID
status	string	Network interface card status
macAddress	string	Physical address
vpcId	string	VPC ID
createdTime	string	Creation time
eniNum	int	Network interface card count
eriNum	int	Count of ERI network interface card in RDMA package
eriInfos	EriInfo	ERI network interface card information
ips	List<IpInfo>	Secondary IP address and primary IP information
ipv6s	List<IpInfo>	IPv6 information
securityGroups	List	Security group short ID list (security groups for primary and elastic network interface cards)
enterpriseSecurityGroups	List	Enterprise security group short ID list (Enterprise security groups for primary and elastic network interface cards)

IpInfo

Parameter name	Types	Description
privateIp	String	Internal IP address
eip	String	Public IP Address
primary	String	Whether it is the primary IP address
eipId	String	Bound EIP long ID
eipAllocationId	String	EIP short ID
eipSize	String	EIP bandwidth peak
eipStatus	String	EIP status
eipGroupId	String	EIPGROUP ID
eipType	String	EIP type, where shared indicates EIPGROUP and normal indicates regular EIP

VolumeModel

Parameter name	Types	Description
id	String	Disk ID (returned by disk details/list APIs)
name	String	The disk name, which can contain uppercase and lowercase letters, numbers, Chinese characters, and the special characters - \ _ /. It must start with a letter and have a length of 1-65 characters. (Returned by the disk details/list APIs)
diskSizeInGB	int	Disk size, in GB (returned by instance details, disk details, and disk list APIs)
paymentTiming	String	The billing type, consisting of Postpaid (Pay-as-you-go) and Prepaid (Subscription). (Returned by the disk list and disk details APIs)
createTime	String	Creation date, compliant with BCE date standards (returned by disk list and disk detail APIs)
expireTime	String	Expiration time (returned by disk list and disk details APIs)
status	VolumeStatus	Disk status (returned by disk list and disk details APIs)
type	VolumeType	Disk type (returned by disk list and disk details APIs)
storageType	StorageType	The CDS disk storage classes include SSD_Enhanced (Enhanced SSD), cloud_hp1 (General-purpose SSD), hp1 (High-Performance Cloud Disk), and hdd (General-purpose HDD), with hp1 set as the default. (Returned by the disk list and disk details APIs)
description	string	Description information (returned by disk list API)
desc	String	Description information (returned by disk details API)
attachments	List<VolumeAttachmentModel>	A list of attached device information. This value is null if the disk is not attached. (Returned by the disk list and disk details APIs)
zoneName	String	Availability zone information (returned by disk list and disk details APIs)
regionId	String	Region (returned by disk details API)
snapshotNum	String	Count of current snapshots on the disk (returned by the disk details API)
sourceSnapshotId	String	Snapshot ID used to create disk (returned by disk details API)
autoSnapshotPolicy	AutoSnapshotPolicyModel	Currently configured snapshot policies of disks (returned by disk details API)
tags	List<TagModel>	Currently configured tags of disks (returned by disk details API)
resGroupInfos	List<GroupInfo>	Currently bound resource group of disks (returned by disk details API)
encrypted	boolean	Whether encrypted (returned by disk list and disk details APIs)
enableAutoRenew	boolean	Whether to automatically renew (returned by disk list and disk details APIs)
autoRenewTime	int	Auto-renewal time (returned by disk list and disk details APIs)
isSystemVolume	boolean	Whether it is a system disk (returned by instance details, disk list, and disk details APIs)
clusterId	string	CDS dedicated cluster ID (returned by disk list and disk details APIs)
volumeId	string	Disk ID (returned by instance details API)
cdsExtraIo	int	Additional performance (returned by disk details and disk list APIs)
deleteWithInstance	boolean	Disks are deleted with instance, and only postpaid data disks will be returned
deleteAutoSnapshot	boolean	Automatic snapshots are deleted with the disk, and any type of disk will be returned

GroupInfo

Parameter name	Types	Description
groupId	String	Resource group ID
groupName	String	Resource group name

VolumeClusterModel

Parameter name	Types	Description
clusterId	String	Dedicated cluster ID
clusterName	String	Dedicated cluster name, which supports uppercase and lowercase letters, numbers, Chinese characters, and -_ /. special characters, starting with a letter and a length of 1-65.
createdTime	String	Creation date, compliant with BCE date specifications
expiredTime	String	The expiration time, formatted according to the BCE date specification.
status	String	Dedicated cluster status
logicalZone	String	Dedicated cluster type
productType	String	Payment type of dedicated cluster
clusterType	String	Dedicated cluster type
totalCapacity	int	Total capacity of dedicated cluster
usedCapacity	int	Used capacity of dedicated cluster
availableCapacity	int	Used capacity of dedicated cluster
expandingCapacity	int	Extended capacity of dedicated cluster
createdVolumeNum	int	Count of CDS created by the dedicated cluster
affiliatedCDSNumber	List	List of CDS created by the dedicated cluster
enableAutoRenew	boolean	Whether to enable automatic payment

DiskZoneResources

Parameter name	Types	Description
zoneName	String	Zone information. The naming convention for zoneName follows the format "country-region-availability zone sequence," written in lowercase. For example, Beijing Availability Zone A is represented as "cn-bj-a.\
diskInfos	List<DiskInfo>	Disk information creatable per availability zone. For specific parameters, see DiskInfo

DiskInfo

Parameter name	Types	Description
storageType	String	Disk storage categories
maxDiskSize	int	Maximum creatable disk capacity
minDiskSize	int	Minimum disk capacity created

EniInfo

Parameter name	Types	Description
eniId	String	Network interface card ID
name	String	Network interface card name
vpcId	String	VPC ID
subnetId	String	Subnet ID
zoneName	String	Region
descritption	String	Description
createdTime	String	Creation time
macAddress	String	Physical address
status	String	Status
securityGroupIds	List	List of bound security groups
privateIpSet	List<IpAddress>	IP address information. For specific details, see IpAddress

IpAddress

Parameter name	Types	Description
primary	boolean	Whether it is the primary IP address
publicIpAddress	String	Public IP address
privateIpAddress	String	Internal IP address
ipv6Address	String	IPV6 address

EphemeralDisk

Parameter name	Types	Description
storageType	StorageType	Disk storage categories
sizeInGB	int	Total disk capacity
freeSizeInGB	int	Available capacity, GB

ZoneModel

Parameter name	Types	Description
zoneName	String	Availability zone information

TagModel

Parameter name	Types	Description
tagKey	String	Tag key
tagValue	String	Tag value

ResourceBo

Parameter name	Types	Description
id	String	Instance ID
serialNumber	String	Instance long ID
name	String	Instance name
recycleTime	String	Time moved to recycle bin
deleteTime	String	Time of deletion from the recycle bin
paymentTiming	String	Billing type: prepay/postpay
serviceName	String	Resource name, here it is "Baidu Cloud Compute"
serviceType	String	Resource type, here it is "BCC"
configItem	ConfigItem	Instance configuration information, for specific details, refer to ConfigItem
configItems	List	Instance configuration list

RegionModel

Parameter name	Types	Description
regionId	String	Region ID, e.g., bj
regionName	String	Region name, e.g.: North China-Beijing
regionEndpoint	String	Region-specific access address (Endpoint)

ConfigItem

Parameter name	Types	Description
cpu	int	CPU count
memory	int	Memory size
type	String	Instance type. For specific optional types, see InstanceType
specId	String	Specification type
spec	String	Instance specification.
zoneName	String	Availability zone name

CreateCdsModel

Parameter name	Types	Whether required	Description
cdsSizeInGB	int	Yes	CDS disk capacity must be an integer greater than 0, in GB, ranging from 0 - 5120G
storageType	StorageType	No	The CDS disk storage class, which defaults to hp1 (high-performance cloud disk).
snapshotId	String	No	Snapshot ID. This attribute is valid when creating a disk via snapshot and cannot be smaller than the snapshot size
deleteWithInstance	boolean	No	Disk is deleted with instance, effective for Pay-As-You-Go, defaulting to false. V2 API requires setting the cdsAttributeActive parameter to true when releasing an instance for taking effect.
encryptKey	String	No	Encrypted key

VolumeAttachmentModel

Parameter name	Types	Description
volumeId	String	Disk ID
instanceId	String	Instance ID
device	String	Mount device path (This parameter will soon be deprecated. For better code compatibility, avoid using it.)
serial	String	Disk serial number

SnapshotModel

Parameter name	Types	Description
id	String	Snapshot ID
name	String	The snapshot name, which supports uppercase and lowercase letters, numbers, Chinese characters, and the special characters - \ _ /. It must start with a letter and have a length of 1-65 characters.
sizeInGB	int	Snapshot size, in GB
createTime	String	Snapshot creation time, in BCE-compliant date format
status	SnapshotStatus	Snapshot status
createMethod	String	Snapshot creation method, including manual creation, scheduled creation
volumeId	String	Disk ID or instance ID; null indicates the associated disk has been released
desc	String	Snapshot description information
expireTime	String	Snapshot expiration time, in BCE-compliant date format (this parameter is not included in the simplified model returned by list)
package	boolean	Whether it is a large image, defaulting to false
templateId	String	Custom image ID
insnapId	String	Instance snapshot ID
encrypted	boolean	Whether encrypted
tags	List<[Tag](BCC/Tag Service API Reference/Appendix 1.md#Tag)>	List of tags bound to the snapshot

ImageModel

Parameter name	Types	Description
id	String	Image ID
name	String	The image name, which supports uppercase and lowercase letters, numbers, Chinese characters, and the special characters - \ _ /. It must start with a letter and have a length of 1-65 characters.
type	ImageType	Image type
osType	String	OS type
osVersion	String	OS version
osArch	String	OS bitness
osName	String	OS name
osBuild	String	OS creation time of the image
osLang	String	OS language (CHS for Chinese, ENG for English)
createTime	String	Image creation time, in BCE-compliant date format
status	ImageStatus	Image status
desc	String	Image description information
specialVersion	String	OS special version information, where financial_safty indicates financial security reinforcement version
diskSize	int	Deprecated
minDiskGb	int	Minimum required disk capacity
ephemeralSize	int	Deprecated
shareToUserNumLimit	int	Shareable user count limit (this field is not supported by the image list API)
sharedToUserNum	int	Shared user count (this field is not supported by the image list API)
package	boolean	Whether it is large image, defaulting to false
encrypted	boolean	Whether it is an encrypted image
snapshot	List<SnapshotModel>	Data disk snapshot attached as part of a large image

SecurityGroupModel

Parameter name	Types	Description
id	String	Security group ID
name	String	The name, which supports uppercase and lowercase letters, numbers, Chinese characters, and the special characters - \ _ /. It must start with a letter and have a length of 1-65 characters.
desc	String	Description
vpcId	String	Virtual Private Cloud (VPC) ID
createdTime	String	Security group creation time
sgVersion	long	Security group version number
rules	List<SecurityGroupRuleModel>	Security group rule
tags	List<[Tag](BCC/Tag Service API Reference/Appendix 1.md#Tag)>	Tag list bound to the security group

SecurityGroupRuleModel

Parameter name	Types	Description	Required or not
remark	String	Remarks	No
direction	String	Ingress/Egress: either ingress or egress.	Yes
ethertype	String	The network type, which can be either IPv4 or IPv6. When this value is null, it defaults to IPv4.	No
portRange	String	A port range can be specified, such as a single port like 80, with a default range of 1-65535 if no value is provided.	No
protocol	String	Protocol type: TCP, UDP, or ICMP. Defaults to "all" if no value is provided.	No
sourceGroupId	String	Source security group ID	No
sourceIp	String	Source IP address cannot be set at the same time as sourceGroupId.	No
destGroupId	String	Destination security group ID	No
destIp	String	Destination IP address cannot be set at the same time as destGroupId.	No
securityGroupId	String	Security group ID	No
securityGroupRuleId	String	ID of security group rules	No
createdTime	String	Security group rule creation time	No
updatedTime	String	Security group rule modification time	No

SnapchainModel

Parameter name	Types	Description
status	String	Snapshot chain status: active, expired, clear are available
chainSize	String	Snapshot chain capacity, in GB
chainId	String	Snapshot chain ID
instanceId	String	Virtual machine ID
userId	String	User ID
volumeId	String	Disk ID
volumeSize	int	Disk size, in GB
manualSnapCount	int	Manual snapshot count
autoSnapCount	int	Automatic snapshot count
createTime	String	Creation time

ZoneInstanceType

Parameter name	Types	Description
zoneName	String	Zone information follows the naming convention "country-region-availability zone sequence" in lowercase. For example, Beijing Availability Zone A is named "cn-bj-a".
instanceTypes	List	Available models

ZoneResource

Parameter name	Types	Description
zoneName	String	Availability zone name
bccResources	List<BccBidResources>	BCC resources

BccBidResources

Parameter name	Types	Description
instanceType	String	Instance type
flavors	List<BccBidFlavors>	Package list. Flavors return null when the spot instance package for the instanceType is sold out.

BccBidFlavors

Parameter name	Types	Description
specId	String	Specification type
cpuCount	int	CPU core count
memoryCapacityInGB	int	Memory size
productType	ProductType	Product type
spec	String	Instance specification.

InstanceTypeModel

Parameter name	Types	Description
type	String	Specification category
name	String	Specification code
cpuCount	int	CPU (Core) count
memorySizeInGB	int	Memory (GB)
localDiskSizeInGB	int	Local disk (GB)

KeypairModel

Parameter name	Types	Description
keypairId	String	Key pair ID
name	String	Key pair name
description	String	Key pair description
createdTime	Datetime	Key pair creation time
publicKey	String	Public key content
privateKey	String	Private key content
instanceCount	Integer	Count of VMs bound to the key pair
regionId	String	Region ID of the key pair
fingerPrint	String	Public key fingerprint

OsModel

Parameter name	Types	Description
instanceId	String	Instance ID
osArch	String	OS bitness
osName	String	OS name
osVersion	String	OS version
osType	String	OS type
osLang	String	OS language (CHS for Chinese, ENG for English)
specialVersion	String	OS special version information, where financial_safty indicates financial security reinforcement version

SharedUser

Parameter name	Types	Description
account	String	Shared username
accountId	String	ID of the shared user
ucAccount	String	UC account

AutoSnapshotPolicyModel

Parameter name	Types	Description
id	String	Automatic snapshot policy ID
name	String	Automatic snapshot policy name supports uppercase and lowercase letters, numbers, Chinese characters, and special characters like -_/. It must start with a letter and have a length of 1-65 characters.
timePoints	List	Specify creation time point of automatic snapshot. Minimum unit: hour; totally 24 selectable time points from 00:00~23:00, parameter values 0~23 (e.g., 1 represents 01:00). Multiple time points can be selected. The transfer parameter is a formatted Json Array: [0, 1, … 23], with a maximum of 24 time points, separated by half-width comma characters.
repeatWeekdays	List	Specify the repeat date for automatic snapshots. Select the days from Monday to Sunday to create snapshots. The parameter is a number from 0 - 6, e.g., 0 represents Monday. Multiple dates can be selected. The transfer parameter is a formatted Json Array: [0，1…6].
status	String	Snapshot status: active, deleted, or paused
retentionDays	int	Specify the retention time for automatic snapshots in days. -1: Retain permanently. 1 - 65536: Specify the number of days for retention.
createdTime	String	Creation time of automatic snapshot policy is in BCE-compliant date format (starting from this field and subsequent fields, not returned in volume API)
updatedTime	String	Last update time of automatic snapshot policy, in BCE-compliant date format
deletedTime	String	Deletion time of automatic snapshot policy, in BCE-compliant date format
lastExecuteTime	String	The final execution time of automatic snapshot policy, in BCE-compliant date format
volumeCount	int	Associated disk count

InstancePassRoleModel

Parameter name	Types	Description
instanceId	String	Instance ID

InstancePassRoleFailModel

Parameter name	Types	Description
instanceId	String	Instance ID
failMessage	String	Failure information

InstanceRoleAssociationModel

Parameter name	Types	Description
instanceId	String	Instance ID

InstanceRoleModel

Parameter name	Types	Description
roleName	String	Role name

ZoneResourceDetailSpec

Parameter name	Types	Description
zoneName	String	Availability zone
bccResources	BccResources	BCC instance resource information
ebcResources	BccResources	EBC instance resource information

BccResources

Parameter name	Types	Description
flavorGroups	List<FlavorGroup>	Instance package specification information

FileSystemModel

Parameter name	Types	Description
fsId	String	CFS ID
mountAds	String	Mount target address
path	String	Mount directory
protocol	String	CFS protocol type, options: nfs, smb

FlavorGroup

Parameter name	Types	Description
groupId	String	Instance package family
flavors	List<BccFlavor>	Instance package specification

BccFlavor

Parameter name	Types	Description
cpuCount	int	CPU count
memoryCapacityInGB	int	Memory capacity (in GB)
ephemeralDiskInGb	int	Local data disk capacity (unit: GB)
ephemeralDiskCount	int	Local data disk count
ephemeralDiskType	String	Local data disk type
gpuCardType	String	GPU card type
gpuCardCount	int	GPU card count
fpgaCardType	String	FPGA card type
fpgaCardCount	int	FPGA card count
productType	String	Supported bill types (PrePaid: Subscription; PostPaid: Postpay; both: Subscription/Postpay)
spec	String	Instance package specification
specId	String	Instance package specification type
enableJumboFrame	Boolean	Whether the instance package supports to enable Jumbo frames. Enable: true; disable: false
cpuModel	String	Processor model
cpuGHz	String	Processor base frequency
networkBandwidth	String	Intranet bandwidth (Gbps)
networkPackage	String	Network packet transmission/reception
netEthQueueCount	String	Package network interface card queue count
netEthMaxQueueCount	String	Maximum supported queue count for package network interface card
eniQuota	int	Maximum ENI count (quota)
eriQuota	int	Maximum ERI count (quota)
rdmaType	String	RDMA type, RoCE or IB
rdmaNetCardCount	int	RDMA network interface card count
rdmaNetBandwidth	int	RDMA network interface card bandwidth (Gbps)
systemDiskType	StorageType	System disk types supported by the package
dataDiskType	StorageType	Data disk types supported by the package
nicIpv4Quota	int	Single network interface card IPv4 address count (quota)
nicIpv6Quota	int	Single network interface card IPv6 address count (quota)
volumeCount	int	CDS count

SpecIdPrices

Parameter name	Types	Description
specId	String	Specification type
specPrices	List<SpecPrices>	Instance package specification information

SpecPrices

Parameter name	Types	Description
spec	String	Instance package specification
status	String	Instance package specification status
specPrice	double	Corresponding price of instance package specification
tradePrice	double	Instance final price, i.e., the actual payment price after discounts

AsGroup

Parameter name	Types	Description
groupId	String	The scaling group ID follows BCE specifications and is a fixed-length string allowing only uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
groupName	String	The scaling group name supports uppercase and lowercase letters, numbers, Chinese characters, and special characters like -_/., starting with a letter and having a length of 1-65 characters.
region	String	Region where the scaling group is located
status	AsGroupStatus	Scaling group status
vpcId	String	Virtual Private Cloud VpcId
nodeNum	int	Node count under the scaling group
createTime	String	Creation time
zoneInfo	ZoneInfo	Availability zone and subnet information
groupConfig	GroupConfig	Scaling group specifications
blbId	String	Load balancer ID

ZoneInfo

Parameter name	Types	Description
zone	String	Availability zone
subnetId	String	Subnet ID

GroupConfig

Parameter name	Types	Description
minNodeNum	int	Minimum node count
maxNodeNum	int	Maximum node count
cooldownInSec	int	Cool down time (Unit: seconds)

VpcInfo

Parameter name	Types	Description
vpcId	String	Virtual Private Cloud VpcId
vpcName	String	Virtual Private Cloud (VPC) name

NodeModel

Parameter name	Types	Description
instanceId	String	Instance ID
instanceName	String	Instance name
floatingIp	String	Floating IP address
internalIp	String	Internal IP address
status	String	Node status
payment	String	Bill type
cpuCount	int	CPU count
memoryCapacityInGB	int	Memory size
instanceType	String	Instance type
sysDiskInGB	int	System disk size
subnetType	String	Subnet type
isProtected	boolean	Whether it is a protected node
createTime	String	Creation time
nodeType	String	Node type
eip	AsEipModel	EIP information

AsEipModel

Parameter name	Types	Description
bandwidthInMbps	int	Maximum bandwidth
address	String	Public IP address
eipStatus	String	EIP status
eipAllocationId	String	EIP - instance ID

DeploySetModel

Parameter name	Types	Description
deploysetId	String	Deployment group ID
name	String	Deployment group name
desc	String	Deployment group description
concurrency	int	Deployment group concurrency count
strategy	String	Deployment group policy: HOST_HA (host); RACK_HA (rack); TOR_HA (switch); POD_RQ (cluster)
azIntstanceStatisList	List<AzIntstanceStatisDetail>	Statistic list of instance count in availability zone

AzIntstanceStatisDetail

Parameter name	Types	Description
zoneName	String	Availability zone name
instanceCount	String	Instance count associated with deployment group
bccInstanceCnt	String	Count of deployment group-associated BCC instances
bbcInstanceCnt	String	Count of deployment group-associated BCC instances
instanceTotal	int	Quota of specified availability zone under current deployment group strategy type
instanceIds	List	List of deployment group associated instances, returned when querying deployment group details, not returned when querying deployment group list
bccInstanceIds	List	ID List of deployment group-associated BCC instances, returned when querying deployment group details, not returned when querying deployment group list
bbcInstanceIds	List	Count of deployment group-associated BCC instances, when querying deployment group details, not returned when querying deployment group list

PrepayConfig

Parameter name	Types	Description
instanceId	String	Instance ID
duration	int	Purchase period (unit: month)
cdsList	List	(This parameter is deprecated. Postpaid CDS data disks attached to BCC must be converted to Subscription together) List of data disks associated to modification, defaulting to null, "all" indicates all associated data disks (e.g., "cdsList":["all"]. To modify only part of the associated data disks, pass the specific data disk ID)
autoRenew	boolean	Whether to automatically renew the instance upon expiration. Values: true: Auto-renewal; false: No auto-renewal. Default value: false.
autoRenewPeriod	int	Duration of each auto-renewal (unit: months). Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36. The default is 1. This parameter is valid only when autoRenew is set to true.
autoPay	boolean	Whether it is auto-pay, defaulting to true indicates auto-pay

PostpayConfig

Parameter name	Types	Description
instanceId	String	Instance ID
cdsList	List	(This parameter is deprecated. Subscribed CDS data disks attached to BCC must be converted to Postpay together) List of data disks associated to modification, defaulting to null, "all" indicates all associated data disks (e.g., "cdsList":["all"]. To modify only part of the associated data disks, pass the specific data disk ID).
effectiveType	String	Effective method: AtOnce (immediate switch to Postpay) or AfterExpiration (switch to Postpay after expiration). Defaults to AfterExpiration if no option is specified. This parameter must remain uniform for batch operations.

InstanceDeleteResultModel

Parameter name	Types	Description
instanceId	String	Instance ID
eip	String	eip
insnapIds	List	Instance snapshot ID list
snapshotIds	List	Snapshot ID list
volumeIds	List	Disk ID list

Type code definition

VolumeType

Encoding	Description
System	System disk
Ephemeral	Local disk
Cds	Cloud disk server (CDS)

StorageType

Encoding	Description	Creatable data disk	Creatable system disk
enhanced_ssd_pl1 or SSD_Enhanced	Enhanced SSD_PL1	Yes	Yes
enhanced_ssd_pl2	Enhanced SSD_PL2	Yes	Yes
enhanced_ssd_pl3	Enhanced SSD_PL3	Yes	Yes
cloud_hp1 or premium_ssd	General-purpose SSD	Yes	Yes
hp1 or ssd	High-performance cloud disk	Yes	Yes
hdd	General-purpose HDD (This type is being phased out)	Yes	No
local	Local disk	No	No
sata	Previous-generation cloud disk, dedicated for creating DCC sub-instances,	-	-
local_ssd	With data stored on local SSD disks with low latency, good IO and throughput performance, suitable for medium-to-large relational database services	-	-
local_hdd or std1	Local HDD disk, which is suitable for large-scale data storage scenarios	-	-
local_nvme or nvme	Local NVME disk, with data stored on local NVME SSD, with ultra-high performance, suitable for latency-sensitive services	-	-

ImageType

Encoding	Description
System	System image/public image
Custom	Custom image
Integration	Service integration image

GpuType

Encoding	Description
V100-32	NVIDIA Tesla V100-32G
V100-16	NVIDIA Tesla V100-16G
P40	NVIDIA Tesla P40
P4	NVIDIA Tesla P4
K40	NVIDIA Tesla K40
DLCard	NVIDIA deep learning development card

FpgaType

Encoding	Description
KU115	xilinx ku115

InternetChargeType

Encoding	Description
BANDWIDTH_PREPAID	Subscription settled by bandwidth
TRAFFIC_POSTPAID_BY_HOUR	Traffic postpaid by hour
BANDWIDTH_POSTPAID_BY_HOUR	Bandwidth postpaid by hour

BidModel

Encoding	Description
market	Bid at market price
custom	Custom bid

DeployStrategy

Encoding	Description
HOST_HA	Host isolation
RACK_HA	Rack isolation
TOR_HA	Switch isolation

SystemImageModel

	Parameter name	Types
imageId	String	Image ID
imageName	String	Image name
osType	String	OS type
osVersion	String	OS version
osArch	String	OS bitness
osName	String	OS name
osLang	String	OS language (CHS for Chinese, ENG for English)
minSizeInGiB	String	Minimum supported system disk capacity (unit: GB)

Status code definitions

ProductType

Encoding	Description
Prepaid	Subscription (prepay)
Postpaid	Postpay

InstanceStatus

Encoding	Description
Starting	Starting
Running	Running
Stopping	Stopping
Stopped	Stopped
Recycled	In recycle bin
Deleted	Released, this status is internal and cannot be queried via API
Scaling	Scaling
Expired	Expired or in debt
Error	Error
SnapshotProcessing	Snapshot operation in progress
ImageProcessing	Image operation in progress
Recharging	Recharging
VolumeResizing	Disk scale-up in progress
BillingChanging	Shift charge in progress
ChangeSubnet	Subnet change in progress
ChangeVpc	VPC change in progress
AttachingPort	Attaching elastic network interface card in progress
DetachingPort	Detach elastic network interface in progress
Moving	Moving in progress - status during instance availability zone modification or cross-AZ migration

VolumeStatus

Encoding	Description
Creating	Creation in progress. Volume creation is asynchronous. This status means the system has received the request, allocated a volume ID, but has not completed the creation process.
Available	Ready to be attached. The volume has been created, is in normal status, and is not yet attached to any virtual machine instance.
Attaching	Attaching. Volume attachment is an asynchronous operation, and this status indicates the attachment is in progress.
NotAvailable	Temporarily unavailable status
InUse	In use
Detaching	Detaching. Volume detachment is asynchronous, and this status indicates the operation is ongoing.
Deleting	Deleting
Deleted	Deleted, this status is internal and cannot be queried via API
Scaling	Scaling
Expired	Expired or in debt
Error	Error
SnapshotProcessing	Snapshot operation in progress
ImageProcessing	Image operation in progress
Recharging	Recharging

RemoteCopyRequest

Encoding	Types	Description
name	String	Snapshot name
destRegion	String	Target region for snapshot to be copied

RemoteCopySnapshot

Encoding	Types	Description
region	String	Target region
snapshotId	String	Snapshot ID successfully copied to the target region

SnapshotStatus

Encoding	Description
Creating	Creating
CreatedFailed	Creation failed
Available	Available
NotAvailable	Unavailable

ImageStatus

Encoding	Description
Creating	Creating
CreatedFailed	Creation failed
Available	Available
NotAvailable	Unavailable
Error	Error

RelatedRenewFlag

Encoding	Description
CDS	Only renew subscribed (prepaid) CDS associated with BCC instances
EIP	Only renew subscribed (prepaid) EIP associated with BCC instances
MKT	Only renew subscribed (prepaid) MKT associated with BCC instances
CDS_EIP	Only renew subscribed (prepaid) CDS and EIP associated with BCC instances
CDS_MKT	Only renew subscribed (prepaid) CDS and MKT associated with BCC instances
EIP_MKT	Only renew subscribed (prepaid) EIP and MKT associated with BCC instances
CDS_EIP_MKT	Only renew subscribed (prepaid) CDS, EIP and MKT associated with BCC instances

AsGroupStatus

Encoding	Description
CREATING	Creating
RUNNING	Running
SCALING_UP	Scale-up in progress
SCALING_DOWN	Scale-down in progress
ATTACHING_NODE	Moving into node in progress
DETACHING_NODE	Removing a node
DELETING	Deleting
BINDING_BLB	Binding BLB in progress
UNBINDING_BLB	Unbounding blb
COOLDOWN	Cooling down in progress
PAUSE	Suspension in progress
DELETED	Deleted

Regional models and optional configurations

InstanceType

Encoding	Description	New model name
N1	General-purpose BCC instance	General-purpose g1, Compute-optimized c1, Intensive compute-optimized ic1, Memory-optimized m1
N2	General-purpose II BBC instance	General-purpose g2, Compute-optimized c2, Intensive compute-optimized ic2, Memory-optimized m2
N3	General-purpose III BCC instance	General-purpose g3, Compute-optimized c3, Intensive compute-optimized ic3, Memory-optimized m3
N4	Network-enhanced BCC instance	General network-enhanced g3ne, Compute network-enhanced c3ne, Memory network-enhanced m3ne
N5	General-purpose IV BCC instance	General-purpose g4, Intensive compute ic4Compute-optimized c4, Memory-optimized m4
N6	General-purpose V BCC instance	General-purpose g5, Intensive compute ic5Compute-optimized c5, Memory-optimized m5
C1	Compute-optimized instance	High-base frequency compute-optimized hcc1, High-base frequency general-purpose hcg1
C2	Compute-optimized II instance	High-base frequency compute-optimized hcc2, High-base frequency general-purpose hcg2
S1	Storage-optimized instance	Local SSD l1
G1	GPU instance	---
F1	FPGA instance	---

GpuType

Encoding	Description
V100-32	NVIDIA Tesla V100-32G
V100-16	NVIDIA Tesla V100-16G
P40	NVIDIA Tesla P40
P4	NVIDIA Tesla P4
K40	NVIDIA Tesla K40
DLCard	NVIDIA deep learning development card

Region supported instance types (subject to changes based on product planning, refer to the Console Purchase page)

Region	Instance types supported for creation
Beijing (bj)	General-purpose BCC (N1), refer to [General-purpose BCC (N1) Optional Specification Configuration](#General-purpose BCC Optional Specification Configuration) for optional configuration, General-purpose II BCC (N2), refer to [General-purpose II BCC (N2) Optional Specification Configuration](#General-purpose BCC II Optional Specification Configuration) for optional configuration, General-purpose III BCC (N3), refer to [General-purpose III BCC (N3) Optional Specification Configuration](#General-purpose BCC III Optional Specification Configuration) for optional configuration, Compute-optimized Instance (C1), refer to [Compute-optimized Instance (C1) Optional Specification Configuration](#Compute-optimized Instance Optional Specification Configuration) for optional configuration, Storage-optimized Instance (S1), refer to [Storage-optimized Instance(S1) Optional Specification Configuration](#General-purpose BCC Optional Specification Configuration) for optional configuration, GPU-optimized Instance (G1), refer to [GPU-optimized Instance (G1) Optional Specification Configuration](#GPU-purpose BCC Optional Specification Configuration) for optional configuration, FPGA-optimized Instance (F1), refer to [FPGA-optimized Instance (F1) Optional Specification Configuration](#FPGA-purpose BCC Optional Specification Configuration) for optional configuration
Guangzhou (gz)	General-purpose BCC (N1), refer to [General-purpose BCC (N1) Optional Specification Configuration](#General-purpose BCC Optional Specification Configuration) for optional configuration, General-purpose II BCC (N2), refer to [General-purpose II BCC (N2) Optional Specification Configuration](#General-purpose BCC II Optional Specification Configuration) for optional configuration, General-purpose III BCC (N3), refer to [General-purpose III BCC (N3) Optional Specification Configuration ](#General-purpose BCC III Optional Specification Configuration) for optional configuration, Compute-optimized Instance (C1), refer to [Compute-optimized Instance (C1) Optional Specification Configuration ](#Compute-optimized Instance Optional Specification Configuration) for optional configuration, Storage-optimized Instance (S1), refer to [Storage-optimized Instance (S1) Optional Specification Configuration](#General-purpose BCC Optional Specification Configuration) for optional configuration, GPU Instance (G1), refer to [GPU Instance (G1) Optional Specification Configuration ](#GPU-purpose BCC Optional Specification Configuration) for optional configuration
Suzhou (su)	Standard II BCC (N2), refer to [Standard II BCC (N2) Optional Specification Configuration](#General-purpose BCC II Optional Specification Configuration) for optional configuration, Standard III BCC (N3), refer to [Standard III BCC (N3) Optional Specification Configuration](#General-purpose BCC III Optional Specification Configuration) for optional configuration, Compute-optimized Instance (C1), refer to [Compute-optimized Instance (C1) Optional Specification Configuration](#Compute-optimized Instance Optional Specification Configuration) for optional configuration, Storage-optimized Instance (S1), refer to [Storage-optimized Instance (S1) Optional Specification Configuration](#General-purpose BCC Optional Specification Configuration) for optional configuration, GPU Instance (G1), refer to [GPU Instance (G1) Optional Specification Configuration](#GPU-purpose BCC Optional Specification Configuration) for optional configuration

General-purpose BCC Optional Specification Configuration

Subscription (Prepay) Optional Specification Configuration (CPU cores, memory GB)	Postpay Optional Specification Configuration (CPU cores, memory GB)
[1, 1], [1, 2], [1, 4], [1, 8], [2, 2], [2, 4], [2, 8], [2, 12], [2, 16], [4, 4], [4, 8], [4, 12], [4, 16], [4, 32], [8, 8], [8, 12], [8, 16], [8, 24], [8, 32], [8, 64], [12, 12], [12, 16], [12, 24], [12, 32], [12, 48], [12, 64], [16, 16], [16, 24], [16, 32], [16, 48], [16, 64]	The same as Subscription (Prepay) Optional Specification Configuration (CPU cores, memory GB)

General-purpose BCC II Optional Specification Configuration

Subscription (Prepay) Optional Specification Configuration (CPU cores, memory GB)	Postpay Optional Specification Configuration (CPU cores, memory GB)
[1, 1], [1, 2], [1, 4], [1, 8], [2, 2], [2, 4], [2, 8], [2, 12], [2, 16], [4, 4], [4, 8], [4, 12], [4, 16], [4, 32], [8, 8], [8, 12], [8, 16], [8, 24], [8, 32], [8, 64], [12, 12], [12, 16], [12, 24], [12, 32], [12, 48], [12, 64], [16, 16], [16, 24], [16, 32], [16, 48], [16, 64], [16, 128], [32, 64], [32, 128], [48, 96], [48, 128], [48, 192]	[1, 1], [1, 2], [1, 4], [1, 8], [2, 2], [2, 4], [2, 8], [2, 12], [2, 16], [4, 4], [4, 8], [4, 12], [4, 16], [4, 32], [8, 8], [8, 12], [8, 16], [8, 24], [8, 32], [8, 64], [12, 12], [12, 16], [12, 24], [12, 32], [12, 48], [12, 64], [16, 16], [16, 24], [16, 32], [16, 48], [16, 64], [16, 128]

###General-purpose BCC III Optional Specification Configuration

Subscription (Prepay) Optional Specification Configuration (CPU cores, memory GB)

Postpay Optional Specification Configuration (CPU cores, memory GB)

[1, 1], [1, 2], [1, 4], [1, 8], [2, 2], [2, 4], [2, 8], [2, 12], [2, 16], [4, 4], [4, 8], [4, 12], [4, 16], [4, 32], [8, 8], [8, 12], [8, 16], [8, 24], [8, 32], [8, 64], [12, 12], [12, 16], [12, 24], [12, 32], [12, 48], [12, 64], [16, 16], [16, 24], [16, 32], [16, 48], [16, 64], [16, 128], [24, 48], [24, 96], [24, 128], [32, 64], [32, 128], [32, 256], [48, 96], [48, 128], [48, 192], [48, 256], [64, 128], [64, 256], [96, 256]

The same as Subscription (Prepay) Optional Specification Configuration (CPU cores, memory GB)

Compute-optimized Instance Optional Specification Configuration

Subscription (Prepay) Optional Specification Configuration (CPU cores, memory GB)	Postpay Optional Specification Configuration (CPU cores, memory GB)
[4, 8], [4, 16], [4, 32], [8, 16], [8, 32], [16, 32], [16, 64], [24, 96]	The same as Subscription (Prepay) Optional Specification Configuration (CPU cores, memory GB)

Storage-optimized Instance Optional Specification Configuration

Prepay Optional Specification Configuration (CPU cores, memory GB)	Postpay Optional Specification Configuration (CPU cores, memory GB)
[1, 1], [1, 2], [1, 4], [1, 8], [2, 2], [2, 4], [2, 8], [2, 12], [2, 16], [4, 4], [4, 8], [4, 12], [4, 16], [4, 32], [8, 8], [8, 12], [8, 16], [8, 24], [8, 32], [8, 64], [12, 12], [12, 16], [12, 24], [12, 32], [12, 48], [12, 64], [16, 16], [16, 24], [16, 32], [16, 48], [16, 64]	The same as Prepay Optional Specification Configuration (CPU cores, memory GB)

GPU-purpose BCC Optional Specification Configuration

Prepay Optional Specification Configuration (GPU card type, GPU card count, CPU cores, memory GB, local disk size GB)	Postpay Optional Specification Configuration (GPU card type, GPU card count, CPU cores, memory GB, local disk size GB)
[P4,1,12,40,450],[P4,2,24,80,900],[P4,4,48,160,1800], [P40,1,12,40,450],[P40,2,24,80,900],[P40,4,48,160,1800], [K40,1,6,40,450],[K40,2,12,80,400],[K40,4,24,160,800], [DLCard,1,6,40,450],[DLCard,2,12,80,400],[DLCard,4,24,160,800]	The same as Prepay Optional Specification Configuration (GPU card type, GPU card count, CPU cores, memory GB, local disk size GB)

FPGA-purpose BCC Optional Specification Configuration

Prepay Optional Specification Configuration (FPGA card type, FPGA card count, CPU cores, memory GB, local disk size GB)	Postpay Optional Specification Configuration (FPGA card type, FPGA card count, CPU cores, memory GB, local disk size GB)
[KU115,1,16,64,450]	The same as Prepay Optional Specification Configuration (FPGA card type, FPGA count, CPU cores, memory GB, local disk size GB)

Instance package specification definition (deprecated, not recommended)

Specification category	Specification code	CPU(Core)	Memory (GB)
Tiny	bcc.t1.tiny	1	1
General	bcc.g1.tiny	1	2
General	bcc.g2.tiny	1	4
General	bcc.g3.tiny	1	8
General	bcc.g1.small	2	2
General	bcc.g2.small	2	4
General	bcc.g3.small	2	8
General	bcc.g4.small	2	12
General	bcc.g1.medium	4	4
General	bcc.g2.medium	4	8
Memory	bcc.m1.medium	4	12
Memory	bcc.m2.medium	4	16
Memory	bcc.m1.large	8	16
Memory	bcc.m2.large	8	24
Memory	bcc.m3.large	8	32
cpu	bcc.c1.large	8	8
cpu	bcc.c2.large	8	12
cpu	bcc.c1.xlarge	12	12
cpu	bcc.c2.xlarge	12	16
cpu	bcc.c3.xlarge	12	24
cpu	bcc.c4.xlarge	12	32
cpu	bcc.c5.xlarge	12	48
cpu	bcc.c1.2xlarge	16	16
cpu	bcc.c2.2xlarge	16	24
cpu	bcc.c3.2xlarge	16	32
cpu	bcc.c4.2xlarge	16	48
cpu	bcc.c5.2xlarge	16	64

Order information definition

Billing

Status	Types	Description
paymentTiming	String	Bill type, including prepaid, postpaid and spot instance (bidding)
reservation	Reservation	Reserved information, not required when payment method is Postpay, but must be set when it is Prepay

Reservation

Status	Types	Description
reservationLength	int	Duration: [1,2,3,4,5,6,7,8,9,12,24,36]
reservationTimeUnit	String	Time unit: Month - currently only monthly is supported

TransferInRecord

Status	Types	Description
transferRecordId	String	Reserved instance transfer record ID
grantorUserId	String	Transferor account (desensitized)
status	String	Reserved instance transfer record status
reservedInstanceInfo	ReservedInstanceInfo	Reserved instance details
applicationTime	String	Reserved instance transfer initiation time
expireTime	String	Reserved instance transfer expiration time
endTime	String	Reserved instance transfer end time

TransferOutRecord

Status	Types	Description
transferRecordId	String	Reserved instance transfer record ID
recipientUserId	String	Recipient account (desensitized)
status	String	Reserved instance transfer record status
reservedInstanceInfo	ReservedInstanceInfo	Reserved instance details
applicationTime	String	Reserved instance transfer initiation time
expireTime	String	Reserved instance transfer expiration time
endTime	String	Reserved instance transfer end time

ReservedInstanceInfo

Status	Types	Description
reservedInstanceId	String	Reserved instance ID
reservedInstanceUuId	String	Reserved instance long ID
reservedInstanceName	String	Reserved instance name
scope	String	Reserved instance effective scope
zoneName	String	Reserved instance availability zone
spec	String	Reserved instance specification
reservedType	String	Reserved instance type
offeringType	String	Reserved instance bill type
osType	String	Reserved instance image type
reservedInstanceStatus	String	Reserved instance status
instanceCount	int	Reserved instance count
instanceId	String	Deduct instance ID
instanceName	String	Deduction instance name
effectiveTime	String	Reserved instance effective time
expireTime	String	Reserved instance expiration time
autoRenew	String	Whether auto-renewal is enabled for reserved instances
renewTimeUnit	String	Reserved instance auto-renewal unit
renewTime	String	Reserved instance renewal duration
nextRenewTime	String	Next auto-renewal time for reserved instances
ehcClusterId	String	EHC cluster ID where the reserved instance is located

TaskModel

Status	Types	Description
taskId	String	The task ID follows BCE specifications and must be a fixed-length string containing only uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
instanceId	String	Instance ID
internalIp	String	Instance internal IP address
status	String	Task status
errResult	String	Fault description
createTime	String	Creation time
enableHotplug	Boolean	Support hot repair or not: true indicates supported, null indicates unsupported
isSystemDiskRecoverable	Boolean	Whether system disk data is repairable, true indicates repairable, null indicates not repairable
relocationTime	int	Estimated cold migration duration, null indicates no information
retainDataDisk	Boolean	Whether to retain data disk data. true means retain, null means not retain
errStartTime	String	Fault occurrence time
newTaskTime	String	Repair task creation time
authorizeTaskTime	String	Authorized repair task time
unAuthorizeTaskTime	String	Not certified repair task time
simCompletionTime	String	Repair completion time by repairman
checkTaskTime	String	Repair task acceptance time
firstConfirmedTime	String	Time for first acceptance of repair task or uncompleted acceptance

ClosedTaskModel

Status	Types	Description
taskId	String	The task ID follows BCE specifications and must be a fixed-length string containing only uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
instanceId	String	Instance ID
internalIp	String	Instance internal IP address
errResult	String	Fault description
startTime	String	Task start time
endTime	String	Task end time
errStartTime	String	Fault occurrence time
newTaskTime	String	Repair task creation time
authorizeTaskTime	String	Authorized repair task time
unAuthorizeTaskTime	String	Not certified repair task time
simCompletionTime	String	Repair completion time by repairman
checkTaskTime	String	Repair task acceptance time
firstConfirmedTime	String	Time for first acceptance of repair task or uncompleted acceptance

RepairTaskDetail

Status	Types	Description
taskId	String	The task ID follows BCE specifications and must be a fixed-length string containing only uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
instanceId	String	Instance ID
instanceName	String	Instance name
errResult	String	Fault description
status	String	Task status
serverStatus	String	Instance status
region	String	Region where the instance is located
internalIp	String	Instance internal IP address
floatingIp	String	Instance floating IP address
errStartTime	String	Fault occurrence time
newTaskTime	String	Repair task creation time
authorizeTaskTime	String	Authorized repair task time
unAuthorizeTaskTime	String	Not certified repair task time
simCompletionTime	String	Repair completion time by repairman
checkTaskTime	String	Repair task acceptance time
firstConfirmedTime	String	Time for first acceptance of repair task or uncompleted acceptance

OperationRecord

Status	Types	Description
name	String	Operation name
operator	String	Operator
operateTime	String	Operation time

RuleModel

Status	Types	Description
ruleId	String	Operation name
ruleName	String	Operator
tagCount	int	Associated tag count
limit	int	Pre-certification limit
status	String	Rule status: enabled/disabled

RuleDetail

Status	Types	Description
ruleId	String	Operation name
ruleName	String	Operator
tagCount	int	Associated tag count
limit	int	Pre-certification limit
status	String	Rule status: enabled/disabled
tags	List<[Tag](BCC/Tag Service API Reference/Appendix 1.md#Tag)>	Associated tag list

CdsCustomPeriod

Status	Types	Description
volumeId	String	Disk ID (returned by disk details/list APIs)
period	int	Renewal duration in months, ranging from 1 to 60. Ensure the disk's expiration time after renewal matches or exceeds the BCC's expiration time; otherwise, the renewal will fail.