DescribeHostEcsLevelInfo - ApsaraDB for MyBase - Alibaba Cloud Documentation Center

Queries the information about host specifications.

Operation description

After a host is created, you can call this operation to query the information about the host specifications, such as the CPU resources, memory resources, CPU model, host category, and storage type.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cddc:DescribeHostEcsLevelInfo	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DbType	string	Yes	The database engine. Valid values: mysql mssql pgsql redis	mysql
RegionId	string	Yes	The region ID. For more information, see Region IDs.	cn-hangzhou
ZoneId	string	Yes	The zone ID.	ap-southeast-1a
StorageType	string	Yes	The storage type. Valid values: local_ssd: standard SSD. cloud_essd: PL1 enhanced SSD (ESSD). cloud_essd2: PL2 ESSD. cloud_essd3: PL3 ESSD.	local_ssd
ImageCategory	string	No	The image of the host. Valid values: WindowsWithMssqlEntAlwaysonLicense: SQL Server Cluster Edition. WindowsWithMssqlStdLicense: SQL Server Standard Edition. WindowsWithMssqlEntLicense: SQL Server Enterprise Edition. WindowsWithMssqlWebLicense: SQL Server Web Edition. AliLinux: other images.	AliLinux

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	395858E2-2A82-4ED7-BB93-2DB60119EF4C
HostEcsLevelInfos	array<object>	The queried host.
HostEcsLevelInfos	object
CddcHostType	string	The category of the host. Valid values: general: general-purpose. compute: compute-optimized. ram: memory-optimized. dragon: ECS Bare Metal Instance.	ram
Items	array<object>	The queried host specifications.
Items	object
NetBandWidth	float	The internal bandwidth of the host. Unit: Gbit/s.	10
EcsClass	string	The instance family of the host.
RdsClassCode	string	The instance type of the instance.	mssql.cluster.host.g2xlarge
Cpu	integer	The number of CPU cores of the host.	24
CpuFrequency	string	The processor frequency. Unit: GHz.	2.5 GHz/3.2 GHz
StorageIops	integer	The storage IOPS of the host, which is displayed after being divided by 10,000.	5
CloudStorageBandwidth	float	The disk bandwidth. Unit: Gbit/s.	4
EcsClassCode	string	The instance type of the host.	ecs.g6.2xlarge
IsCloudDisk	integer	Indicates whether the host uses cloud disks.	1
Memory	integer	The memory size of the host. Unit: GB.	192
NetPackage	integer	The packet forwarding rate over the internal network, which is displayed after being divided by 10,000. Unit: packets per second (PPS).	150
CpuVersion	string	The CPU model of the host.	Intel Xeon(Cascade Lake) Platinum 8269CY
LocalStorage	string	The local storage.	7
Description	string	The name of the host.	testxxx

Examples

Sample success responses

JSONformat

{
  "RequestId": "395858E2-2A82-4ED7-BB93-2DB60119EF4C",
  "HostEcsLevelInfos": [
    {
      "CddcHostType": "ram",
      "Items": [
        {
          "NetBandWidth": 10,
          "EcsClass": "",
          "RdsClassCode": "mssql.cluster.host.g2xlarge\t",
          "Cpu": 24,
          "CpuFrequency": "2.5 GHz/3.2 GHz",
          "StorageIops": 5,
          "CloudStorageBandwidth": 4,
          "EcsClassCode": "ecs.g6.2xlarge\t",
          "IsCloudDisk": 1,
          "Memory": 192,
          "NetPackage": 150,
          "CpuVersion": "Intel Xeon(Cascade Lake) Platinum 8269CY\t",
          "LocalStorage": 7,
          "Description": "testxxx"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidAction	The specified action is not valid.	The specified action is not valid.
403	Permission.NotSupport	You are not authorized to perform this action.	You are not authorized to perform the action.
403	Forbidden.RAM	User not authorized to operate on the specified resource, or this API does not support RAM.	The user is not authorized to operate on the specified resource.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2021-09-08	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details