All Products
Search
Document Center

Elastic Compute Service:DescribeDedicatedHostClusters

Last Updated:Oct 16, 2026

Queries the details of one or more dedicated host clusters.

Operation description

Operation description

Request parameters act as filters and are connected by the logical AND operator. If a parameter is left empty, the filter does not take effect. However, if the DedicatedHostClusterIds parameter is set to an empty JSON array, namely [], the filter is considered valid and an empty result is returned.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeDedicatedHostClusters

get

DedicatedHostCluster

acs:ecs:{#regionId}:{#accountId}:ddhcluster/{#ddhclusterId}

DedicatedHostCluster

acs:ecs:{#regionId}:{#accountId}:ddhcluster/*

None None

Request parameters

Parameter

Type

Required

Description

Example

Status

string

No

Note

This parameter is not available and is not supported.

null

LockReason

string

No

Note

This parameter is not available and is not supported.

null

ResourceGroupId

string

No

The ID of the resource group to which the dedicated host cluster belongs. When you use this parameter to filter resources, the resource count cannot exceed 1,000.

Note

Filtering by the default resource group is not supported.

rg-bp67acfmxazb4p****

Tag

array<object>

No

The list of tags.

object

No

The list of tags.

Key

string

No

The tag key of the dedicated host cluster. Valid values of N: 1 to 20. If you specify this parameter, it cannot be an empty string. The tag key can be up to 64 characters in length, and cannot start with aliyun or acs:, or contain http:// or https://.

When you use a single tag to filter resources, the resource count returned cannot exceed 1,000. When you use multiple tags to filter resources, the resource count of resources attached to all the specified tags cannot exceed 1,000. If the resource count exceeds 1,000, call the ListTagResources operation to query the resources.

TestKey

Value

string

No

The tag value of the dedicated host cluster. Valid values of N: 1 to 20. If you specify this parameter, it cannot be an empty string. The tag value can be up to 64 characters in length, and cannot contain http:// or https://.

TestValue

RegionId

string

Yes

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

cn-hangzhou

ZoneId

string

No

The zone ID of the dedicated host cluster. You can call the DescribeZones operation to query the zones in a region.

cn-hangzhou-f

DedicatedHostClusterIds

string

No

The list of dedicated host cluster IDs. The value can be a JSON array that consists of multiple dedicated host cluster IDs in the following format: ["dc-xxxxxxxxx", "dc-yyyyyyyyy", ..., "dc-zzzzzzzzz"]. You can specify up to 100 IDs. Separate multiple IDs with commas (,).

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

DedicatedHostClusterName

string

No

The name of the dedicated host cluster.

myDDHCluster

PageNumber

integer

No

The page number of the dedicated host cluster list.

Starting value: 1.

Default value: 1.

1

PageSize

integer

No

The paging Settings for the number of entries per page in a paged query.

Maximum value: 100.

Default value: 10.

5

Response elements

Element

Type

Description

Example

object

PageSize

integer

The number of entries returned per page.

5

RequestId

string

The request ID.

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

PageNumber

integer

The page number of the dedicated host cluster list.

1

TotalCount

integer

The total number of dedicated hosts.

2

DedicatedHostClusters

object

DedicatedHostCluster

array<object>

The array of dedicated host clusters.

array<object>

Description

string

The description of the dedicated host cluster.

This-is-my-DDHCluster

DedicatedHostClusterId

string

The ID of the dedicated host cluster.

dc-bp12wlf6am0vz9v2****

ResourceGroupId

string

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

rg-bp67acfmxazb4p****

ZoneId

string

The zone ID of the dedicated host cluster.

cn-hangzhou-f

RegionId

string

The region ID of the dedicated host cluster.

cn-hangzhou

DedicatedHostClusterName

string

The name of the dedicated host cluster.

myDDHCluster

Tags

object

Tag

array<object>

The tags of the dedicated host cluster.

object

TagValue

string

The tag value of the dedicated host cluster.

TestValue

TagKey

string

The tag key of the dedicated host cluster.

TestKey

DedicatedHostIds

object

DedicatedHostId

array

The list of dedicated host IDs in the dedicated host cluster.

string

The ID of the dedicated host.

dh-bp181e5064b5sotr****

DedicatedHostClusterCapacity

object

The capacity of the dedicated host cluster.

AvailableVcpus

integer

The number of available vCPUs.

2

AvailableMemory

integer

The available memory size. Unit: GiB.

4

TotalMemory

integer

The total memory size. Unit: GiB.

8

TotalVcpus

integer

The total number of vCPUs.

4

LocalStorageCapacities

object

LocalStorageCapacity

array<object>

The local storage capacity.

object

DataDiskCategory

string

The data disk category. Valid values:

  • cloud: basic disk.

  • cloud_efficiency: ultra disk.

  • cloud_ssd: standard SSD.

  • ephemeral_ssd: local SSD.

  • cloud_essd: enterprise SSD.

cloud

AvailableDisk

integer

The available local disk size. Unit: GiB.

20

TotalDisk

integer

The total local disk size. Unit: GiB.

40

AvailableInstanceTypes

object

AvailableInstanceType

array<object>

The available capacity of ECS instance types in the dedicated host cluster.

object

InstanceType

string

The instance type.

ecs.c6.26xlarge

AvailableInstanceCapacity

integer

The available capacity of the instance type.

0

Examples

Success response

JSON format

{
  "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****"
          ]
        },
        "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 code

Error code

Error message

Description

400 MissingParamter.RegionId The regionId should not be null. The RegionId parameter is required.
400 InvalidParameter.DedicatedHostClusterIds The specified parameter dedicatedHostClusterIds is not valid.
400 InvalidRegion.NotFound The specified parameter RegionId is not valid. The specified RegionId parameter is invalid.
400 InvalidZone.NotFound The specified parameter ZoneId is not valid. The specified ZoneId parameter is invalid.
403 InvalidDedicatedHostIds.Malformed The amount of specified dedicatedHostClusterIds exceeds the limit.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.