Tenant Cloud Compute Cloud Virtual Machine Data structure

Data structure

Last Updated At: 2026-08-02 00:05:21

DiagnosticReportDataSet

Referenced by the following interfaces: DescribeDiagnosticReports

name	required	NULL allowed	type	description
CreateTime	no	no	Datetime	Start Time Example: 2014-08-03 12:00:00
DiagnosticReportId	no	no	String	Report ID Example: dr-61dyt49h
FinishTime	no	no	Datetime	End time Example: 2014-08-03 12:00:00
InstanceId	no	no	String	Instance ID Example: ins-61dyt49h
InstanceName	no	no	String	Instance name Example: jack-use
ReportDetailSet	no	no	Array of ReportDetailSet	ReportDetailSet Example:View
Severity	no	yes	String	Detection status Example: Normal
Status	no	no	String	Status Example: Finished
Uuid	no	no	String	uuid Example: 4904ffac-02e4-4161-9636-cca0a687e841

Price

Referenced by the following interfaces: InquiryPriceModifyInstancesChargeType, InquiryPriceRenewInstances, InquiryPriceResetInstance, InquiryPriceResetInstancesInternetMaxBandwidth, InquiryPriceResetInstancesType, InquiryPriceResizeInstanceDisks, InquiryPriceRunInstances

name	required	NULL allowed	type	description
InstancePrice	no	no	ItemPrice	It describes the instance price. Example:View
BandwidthPrice	no	yes	ItemPrice	It describes the network price. Example:View

StorageBlock

HDD Local Storage Information
Referenced by the following APIs: CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeZoneInstanceConfigInfos, and RunInstances.

Referenced by the following interfaces: DescribeInstanceConfigInfos, DescribeInstancesActionTimer, DescribeLaunchTemplatesInfo, DescribeZoneInstanceConfigInfos, ImportInstancesActionTimer, ModifyInstancesActionTimer, QueryInstancesActionTimer, SwitchParameterRunInstances, UpdateInstancesActionTimer

name	required	NULL allowed	type	description
Type	no	no	String	HDD local storage type, whose value is LOCAL_PRO. Note: This field may return null, indicating that no valid values can be obtained. Example: LOCAL_PRO
MinSize	no	no	Int64	Minimum HDD Local Storage Capacity Note: This field may return null, indicating that no valid value was found. Example: 10
MaxSize	no	no	Int64	Maximum Capacity of HDD Local Storage Note: This field may return null, indicating that no valid values can be obtained. Example: 500

SwapDisks

System disk information.

Referenced by the following interfaces: DescribeInstances

name	required	NULL allowed	type	description
DiskType	no	no	String	System Disk Type Example: CLOUD_SSD
DiskSize	no	no	Uint64	System Disk Size (GB) Example: 50
DiskId	no	yes	String	Unique identifier of the system disk. Example: disk-r92o1auc
Encrypt	no	yes	Bool	Encryption Example: true
KmsKeyId	no	yes	String	Encryption key ID. Example: kms-33456736
ThroughputPerformance	no	yes	Uint64	Throughput performance (MB/s). Example: 100
CdcId	no	yes	String	Dedicated Cluster ID Example: cluster-0dwcu6ns

KeyBill

Description of Instance Order ID

Referenced by the following interfaces: DescribeInstancesAttribute

name	required	NULL allowed	type	description
InstanceId	yes	no	String	Instance ID, in the format of ins-11112222. Example: ins-61dyt49h
BillId	yes	yes	String	Order ID Example: 20181225834839234

SystemDisk

It describes the information about the block device, namely, the system disk, where the operating system is located.

Referenced by the following interfaces: CloneInstance, CreateLaunchTemplate, DescribeInstances, DescribeLaunchTemplatesInfo, InquiryPriceResetInstance, InquiryPriceResizeInstanceDisks, InquiryPriceRunInstances, ModifyLaunchTemplate, ResetInstance, ResizeInstanceDisks, RunInstances, SwitchParameterRunInstances

name	required	NULL allowed	type	description
DiskType	no	no	String	System disk type. Value range: LOCAL_BASIC: Local HDD LOCAL_SSD: Local SSD CLOUD_BASIC: Standard CBS CLOUD_SSD: SSD CBS CLOUD_PREMIUM: High-Performance CBS Default value: LOCAL_BASIC. Example: Local Hard Disk
DiskId	no	yes	String	System disk ID. The LOCAL_BASIC and LOCAL_SSD types do not have an ID. Currently, this parameter is not supported. Example: disk-61dyt49h
DiskSize	no	no	Int64	System disk size, in GB. The default value is 50. Example: 500
DiskStoragePoolGroup	no	yes	String	Storage pool specified by the system disk. Example: alice-1255000080
AutoSnapshotPolicyId	no	yes	String	Auto Backup Policy ID of CBS Example: asp-c0jt9yym
Encrypt	no	no	Bool	Encryption Example: true
KmsKeyId	no	yes	String	Encryption key ID. Example: kms-33453241
ThroughputPerformance	no	no	Uint64	Throughput performance (MB/s). Example: 100
CdcId	no	yes	String	Dedicated Cluster ID Example: cluster-0dwcu6ns

BasicService

Describes the relevant information about the basic service.

Referenced by the following interfaces: CloneInstance, CreateLaunchTemplate, DescribeLaunchTemplatesInfo, InquiryPriceResetInstance, InquiryPriceRunInstances, ModifyLaunchTemplate, ResetInstance, RunInstances, SwitchParameterRunInstances

name	required	NULL allowed	type	description
Enabled	no	no	Bool	Whether the basic service is enabled. Valid values: TRUE: enabled; FALSE: not enabled. Default value: TRUE. Example: false

InstanceStatus

Description of the instance status. For details on status types, see Instance Status Table.

Referenced by the following interfaces: DescribeInstancesStatus

name	required	NULL allowed	type	description
InstanceId	no	no	String	Instance ID. Example: ins-61dyt49h
InstanceState	no	no	String	Instance Status. Example: RUNNING
OperationMask	no	no	Int64	Operation Mask Example: 14088
RunFlag	no	no	Int64	Instance Status Example: 0
Hypervisor	no	no	Int64	Virtualization Type Example: 0
IsReturnable	no	no	Bool	Whether the instance can be proactively returned. Example: true
ReturnFailCode	no	no	Int64	Reason why proactive return is not supported. Example: 0
ReturnFailMessage	no	no	String	Error message when proactive return is not supported. Example: Refundable
TotalDuration	no	no	Int64	TotalDuration Example: 0
UsedDuration	no	no	Int64	UsedDuration Example: 0
InnerVpcId	no	no	Int64	VPC ID Example: 5350233

EnhancedService

It describes the enhanced services enabling situation and settings of the instance, such as Cloud Security, Cloud Monitor, and other instance agents.

name	required	NULL allowed	type	description
SecurityService	no	no	RunSecurityServiceEnabled	Enable the Cloud Security service. If this parameter is not specified, the Cloud Security service is enabled by default. Example:View
MonitorService	no	no	RunMonitorServiceEnabled	Enable the Cloud Security service. If this parameter is not specified, the Cloud Monitor service is enabled by default. Example:View
AutomationService	no	no	AutomationServiceEnabled	Install tat-agent. If this parameter is not specified, it will be installed by default. Example:View
BasicService	no	no	BasicService	Enables basic service. Example:View

Image

A structure about detailed information of an image, mainly includes the main status and attributes of the image.

Referenced by the following interfaces: DescribeImages

name	required	NULL allowed	type	description
ImageId	no	no	String	Image ID Example: img-19mu3fy3
OsName	no	no	String	Image OS Example: CentOS 8.0 64-bit
ImageType	no	no	String	Image type Example: PRIVATE_IMAGE
CreatedTime	yes	yes	Datetime_iso	Image created Example: 2022-03-21T08:41:45Z
ImageName	yes	no	String	Image name Example: centos
ImageDescription	yes	no	String	Description Example: alice use
ImageSize	yes	no	Int64	Image size Example: 50
Architecture	yes	no	String	Image Architecture Example: x86_64
ImageState	yes	no	String	Instance status Example: NORMAL
Platform	no	no	String	Image Source Platform Example: CentOS
ImageCreator	no	yes	String	Image Creator Example: 1255000041
ImageSource	no	no	String	Image source Example: CREATE_IMAGE
SyncPercent	yes	yes	Int64	Synchronization Percentage Example: null
IsSupportCloudinit	no	yes	Bool	Whether the Image Supports cloud-init Example: true
SnapshotSet	no	yes	Array of Snapshot	Snapshot Information Associated with Image Example:View
IsSupportAutoInstallGPUDriver	yes	yes	Bool	Whether the image supports automatically install the GPU driver. Example: true
OsKey	yes	no	String	Image name Example: centos7.9
ProductCode	no	yes	String	Product Code Example: image-zero
GPUDriverList	yes	no	Array of String	List of GPU Drivers Example: [{ "version": "460.32.03", "name": "NVIDIA-Linux-x86_64-460.32.03", "CUDA": [ { "version": "460.32.03", "name": "CUDA 11.0" } ] }]
ImageFormat	yes	no	String	Image format Example: qcow2
OperationMask	yes	no	Int64	Image Operation Mask Example: 64
Flags	yes	no	Array of String	Image Marking Example: centos
DeviceImageId	yes	yes	Int64	Custom Image ID Example: img-c1otssej
IsSupportTat	no	no	Bool	Image Situation Supported by TAT Example: true
OsVersion	no	no	String	Operating system version Example: 0.0.0
OsType	no	no	String	OS type Example: linux
Encrypt	no	no	Bool	Encryption Example: false
BootMode	no	no	String	Boot mode Example: Legacy BIOS
IsCommercial	no	no	Bool	Whether it is for commercial use. Example: false
IsSupportChargeGridLicense	no	no	Bool	Whether the charging grid license is supported. Example: false
ImageIsShared	no	no	Bool	The image has been shared. Example: false
ImagePreheat	no	no	Bool	Image warm-up. Example: false
ImagePreheatZones	no	yes	String	Image warm-up area. Example: null
ImageDeprecated	no	no	Bool	Deprecated image. Example: false
ImageFamily	no	no	String	Image Family Example: business-daily-update
Tags	yes	yes	Array of Tag	List of tags associated with the image. Example:View
Locations	no	no	Array of ImageLocation	Image location information. Example:View
_ImageStatusInner	no	no	Uint64	Internal status of the image, which is used to identify the current image status (for example, creating, normal, and deleting). Example: 1
ImagePreheatPlacement	no	yes	String	Location identifier for image preheating, which is usually the name of an AZ or a location. Example: ap-city1-cdz-haerbin-1

KvType

Key Value Type

Referenced by the following interfaces: DescribeUserGlobalConfigs

name	required	NULL allowed	type	description
Name	yes	no	String	Key Name Example: key
Value	yes	no	String	Value Corresponding to Key Example: val

Externals

Extended Data

