Queries the parameter settings of a specified host in an ApsaraDB for MyBase dedicated cluster.

ApsaraDB for MyBase allows you to manage multiple instances in clusters. You can create multiple clusters in a region. Each cluster consists of multiple hosts. Multiple instances can be deployed on each host. For more information, see What is ApsaraDB for MyBase?

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No DescribeDedicatedHostAttribute

The operation that you want to perform. Set the value to DescribeDedicatedHostAttribute.

DedicatedHostGroupId String Yes dhg-h5i4p331f509****

The ID of the dedicated cluster. You can view the dedicated cluster ID on the Dedicated Cluster Information page in the ApsaraDB for MyBase console.

DedicatedHostId String Yes dhg-6w7q18iwt5jo****

The ID of the host in the dedicated cluster. You can call the DescribeDedicatedHosts operation to query the host ID.

RegionId String No cn-hangzhou

The ID of the region. You can call the DescribeRegions operation to query the region ID.

Response parameters

Parameter Type Example Description
AccountName String test

The custom name of the host account.

AccountType String Admin

The type of the account. Valid values:

  • Normal: standard account
  • Admin: administrator account
AllocationStatus String Suspended

Indicates whether instances can be created on the host. Valid values:

  • Allocatable: Instances can be created on the host.
  • Suspended: Instances cannot be created on the host.
AutoRenew String Null

A hidden parameter.

CPUAllocationRatio String 25

The numerator of a percent value that indicates the CPU overcommitment ratio of the dedicated cluster. The value is accurate to the tens digit.

CpuUsed String 10

The number of CPU cores used by the dedicated cluster.

CreatedTime String 2021-11-13T07:14:22Z

The time when the host was created. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.

DedicatedHostGroupId String 6w7q18iwt5jo****

The ID of the dedicated cluster.

DedicatedHostId String ch-t4nc1nra4s2ja****

The ID of the host for which the host account is queried.

DiskAllocationRatio String 100

The numerator of a percent value that indicates the storage overcommitment ratio of the dedicated cluster. The value is accurate to the tens digit.

EcsClassCode String ecs.r5.16xlarge

The ECS instance type. For more information, see ECS instance types.

ExpiredTime String 2021-11-13T07:14:22Z

The time when the host expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

HostCPU Integer 16

The number of the CPU cores used by the host.

HostClass String rds.g6.4xlarge

The specifications of the host.

HostMem Integer 65536

The memory of the host. Unit: GB.

HostName String ch-bp15xfnp706tl****

The name of the host.

HostStatus String 1

The status of the host. Valid values:

  • 0: The host is being created.
  • 1: The host is running.
  • 2: The host is faulty.
  • 3: The host is ready for deactivation.
  • 4: The host is being maintained.
  • 5: The host is deactivated.
  • 6: The host is restarting.
  • 7: The host is locked.
Note When a host fails, the host is deactivated. Before the host is deactivated, the instance data in the host is migrated to another host.
HostStorage Integer 1

The total storage of the host. Unit: GB.

HostType String dhg_cloud_ssd

The storage type of the host. Valid values:

  • Local SSD: indicates the local storage that is attached to the physical machine on which the instance is deployed. It provides block-level data access capabilities for instances and features low latency, high random IOPS, and high throughput.
  • Enhanced SSD (ESSD): applies to latency-sensitive applications or I/O intensive business scenarios.
Note Different database engines support different types of storage. You can view the supported types of storage in the ApsaraDB for MyBase console.
IPAddress String 192.168.0.56

The IP address of the host.

ImageCategory String WindowsWithMssqlStdLicense

The image of the host. A value is returned only if the value of the Engine parameter is mssql. Valid values:

  • WindowsWithMssqlStdLicense: a Windows image that contains the licenses of SQL Server Standard Edition
  • WindowsWithMssqlEntLisence: a Windows image that contains the licenses of SQL Server Enterprise Edition
  • WindowsWithMssqlWebLisence: a Windows image that contains the licenses of SQL Server Web Edition
InstanceNumber Integer 1

The number of instances on the host.

InstanceNumberMaster Integer 2

The number of the primary nodes on the host.

InstanceNumberROMaster Integer 1

The number of the primary nodes of the read-only instances on the host.

InstanceNumberROSlave Integer 1

The number of the secondary nodes of the read-only instances on the host.

InstanceNumberSlave Integer 1

The number of the secondary nodes on the host.

MemAllocationRatio String 90

The memory usage in percentage.

MemoryUsed String 24576

The maximum memory usage of each host in the dedicated cluster. Unit: GB.

OpenPermission String 1

Indicates whether to enable the feature that allows you to have host OS permissions. Valid values:

  • 0: disables the feature. This is the default value.
  • 1: enables the feature.
RegionId String cn-hangzhou

The ID of the region.

RequestId String D6E068C3-25BC-455A-85FE-45F0B22E****

The ID of the request.

StorageUsed String 588800

