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

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.

RegionId String No cn-hangzhou

The ID of the region.

DedicatedHostId String Yes ch-bp10a5id3boqi****

The ID of the host. You can log on to the ApsaraDB MyBase console and go to the Hosts page to view the host ID.

DedicatedHostGroupId String Yes dhg-34639v1jt4y4****

The ID of the dedicated cluster in which the host is deployed. You can log on to the ApsaraDB MyBase console and go to the Dedicated Clusters page to view the dedicated cluster ID.

Response parameters

Parameter Type Example Description
HostType String dhg_cloud_ssd

The storage type of the host. Valid values:

  • dhg_cloud_ssd or dhg_cloud_essd: enhanced SSD (ESSD)
  • dhg_local_ssd: local SSD
HostStorage Integer 100

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

InstanceNumberROSlave Integer 1

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

AccountType String Admin

The type of the host account. Valid values:

  • Normal: standard account
  • Admin: administrator account
MemoryUsed String 24576

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

DedicatedHostGroupId String dhg-34639v1jt4y4****

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

RequestId String 00A001D6-2630-5CBD-A23C-80BC1BAFDC31

The ID of the request.

InstanceNumberROMaster Integer 1

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

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.
StorageUsed String 588800

The storage usage of the host. Unit: GB.

EcsClassCode String ecs.r5.16xlarge

The instance type of the Elastic Compute Service (ECS) instance.

DedicatedHostId String ch-bp10a5id3boqi****

The ID of the host.

MemAllocationRatio String 90

The memory usage of the host. Unit: %.

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.

IPAddress String 192.168.XX.XX

The IP address of the host.

AutoRenew String false

Indicates whether auto-renewal is enabled on the host. Default value: false. Valid values:

  • true: Auto-renewal is enabled.
  • false: Auto-renewal is disabled.
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 disabling.
  • 4: The host is being maintained.
  • 5: The host is disabled.
  • 6: The host is restarting.
  • 7: The host is locked.
Note When a host fails, the host is disabled. Before the host is disabled, 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.
HostName String ch-8vbj9x74z874o****

The name of the host.

HostCPU Integer 16

The number of CPU cores of the host.

OpenPermission String 1

Indicates whether the feature that allows you to have OS permissions on the hosts in the dedicated cluster is enabled.

  • 0: The feature is disabled.
  • 1: The feature is enabled.
InstanceNumber Integer 3

The number of instances created on the host.

CpuUsed String 36

The number of CPU cores used by the host.

VPCId String vpc-wz9vu1jb32wn3sdd6****

The ID of the virtual private cloud (VPC) where the host is created.

HostClass String mssql.host.c2xlarge

The instance type of the host.

RegionId String cn-hangzhou

The ID of the region.

InstanceNumberMaster Integer 4

The number of primary instances created on the host.

VSwitchId String vsw-bp1kaugqyrzb58oc1****

The ID of the vSwitch.

InstanceNumberSlave Integer 1

The number of secondary instances created on the host.

ExpiredTime String 2022-03-16T16:00:00Z

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.

ZoneId String cn-hangzhou-h

The ID of the zone.

CPUAllocationRatio String 200

The CPU overcommit ratio of the dedicated cluster. Unit: %. The value is accurate to the tens digit.

ImageCategory String WindowsWithMssqlStdLicense

The image of the host. This parameter is returned if the database engine is SQL Server. Valid values:

  • WindowsWithMssqlEntAlwaysonLicense: SQL Server Enterprise Edition AlwaysOn
  • WindowsWithMssqlStdLicense: SQL Server Standard Edition
  • WindowsWithMssqlEntLicense: SQL Server Enterprise Edition
  • WindowsWithMssqlWebLicense: SQL Server Web Edition
DiskAllocationRatio String 200

The storage overcommit ratio of the dedicated cluster.

HostMem Integer 2048

The amount of memory of the host. Unit: MB.

AccountName String cdp_system

The name of the host account.

  • The name can contain lowercase letters, digits, and underscores (_).
  • The name must start with a lowercase letter and end with a lowercase letter or a digit.
  • The name must be 2 to 16 characters in length.
DistributionTag String tag

The distribution tag of the host.

Examples

