Docs

Elastic Compute Service

proprietary host

DescribeDedicatedHosts - Queries DDH information

Call the DescribeDedicatedHosts operation to fetch detailed information about one or multiple DDH, including status, expiration time, and the list of created instances.

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Only the request parameters specific to this operation and some common parameters are listed below. For more information, refer to Common parameters.

Action string required Sample value: DescribeDedicatedHosts

The action that you want to perform. Value: DescribeDedicatedHosts.

Version string requiredSample value: 2020-04-01

The API version. Valid value: 2020-04-01.

DedicatedHostClusterId string Optional Sample value: dc-ycle6b76kgv2wrsm****

The ID of the cluster to which the DDH belongs.

DedicatedHostIds.N string[] Optional Sample value: DedicatedHostIds.1=dh-3tigy72q3u3vj0x2****&DedicatedHostIds.2=dh-ycje2rquioh9l3bn****

The DDH ID. A maximum of 100 IDs is supported.

Parameter - N: indicates the serial number of the DDH ID.

Separate multiple IDs with ampersands (&).

DedicatedHostName string Optional Sample value: dedicated-host-test

The name of the DDH. Fuzzy queries with keywords are supported.

DedicatedHostTypeId string Optional Sample value: ecs.ddhr2s

The DDH type.

MaxResults integer Optional Sample value: 10

The number of entries per page.

Maximum value: 100

Default value: 10

NextToken string Optional Sample value: --

Pagination token marking the query position. Omit this parameter for initial API requests. In the next query, set the NextToken parameter to the value returned by the previous API call.

Status string Optional Sample value: Available

The status of the DDH. Valid values:

Starting: DDH is being started

Available: DDH is available.

Stopping: DDH is being stopped

Stopped: DDH is stopped

Released: DDH is released

UnderAssessment: Potential risk exists

TempUnavailable: Temporarily unavailable

Pending: DDH is under maintenance

PermanentFailure: Permanent failure

Unknown: Unknown

ZoneId string Optional Samle value: cn-beijing-a

The ID of the availability zone where the DDH is deployed.

You can call DescribeZones to query the availability zone information within a region.

Response parameters

Only the response parameters specific to this operation are listed below. For more information, refer to the response structure.

DedicatedHosts object[] Sample value: --

The information of the DDH.

AutoPlacement string Sample value: Off

Indicates whether the DDH supports automatic deployment. Valid values:

On: Supports automatic deployment.

Off: Does not support automatic deployment.

Capacity object Sample value: --

The capacity information of the DDH.

LocalVolumeCapacities object[] Sample value: --

Information about the local volume capacity of the DDH.

AvailableSize integer Sample value: 64

The remaining capacity of the local volume. Unit: GiB.

TotalSize integer Sample value: 512

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

VolumeType string Sample value: LOCAL_SSD

The local volume type. Valid values:

LOCAL_SSD: local SSD

LOCAL_HDD: local HDD

AvailableMemory integer Sample value: 962560

The remaining memory size. Unit: MiB.

AvailableVcpus integer Sample value: 448

Number of available vCPUs.

TotalMemory integer Sample value: 962560

The total memory capacity. Unit: MiB.

TotalVcpus integer Sample value: 448

The total number of vCPUs.

ChargeType string Sample value: PrePaid

The billing method of the DDH. Valid values:

PrePaid: Subscription.

CpuOvercommitRatio float Sample value: 4

CPU oversubscription ratio.

CreatedAt string Sample value: 2022-06-28T18:29:38+08:00

The creation time of the DDH.

DedicatedHostClusterId string Sample value: dc-ycle6b76kgv2wrsm****

The ID of the DDH cluster.

DedicatedHostId string Sample value: dh-ycje2rquioh9l3bn****

Dedicated host ID.

DedicatedHostName string Sample value: dedicated-host-test

The name of the DDH.

DedicatedHostTypeId string Sample value: ecs.ddhr2s

The DDH type.

Description string Sample value: DDH for testing

The DDH description.

ExpiredAt string Sample value: 2022-07-28T18:29:38+08:00

The expiration time of the DDH.

HostRecovery string Sample value: Off

Indicates whether automatic migration is enabled when the DDH crashes. Valid values:

On: Automatic migration is enabled.

Off: Automatic migration is not enabled.

Instances object[] Sample value: --

Information about ECS instances deployed on the DDH.

InstanceId string Sample value: i-3tigy72q3u3vj0x2****

The instance ID.

InstanceTypeId string Sample value: ecs.ddhr2s.define.c1m1

Instance type.

Status string Sample value: Available

The status of the DDH.

UpdatedAt string Sample value: 2022-06-28T18:29:38+08:00

The update time of the DDH.

ZoneId string Sample value: cn-beijing-a

The ID of the availability zone where the DDH is deployed.

NextToken string Sample value: bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******

The query credentials value returned by this call. If null is returned, this page is the last page.

Sample request

GET /?Action=DescribeDedicatedHosts&Version=2020-04-01 HTTP/1.1​
Host: ecs.cn-beijing.volcengineapi.com​
Region: cn-beijing​
Service: ecs​

Sample response

{​
  "ResponseMetadata": {​
    "RequestId": "20230714173759DC17D8F861B10D4D****",​
    "Action": "DescribeDedicatedHosts",​
    "Version": "2020-04-01",​
    "Service": "ecs",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "DedicatedHosts": [​
      {​
        "CreatedAt": "2023-07-14T17:17:56+08:00",​
        "UpdatedAt": "2023-07-14T17:17:58+08:00",​
        "DedicatedHostId": "dh-ycje2rquioh9l3bn****",​
        "ZoneId": "cn-beijing-a",​
        "Status": "Available",​
        "DedicatedHostName": "dedicated-host-test",​
        "Description": "",​
        "AutoPlacement": "Off",​
        "HostRecovery": "Off",​
        "HostMaintenance": "Off",​
        "CpuOvercommitRatio": 4,​
        "Instances": [],​
        "Capacity": {​
          "TotalVcpus": 448,​
          "AvailableVcpus": 448,​
          "TotalMemory": 962560,​
          "AvailableMemory": 962560,​
          "LocalVolumeCapacities": []​
        },​
        "DedicatedHostTypeId": "ecs.ddhr2s",​
        "ChargeType": "PrePaid",​
        "ExpiredAt": "2023-08-14T23:59:59+08:00"​
      }​
    ],​
    "NextToken": "eWNsYTg0b2s1Y3Yyd3Jzb2do****"​
  }​
}​

Error codes

The table below lists the business-related error codes of the operation. For more information, refer to Common error codes.

Status code	Error code	Error message	Description
400	InvalidArgument	The specified argument is invalid.	The specified parameter is invalid.
400	LimitExceeded.MaximumDedicatedHostIds	The number of specified DedicatedHostIds exceeds the maximum limit.	The number of specified DDH IDs (DedicatedHostIds) exceeds the upper limit.
500	InternalError	An internal error has occurred.	An internal error occurred. Try again. If multiple attempts fail, submit a ticket.

Last updated: 2026.01.16 19:04:49