name	required	NULL allowed	type	description
ReleaseAddress	no	yes	Bool	Release Address Note: This field may return null, indicating that no valid value was found. Example: true
UnsupportNetworks	no	yes	Array of String	Unsupported network types, possible value range: BASIC: Basic network VPC1.0: VPC VPC1.0 Note: This field may return null, indicating that no valid value was found. Example: ["BASIC"]
StorageBlockAttr	no	yes	StorageBlock	HDD Local Storage Attributes Note: This field may return null, indicating that no valid values can be obtained. Example:View
InquiryWithEntireServer	no	yes	String	Query Entire Server Example: true
RequireNetworkFeatures	no	yes	Array of String	Required Network Feature Note: This field may return null, indicating that no valid values can be obtained. Example: null
RequiredEnhancedService	no	yes	RequiredEnhancedService	Service required to be enhanced. Note: This field may return null, indicating no valid value was found. Example:View
GpuAttr	no	yes	GpuAttr	GPU Parameters Note: This field may return null, indicating that no valid values can be obtained. Example:View
UnsupportNetworkFeature	no	no	Array of String	Not support the network feature. Example: VPC_GATEWAY
CoresOfOneThreadPerCore	no	no	Array of Int64	Specifies the number of cores (for example, '1'), with each core bound to a single thread. Example: 1
CoresOfTwoThreadPerCore	no	no	Array of Int64	Specifies the number of cores (for example, '2'), with each core bound to two threads. Example: 2
Hypervisor	no	yes	String	Instance category. Example: kvm
HypervisorSpec	no	yes	Array of String	Instance property Example: ["rdma"]

ReportDetailSet

Referenced by the following interfaces: DescribeDiagnosticReports

name	required	NULL allowed	type	description
Category	no	no	String	Detection Type Example: Expense
CategoryName	no	no	String	Detection Type Name Example: Account fees detection
Code	no	no	String	Detection Code Example: Instance.Deadline
CodeName	no	no	String	Code Name Example: utf-8
IsAuthorized	no	no	Bool	Authorized Example: false
Message	no	no	String	Information Example: success
Severity	no	no	String	Detection status Example: Normal
Status	no	no	String	Status Example: Finished

ImportImageOsListSupported

List of OS Supported by Imported Images

Referenced by the following interfaces: DescribeImportImageOs

name	required	NULL allowed	type	description
linux	yes	no	Array of String	List of Linux Systems Example: ["CentOS"]
windows	yes	no	Array of String	List of Windows Systems Example: ["Windows Server 2016"]

HostOrder

Order Information Related to CDH Instance

Referenced by the following interfaces: SwitchParameterAllocateHosts

name	required	NULL allowed	type	description
appId	no	no	Uint64	Application ID of Order Account Example: 125550011
uin	no	no	String	Account UIN that Created Order Example: 324532343
ownerUin	no	no	String	Owner UIN of Order Account Example: 324532343
goods	no	no	Array of HostGoodsItem	List of Resource Information for Order Shipment Example:View

InternetAccessible

It describes the public network accessibility of the instance, and claims public network usage billing mode, maximum bandwidth, etc of the instance.

Referenced by the following interfaces: CloneInstance, CreateLaunchTemplate, DescribeInstanceInternetBandwidthConfigs, DescribeInstances, DescribeLaunchTemplatesInfo, InquiryPriceRenewInstances, InquiryPriceResetInstancesInternetMaxBandwidth, InquiryPriceRunInstances, ModifyLaunchTemplate, ResetInstancesInternetMaxBandwidth, RunInstances, SwitchParameterResetInstancesInternetMaxBandwidth, SwitchParameterRunInstances

name	required	NULL allowed	type	description
InternetChargeType	no	yes	String	Network billing type. Value range: BANDWIDTH_PREPAID: Prepaid by bandwidth TRAFFIC_POSTPAID_BY_HOUR: Traffic pay-per-hour postpaid BANDWIDTH_POSTPAID_BY_HOUR: Bandwidth pay-per-hour postpaid BANDWIDTH_PACKAGE: Bandwidth package users Default value: TRAFFIC_POSTPAID_BY_HOUR. Example: TRAFFIC_POSTPAID_BY_HOUR
InternetMaxBandwidthOut	no	no	Int64	Public network outbound bandwidth cap, in Mbps. Default value: 0 Mbps. Different models have different bandwidth cap ranges. Example: 20
PublicIpAssigned	no	no	Bool	Whether to allocate a public IP. Value range: TRUE: Indicates assigning a public IP FALSE: Indicates not assigning a public IP When the public network bandwidth is greater than 0, it should be set to True by default. When the public network bandwidth is 0, it is not allowed to assign a public IP. Example: false
InternetServiceProvider	no	yes	String	Network modes: Mobile: CMCC, Unicom: CTCC, Telecom: CUCC, Public network CAP: BGP. Under the three network modes (Mobile, Unicom, Telecom), it should be bandwidth package billing mode. In other words, the parameter InternetChargeType must be provided and its value must be BANDWIDTH_PACKAGE. There are no such restrictions under the BGP mode. This API does not support multi-operator mode. In other words, the parameter InternetServiceProvider should not be Multi-operator. Example: CTCC

HostItem

Detailed Information of CDH Instance

Referenced by the following interfaces: DescribeHosts

name	required	NULL allowed	type	description
Placement	no	no	Placement	CDH instance location. You can specify attributes such as the availability zone and project to which the instance belongs through this parameter. Example:View
HostId	no	no	String	CDH Instance ID Example: host-61dyt49h
HostType	no	no	String	CDH Instance Type Example: M10
HostName	no	no	String	CDH Instance Name Example: alice-host
HostChargeType	no	no	String	CDH Instance Billing Mode Example: PREPAID
RenewFlag	no	no	String	CDH Instance Auto-Renewal Flag Example: DISABLE_NOTIFY_AND_MANUAL_RENEW
CreatedTime	no	no	Datetime_iso	CDH Instance Creation Time Example: 2014-08-03 12:00:00
ExpiredTime	no	yes	Datetime_iso	CDH Instance Expiration Time Example: 2014-08-03 12:00:00
InstanceIds	no	no	Array of String	List of Instance IDs for Newly Created Cloud Virtual Machines on CDH Instance Example: ["ins-61dyt49hx"]
HostState	no	no	String	CDH Instance Status Example: RUNNING
HostIp	no	no	String	CDH Instance IP Example: 10.21.0.11
HostResource	no	no	HostResource	CDH Instance Resource Information Example:View
CageId	no	no	String	cage id Example: ap-region1-2
OperationMask	no	no	Int64	Operation Mask Example: 62
Tags	no	no	Array of String	Tag Example: ["alice-1"]

ResourceForInstanceType

Resources of Instance Type

Referenced by the following interfaces: InquiryResourceResetInstancesType

name	required	NULL allowed	type	description
Memory	yes	no	Uint64	Memory size, in GB. Example: 2048
CPU	yes	no	Uint64	CPU cores Example: 2
InstanceType	yes	no	String	Instance model specification, such as S1.SMALL1 and S1.SMALL2. Example: S1.SMALL2
Status	yes	no	String	Instance Specification Status Example: SELL

InternetAccessibleModifyChargeType

It describes the network billing.

Referenced by the following interfaces: InquiryPriceModifyInstanceInternetChargeType, ModifyInstanceInternetChargeType, SwitchParameterModifyInstanceInternetChargeType

name	required	NULL allowed	type	description
InternetChargeType	yes	no	String	Online Payment Mode Example: TRAFFIC_POSTPAID_BY_HOUR
InternetMaxBandwidthOut	yes	no	Int64	Public Outbound Bandwidth Value Example: 20

LaunchTemplatesInfo

Information about an instance launch template.
Referenced by the following API: DescribeLaunchTemplatesInfo.

Referenced by the following interfaces: DescribeLaunchTemplatesInfo

name	required	NULL allowed	type	description
LaunchTemplateId	no	yes	String	Instance launch template ID. Note: This field may return null, indicating that no valid value was found. Example: lt-k8wrok8e
LaunchTemplateName	no	yes	String	Name of an instance launch template. Note: This field may return null, indicating that no valid values can be obtained. Example: jack lt
LaunchTemplateVersionData	no	yes	LaunchTemplateVersionData	Version information of an instance launch template. Note: This field may return null, indicating that no valid values can be obtained. Example:View
LaunchTemplateVersionDescription	no	yes	String	Description of an instance launch template. Note: This field may return null, indicating that no valid values can be obtained. Example: alice use
CreatedBy	no	yes	String	Create the user UIN of this template. Note: This field may return null, indicating that no valid values can be obtained. Example: 32341324
CreationTime	no	yes	String	Creation time of this template. Note: This field may return null, indicating that no valid values can be obtained. Example: 2014-08-03 12:00:00

LaunchTemplateVersionData

Version information of the instance launch template.
Referenced by the following API: DescribeLaunchTemplateVersions.

Referenced by the following interfaces: DescribeLaunchTemplatesInfo

name	required	NULL allowed	type	description
Placement	no	yes	Placement	Position of the instance. Note: This field may return null, indicating that no valid value was found. Example:View
InstanceType	no	yes	String	Instance model. Note: This field may return null, indicating that no valid value was found. Example: S1.SMALL2
InstanceName	no	yes	String	Instance name. Note: This field may return null, indicating that no valid values can be obtained. Example: MyInstance
InstanceChargeType	no	yes	String	Instance billing type. Value range: PREPAID: Indicates prepaid, that is, monthly subscription POSTPAID_BY_HOUR: Indicates postpaid, that is, pay-as-you-go CDHPAID: CDH payment, that is, billed only on the CDH but not on instances on the CDH. SPOTPAID: Indicates spot instance payment. Note: This field may return null, indicating that no valid values can be obtained. Example: PREPAID
SystemDisk	no	yes	SystemDisk	System disk information of an instance. Note: This field may return null, indicating that no valid values can be obtained. Example:View
DataDisks	no	yes	Array of DataDisk	Instance data disk information. Only includes data disks purchased with the instance. Note: This field may return null, indicating that no valid values can be obtained. Example:View
InternetAccessible	no	yes	InternetAccessible	Instance bandwidth information. Note: This field may return null, indicating that no valid values can be obtained. Example:View
VirtualPrivateCloud	no	yes	VirtualPrivateCloud	Information about virtual VPC to which the instance belongs. Note: This field may return null, indicating that no valid values can be obtained. Example:View
ImageId	no	yes	String	Image ID used by instance production. Note: This field may return null, indicating no valid value was found. Example: img-pi0aa46r
SecurityGroupIds	no	yes	Array of String	Security groups to which an instance belongs. You can obtain this parameter through the sgId field in the returned value by calling DescribeSecurityGroups. Note: This field may return null, indicating that no valid values can be obtained. Example: ['sg-rf6ogz49']
LoginSettings	no	yes	LoginSettings	Instance login settings. Currently, only the key associated with the instance is returned. Note: This field may return null, indicating that no valid value was found. Example:View
CamRoleName	no	yes	String	CAM role name. Note: This field may return null, indicating that no valid values can be obtained. Example: roleName001
HpcClusterId	no	yes	String	High-performance computing cluster ID. Note: This field may return null, indicating that no valid values can be obtained. Example: hpc-a5n666lo
InstanceCount	no	yes	Int64	Number of Instances to Purchase. Note: This field may return null, indicating that no valid value was found. Example: 1
EnhancedService	no	yes	EnhancedService	Enhanced service. Note: This field may return null, indicating no valid value was found. Example:View
UserData	no	yes	String	User data provided for the instance, should be encoded in base64 format, supports a maximum data size of 16 KB. Note: This field may return null, indicating that no valid values can be obtained. Example: TXlVc2VyRGF0YQo=
DisasterRecoverGroupIds	no	yes	Array of String	Placement Group ID, only one can be specified. Note: This field may return null, indicating that no valid values can be obtained. Example: ['ps-3p88qhfo']
ActionTimer	no	yes	ActionTimer	Scheduled task. You can specify a scheduled task for the instance through this parameter. Currently, only scheduled termination is supported. Note: This field may return null, indicating that no valid values can be obtained. Example:View
HostName	no	yes	String	Hostname of the cloud server. Note: This field may return null, indicating no valid value was found. Example: MyHostName
ClientToken	no	yes	String	String used to ensure request idempotency. Note: This field may return null, indicating that no valid values can be obtained. Example: system-f3827db9-c58a-49cc-bf10-33fc1923a34a
TagSpecification	no	yes	Array of TagSpecification	Tag description list. By specifying this parameter, you can associate a tag with the corresponding cloud server and cloud disk instance at the same time. Note: This field may return null, indicating that no valid value was found. Example:View
CPU	no	no	Int64	CPU Example: 2
Memory	no	no	Int64	Memory Example: 1024
OperatorUin	no	no	String	Operator UIN. Example: 110000004676
DisableApiTermination	no	no	Bool	Whether to allow instance deletion through the API. Example: false

