All Products
Search
Document Center

Elastic Compute Service:DescribeDedicatedHostClusters

Last Updated:Mar 19, 2024

Queries the details of one or more dedicated host clusters.

Operation 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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
StatusstringNo
Note This parameter is unavailable for use.
null
LockReasonstringNo
Note This parameter is unavailable for use.
null
ResourceGroupIdstringNo

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.
rg-bp67acfmxazb4p****
Tagobject []No

The list of the tags.

KeystringNo

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 acs: or aliyun. It cannot contain http:// or https://.

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.

TestKey
ValuestringNo

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 acs: or aliyun. It cannot contain http:// or https://.

TestValue
RegionIdstringYes

The region ID of the dedicated host cluster. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
ZoneIdstringNo

The zone ID of the dedicated host cluster. You can call the DescribeZones operation to query the most recent zone list.

cn-hangzhou-f
DedicatedHostClusterIdsstringNo

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 ["dc-xxxxxxxxx", "dc-yyyyyyyyy", ... "dc-zzzzzzzzz"]. Separate the IDs with commas (,).

["dc-bp12wlf6am0vz9v2****", "dc-bp12wlf6am0vz9v3****"]
DedicatedHostClusterNamestringNo

The name of the dedicated host cluster.

myDDHCluster
PageNumberintegerNo

The number of the page to return.

Pages start from page 1.

Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page.

Maximum value: 100.

Default value: 10.

5

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries returned per page.

5
RequestIdstring

The ID of the request.

214A2187-B06F-4E49-A081-4D053466A8C7
PageNumberinteger

The page number of the returned page.

1
TotalCountinteger

The total number of dedicated host clusters.

2
DedicatedHostClustersobject []

Details about the dedicated host clusters.

Descriptionstring

The description of the dedicated host cluster.

This-is-my-DDHCluster
DedicatedHostClusterIdstring

The ID of the dedicated host cluster.

dc-bp12wlf6am0vz9v2****
ResourceGroupIdstring

The ID of the resource group to which the dedicated host cluster belongs.

rg-bp67acfmxazb4p****
ZoneIdstring

The zone ID of the dedicated host cluster.

cn-hangzhou-f
RegionIdstring

The region ID of the dedicated host cluster.

cn-hangzhou
DedicatedHostClusterNamestring

The name of the dedicated host cluster.

myDDHCluster
Tagsobject []

The tags of the dedicated host cluster.

TagValuestring

The tag value of the dedicated host cluster.

TestValue
TagKeystring

The tag key of the dedicated host cluster.

TestKey
DedicatedHostIdsarray

The IDs of dedicated hosts in the dedicated host cluster.

string

The IDs of dedicated hosts in the dedicated host cluster.

["dh-bp181e5064b5sotr****","dh-bp18064b5sotrr9c****"]
DedicatedHostClusterCapacityobject

The capacity of the dedicated host cluster.

AvailableVcpusinteger

The number of available vCPUs.

2
AvailableMemoryinteger

The size of available memory. Unit: GiB.

4
TotalMemoryinteger

The total memory size. Unit: GiB.

8
TotalVcpusinteger

The total number of vCPUs.

4
LocalStorageCapacitiesobject []

The local storage capacity.

DataDiskCategorystring

The category of the data disk. Valid values:

  • cloud: basic disk
  • cloud_efficiency: ultra disk
  • cloud_ssd: standard SSD
  • ephemeral_ssd: local SSD
  • cloud_essd: enhanced SSD (ESSD)
cloud
AvailableDiskinteger

The available capacity of the local disk. Unit: GiB.

20
TotalDiskinteger

The total capacity of the local disk. Unit: GiB.

40
AvailableInstanceTypesobject []

The available capacity of the Elastic Compute Service (ECS) instance types in the dedicated host cluster.

InstanceTypestring

The ECS instance type.

ecs.c6.26xlarge
AvailableInstanceCapacityinteger

The available capacity of the ECS instance type.

0

Examples

Sample success responses

JSONformat

{
  "PageSize": 5,
  "RequestId": "214A2187-B06F-4E49-A081-4D053466A8C7",
  "PageNumber": 1,
  "TotalCount": 2,
  "DedicatedHostClusters": {
    "DedicatedHostCluster": [
      {
        "Description": "This-is-my-DDHCluster",
        "DedicatedHostClusterId": "dc-bp12wlf6am0vz9v2****",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "ZoneId": "cn-hangzhou-f",
        "RegionId": "cn-hangzhou",
        "DedicatedHostClusterName": "myDDHCluster",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "DedicatedHostIds": {
          "DedicatedHostId": [
            "[\"dh-bp181e5064b5sotr****\",\"dh-bp18064b5sotrr9c****\"]"
          ]
        },
        "DedicatedHostClusterCapacity": {
          "AvailableVcpus": 2,
          "AvailableMemory": 4,
          "TotalMemory": 8,
          "TotalVcpus": 4,
          "LocalStorageCapacities": {
            "LocalStorageCapacity": [
              {
                "DataDiskCategory": "cloud",
                "AvailableDisk": 20,
                "TotalDisk": 40
              }
            ]
          },
          "AvailableInstanceTypes": {
            "AvailableInstanceType": [
              {
                "InstanceType": "ecs.c6.26xlarge",
                "AvailableInstanceCapacity": 0
              }
            ]
          }
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400MissingParamter.RegionIdThe regionId should not be null.The RegionId parameter is required.
400InvalidParameter.DedicatedHostClusterIdsThe specified parameter dedicatedHostClusterIds is not valid.-
400InvalidRegion.NotFoundThe specified parameter RegionId is not valid.The specified RegionId parameter is invalid.
400InvalidZone.NotFoundThe specified parameter ZoneId is not valid.The specified ZoneId parameter is invalid.
403InvalidDedicatedHostIds.MalformedThe amount of specified dedicatedHostClusterIds exceeds the limit.-

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