DescribeInstanceTypes

Description

Call the DescribeInstanceTypes to query the instance specification resources provided by the cloud server ECS.

Request Method

POST

Request Path

/apsara/route/Ecs/DescribeInstanceTypes

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
regionId	BODY	string	Yes	No sample value for this parameter.	region id
InstanceTypeFamily	BODY	string	No	ecs.g6	the specification family to which the instance specification belongs. See DescribeInstanceTypeFamilies for values. For more details, please refer to the instance specification section in the cloud server ECS product introduction.
version	BODY	string	No	2016-01-01	version of api

Return data

Name	Type	Sample value	Description
InstancePpsTx	long	300000	Intranet outbound network packet sending and receiving capability, unit: Pps.
LocalStorageCapacity	long	5000	The single disk capacity of the local disk mounted on the instance, in GiB.
TotalEniQueueQuantity	integer	128	the quota of queues allowed to be modified by the instance specification. Note The number of queues for primary network cards is not accumulated.
EniTrunkSupported	boolean	false	Description This parameter is not currently supported.
InstanceTypeFamily	string	ecs.g5	instance specification family.
InstancePpsRx	long	300000	Intranet inbound network packet sending and receiving capability, unit: Pps.
InstanceBandwidthRx	integer	1024000	internal network inbound bandwidth limit, unit: kbit/s.
InstanceBandwidthTx	integer	1024000	internal network outbound bandwidth limit, unit: kbit/s.
LocalStorageAmount	integer	1	the number of local disks mounted on the instance.
LocalStorageCategory	string	local_ssd_pro	local disk type. Possible values: local_hdd_pro: SATA HDD local disk on instance type family d1. local_ssd_pro: NVMe SSD local disks installed in instance type families i2, ga1, and gn5.
GPUSpec	string	NVIDIA V100	GPU type.
InstanceTypeId	string	ecs.g5.large	instance specification ID.
InstanceTypes	array of instancetype	No sample value for this parameter.	set of instance specification families.
InstanceType		No sample value for this parameter.	No description for this parameter.
MemorySize	float	8.0	memory size, unit GiB.
EniIpv6AddressQuantity	integer	1	IPv6 address limit for a single flexible network card.
CpuCoreCount	integer	8	vCPU number.
EniTotalQuantity	integer	0	Description This parameter is not currently supported.
RequestId	string	00827261-20B7-4562-83F2-4DF39876A45A	request ID.
InitialCredit	integer	120	initial vCPU integral value of burst performance instance t5.
EniQuantity	integer	2	The upper limit of the supported ENI.
GPUAmount	integer	2	number of GPU.
BaselineCredit	integer	4	benchmark vCPU computing performance (sum of all vCPUs) of burst performance instance t5.
InstanceFamilyLevel	string	EnterpriseLevel	instance type family level. Possible values: EntryLevel: entry level. EnterpriseLevel: enterprise level. CreditEntryLevel: entry level of points.
EniPrivateIpAddressQuantity	integer	6	the upper limit of the private IP address of a single flexible network card.

Example

Successful Response example

{
 "InstancePpsTx":"300000",
 "LocalStorageCapacity":"5000",
 "TotalEniQueueQuantity":"128",
 "EniTrunkSupported":"false",
 "InstanceTypeFamily":"ecs.g5",
 "InstancePpsRx":"300000",
 "InstanceBandwidthRx":"1024000",
 "InstanceBandwidthTx":"1024000",
 "LocalStorageAmount":"1",
 "LocalStorageCategory":"local_ssd_pro",
 "GPUSpec":"NVIDIA V100",
 "InstanceTypeId":"ecs.g5.large",
 "InstanceTypes":"",
 "InstanceType":"",
 "MemorySize":"8.0",
 "EniIpv6AddressQuantity":"1",
 "CpuCoreCount":"8",
 "EniTotalQuantity":"0",
 "RequestId":"00827261-20B7-4562-83F2-4DF39876A45A",
 "InitialCredit":"120",
 "EniQuantity":"2",
 "GPUAmount":"2",
 "BaselineCredit":"4",
 "InstanceFamilyLevel":"EnterpriseLevel",
 "EniPrivateIpAddressQuantity":"6"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}