Snapshot

Description of Snapshot Information Associated with Image

Referenced by the following interfaces: DescribeImages

name	required	NULL allowed	type	description
SnapshotId	yes	no	String	Snapshot ID. Example: snap-7et7t234
DiskUsage	yes	no	String	Cloud disk type that creates the snapshot. Value range: SYSTEM_DISK: System disk DATA_DISK: Data disk. Example: SYSTEM_DISK
DiskSize	yes	no	Uint64	The size of the CBS for creating this snapshot, in GB. Example: 50

HostResource

Resource Information of CDH Instance

Referenced by the following interfaces: DescribeHosts

name	required	NULL allowed	type	description
CpuTotal	no	no	Uint64	Total Number of CPU Cores of CDH Instance Example: 32
CpuAvailable	no	no	Uint64	Number of Available CPU Cores of CDH Instance Example: 32
MemTotal	no	no	Float	Total Memory Size of CDH Instance (in GiB) Example: 96
MemAvailable	no	no	Float	Available Memory Size of CDH Instance (in GiB) Example: 96
DiskTotal	no	no	Uint64	Total Disk Size of CDH Instance (in GiB) Example: 1000
DiskAvailable	no	no	Uint64	Available Disk Size of CDH Instance (in GiB) Example: 1000
DiskType	no	no	String	CDH Instance Disk Type Example: "LOCAL_SSD"

InstanceDisasterMap

Placement Group Pair Corresponding to Instance ID

Referenced by the following interfaces: RemoveInstancesDisasterRecoverGroup

name	required	NULL allowed	type	description
InstanceId	no	no	String	Instance ID Example: ins-61dyt49h
DisasterIds	no	no	Array of String	Placement Group ID Example: ["ps-l86ok62z"]

OfflineMigrateUserTaskData

Offline migration task data types, including instance migration and data migration.

Referenced by the following interfaces: DescribeUserMigrateTasks

name	required	NULL allowed	type	description
JobId	yes	yes	String	Task ID Example: migrate-qwer1343
JobName	yes	yes	String	Task Name Example: onejob
AppId	yes	yes	Uint64	Cloud platform application ID, usually has a one-to-one correspondence with UIN. Example: 1255000041
Uin	yes	yes	String	User UIN Example: 32432442
Uuid	no	yes	String	Instance UUID Example: 5b33b986-084c-48e1-8cdb-d2e5ca5d045a
InstanceId	no	yes	String	Instance ID Example: ins-61dyt49h
ImageUrl	no	yes	String	System Disk Image COS URL Example: https://kaijian-gz-1251783334.cos.ap-region1.convergecloud.com/image_m-wz95mjeh07vy3d48fcj9_system.raw
DataSize	no	yes	Uint64	Auxiliary Data Disk Size Example: 50
Region	yes	yes	String	Region. Example: region1
Status	yes	yes	String	Task Status Example: SUCCESS
Progress	yes	yes	Uint64	Migration Task Progress Example: 2
CreateTime	yes	yes	String	Creation Time Example: 2019-12-04T16:44:55+08:00
EndTime	yes	yes	String	End time Example: 2019-12-04T16:44:55+08:00
SnapshotUrl	no	yes	String	Data Disk Image URL Example: https://kaijian-gz-1251783334.cos.ap-region1.convergecloud.com/image_m-wz95mjeh07vy3d48fcj9_system.raw
DiskId	no	yes	String	Data Disk ID Example: disk-adggyzhh
DiskSize	no	yes	Uint64	Data Disk Size Example: 50
Action	no	yes	String	Migration action name. Example: ColdMigrateInstance

RequiredEnhancedService

Require Enhanced Services

name	required	NULL allowed	type	description
MonitorService	no	yes	MonitorServiceItem	Monitoring service Example:View

ClientSysInfo

Used to pass client system information during live migration.

Referenced by the following interfaces: LiveMigrateInstance

name	required	NULL allowed	type	description
OsType	yes	no	String	Operating System Example: CentOS
OsVersion	yes	no	String	Operating system version Example: 6
DiskSize	yes	no	Array of Uint64	Data Disk Information of to-be-Imported System Disk Example: 100
ExtraInfo	no	no	String	Additional Information Example: extral

RunSecurityServiceEnabled

It describes the information related to the Cloud Security service.

name	required	NULL allowed	type	description
Enabled	no	no	Bool	Whether to enable Cloud Security service. Value Range: TRUE: Indicates that the Cloud Security service is enabled FALSE: Indicates that the Cloud Security service is not enabled Default Value: TRUE. Example: false

InstanceFamilyConfig

Description of the model family configuration information of the instance.
Example: {'InstanceFamilyName': 'Standard Type S1', 'InstanceFamily': 'S1'}, {'InstanceFamilyName': 'Network Optimized N1', 'InstanceFamily': 'N1'}, {'InstanceFamilyName': 'High IO Type I1', 'InstanceFamily': 'I1'}, etc.

Referenced by the following interfaces: DescribeInstanceFamilyConfigs

name	required	NULL allowed	type	description
InstanceFamilyName	yes	no	String	Full name of model family. Example: Standard S1
InstanceFamily	yes	no	String	English abbreviation of the model family name. Example: S1

ImageLocation

Image location information.

Referenced by the following interfaces: DescribeImages

name	required	NULL allowed	type	description
Type	no	no	String	Position Example: cdz
Position	no	no	String	Location value. Example: ap-city1-cdz-haerbin-1

ChargePrepaid

It describes the prepaid mode, that is, the monthly subscription-related parameters, including purchase duration, auto-renewal logic, etc.

Referenced by the following interfaces: AllocateHosts, InquiryPriceAllocateHosts, RenewHosts, SwitchParameterAllocateHosts

name	required	NULL allowed	type	description
Period	yes	no	Uint64	Duration for purchasing an instance, unit: months. Value range: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, and 36. Example: 1
RenewFlag	no	no	String	Auto-renewal flag. Value range: NOTIFY_AND_AUTO_RENEW: Notifies of expiration and performs auto-renewal NOTIFY_AND_MANUAL_RENEW: Notifies of expiration but does not perform auto-renewal DISABLE_NOTIFY_AND_MANUAL_RENEW: Does not notify of expiration nor perform auto-renewal Default value: NOTIFY_AND_AUTO_RENEW. If this parameter is specified to NOTIFY_AND_AUTO_RENEW, the instance will be automatically renewed on a monthly basis after it expires if there is sufficient account balance. Example: NOTIFY_AND_MANUAL_RENEW

ExtraProperty

Describes additional attribute information.

Referenced by the following interfaces: DescribeZoneInstanceConfigInfos

name	required	NULL allowed	type	description
edgeZonePid	no	no	Uint64	Edge zone process. Example: 0

VirtualPrivateCloud

It describes VPC-related information, including subnet, IP information, etc.

Referenced by the following interfaces: CloneInstance, CreateLaunchTemplate, DescribeInstances, DescribeLaunchTemplatesInfo, InquiryPriceRunInstances, ModifyInstancesVpcAttribute, ModifyLaunchTemplate, RunInstances, SwitchParameterRunInstances

name	required	NULL allowed	type	description
VpcId	yes	no	String	VPC ID, in the format of `vpc-xxx`. A valid VpcId can be queried by logging in to the Console. Example: vpc-2ij
SubnetId	yes	no	String	VPC subnet ID, in the format of `subnet-xxx`. You can obtain a valid VPC subnet ID by logging in to the Console. You can also call the API Console and obtain the valid VPC subnet ID through the `unSubnetId` field returned by the API. Example: subnet-2ks
SubnetName	no	yes	String	VPC subnet name. This parameter is only used as an output parameter. Example: cloud
AsVpcGateway	no	no	Bool	Whether it is used as a public gateway. The public gateway can be used normally only when the instance has a public IP and is located in the VPC. Value range: TRUE: Indicates that it is used as a public gateway FALSE: Indicates that it is not used as a public gateway Default value: FALSE. Example: false
PrivateIpAddresses	no	no	Array of String	VPC subnet IP array. You can use this parameter when creating an instance or modifying VPC attributes of an instance. Currently, passing multiple IPs of the same subnet is supported only when creating multiple instances in batches. Example: ["10.0.0.1"]
VpcName	no	yes	String	VPC name. This parameter is only used as an output parameter. Example: 69333vpc-cfs-474d7bfd7
Ipv6AddressCount	no	no	Int64	Specify the number of randomly generated IPv6 addresses for ENI. Example: 1

ItemPrice

It describes the price information of a single item.

Referenced by the following interfaces: DescribeZoneInstanceConfigInfos, InquiryPriceAllocateHosts, InquiryPriceModifyInstancesChargeType, InquiryPriceRenewInstances, InquiryPriceResetInstance, InquiryPriceResetInstancesInternetMaxBandwidth, InquiryPriceResetInstancesType, InquiryPriceResizeInstanceDisks, InquiryPriceRunInstances

name	required	NULL allowed	type	description
UnitPrice	no	yes	Float	Subsequent unit price, unit: USD. Example: 35.5
ChargeUnit	no	yes	String	Subsequent billing unit, possible value range: HOUR: Indicates that the billing unit is calculated on a hourly basis. Current scenarios involving this billing unit include: instance pay-per-hour postpaid (POSTPAID_BY_HOUR), bandwidth pay-per-hour postpaid (BANDWIDTH_POSTPAID_BY_HOUR): GB: Indicates that the billing unit is calculated per GB. Current scenarios involving this billing unit include: traffic pay-per-hour postpaid (TRAFFIC_POSTPAID_BY_HOUR). Example: 35.5
OriginalPrice	no	yes	Float	Original price of prepaid costs, unit: USD. Example: 35.5
DiscountPrice	no	yes	Float	Discount price of prepaid costs, unit: USD. Example: 35.5
Discount	no	yes	Float	Discount, for example, 20.0 represents 80% off. Example: 20.0
UnitPriceDiscount	no	yes	Float	Discount price of subsequent total costs, used for the postpaid billing mode, unit: USD. If other time interval items such as UnitPriceDiscountSecondStep are returned, this item represents the time interval of (0, 96) hours; if no other time interval items are returned, this item represents the entire period, that is, (0, ∞) hours. Example: 35.5
UnitPriceSecondStep	no	yes	Float	Original price for subsequent total costs of usage time range between (96, 360) hours, used in the postpaid mode, unit: USD. Example: 35.5
UnitPriceDiscountSecondStep	no	yes	Float	Discount price for subsequent total costs of usage time range between (96, 360) hours, used in the postpaid mode, unit: USD. Example: 35.5
UnitPriceThirdStep	no	yes	Float	Original price for subsequent total costs of usage time range between (360, ∞) hours, used in the postpaid mode, unit: USD. Example: 35.5
UnitPriceDiscountThirdStep	no	yes	Float	Discount price for subsequent total costs of usage time range between (360, ∞) hours, used in the postpaid mode, unit: USD. Example: 35.5
DetailPrices	no	yes	DetailPrices	Detailed Price Example:View
DiscountThirdStep	no	yes	Float	Discount, for example, 20.0 represents 80% off. Example: 20.0
DiscountSecondStep	no	yes	Float	Discount, for example, 20.0 represents 80% off. Example: 20.0
DiskType	no	yes	String	Disk type Example: CLOUD_SSD

