Queries the parameter settings of a specified host in a dedicated cluster.

ApsaraDB MyBase allows you to manage multiple instances in a dedicated cluster at the same time. You can create multiple dedicated clusters in a region. Each dedicated cluster consists of multiple hosts. Multiple instances can be deployed on each host. For more information, see What is ApsaraDB 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 Yes DescribeDedicatedHostAttribute

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

DedicatedHostGroupId String Yes dhg-34639v1jt4y4****

The ID of the dedicated cluster.

Note You can view the ID of the dedicated cluster on the Dedicated Clusters page in the ApsaraDB MyBase console.
DedicatedHostId String Yes ch-bp10a5id3boqi****

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

RegionId String No cn-hangzhou

The region ID of the host. For more information about region IDs, see Region IDs.

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: a standard account
  • Admin: an 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 200

The numeric value of the CPU overcommit ratio of the dedicated cluster.

CpuUsed String 2

The number of CPU cores used by the host.

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 dhg-34639v1jt4y4****

The ID of the dedicated cluster in which the host is created.

DedicatedHostId String ch-bp10a5id3boqi****

The ID of the host.

DiskAllocationRatio String 200

The numeric value of the storage overcommit ratio of the dedicated cluster.

EcsClassCode String ecs.r5.16xlarge

The Elastic Compute Service (ECS) instance type.

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 CPU cores specified for the host. Unit: core.

HostClass String rds.g6.4xlarge

The instance type of the host.

HostMem Integer 2048

The memory of the host. Unit: M.

HostName String ch-bp15xfnp706tl****

The name of the host.

HostStatus String 1

The state 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 data of the instances that are created on the host is migrated to another host in the same dedicated cluster. This ensures data integrity.
HostStorage Integer 100

The total storage capacity of the host. Unit: GB.

HostType String dhg_cloud_ssd

The storage type of the host. Valid values:

  • dhg_ssd: indicates that the host uses the local SSDs that are attached to the physical machine on which the host is deployed. A local SSD provides block-level data access capabilities for instances and features low latency, high random IOPS, and high throughput.
  • dhg_cloud_ssd: indicates that the host uses enhanced SSDs (ESSDs). ESSDs are suitable for 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 MyBase console.
IPAddress String 192.168.XX.XX

The IP address of the host.

ImageCategory String WindowsWithMssqlStdLicense

The image of the host. A value is returned for this parameter only if the host is created in a dedicated cluster that runs SQL Server. 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 1

The number of primary nodes on the host.

InstanceNumberROMaster Integer 1

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

InstanceNumberROSlave Integer 1

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

InstanceNumberSlave Integer 1

The number of secondary nodes on the host.

MemAllocationRatio String 90

The memory usage in percentage.

MemoryUsed String 24576

The amount of memory used by the host. Unit: GB.

OpenPermission String 1

Indicates whether you have the OS permissions on the host. Valid values:

  • 0: You do not have the OS permissions on the host.
  • 1: You have the OS permissions on the host.
RegionId String cn-hangzhou

The ID of the region.

RequestId String D6E068C3-25BC-455A-85FE-45F0B22E1234

The ID of the request.

StorageUsed String 588800

The storage usage of the host. Unit: GB.

VPCId String vpc-bp1roz55mrbj3ka1s****

The ID of the virtual private cloud (VPC) to which the host is connected.

VSwitchId String vsw-bp133c8ifzxd3iv6q****

The ID of the vSwitch.

ZoneId String cn-hangzhou-e

The zone ID of the host.

Examples

Sample requests

http(s)://cddc.aliyuncs.com/?Action=DescribeDedicatedHostAttribute
&DedicatedHostGroupId=dhg-34639v1jt4y4****
&DedicatedHostId= ch-bp10a5id3boqi****
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<DescribeDedicatedHostAttributeReponse>
<CPUAllocationRatio>200</CPUAllocationRatio>
<DiskAllocationRatio>200</DiskAllocationRatio>
<InstanceNumber>1</InstanceNumber>
<DedicatedHostId>ch-bp10a5id3boqi****</DedicatedHostId>
<CreatedTime>2021-11-13T07:14:22Z</CreatedTime>
<DedicatedHostGroupId>dhg-34639v1jt4y4****</DedicatedHostGroupId>
<AutoRenew>Null</AutoRenew>
<ImageCategory>WindowsWithMssqlStdLicense</ImageCategory>
<HostStorage>100</HostStorage>
<InstanceNumberSlave>1</InstanceNumberSlave>
<OpenPermission>1</OpenPermission>
<HostType>dhg_cloud_ssd</HostType>
<ExpiredTime>2021-11-13T07:14:22Z</ExpiredTime>
<HostMem>2048</HostMem>
<MemoryUsed>24576</MemoryUsed>
<HostStatus>1</HostStatus>
<CpuUsed>2</CpuUsed>
<HostName>ch-bp15xfnp706tl****</HostName>
<InstanceNumberROSlave>1</InstanceNumberROSlave>
<AllocationStatus>Suspended</AllocationStatus>
<ZoneId>cn-hangzhou-e</ZoneId>
<RequestId>D6E068C3-25BC-455A-85FE-45F0B22E1234</RequestId>
<MemAllocationRatio>90</MemAllocationRatio>
<VPCId>vpc-bp1roz55mrbj3ka1s****</VPCId>
<InstanceNumberROMaster>1</InstanceNumberROMaster>
<VSwitchId> vsw-bp133c8ifzxd3iv6q****</VSwitchId>
<AccountType>Admin</AccountType>
<InstanceNumberMaster>1</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": "200",
    "DiskAllocationRatio": "200",
    "InstanceNumber": "1",
    "DedicatedHostId": "ch-bp10a5id3boqi****",
    "CreatedTime": "2021-11-13T07:14:22Z",
    "DedicatedHostGroupId": "dhg-34639v1jt4y4****",
    "AutoRenew": "Null",
    "ImageCategory": "WindowsWithMssqlStdLicense",
    "HostStorage": "100",
    "InstanceNumberSlave": "1",
    "OpenPermission": "1",
    "HostType": "dhg_cloud_ssd",
    "ExpiredTime": "2021-11-13T07:14:22Z",
    "HostMem": "2048",
    "MemoryUsed": "24576",
    "HostStatus": "1",
    "CpuUsed": "2",
    "HostName": "ch-bp15xfnp706tl****",
    "InstanceNumberROSlave": "1",
    "AllocationStatus": "Suspended",
    "ZoneId": "cn-hangzhou-e",
    "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22E1234",
    "MemAllocationRatio": "90",
    "VPCId": "vpc-bp1roz55mrbj3ka1s****",
    "InstanceNumberROMaster": "1",
    "VSwitchId": " vsw-bp133c8ifzxd3iv6q****",
    "AccountType": "Admin",
    "InstanceNumberMaster": "1",
    "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.