Sample requests

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

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDedicatedHostAttributeResponse>
    <HostType>dhg_cloud_ssd</HostType>
    <HostStorage>100</HostStorage>
    <InstanceNumberROSlave>1</InstanceNumberROSlave>
    <AccountType>Admin</AccountType>
    <MemoryUsed>24576</MemoryUsed>
    <DedicatedHostGroupId>dhg-34639v1jt4y4****</DedicatedHostGroupId>
    <RequestId>00A001D6-2630-5CBD-A23C-80BC1BAFDC31</RequestId>
    <InstanceNumberROMaster>1</InstanceNumberROMaster>
    <AllocationStatus>Suspended</AllocationStatus>
    <StorageUsed>588800</StorageUsed>
    <EcsClassCode>ecs.r5.16xlarge</EcsClassCode>
    <DedicatedHostId>ch-bp10a5id3boqi****</DedicatedHostId>
    <MemAllocationRatio>90</MemAllocationRatio>
    <CreatedTime>2021-11-13T07:14:22Z</CreatedTime>
    <IPAddress>192.168.XX.XX</IPAddress>
    <AutoRenew>false</AutoRenew>
    <HostStatus>1</HostStatus>
    <HostName>ch-8vbj9x74z874o****</HostName>
    <HostCPU>16</HostCPU>
    <OpenPermission>1</OpenPermission>
    <InstanceNumber>3</InstanceNumber>
    <CpuUsed>36</CpuUsed>
    <VPCId>vpc-wz9vu1jb32wn3sdd6****</VPCId>
    <HostClass>mssql.host.c2xlarge</HostClass>
    <RegionId>cn-hangzhou</RegionId>
    <InstanceNumberMaster>4</InstanceNumberMaster>
    <VSwitchId>vsw-bp1kaugqyrzb58oc1****</VSwitchId>
    <InstanceNumberSlave>1</InstanceNumberSlave>
    <ExpiredTime>2022-03-16T16:00:00Z</ExpiredTime>
    <ZoneId>cn-hangzhou-h</ZoneId>
    <CPUAllocationRatio>200</CPUAllocationRatio>
    <ImageCategory>WindowsWithMssqlStdLicense</ImageCategory>
    <DiskAllocationRatio>200</DiskAllocationRatio>
    <HostMem>2048</HostMem>
    <AccountName>cdp_system</AccountName>
    <DistributionTag>tag</DistributionTag>
</DescribeDedicatedHostAttributeResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "HostType" : "dhg_cloud_ssd",
  "HostStorage" : 100,
  "InstanceNumberROSlave" : 1,
  "AccountType" : "Admin",
  "MemoryUsed" : "24576",
  "DedicatedHostGroupId" : "dhg-34639v1jt4y4****",
  "RequestId" : "00A001D6-2630-5CBD-A23C-80BC1BAFDC31",
  "InstanceNumberROMaster" : 1,
  "AllocationStatus" : "Suspended",
  "StorageUsed" : "588800",
  "EcsClassCode" : "ecs.r5.16xlarge",
  "DedicatedHostId" : "ch-bp10a5id3boqi****",
  "MemAllocationRatio" : "90",
  "CreatedTime" : "2021-11-13T07:14:22Z",
  "IPAddress" : "192.168.XX.XX",
  "AutoRenew" : "false",
  "HostStatus" : "1",
  "HostName" : "ch-8vbj9x74z874o****",
  "HostCPU" : 16,
  "OpenPermission" : "1",
  "InstanceNumber" : 3,
  "CpuUsed" : "36",
  "VPCId" : "vpc-wz9vu1jb32wn3sdd6****",
  "HostClass" : "mssql.host.c2xlarge",
  "RegionId" : "cn-hangzhou",
  "InstanceNumberMaster" : 4,
  "VSwitchId" : "vsw-bp1kaugqyrzb58oc1****",
  "InstanceNumberSlave" : 1,
  "ExpiredTime" : "2022-03-16T16:00:00Z",
  "ZoneId" : "cn-hangzhou-h",
  "CPUAllocationRatio" : "200",
  "ImageCategory" : "WindowsWithMssqlStdLicense",
  "DiskAllocationRatio" : "200",
  "HostMem" : 2048,
  "AccountName" : "cdp_system",
  "DistributionTag" : "tag"
}

Error codes

HTTP status code 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 prohibited.
403 Permission.NotSupport The user permission does not support the operation. The error message returned because you are not authorized to perform this operation.

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