DataDisks

Description of the data disk image, including the image COS URL, data disk size, and data disk device name (DiskId);

Referenced by the following interfaces: ImportFullCvmImage

name	required	NULL allowed	type	description
ImageUrl	yes	no	String	Data Disk Image COS URL Example: http://kiki-1255000041.cos.region1.csp.yfm4.fsphere.cn/xxx
Size	yes	no	Uint64	Data Disk Size Example: 22
Device	yes	no	String	Device name corresponding to the data disk, currently is DiskId. Example: disk-61dyt49h

ResourceInfo

Detailed Information of User Instance Resource

Referenced by the following interfaces: SearchUserInstance

name	required	NULL allowed	type	description
ResourceId	yes	no	String	User resource instance ID. Example: ins-61dyt49h
SearchWord	yes	no	String	User resource keywords. Example: alice
RelationInstanceId	no	no	String	CVM instance ID associated with the user resource instance. Example: ins-61dyt49h
Region	no	no	String	Region. Example: region1
KeyType	no	no	String	Type used for this data search, values are instance ID (instance), instance name (alias), instance private IP (lan), and instance public IP (wan). Example: instance

UserMigrateTaskData

User Migration Task Details

Referenced by the following interfaces: DescribeUserMigrateTasks

name	required	NULL allowed	type	description
JobId	yes	yes	String	Task ID Example: migrate-qwer1353
JobName	yes	yes	String	Task Name Example: onejob
AppId	yes	yes	Uint64	Cloud platform application ID, usually has a one-to-one correspondence with UIN. Example: 125000111
Uin	yes	yes	String	User UIN Example: 32431223
Uuid	yes	yes	String	Instance UUID Example: 5b33b986-084c-48e1-8cdb-d2e5ca5d045a
InstanceId	yes	yes	String	Instance ID Example: ins-61dyt49h
ImageUrl	yes	yes	String	Data Disk Image COS URL Example: http://111-1251433127.cosd.convergecloud.com/Windows%20Server%202008%20R2%20x64a.vmdk.
DataSize	yes	yes	Uint64	Data Size Example: 500
Region	yes	yes	String	Region. Example: region1
Status	yes	yes	String	Task Status Example: RUNNING
Progress	yes	yes	Uint64	Migration Task Progress Example: 3
CreateTime	yes	yes	String	Creation Time Example: 2019-04-20 22:00:00
EndTime	yes	yes	String	End time Example: 2019-04-20 22:00:00

LoginSettings

It describes related configuration and information of instance login.

Referenced by the following interfaces: CloneInstance, CreateLaunchTemplate, DescribeInstances, DescribeLaunchTemplatesInfo, InquiryPriceResetInstance, InquiryPriceRunInstances, ModifyLaunchTemplate, ResetInstance, RunInstances, SwitchParameterRunInstances