The storage usage of each host in the dedicated cluster. Unit: GB.

VPCId String vpc-bp1roz55mrbj3ka1s****

The ID of the virtual private cloud (VPC).

VSwitchId String vsw-bp133c8ifzxd3iv6q****

The ID of the vSwitch.

ZoneId String cn-hangzhou-e

The zone in which the dedicated cluster is deployed.

Examples

Sample requests

http(s)://cddc.aliyuncs.com/?Action=DescribeDedicatedHostAttribute
&DedicatedHostGroupId=dhg-h5i4p331f509****
&DedicatedHostId= dhg-6w7q18iwt5jo****
&RegionId=cn-hangzhou
&<Common request parameters>|

Sample success responses

XML format

<DescribeDedicatedHostAttributeReponse>
  <CPUAllocationRatio>25</CPUAllocationRatio>
  <DiskAllocationRatio>100</DiskAllocationRatio>
  <InstanceNumber>1</InstanceNumber>
  <DedicatedHostId>ch-t4nc1nra4s2ja****</DedicatedHostId>
  <CreatedTime>2021-11-13T07:14:22Z</CreatedTime>
  <DedicatedHostGroupId>6w7q18iwt5jo****</DedicatedHostGroupId>
  <AutoRenew>Null</AutoRenew>
  <ImageCategory>WindowsWithMssqlStdLicense</ImageCategory>
  <HostStorage>1</HostStorage>
  <InstanceNumberSlave>1</InstanceNumberSlave>
  <OpenPermission>1</OpenPermission>
  <HostType>dhg_cloud_ssd</HostType>
  <ExpiredTime>2021-11-13T07:14:22Z</ExpiredTime>
  <HostMem>65536</HostMem>
  <MemoryUsed>24576</MemoryUsed>
  <HostStatus>1</HostStatus>
  <CpuUsed>10</CpuUsed>
  <HostName>ch-bp15xfnp706tl****</HostName>
  <InstanceNumberROSlave>1</InstanceNumberROSlave>
  <AllocationStatus>Suspended</AllocationStatus>
  <ZoneId>cn-hangzhou-e</ZoneId>
  <RequestId>D6E068C3-25BC-455A-85FE-45F0B22E****</RequestId>
  <MemAllocationRatio>90</MemAllocationRatio>
  <VPCId>vpc-bp1roz55mrbj3ka1s****</VPCId>
  <InstanceNumberROMaster>1</InstanceNumberROMaster>
  <VSwitchId> vsw-bp133c8ifzxd3iv6q****</VSwitchId>
  <AccountType>Admin</AccountType>
  <InstanceNumberMaster>2</InstanceNumberMaster>
  <StorageUsed>588800</StorageUsed>
  <HostClass>rds.g6.4xlarge</HostClass>
  <HostCPU>16</HostCPU>
  <EcsClassCode>ecs.r5.16xlarge</EcsClassCode>
  <RegionId>cn-hangzhou</RegionId>
  <IPAddress>192.168.0.56</IPAddress>
  <AccountName>test</AccountName>
</DescribeDedicatedHostAttributeReponse>

JSON format

{"CPUAllocationRatio":"25",
"DiskAllocationRatio":"100",
"InstanceNumber":"1",
"DedicatedHostId":"ch-t4nc1nra4s2ja****",
"CreatedTime":"2021-11-13T07:14:22Z",
"DedicatedHostGroupId":"6w7q18iwt5jo****",
"AutoRenew":"Null",
"ImageCategory":"WindowsWithMssqlStdLicense",
"HostStorage":"1",
"InstanceNumberSlave":"1",
"OpenPermission":"1",
"HostType":"dhg_cloud_ssd",
"ExpiredTime":"2021-11-13T07:14:22Z",
"HostMem":"65536",
"MemoryUsed":"24576",
"HostStatus":"1",
"CpuUsed":"10",
"HostName":"ch-bp15xfnp706tl****",
"InstanceNumberROSlave":"1",
"AllocationStatus":"Suspended",
"ZoneId":"cn-hangzhou-e",
"RequestId":"D6E068C3-25BC-455A-85FE-45F0B22E****",
"MemAllocationRatio":"90",
"VPCId":"vpc-bp1roz55mrbj3ka1s****",
"InstanceNumberROMaster":"1",
"VSwitchId":" vsw-bp133c8ifzxd3iv6q****",
"AccountType":"Admin",
"InstanceNumberMaster":"2",
"StorageUsed":"588800",
"HostClass":"rds.g6.4xlarge",
"HostCPU":"16",
"EcsClassCode":"ecs.r5.16xlarge",
"RegionId":"cn-hangzhou",
"IPAddress":"192.168.0.56",
"AccountName":"test"}

Error codes

HttpCode Error code Error message Description
403 Forbidden.RAM User not authorized to operate on the specified resource, or this API does not support RAM. The error message returned because the specified operation is forbidden.

For a list of error codes, visit the API Error Center.