Queries the details of one or more dedicated host clusters.
Description
You can specify multiple request parameters to be queried. Specified parameters have logical AND relations. Only the specified parameters are included in the filter conditions. However, if DedicatedHostClusterIds
is set to an empty JSON array ([]
), it is regarded as a valid filter condition and an empty result is returned.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeDedicatedHostClusters | The operation that you want to perform. Set the value to DescribeDedicatedHostClusters. |
Status | String | No | null | Note This parameter is unavailable for use. |
LockReason | String | No | null | Note This parameter is unavailable for use. |
ResourceGroupId | String | No | rg-bp67acfmxazb4p**** | The ID of the resource group to which the dedicated host cluster belongs. If this parameter is specified to query resources, up to 1,000 resources that belong to the specified resource group can be displayed in the response. Note Resources in the default resource group are displayed in the response regardless of how this parameter is set. |
Tag.N.Key | String | No | TestKey | The key of tag N of the dedicated host cluster. Valid values of N: 1 to 20. The tag key cannot be an empty string. It can be up to 64 characters in length and cannot start with If a single tag is specified to query resources, up to 1,000 resources that have this tag added can be displayed in the response. If multiple tags are specified to query resources, up to 1,000 resources that have all these tags added can be displayed in the response. To query more than 1,000 resources that have specified tags added, call the ListTagResources operation. |
Tag.N.Value | String | No | TestValue | The value of tag N of the dedicated host cluster. Valid values of N: 1 to 20. The tag value cannot be an empty string. It can be up to 64 characters in length and cannot start with |
RegionId | String | Yes | cn-hangzhou | The region ID of the dedicated host cluster. You can call the DescribeRegions operation to query the most recent region list. |
ZoneId | String | No | cn-hangzhou-f | The zone ID of the dedicated host cluster. You can call the DescribeZones operation to query the most recent zone list. |
DedicatedHostClusterIds | String | No | ["dc-bp12wlf6am0vz9v2****", "dc-bp12wlf6am0vz9v3****"] | The IDs of dedicated host clusters. The value can be a JSON array that consists of up to 100 dedicated host cluster IDs in the format of |
DedicatedHostClusterName | String | No | myDDHCluster | The name of the dedicated host cluster. |
PageNumber | Integer | No | 1 | The number of the page to return. Pages start from page 1. Default value: 1. |
PageSize | Integer | No | 5 | The number of entries to return on each page. Maximum value: 100 Default value: 10. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
PageSize | Integer | 5 | The number of entries returned per page. |
RequestId | String | 214A2187-B06F-4E49-A081-4D053466A8C7 | The ID of the request. |
PageNumber | Integer | 1 | The page number of the returned page. |
TotalCount | Integer | 2 | The total number of dedicated host clusters. |
DedicatedHostClusters | Array of DedicatedHostCluster | Details about the dedicated host clusters. | |
DedicatedHostCluster | |||
Description | String | This-is-my-DDHCluster | The description of the dedicated host cluster. |
DedicatedHostClusterId | String | dc-bp12wlf6am0vz9v2**** | The ID of the dedicated host cluster. |
ResourceGroupId | String | rg-bp67acfmxazb4p**** | The ID of the resource group to which the dedicated host cluster belongs. |
ZoneId | String | cn-hangzhou-f | The zone ID of the dedicated host cluster. |
RegionId | String | cn-hangzhou | The region ID of the dedicated host cluster. |
DedicatedHostClusterName | String | myDDHCluster | The name of the dedicated host cluster. |
Tags | Array of Tag | The tags of the dedicated host cluster. | |
Tag | |||
TagValue | String | TestValue | The tag value of the dedicated host cluster. |
TagKey | String | TestKey | The tag key of the dedicated host cluster. |
DedicatedHostIds | Array of String | ["dh-bp181e5064b5sotr****","dh-bp18064b5sotrr9c****"] | The IDs of dedicated hosts in the dedicated host cluster. |
DedicatedHostClusterCapacity | Object | The capacity of the dedicated host cluster. | |
AvailableVcpus | Integer | 2 | The number of available vCPUs. |
AvailableMemory | Integer | 4 | The size of available memory. Unit: GiB. |
TotalMemory | Integer | 8 | The total memory size. Unit: GiB. |
TotalVcpus | Integer | 4 | The total number of vCPUs. |
LocalStorageCapacities | Array of LocalStorageCapacity | The local storage capacity. | |
LocalStorageCapacity | |||
DataDiskCategory | String | cloud | The category of the data disk. Valid values:
|
AvailableDisk | Integer | 20 | The available capacity of the local disk. Unit: GiB. |
TotalDisk | Integer | 40 | The total capacity of the local disk. Unit: GiB. |
AvailableInstanceTypes | Array of AvailableInstanceType | The available capacity of the Elastic Compute Service (ECS) instance types in the dedicated host cluster. | |
AvailableInstanceType | |||
InstanceType | String | ecs.c6.26xlarge | The ECS instance type. |
AvailableInstanceCapacity | Integer | 0 | The available capacity of the ECS instance type. |
Examples
Sample requests
https://ecs.aliyuncs.com/?Action=DescribeDedicatedHostClusters
&RegionId=cn-hangzhou
&ZoneId=cn-hangzhou-f
&DedicatedHostClusterName=myDDHCluster
&PageNumber=1
&PageSize=5
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDedicatedHostClustersResponse>
<PageSize>5</PageSize>
<RequestId>214A2187-B06F-4E49-A081-4D053466A8C7</RequestId>
<PageNumber>1</PageNumber>
<TotalCount>2</TotalCount>
<DedicatedHostClusters>
<Description>This-is-my-DDHCluster</Description>
<DedicatedHostClusterId>dc-bp12wlf6am0vz9v2****</DedicatedHostClusterId>
<ResourceGroupId>rg-bp67acfmxazb4p****</ResourceGroupId>
<ZoneId>cn-hangzhou-f</ZoneId>
<RegionId>cn-hangzhou</RegionId>
<DedicatedHostClusterName>myDDHCluster</DedicatedHostClusterName>
<Tags>
<TagValue>TestValue</TagValue>
<TagKey>TestKey</TagKey>
</Tags>
<DedicatedHostIds>dh-bp181e5064b5sotr****</DedicatedHostIds>
<DedicatedHostClusterCapacity>
<AvailableVcpus>2</AvailableVcpus>
<AvailableMemory>4</AvailableMemory>
<TotalMemory>8</TotalMemory>
<TotalVcpus>4</TotalVcpus>
<LocalStorageCapacities>
<DataDiskCategory>cloud</DataDiskCategory>
<AvailableDisk>20</AvailableDisk>
<TotalDisk>40</TotalDisk>
</LocalStorageCapacities>
<AvailableInstanceTypes>
<InstanceType>ecs.c6.26xlarge</InstanceType>
<AvailableInstanceCapacity>0</AvailableInstanceCapacity>
</AvailableInstanceTypes>
</DedicatedHostClusterCapacity>
</DedicatedHostClusters>
</DescribeDedicatedHostClustersResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"PageSize" : 5,
"RequestId" : "214A2187-B06F-4E49-A081-4D053466A8C7",
"PageNumber" : 1,
"TotalCount" : 2,
"DedicatedHostClusters" : [ {
"Description" : "This-is-my-DDHCluster",
"DedicatedHostClusterId" : "dc-bp12wlf6am0vz9v2****",
"ResourceGroupId" : "rg-bp67acfmxazb4p****",
"ZoneId" : "cn-hangzhou-f",
"RegionId" : "cn-hangzhou",
"DedicatedHostClusterName" : "myDDHCluster",
"Tags" : [ {
"TagValue" : "TestValue",
"TagKey" : "TestKey"
} ],
"DedicatedHostIds" : [ "dh-bp181e5064b5sotr****" ],
"DedicatedHostClusterCapacity" : {
"AvailableVcpus" : 2,
"AvailableMemory" : 4,
"TotalMemory" : 8,
"TotalVcpus" : 4,
"LocalStorageCapacities" : [ {
"DataDiskCategory" : "cloud",
"AvailableDisk" : 20,
"TotalDisk" : 40
} ],
"AvailableInstanceTypes" : [ {
"InstanceType" : "ecs.c6.26xlarge",
"AvailableInstanceCapacity" : 0
} ]
}
} ]
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | MissingParamter.RegionId | The regionId should not be null. | The error message returned because the RegionId parameter is not specified. |
400 | InvalidRegion.NotFound | The specified parameter RegionId is not valid. | The error message returned because the specified RegionId parameter is invalid. |
400 | InvalidZone.NotFound | The specified parameter ZoneId is not valid. | The error message returned because the specified ZoneId parameter is invalid. |
For a list of error codes, visit the API Error Center.