name	required	NULL allowed	type	description
Password	no	yes	String	Instance login password. The password complexity requirements vary by different operating system types, as follows: The password of a Linux instance should contain 10 to 30 characters, including at least three of [a-z], [A-Z], [0-9], and special symbols [()`~!@#$%^&*-+=_
KeyIds	no	yes	Array of String	List of key IDs. After associating a key, the instance can be accessed by using the corresponding private key. You can obtain the keyId through the API DescribeKeyPairs. Key and password should not be specified at the same time, and the Windows operating system does not support specifying a key. Currently, only one key can be specified at the time of purchase. Example: ["skey-3glfot13"]
KeepImageLogin	no	yes	String	Retain the original settings of an image. This parameter should not be specified at the same time as Password or KeyIds.N. You can specify this parameter as TRUE only when using custom images, shared images, or externally imported images to create the instance. Value range: TRUE: Indicates retaining the login settings of the image FALSE: Indicates not retaining the login settings of the image Default value: FALSE. Example: TRUE

SharePermission

Image Sharing Information Structure

Referenced by the following interfaces: DescribeImageSharePermission

name	required	NULL allowed	type	description
CreatedTime	yes	no	Datetime_iso	Image Sharing Duration Example: 2014-08-03T12:00:00+08:00
AccountId	yes	no	String	Account ID for Image Sharing Example: 32344323

DiagnosticReportSet

Referenced by the following interfaces: CreateDiagnosticReports

name	required	NULL allowed	type	description
InstanceId	no	no	String	Instance ID Example: ins-61dyt49h
DiagnosticReportId	no	no	String	Detection Report ID Example: dr-61dyt49h

MonitorServiceItem

Monitoring Service

name	required	NULL allowed	type	description
Enabled	no	yes	String	Enable/Disable Example: FALSE

Tag

Tag Key-Value Pair

Referenced by the following interfaces: CloneInstance, CreateLaunchTemplate, DescribeDisasterRecoverGroups, DescribeImages, DescribeInstances, DescribeKeyPairs, DescribeLaunchTemplatesInfo, ModifyLaunchTemplate, RunInstances

name	required	NULL allowed	type	description
Key	yes	no	String	Tag Key Example: alice-key
Value	yes	no	String	Tag Value Example: alice-value
tagKey	no	yes	String	Tag Key Example: alice-key
tagValue	no	yes	String	Tag Value Example: alice-value

KeyPair

It describes the key pair information.

Referenced by the following interfaces: DescribeKeyPairs

name	required	NULL allowed	type	description
KeyId	no	no	String	ID of a key pair, is the unique flag of the key pair. Example: skey-q29u65hu
KeyName	no	no	String	Key pair name. Example: alice-key
Description	no	no	String	Key Pair Description Example: alice use
PublicKey	no	no	String	Plaintext public key of the key pair. Example: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC0ran+u+y09bSSoAbHBhJm2ivci0uwTif+/MqoGj5odBuGcDHGIBE7Th74ITXtbuqEXxdOSROi7DOVaTZa1MYe6qKGPAi5/8jlV8c9CKCezXr99A2Dps/eVPVn4yO2NhSXbr0U/voRxTqNprP0YLo25y1lVnN0vg0CfWL8DDYh6DkMMVufGikA7WVPdsHomTLlSPdlSLvCRZPHC7eBhkrznO0rnfM+cJY2fqqSrdI1kqtDRJNpNvPLaRnJsc3uoot2nGqrGD6yiwx2tvdLAqgQT5tASfvtTc3CTMMJRGIqm+CdG2S1y0VlMDmm9XHeVBmZuX5YDJPNGIOcBI2Cgrj5 skey-mk5eqeu6
AssociatedImageCount	no	no	Int64	Number of images associated with the key. Example: 0
AssociatedInstanceCount	no	no	Int64	Number of instances associated with the key. Example: 0
AssociatedInstanceIds	no	no	Array of String	List of instance IDs associated with the key. Example: ["ins-syht65r4"]
ProjectId	no	no	Int64	Project ID to which the key pair belongs. When the value of ProjectId is 0, it indicates the default project. Example: 0
Tags	no	yes	Array of Tag	List of tags associated with keys. Example:View
CreatedTime	yes	no	Datetime_iso	Key Pair Creation Date Example: 2022-03-21T08:41:45Z

KeyQuota

It describes the quotas under the user availability zone.

Referenced by the following interfaces: DescribeUserInstanceQuota

name	required	NULL allowed	type	description
Zone	no	no	String	Availability zone ID to which the instance belongs. Filter by the availability zone. Example: region1
InstanceChargeType	no	no	String	Instance billing mode. Supported types: PREPAID, POSTPAID_BY_HOUR, SPOTPAID. The maximum limit is 10, and the maximum limit of value is 5. Example: POSTPAID_BY_HOUR
QuotaCurrent	yes	no	Uint64	Current quantity Example: 2
QuotaLimit	yes	no	Uint64	Quota Example: 1

DeniedActions

List of Restricted Operations

Referenced by the following interfaces: DescribeInstancesDeniedActions

name	required	NULL allowed	type	description
Action	yes	no	String	Action Name Example: AllocateHosts
Code	yes	no	String	Returned values Example: AddressQuotaLimitExceeded_DailyAllocate
Message	yes	no	String	Returned Information Example: Insufficient purchase attempts. Each account in a region has a daily purchase attempt limit of quota * 2.

HpcClusterInfo

HPC cluster

Referenced by the following interfaces: CreateHpcCluster, DescribeHpcClusters

name	required	NULL allowed	type	description
HpcClusterId	yes	no	String	HPC cluster ID Example: hpc-g9zbwc5o
Name	yes	yes	String	Hyper computing cluster name. Example: jack
Remark	yes	yes	String	Hyper Computing Cluster remarks. Example: H20
CvmQuotaTotal	yes	no	Uint64	Device capacity under the cluster. Example: 20
Zone	yes	no	String	Cluster AZ Example: region1
CurrentNum	yes	no	Uint64	Current number of devices in the cluster. Example: 2
CreateTime	yes	yes	Datetime_iso	Cluster Creation Time Example: 2014-08-03T12:00:00+08:00
InstanceIds	yes	yes	Array of String	List of instance IDs in the cluster. Example: ["ins-61dyt49h"]
HpcClusterType	no	yes	String	HPC cluster type. Example: CDC
HpcClusterBusinessId	no	yes	String	Workload ID of the HPC cluster. Example: cluster-1f6v312
HpcInstanceFamily	no	yes	String	HPC instance family type. Example: H1

GpuAttr

GPU Parameters

name	required	NULL allowed	type	description
Type	no	yes	String	Type Note: This field may return null, indicating that no valid values can be obtained. Example: {"Type": "wx"}

RegionInfo

Region Info

Referenced by the following interfaces: DescribeRegions

name	required	NULL allowed	type	description
Region	yes	no	String	Region name. For example, ap-region1. Example: ap-region1
RegionName	yes	no	String	Region description. For example, region 1. Example: Region 1
RegionState	yes	no	String	Whether the region is in an available state. Example: available

HostTypeConfigSet

Obtain CDH model configuration information and a list of information about the sell-out state.

Referenced by the following interfaces: DescribeZoneHostConfigInfos

name	required	NULL allowed	type	description
Zone	yes	yes	String	Availability Zone Example: ap-region1-2
HostType	yes	yes	String	Model. Note: This field may return null, indicating that no valid values can be obtained. Example: M10
HostChargeType	yes	yes	String	CDH Instance Billing Mode Example: PREPAID
HostFamily	yes	yes	String	CDH Type Example: Balance
CPU	yes	yes	Uint64	Number of CPU cores of an instance, unit: cores. Example: 2
Memory	yes	yes	Uint64	Instance memory capacity, in GB. Example: 2048
DiskSize	yes	yes	Uint64	The size of the CBS for creating this snapshot, in GB. Example: 500
DiskType	yes	yes	String	System Disk Type Example: Local Hard Disk
HostQuota	no	yes	Uint64	CDH Quota Example: 5
Price	yes	yes	HostTypeConfigSetPrice	Pricing information Example:View
CpuModeLName	no	yes	String	CPU model name. Example: Intel Xeon Skylake 6133
Status	yes	yes	String	Whether the instance is for sale. Value range: SELL: Indicates that the instance is available for purchase; SOLD_OUT: Indicates that the instance has been sold out. Example: PENDING
SupportCustomizedInstanceType	no	no	Bool	Specifies whether custom models are supported. Example: true
SupportStandardInstanceType	no	no	Bool	Specifies whether standard models are supported. Example: false
SupportStandardInstanceTypeSet	no	no	Array of String	List of supported standard models. Example: ["S1.SMALL1", "S2.MEDIUM2"]

InstanceReturnable

Refundable information of an instance.

Referenced by the following interfaces: DescribeInstancesReturnable

name	required	NULL allowed	type	description
InstanceId	yes	no	String	Instance ID. Example: ins-61dyt49h
IsReturnable	yes	no	Bool	Whether the Instance is Refundable. Example: true
ReturnFailCode	yes	no	Int64	Error code of instance return failure. Example: 0
ReturnFailMessage	yes	no	String	Error information of instance return failure. Example: success

ZoneInfo

AZ Info

Referenced by the following interfaces: DescribeZones

name	required	NULL allowed	type	description
Zone	yes	no	String	Availability zone name. For example, ap-region1-3. Example: ap-region1-3
ZoneName	yes	no	String	Availability zone description. For example, zone 3 in region 1. Example: Zone 3 in region 1
ZoneId	yes	no	String	Availability Zone ID Example: 100003
ZoneState	yes	no	String	Availability zone status Example: AVAILABLE

InternetChargeTypeConfig

It describes the network billing.

Referenced by the following interfaces: DescribeInternetChargeTypeConfigs

name	required	NULL allowed	type	description
InternetChargeType	no	no	String	Network billing mode. Example: TRAFFIC_POSTPAID_BY_HOUR
Description	no	no	String	Description information of network billing mode. Example: alice use

TagSpecification

Explanation of Tag Pair to Be Bound when Creating CVM Instance

Referenced by the following interfaces: CloneInstance, CreateLaunchTemplate, DescribeLaunchTemplatesInfo, ModifyLaunchTemplate, RunInstances

name	required	NULL allowed	type	description
ResourceType	yes	no	String	Resource Type Associated with Tag Example: instance
Tags	yes	no	Array of Tag	List of Tag Pairs Example:View

ImageAttributeSet

Array of Mappings from unImgId to deviceImageId

Referenced by the following interfaces: DescribeImagesAttribute

name	required	NULL allowed	type	description
ImageId	yes	no	String	Image ID Example: img-c1otssej
InnerImageId	yes	no	Uint64	Internal Image ID Example: 53242

InstanceTypeQuota

Description of Instance Model Quota Information

Referenced by the following interfaces: DescribeInstanceTypeQuota

name	required	NULL allowed	type	description
Zone	yes	no	String	Availability zone. Example: ap-region1-1
InstanceType	yes	no	String	Instance model. Example: I1.MEDIUM4
InstanceQuota	yes	no	Int64	Instance model quota. Example: 20
InstanceChargeType	yes	no	String	Instance billing mode. Value range: `PREPAID`: Indicates prepaid, that is, monthly subscription `POSTPAID_BY_HOUR`: Indicates postpaid, that is, pay-as-you-go * `CDHPAID`: CDH payment, that is, billed only on the CDH but not on instances on the CDH. Example: PREPAID
DeviceClass	no	no	String	Instance type. Example: S
CPU	no	no	Int64	Number of CPU cores of an instance, unit: cores. Example: 2
Memory	no	no	Int64	Instance memory capacity, in GB. Example: 1024
GPU	no	no	Int64	Number of GPU cores of the instance, unit: cores. Example: 3

AccountAttributeSet

Account Attribute Settings

Referenced by the following interfaces: DescribeAccountAttributes

name	required	NULL allowed	type	description
AttributeClass	yes	yes	String	Attribute Type Example: PostPaidInstanceCountLimit
AttributeValueSet	yes	yes	Array of AccountAttribute	Attribute Value Example:View

Placement

It describes the abstract location of the instance, including its availability zone, associated project, host, etc (available only for CDH products).

Referenced by the following interfaces: AllocateHosts, CloneInstance, CreateLaunchTemplate, DescribeHosts, DescribeInstances, DescribeLaunchTemplatesInfo, InquiryPriceAllocateHosts, InquiryPriceRunInstances, ModifyLaunchTemplate, RunInstances, SwitchParameterAllocateHosts, SwitchParameterRunInstances

name	required	NULL allowed	type	description
Zone	yes	no	String	Availability Zone ID to which the instance belongs. You can also obtain this parameter through the Zone field in the returned value by calling DescribeZones. Example: region1
ProjectId	no	no	Int64	Project ID to which the instance belongs. You can obtain this parameter through the projectId field in the returned value by calling Availability Zone. If it is not specified, the default project is used. Example: 0
HostId	no	yes	String	List of IDs of CDH instances where CVM instances reside. If you have purchased CDH instances and specified this parameter, CVM instances you purchase are deployed on these CDH instances randomly. This parameter is only used as an output parameter and is not supported currently. Example: host-o5i742go
HostIds	no	yes	Array of String	ID list of CDHs from which the instance can be created. If you have purchased CDHs and specify this parameter, the instances you purchase will be randomly deployed on the CDHs. Example: ["host-o5i742go"]
ProjectName	no	no	String	Project name of the instance. Example: default project

HostGoodsItem

Detailed Information of CDH Shipment Instance

Referenced by the following interfaces: SwitchParameterAllocateHosts

name	required	NULL allowed	type	description
goodsCategoryId	no	no	Uint64	goodsCategoryId Example: 100021
payMode	no	no	Uint64	Instance Billing Mode Example: 2
goodsNum	no	no	Uint64	Number of Shipped Instances Example: 5
regionId	no	no	Uint64	Region ID Example: 1
uin	no	no	String	UIN of User Initiating Shipment Example: 12443154
ownerUin	no	no	String	Owner UIN of Account Initiating Shipment Example: 12443154
appId	no	no	Uint64	AppId Corresponding to Account Initiating Shipment Example: 122443154
projectId	no	no	Uint64	Project ID Example: 1
zoneId	no	no	Uint64	Availability Zone ID Example: 100002
goodsDetail	no	no	HostGoodsDetailItem	Detailed Information of CDH Instance Example:View

InstanceTypeQuotaItemArchitecture

Model quota information of an instance with CPU architecture.

Referenced by the following interfaces: DescribeZoneInstanceConfigInfos

name	required	NULL allowed	type	description
Zone	yes	no	String	Availability zone. Example: ap-region1-2
InstanceType	yes	no	String	Instance model. Example: S1.SMALL2
InstanceChargeType	yes	no	String	Instance billing mode. Value range: PREPAID: Indicates prepaid, that is, monthly subscription POSTPAID_BY_HOUR: Indicates postpaid, that is, pay-as-you-go CDHPAID: Indicates CDH payment, that is, billed only on the CDH but not on instances on the CDH. `SPOTPAID`: Indicates spot instance payment. Example: PREPAID
NetworkCard	yes	no	Int64	Network interface card type, for example, 25 represents a 25 GB network interface card. Example: 0
Externals	yes	yes	Externals	Extended attributes. Example:View
Cpu	yes	no	Int64	Number of CPU cores of an instance, unit: cores. Example: 2
Memory	yes	no	Int64	Instance memory capacity, in GB. Example: 2048
InstanceFamily	yes	no	String	Instance model series. Example: S2
TypeName	yes	no	String	Model name. Example: Standard
LocalDiskTypeList	yes	no	Array of LocalDiskType	Local disk specification list. When this parameter returns a null value, it indicates that the local disk cannot be created under the current conditions. Example:View
Status	yes	no	String	Whether the instance is for sale. Value range: SELL: Indicates that the instance is available for purchase. SOLD_OUT: Indicates the instance has been sold out. Example: PENDING
Price	yes	no	ItemPrice	Instance selling price. Example:View
SoldOutReason	yes	yes	String	Reasons for sell out. Example: Insufficient resources in this AZ
InstanceBandwidth	yes	no	Float	Internal network bandwidth, in Gbps. Example: 10.0
InstancePps	yes	no	Int64	network packet send and receive processing capability, unit: ten thousand PPS. Example: 2
StorageBlockAmount	yes	no	Int64	Number of local storage blocks. Example: 3
CpuType	yes	no	String	Processor model. Example: AMD Ryzen 7 5600G
Gpu	yes	no	Int64	Number of GPUs on the Instance. Example: 1
Fpga	yes	no	Int64	Number of FPGAs on the Instance. Example: 0
Remark	yes	no	String	Instance remark information. Example: alice use
Architecture	yes	yes	String	CPU architecture Example: x86_64
ConfigId	no	no	String	Configuration ID Example: qw4324352
DeviceClass	no	yes	String	Device Type Example: VSELF_2
Disable	no	yes	String	Disable Example: DISABLE
StorageBlock	no	yes	Int64	Local Storage Block Example: 0
Frequency	no	no	String	Frequency Example: 2.5 GHz
StatusCategory	no	no	String	Status category. Example: WithoutStock
GpuCount	no	no	Float	Number of GPUs. Calculation method: gpu x GpuAttr.Ratio. Example: 1
ExtraProperty	no	no	ExtraProperty	Additional attribute information. Example:View

InstanceTypeNameConfig

Instance Type Name Configuration

Referenced by the following interfaces: DescribeInstanceTypeNameConfigs

name	required	NULL allowed	type	description
ShowInMenu	yes	no	Bool	Whether to display it in the list of instance types. Example: false
InstanceFamilyName	yes	no	String	Name of Instance Type Example: Standard S1
InstanceFamily	yes	no	String	Instance Type Example: S1

UnsupportedPreheatZones

AZs that do not support preheating and the reason codes.

Referenced by the following interfaces: DescribeInstancesCreateImageAttributes

name	required	NULL allowed	type	description
zone	no	no	String	AZ name Example: ap-city2-1

CbsMigrateTask

Offline Data Migration Task Details

Referenced by the following interfaces: DescribeUserMigrateTasks

name	required	NULL allowed	type	description
JobId	yes	no	String	Task ID Example: migrate-2d43254d
JobName	yes	no	String	Task Name Example: onejob
AppId	yes	no	Uint64	Cloud platform application ID, usually has a one-to-one correspondence with UIN. Example: 125550001
Uin	yes	no	String	User UIN Example: 1243244232
SnapshotUrl	yes	no	String	Snapshot URL Example: http://kiki-1255000041.cos.region1.csp.yfm4.fsphere.cn/Windows%20Server%202008%20R2%20x64a.vmdk
DiskId	yes	no	Uint64	Disk ID Example: 2
Region	yes	no	String	Region Example: region1
DiskSize	yes	no	Uint64	Data Size Example: 512
Status	yes	no	String	Task Status Example: SUCCESS
Progress	yes	no	Uint64	Migration Task Progress Example: 5
CreateTime	yes	no	String	Creation Time Example: 2019-12-04T16:44:55+08:00
EndTime	yes	no	String	End time Example: 2019-12-04T16:44:55+08:00

InstanceOrder

Detailed information of instance order.

Referenced by the following interfaces: SwitchParameterModifyInstanceInternetChargeType, SwitchParameterResetInstancesInternetMaxBandwidth, SwitchParameterResizeInstanceDisks, SwitchParameterRunInstances

name	required	NULL allowed	type	description

InstanceTypeConfigStatusSet

List of Model Instances and Their Statuses Returned by Adjusting Configuration (Across Models)

Referenced by the following interfaces: DescribeInstancesModification

name	required	NULL allowed	type	description
Status	no	no	String	Status Example: SELL
Message	no	yes	String	Description Example: success
InstanceTypeConfig	no	no	InstanceTypeConfig	List of Models Example:View

HostPrice

CDH-Related Price Information

Referenced by the following interfaces: InquiryPriceAllocateHosts

name	required	NULL allowed	type	description
HostPrice	no	no	ItemPrice	It describes CDH instance-related price information. Example:View

AccountAttribute

Account Attribute Object

Referenced by the following interfaces: DescribeAccountAttributes

name	required	NULL allowed	type	description
AttributeName	yes	no	String	Payment type: Postpaid (PostPaidInstanceCountLimit), prepaid (PrePaidInstanceCountLimit). Example: jack
AttributeValue	yes	no	String	Maximum Purchase Quantity at a Time Example: 20
AttributeValues	no	no	String	Maximum Purchase Quantity at a Time Example: 20

ProductInfoItem

Product Description Information Items

Referenced by the following interfaces: SwitchParameterAllocateHosts

name	required	NULL allowed	type	description
name	yes	no	String	Information Item Name Example: item-name
value	yes	no	String	Value Corresponding to Information Item Example: item-value

InstancesRecentFailedOperationSet

Latest Failed Operation on Instance

Referenced by the following interfaces: DescribeInstancesRecentFailedOperation

name	required	NULL allowed	type	description
InstanceId	yes	no	String	Instance ID Example: ins-61dyt49h
EventType	yes	no	String	Operation Event Type Example: Modify
CreateTime	yes	no	Datetime	Operation Event Occurrence Time Example: 2014-08-03 12:00:00

ImageSet

Image collection.

Referenced by the following interfaces: SyncImages

name	required	NULL allowed	type	description
Region	no	yes	String	Region Info Example: ap-region
ImageId	no	yes	String	Image ID Example: img1111111111

Filter

Describes the key-value pair filter which is used for conditional filtering. For example, ID, name, and status.

If there are multiple filters, the filters are of AND logic.

If a filter involves multiple values, the values of this filter are of OR logic.

Take the filter of the [DescribeInstances](instance APIs/DescribeInstances) API as an example. To query instances whose availability zone (zone) is region 1 and the billing mode is monthly subscription or pay-as-you-go, the filters can be as follows:

Filters.1.Name=zone
&Filters.1.Values.1=ap-region1-1
&Filters.2.Name=instance-charge-type
&Filters.2.Values.1=PREPAID
&Filters.3.Values.2=POSTPAID_BY_HOUR

Referenced by the following interfaces: DescribeDiagnosticReports, DescribeHosts, DescribeImages, DescribeInstanceConfigInfos, DescribeInstanceStatistics, DescribeInstanceTypeConfigs, DescribeInstanceTypeDisasterGroupBlackList, DescribeInstanceTypeQuota, DescribeInstances, DescribeInstancesModification, DescribeKeyPairs, DescribeLaunchTemplatesInfo, DescribeUserAvailableZones, DescribeUserInstanceQuota, DescribeUserMigrateTasks, DescribeUserZoneStatus, DescribeZoneHostConfigInfos, DescribeZoneHostForSellStatus, DescribeZoneInstanceConfigInfos

name	required	NULL allowed	type	description
Name	yes	no	String	Fields need to be filtered. Example: ip
Values	yes	no	Array of String	Filter value of the field. Example: 12.34.32.11

Instance

Description of Instance Information

Referenced by the following interfaces: DescribeInstances

name	required	NULL allowed	type	description
Placement	no	no	Placement	Instance Location. Example:View
InstanceId	no	no	String	Instance ID. Example: ins-9bxebleo
InstanceType	no	no	String	Instance model. Example: S1.SMALL1
CPU	no	no	Int64	Number of CPU cores of an instance, unit: cores. Example: 1
Memory	no	no	Int64	Instance memory capacity, in GB. Example: 1
RestrictState	no	yes	String	Instance service status. Value range: NORMAL: Indicates an instance in the normal state EXPIRED: Indicates an expired instance PROTECTIVELY_ISOLATED: Indicates an instance that is protectively isolated. Example: NORMAL
InstanceName	no	no	String	Instance name. Example: Test instance
InstanceChargeType	no	no	String	Instance billing mode. Value range: `PREPAID`: Indicates prepaid, that is, monthly subscription `POSTPAID_BY_HOUR`: Indicates postpaid, that is, pay-as-you-go `CDHPAID`: Indicates `CDH` payment, that is, billed only on the `CDH` but not on instances on the `CDH`. Example: PREPAID
SystemDisk	no	no	SystemDisk	System disk information of an instance. Example:View
DataDisks	no	yes	Array of DataDisk	Instance data disk information. Only includes data disks purchased with the instance. Example:View
PrivateIpAddresses	no	yes	Array of String	List of private `IP`s of primary network interface card of instance. Example: ["172.16.32.78"]
PublicIpAddresses	no	yes	Array of String	List of public `IP`s of primary network interface card of instance. Example: ["122.207.11.190"]
InternetAccessible	no	no	InternetAccessible	Instance bandwidth information. Example:View
VirtualPrivateCloud	no	no	VirtualPrivateCloud	Information about virtual VPC to which the instance belongs. Example:View
ImageId	no	yes	String	Image ID used for instance production. Example: img-9qabwvbn
RenewFlag	no	yes	String	Auto-renewal flag. Value range: `NOTIFY_AND_MANUAL_RENEW`: Indicates that notification that it is about to expire is made, but auto-renewal is not performed `NOTIFY_AND_AUTO_RENEW`: Indicates that notification that it is about to expire is made, and auto-renewal is performed `DISABLE_NOTIFY_AND_MANUAL_RENEW`: Indicates that notification that it is about to expire is not made, and auto-renewal is neither performed. Example: NOTIFY_AND_MANUAL_RENEW
CreatedTime	no	no	Datetime_iso	Creation time. It is expressed according to the `ISO8601` standard by using the `UTC` time. The format is `YYYY-MM-DDThh:mm:ssZ`. Example: 2020-03-10T02:43:51Z
ExpiredTime	no	yes	Datetime_iso	Expiration time. It is expressed according to the `ISO8601` standard by using the `UTC` time. The format is `YYYY-MM-DDThh:mm:ssZ`. Example: 2020-04-10T02:47:36Z
InstanceState	yes	yes	String	Instance status. Value range: PENDING: Indicates creating in progress LAUNCH_FAILED: Indicates creation failed RUNNING: Indicates running STOPPED: Indicates shutdown STARTING: Indicates starting STOPPING: Indicates shutdown in progress REBOOTING: Indicates rebooting SHUTDOWN: Indicates shutdown and pending termination TERMINATING: Indicates terminating in progress. Example: RUNNING
LatestOperation	yes	yes	String	Latest operation on the instance, such as StopInstances, ResetInstance. Example: RenewInstances
LatestOperationState	yes	yes	String	Latest operation status of the instance. Value range: SUCCESS: Indicates that the operation succeeded OPERATING: Indicates that the operation is in progress FAILED: Indicates that the operation failed. Example: SUCCESS
LatestOperationRequestId	yes	yes	String	Unique request ID for the latest operation on an instance. Example: 3554eb5b-1cfa-471a-ae76-dc436c9d43e8
SecurityGroupIds	yes	yes	Array of String	Security Group of the Instance. You can obtain this parameter by calling the sgId field in the returned value from DescribeSecurityGroups. Example: ["sg-p1ezv4wz"]
LoginSettings	yes	yes	LoginSettings	Instance login settings. Currently, only keys associated with the instance are returned. Example:View
DisasterRecoverGroupId	yes	yes	String	Spread placement group ID. Example: null
Tags	yes	yes	Array of Tag	List of tags associated with the instance. Example:View
Uuid	yes	no	String	Instance UUID Example: 68b510db-b4c1-4630-a62b-73d0c7c970f9
OsName	yes	yes	String	Instance OS Name Example: CentOS 7.6 64bit
IPv6Addresses	yes	yes	Array of String	IPv6 Address of Instance Example: null
StopChargingMode	yes	yes	String	Shutdown Billing Mode of Instance Value range: KEEP_CHARGING: Continue charging after shutdown STOP_CHARGING: Stop charging after shutdown NOT_APPLICABLE: the instance is in a non-shutdown state or conditions not applicable for stopping charges upon shutdown . Example: NOT_APPLICABLE
CamRoleName	yes	yes	String	CAM role name. Example: null
IsolatedSource	yes	yes	String	IsolatedSource Example: NOTISOLATED
PlatformProjectId	yes	yes	String	Project ID to which Resource Belongs Example: 0
RemainTime	yes	yes	String	Duration Example: 10
HpcClusterId	no	yes	String	High-performance computing cluster ID. Example: null
DefaultLoginUser	no	yes	String	Default Login User Example: root
DefaultLoginPort	no	yes	Uint64	Default Login Port Example: 22
DedicatedClusterId	no	yes	String	Dedicated cluster ID where the instance is located. Example: cluster-du3jken
OperatorUin	yes	yes	String	Operator UIN Example: 34232423
RdmaIpAddresses	no	yes	Array of String	List of High-Performance Computing Cluster `IP`s Example: 10.34.23.4
DeviceId	no	yes	Uint64	Instance ID Example: 12
InstanceClass	no	yes	String	Instance Type Example: S
IsolatedTime	no	yes	Datetime_iso	Isolated at Example: 2014-08-03T12:00:00+08:00
ErrorKey	no	yes	String	Incorrect Key Example: 12
GPU	no	yes	Int64	GPU Example: 2
NewCreationIdentify	no	yes	Bool	Newly Created Identification Example: false
OperationMask	no	yes	Uint64	Operation Mask Example: 64
ImageType	no	yes	String	Image type Example: PUBLIC_IMAGE
KeyPairIds	no	yes	Array of String	Secret key ID, data source is MC, BATCH, AS, tke, VPC_CGW, or when there is neither Token nor CamContext in the request, the keypairids field will be returned. Other data sources will not return the keypairids field. Example: ['skey-e7qf43n']
RunFlag	no	no	Int64	Runtime Flag Example: 1
InnerVpcId	no	yes	Uint64	Internal VPC ID Example: 2
InstanceFamily	no	yes	String	Family of Instance Example: S1
Architecture	no	yes	String	Architecture Example: x86_64
ErrorCode	no	yes	Int64	Error code Example: SUCCESS
SafeIsolatedInfo	no	yes	String	Security Isolation Information Example: null
IsSafeIsolated	no	yes	Bool	Whether it is protectively isolated. Example: true
Hypervisor	no	yes	Int64	Virtualization Example: 1
LatestOperationErrorMsg	no	yes	String	Error message of the latest operation on the instance. Example: None
UnderwriteExpiredTime	no	yes	Datetime_iso	Instance expiration time in committed use mode. It should be a UTC time in the format defined in the ISO 8601 standard. Format: YYYY-MM-DDThh:mm:ssZ. Note: This field is null for the postpaid mode. Example: 2020-04-10T02:47:36Z
DisableApiTermination	no	no	Bool	Instance termination protection flag. It indicates whether instance deletion through an API is allowed. true: instance protection enabled (deletion through an API not allowed); false: instance protection disabled (deletion through an API allowed). Default value: false. Example: false
HibernationOptions	no	yes	HibernationOptions	Whether hibernation is configured for the instance. Example:View
VmEniTrunking	no	yes	String	ENI trunking status. Example: on
BootMode	no	yes	String	Boot mode of the instance. Example: UEFI
ChcInstanceType	no	yes	String	CHC instance type. Example: CHC.S3
SwapDisks	no	yes	SwapDisks	List of swap disk information on the instance. Example:View
LatestOperationCode	no	yes	String	Error code of the latest operation. It indicates the operation failure cause. Example: InternalError
DisasterRecoverGroupIds	no	no	Array of String	Placement Group List Example: ["ps-g0qd8r"]
LicenseType	no	no	String	Operating system license type of the instance. Example: Cloud
EnableGridLicence	no	yes	String	Whether to enable the GRID license. Example: ENABLED

HostForSellZoneStatus

CDH sales status in the availability zone.

Referenced by the following interfaces: DescribeZoneHostForSellStatus

name	required	NULL allowed	type	description
Zone	yes	no	String	Availability Zone Example: ap-region1-2
Status	yes	no	String	Sales status, (SELL: Normally in sale, SOLD_OUT: Sold out). Example: PENDING

DetailPrices

Detailed Price Information

name	required	NULL allowed	type	description
ImagePrice	no	yes	ItemPrice	Image Price Example:View
DataDisksPrice	no	yes	Array of ItemPrice	Data Disk Price Example:View
CpuMemPrice	no	yes	ItemPrice	CPU Memory Price Example:View
SystemDiskPrice	no	yes	ItemPrice	System Disk Price Example:View
SystemDiskBackupPrice	no	yes	ItemPrice	Details of system disk fees. Example:View
DataDisksBackupPrice	no	yes	Array of ItemPrice	Details of data disk fees. Example:View

ActionTimers

Returned Value of ActionTimers

Referenced by the following interfaces: QueryInstancesActionTimer

name	required	NULL allowed	type	description
ActionTimerId	yes	no	String	ActionTimerId Example: 4904ffac-02e4-4161-9636-cca0a687e841
AppId	yes	no	Uint64	AppId Example: 125550001
InstanceId	yes	no	String	InstanceId Example: ins-61dyt49h
TimerAction	yes	no	String	TimerAction Example: TerminateInstances
ActionTime	yes	no	String	ActionTime Example: 2018-08-01 20:00:00
Status	yes	no	String	Status Example: SUCCESS
Externals	yes	no	Externals	Externals Example:View

InstanceConfigInfoItemArchitecture

Static configuration information of an instance with CPU architecture.

Referenced by the following interfaces: DescribeInstanceConfigInfos

name	required	NULL allowed	type	description
type	yes	no	String	Instance specifications. Example: S2.SMALL1
typeName	yes	no	String	Instance specification name. Example: Standard S2
order	yes	no	Int64	Priority. Example: 1
instanceFamilies	yes	no	Array of InstanceFamilyItemArchitecture	List of instance family information. Example:View

InstanceStatisticsSet

Instance Data Array

Referenced by the following interfaces: DescribeInstanceStatistics

name	required	NULL allowed	type	description
Region	yes	no	String	Region Example: region1
TotalCount	yes	no	Uint64	Total Number of Machines Example: 20
NewInstanceCount	yes	no	Uint64	Total Number of Red Point Hosts (Newly Created Machines) Example: 20
ExpiredInstanceCount	yes	no	Uint64	Total Number of Expired Hosts Example: 20

KeyPairAttributeSet

Key pair

Referenced by the following interfaces: DescribeKeyPairsAttribute

name	required	NULL allowed	type	description
KeyId	yes	no	String	Key ID Example: skey-mv9yzyjj
InnerKeyId	yes	no	String	Internal Key ID Example: 83723

RunMonitorServiceEnabled

It describes the information related to the Cloud Monitor service.

name	required	NULL allowed	type	description
Enabled	no	no	Bool	Whether to enable the Cloud Monitor service. Value range: TRUE: Indicates that the Cloud Monitor service is enabled FALSE: Indicates that the Cloud Monitor service is not enabled Default value: TRUE. Example: true

ActionTimer

Schedule task

Referenced by the following interfaces: DescribeInstancesActionTimer, DescribeLaunchTemplatesInfo, ImportInstancesActionTimer, ModifyInstancesActionTimer, SwitchParameterRunInstances, UpdateInstancesActionTimer

name	required	NULL allowed	type	description
TimerAction	no	no	String	Timer Example: TerminateInstances
ActionTime	no	no	String	Execution time Example: 2024-05-29T11:26:40Z
Externals	yes	no	Externals	Extended data. This parameter is only used as an output parameter. Example:View

AutomationServiceEnabled

It describes information related to tat-agent.

name	required	NULL allowed	type	description
Enabled	no	no	Bool	Whether to install [tat-agent]. Value range: TRUE: Indicates installation FALSE: Indicates no installation Default value: TRUE. Example: true

InstanceCreateImageAttributeSet

List of Images Created by Instance

Referenced by the following interfaces: DescribeInstancesCreateImageAttributes

name	required	NULL allowed	type	description
InstanceId	yes	no	String	Cloud Host ID Example: ins-61dyt49h
SupportInstanceImage	yes	yes	Bool	Whether to support the instance image. Example: true
SupportOnlineCreateImage	yes	yes	Bool	Whether to support creating an image online. Example: true
SupportCloudinit	yes	yes	Bool	Whether to support cloud initialization. Example: true
NeedPowerOff	yes	yes	Bool	Whether to shut down. Example: true
UnavailableReason	no	yes	String	Reason for unavailability. Example: Need_Enable_Snapshot
SupportPreheat	no	no	Bool	Specifies whether the instance supports the preheating feature. Example: false
SupportPreheatZones	no	no	Array of String	List of AZs supporting preheating. Example: ["ap-city2-1"]
PreheatUnavailableReason	no	yes	String	Code for the reason why preheating is not supported. Example: PREHEAT_NOT_SUPPORTED
UnsupportedPreheatZones	no	yes	UnsupportedPreheatZones	AZs that do not support preheating and the reason codes. Example:View

CreateKeyPair

Describe Key Pair Creation Information

Referenced by the following interfaces: CreateKeyPair

name	required	NULL allowed	type	description
KeyId	yes	yes	String	ID of a key pair, is the unique flag of the key pair. Example: skey-11112222
KeyName	yes	yes	String	Key pair name. Example: alice-key
ProjectId	yes	yes	Uint64	Project ID to which the key pair belongs. Example: 2
PublicKey	yes	yes	String	Plaintext public key of the key pair. Example: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDP0Yw2T4itUKxyz
PrivateKey	yes	yes	String	Plaintext private key of the key pair. Example: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDP0Yw2T4itUKxyz
AssociatedInstanceCount	no	yes	Uint64	Number of instances associated with the key. Example: 10
AssociatedImageCount	no	yes	Uint64	Number of images associated with the key. Example: 5

ProjectSpecification

Platform Project ID

Referenced by the following interfaces: CloneInstance, CreateLaunchTemplate, RunInstances

name	required	NULL allowed	type	description
ResourceType	yes	no	String	Resource type, instance by default. Example: instance
PlatformProjectId	yes	no	String	Project ID Example: pr-46fbb87b

InstanceChargePrepaid

It describes the billing mode of an instance.

Referenced by the following interfaces: CloneInstance, CreateLaunchTemplate, InquiryPriceModifyInstancesChargeType, InquiryPriceRenewInstances, InquiryPriceRunInstances, ModifyInstancesChargeType, ModifyLaunchTemplate, RunInstances, SwitchParameterRunInstances

name	required	NULL allowed	type	description
Period	yes	no	Int64	Duration for purchasing an instance, unit: months. Value range: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, and 36. Example: 1
RenewFlag	no	no	String	Auto-renewal flag. Value range: NOTIFY_AND_AUTO_RENEW: Notifies of expiration and performs auto-renewal NOTIFY_AND_MANUAL_RENEW: Notifies of expiration but does not perform auto-renewal DISABLE_NOTIFY_AND_MANUAL_RENEW: Does not notify of expiration nor perform auto-renewal Default value: NOTIFY_AND_AUTO_RENEW. If this parameter is specified to NOTIFY_AND_AUTO_RENEW, the instance will be automatically renewed on a monthly basis after it expires if there is sufficient account balance. Example: NOTIFY_AND_MANUAL_RENEW

InstanceChargeTypeConfig

Billing Type Configuration Information

Referenced by the following interfaces: DescribeInstanceChargeTypeConfigs

name	required	NULL allowed	type	description
InstanceChargeType	yes	no	String	Instance Billing Type Example: PREPAID
Description	yes	no	String	Instance Billing Type Description Example: jack use

InternetBandwidthConfig

It describes the related information of billing by bandwidth.

Referenced by the following interfaces: DescribeInstanceInternetBandwidthConfigs

name	required	NULL allowed	type	description
StartTime	no	no	Datetime_iso	Start Time. It is expressed according to the `ISO8601` standard by using the `UTC` time. The format is `YYYY-MM-DDThh:mm:ssZ`. Example: 2014-08-03T12:00:00+08:00
EndTime	no	no	Datetime_iso	End time. It is expressed according to the `ISO8601` standard by using the `UTC` time. The format is `YYYY-MM-DDThh:mm:ssZ`. Example: 2014-08-03T12:00:00+08:00
InternetAccessible	no	no	InternetAccessible	Instance bandwidth information. Example:View

HostTypeConfigSetPrice

Price Information

Referenced by the following interfaces: DescribeZoneHostConfigInfos

name	required	NULL allowed	type	description
UnitPrice	yes	yes	Float	Original price of subsequent total costs, used for the postpaid billing mode, unit: USD. If other time interval items such as UnitPriceSecondStep are returned, this item represents the time interval of (0, 96) hours; if no other time interval items are returned, it represents the full period, that is, (0, ∞) hours. Note: This field may return null, indicating that no valid values can be obtained. Example: 0.64
ChargeUnit	yes	yes	String	Subsequent billing unit, used for postpaid modes. Possible value range: HOUR: Indicates that the billing unit is calculated on a hourly basis. Current scenarios involving this billing unit include: instance pay-per-hour postpaid (POSTPAID_BY_HOUR), bandwidth pay-per-hour postpaid (BANDWIDTH_POSTPAID_BY_HOUR): GB: Indicates that the billing unit is calculated per GB. Current scenarios involving this billing unit include: traffic pay-per-hour postpaid (TRAFFIC_POSTPAID_BY_HOUR). Note: This field may return null, indicating that no valid value was found. Example: 0.64
OriginalPrice	yes	yes	Float	Original price of total prepaid costs, used for the prepaid billing mode, unit: USD. Note: This field may return null, indicating that no valid values can be obtained. Example: 0.64
DiscountPrice	yes	yes	Float	Discount price of total prepaid costs, unit: USD. Note: This field may return null, indicating that no valid values can be obtained. Example: 0.64
OriginalPriceOneYear	no	yes	Float	Original price of total costs of one-year advance payment, used in the prepaid mode, unit: USD. Note: This field may return null, indicating that no valid value was found. Example: 0.64
DiscountPriceOneYear	no	yes	Float	Discount price of total prepaid costs for 1 year, used for the postpaid billing mode, unit: USD. Note: This field may return null, indicating that no valid values can be obtained. Note: This field may return null, indicating that no valid values can be obtained. Example: 0.64

HostGoodsDetailItem

Detailed Information of CDH Shipment Instance

Referenced by the following interfaces: SwitchParameterAllocateHosts

name	required	NULL allowed	type	description
transactionId	no	no	String	Request Transaction ID Example: f5a23f7d-2262-4933-b544-b0fa1dccc2e4
action	no	no	String	Operation Name Example: ModifyInstanceInternetChargeType
autoRenewFlag	no	no	Uint64	Auto-Renewal Flag Example: 1
pid	no	no	Uint64	pid Example: 2
timeSpan	no	no	Uint64	Purchase or Renewal Duration Example: 60
timeUnit	no	no	String	Time unit Example: m
resourceId	no	no	String	Resource ID Example: ins-3botj2dn
curDeadline	no	no	Datetime	Current expiry time Example: 2018-04-27 14:35:57
signature	no	no	String	Digital signature Example: 13af5ff01c878914ec60fca51b097cbc
productInfo	no	no	Array of ProductInfoItem	Product Information Item List Example:View

InstanceConnectivity

Instance port connectivity status, used to indicate the connectivity of the default remote login port and ICMP port of the instance.

Referenced by the following interfaces: CheckInstancesConnectivity

name	required	NULL allowed	type	description
InstanceId	yes	no	String	Instance ID Example: ins-61dyt49h
DefaultLoginPortConnectivity	yes	no	Bool	Default Remote Login Port Connectivity Status Example: true
ICMPConnectivity	yes	no	Bool	Whether the ping packet is reachable. Example: true

InstanceTypeConfig

Describes model configuration information of the instance

Referenced by the following interfaces: DescribeInstanceTypeConfigs, DescribeInstancesModification

name	required	NULL allowed	type	description
Zone	no	no	String	Availability zone. Example: ap-region1-2
InstanceType	no	no	String	Instance model. Example: S2.SMALL1
InstanceFamily	no	no	String	Instance model series. Example: S2
GPU	no	no	Int64	Number of GPU cores, unit: cores. Example: 2
GpuCount	no	no	Float	Number of physical GPU cards corresponding to the instance model. The number should be less than 1 for vGPU cards and greater than or equal to 1 for GPU cards in passthrough mode. vGPU is a GPU virtualization technology that splits physical GPU cards for use by different instances. GPU in passthrough mode are directly mounted to instances for use. Example: 1.0
CPU	no	no	Int64	Number of CPU cores, unit: cores. Example: 2
Memory	no	no	Int64	Memory capacity, in GB. Example: 2048
FPGA	yes	no	Uint64	Number of FPGA cores, unit: cores. Example: 2

DisasterRecoverGroups

Placement Group Information

Referenced by the following interfaces: QueryDisasterRecoverGroup

name	required	NULL allowed	type	description
currentNum	yes	yes	Uint64	Number of placement groups the current user has created. Example: 12
uDisasterRecoverGroupId	yes	yes	String	Placement Group ID. Example: ps-l86ok62z
cvmQuotaTotal	yes	yes	Uint64	Maximum number of cloud servers accommodated in the placement group. Example: 100
uuids	yes	yes	Array of String	uuid Example: ["5b33b986-084c-48e1-8cdb-d2e5ca5d045a"]
owner	yes	yes	String	Owner UIN of Account Example: 125550001
disasterRecoverTag	yes	yes	String	Tag Example: TAG_HARD_SW_ps-bpsqiuy1
type	yes	yes	String	Type Example: HOST
createTime	yes	yes	String	Creation Time Example: 2018-05-16 10:40:58
name	yes	yes	String	Placement Group Name Example: alice-1
partitionCount	yes	yes	Uint64	Partition quantity Example: 4
strategy	yes	yes	String	Policies Example: SPREAD
affinity	yes	yes	Int64	Affinity, Matching Degree Example: 1

HibernationOptions

Instance hibernation option configurations.

Referenced by the following interfaces: DescribeInstances

name	required	NULL allowed	type	description
Configured	no	yes	Bool	Whether hibernation options are configured. Example: true

LocalDiskType

Local Disk Specifications

Referenced by the following interfaces: DescribeZoneInstanceConfigInfos

name	required	NULL allowed	type	description
Type	yes	no	String	Local disk type. Example: LOCAL_BASIC
PartitionType	yes	no	String	Local disk attributes. Example: ROOT
MinSize	yes	no	Int64	Minimum value of the local disk. Example: 20
MaxSize	yes	no	Int64	Maximum value of local disk. Example: 100
Required	yes	no	String	Whether the local disk is mandatory during purchasing. Value range: REQUIRED: indicates mandatory OPTIONAL: indicates optional. Example: REQUIRED

InstanceTypeItem

Instance type information.

Referenced by the following interfaces: DescribeInstanceConfigInfos

name	required	NULL allowed	type	description
InstanceType	yes	no	String	Instance type. Example: S1.SMALL2
Cpu	yes	no	Uint64	Number of CPU cores. Example: 2
Memory	yes	no	Uint64	Memory size. Example: 2048
Gpu	yes	no	Uint64	Number of GPU cores. Example: 2
Fpga	yes	no	Uint64	Number of FPGA cores. Example: 2
StorageBlock	yes	no	Uint64	Number of storage blocks. Example: 2
NetworkCard	yes	no	Uint64	Number of network interface cards. Example: 2
MaxBandwidth	yes	no	Float	Maximum bandwidth. Example: 100.0
Frequency	yes	no	String	Frequency. Example: 2.5 GHz
CpuModelName	yes	no	String	CPU model name. Example: Intel Xeon Skylake 6133
Pps	yes	no	Uint64	Packet forwarding rate. Example: 10
Externals	yes	no	Externals	External information. Example:View
Remark	yes	no	String	Remark information. Example: alice use

DisasterRecoverGroup

Disaster Recovery Group Information

Referenced by the following interfaces: DescribeDisasterRecoverGroups

name	required	NULL allowed	type	description
DisasterRecoverGroupId	yes	no	String	Placement Group ID. Example: ps-n4becvb9
Name	yes	no	String	Placement group name, with a length of 1-60 characters. Example: myGroup
Type	yes	no	String	Placement group type. Valid values: HOST: Physical machine SW: Switch RACK: Rack Example: "HOST"
CvmQuotaTotal	yes	no	Int64	Maximum number of cloud servers accommodated in the placement group. Example: 50
CurrentNum	yes	no	Int64	Current quantity of CVMs in the placement group. Example: 2
InstanceIds	yes	yes	Array of String	ID list of CVMs in the placement group. Example: ["ins-19029pru"]
CreateTime	yes	yes	Datetime_iso	Placement group creation time. Example: "2021-04-27T08:49:34Z"
Affinity	no	yes	Int64	Placement group affinity Example: 1
Strategy	yes	no	String	Placement group policies Example: PARTITION
Tags	no	yes	Array of Tag	Placement group tag. Example:View

UserZoneStatusItem

Billing type status of an instance in the availability zone.

Referenced by the following interfaces: DescribeUserZoneStatus

name	required	NULL allowed	type	description
Zone	yes	no	String	Availability Zone Example: region1
InstanceChargeType	yes	no	String	Billing Method Example: PREPAID
Status	yes	no	String	Sales Status Example: AVALIBLE
IsPrimaryZone	no	no	Bool	Whether it is a primary AZ. Example: True

InstanceDeniedActions

List of Instance Operation Restrictions

Referenced by the following interfaces: DescribeInstancesDeniedActions

name	required	NULL allowed	type	description
InstanceId	no	no	String	Instance ID Example: ins-61dyt49h
DeniedActions	no	no	Array of DeniedActions	List of Operation Restrictions Example:View

InstanceFamilyItemArchitecture

Instance family information with CPU architecture.

Referenced by the following interfaces: DescribeInstanceConfigInfos

name	required	NULL allowed	type	description
instanceFamily	yes	no	String	Instance family. Example: S2
order	yes	no	Int64	Priority. Example: 1
instanceTypes	yes	no	Array of InstanceTypeItem	List of instance type information. Example:View
TypeName	yes	no	String	Instance Type Name Example: Standard S2
Architecture	yes	no	String	CPU Architecture Information Example: x86_64

UsbInfo

USB information.

Referenced by the following interfaces: DescribeInstanceUsbInfo

name	required	NULL allowed	type	description
BusNumber	no	no	String	Bus number. Example: 001
DeviceNumber	no	no	String	Device number. Example: 004
VendorId	no	no	String	Vendor number. Example: 0x17ef
ProductId	no	no	String	Product number. Example: 0x38ac
Name	no	no	String	Name Example: Lenovo
Version	no	no	String	Version Example: 2.00
DevType	no	no	String	Dev type. Example: Mass Storage
CreateTime	no	no	String	Creation Time Example: 2023-03-09 11:17:08
UpdateTime	no	no	String	Update time Example: 2023-03-14 16:09:20

AvailableZoneSet

Availability Zone Details

Referenced by the following interfaces: DescribeUserAvailableZones

name	required	NULL allowed	type	description
ZoneId	yes	yes	String	Availability Zone ID Example: 100001
Status	yes	yes	String	Status Example: SUCCESS
InstanceType	yes	yes	Array of Int64	Instance Type Example: 2

DataDisk

It describes the information about the data disk.

Referenced by the following interfaces: CloneInstance, CreateLaunchTemplate, DescribeInstances, DescribeLaunchTemplatesInfo, InquiryPriceRunInstances, ModifyLaunchTemplate, ResizeInstanceDisks, RunInstances, SwitchParameterResizeInstanceDisks, SwitchParameterRunInstances

name	required	NULL allowed	type	description
DiskType	no	no	String	Data disk type. Value range: LOCAL_BASIC: Local HDD LOCAL_SSD: Local SSD CLOUD_BASIC: Basic Cloud Disk CLOUD_PREMIUM: Premium Cloud Disk CLOUD_SSD: SSD Cloud Disk Default value: LOCAL_BASIC. This parameter is invalid for the API `ResizeInstanceDisk`. Example: CLOUD_BASIC
DiskId	no	no	String	System disk ID. The LOCAL_BASIC and LOCAL_SSD types do not have an ID. Currently, this parameter is not supported. Example: disk-61dyt49h
DiskSize	yes	no	Int64	Data disk size, in GB. The minimum adjustment step size is 10 GB. The value range varies with different data disk types. The default value is 0, indicating that no data disk is purchased. For more restrictions, see Product Documentation. Example: 324
DeleteWithInstance	no	yes	Bool	Whether the data disk is terminated with the instance. Value range: TRUE: When the instance is terminated, the data disk is also terminated. Only pay-per-hour postpaid cloud disks are supported. FALSE: When the instance is terminated, the data disk is retained. Default value: TRUE Currently, this parameter is only used for the API `RunInstances`. Example: false
DiskStoragePoolGroup	no	yes	String	Storage pool specified by the data disk. Example: alice-1255000080
AutoSnapshotPolicyId	no	yes	String	Automatic Backup Policy of CBS Example: asp-mrsrn243
SnapshotId	no	yes	String	Snapshot ID of CBS Example: snap-7et7t234