You need to enable JavaScript to run this app.
Elastic Compute Service

Elastic Compute Service

Copy page
Download PDF
proprietary host
DescribeDedicatedHostClusters - Queries DDH cluster information
Copy page
Download PDF
DescribeDedicatedHostClusters - Queries DDH cluster information
Call the DescribeDedicatedHostClusters operation to query detailed information about one or multiple DDH clusters.​
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.
​
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: DescribeDedicatedHostClusters​
The action that you want to perform. Value: DescribeDedicatedHostClusters.​
​
Version string required Sample value: 2020-04-01​
The API version. Valid value: 2020-04-01.​
​
DedicatedHostClusterIds.N string[] Optional Sample value: DedicatedHostClusterIds.1=dc-ycle6b76kgv2wrsm****&DedicatedHostClusterIds.2=dc-yclc1jr9j4arsp3j****​
The ID of the DDH cluster. A maximum of 10 IDs is supported.​
  • Parameter - N: indicates the serial number of the DDH cluster.​
  • Separate multiple cluster IDs with ampersands (&).​
​
DedicatedHostClusterName string Optional Sample value: DDH-Cluster01​
The name of the DDH cluster.​
  • Can not start with a number, a hyphen (-), or an underscore (_).​
  • Only Chinese, letters, numbers, underscores and hyphens are allowed.​
  • The length limit is 1 to 128 characters.​
  • Special characters are currently not supported.​
​
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.​
​
ZoneId string Optional Sample value: cn-beijing-a​
The ID of the availability zone where the DDH cluster is deployed.​​
​
​
​
Response parameters​
Only the response parameters specific to this operation are listed below. For more information, refer to the response structure.​
DedicatedHostClusters object[] Sample value: --​
The information of the DDH cluster.​
CreatedAt string Sample value: 2023-08-11T10:30:25+08:00​
The creation time of the DDH cluster.​
​
DedicatedHostClusterCapacity object Sample value: --​
The capacity information of the DDH cluster.​
LocalVolumeCapacities object[] Sample value: --​
Information about the local volume capacity within the DDH cluster.​
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​
​
​
AvailableInstanceTypes object[] Sample value: --​
The available capacity of ECS instance types within the DDH cluster.​
AvailableCapacity integer Sample value: 58​
The available capacity of the instance types.​
​
InstanceType string Sample value: ecs.ddhr2s.define.c4m16​
Instance type​
​
​
AvailableMemory integer Sample value: 441​
The available memory size. Unit: GiB.​
​
AvailableVcpus integer Sample value: 951296​
Number of available vCPUs.​
​
TotalMemory integer Sample value: 972800​
The total memory size. Unit: GiB.​
​
TotalVcpus integer Sample value: 448​
The total number of vCPUs.​
​
​
DedicatedHostClusterId string Sample value: dc-ycle6b76kgv2wrsm****​
The ID of the dedicated host cluster.​
​
DedicatedHostClusterName string Sample value: DDH-Cluster01​
The name of the DDH cluster.​
​
DedicatedHostIds string[] Sample value: ["dh-3tigy72q3u3vj0x2****","dh-ycje2rquioh9l3bn****"]​
Dedicated host ID.​
​
Description string Sample value: Dedicated Host Cluster for testing.​
The description of the DDH cluster.​
​
UpdatedAt string Sample value: 2023-08-11T10:30:25+08:00​
The update time of the DDH cluster.​
​
ZoneId string Sample value: cn-beijing-a​
The ID of the availability zone where the DDH cluster is deployed.​​
​
​
NextToken string Sample value: eWNsYTg0b2s1Y3Yyd3Jzb2do****​
The query credentials value returned by this call. If null is returned, this page is the last page.​
​
​
​
Sample request​
​
GET /?Action=DescribeDedicatedHostClusters&Version=2020-04-01 HTTP/1.1​
Host: ecs.cn-beijing.volcengineapi.com​
Region: cn-beijing​
Service: ecs​
​
Sample response​
​
{​
"ResponseMetadata": {​
"RequestId": "2023071716274123B73A705E255110****",​
"Action": "DescribeDedicatedHostClusters",​
"Version": "2020-04-01",​
"Service": "ecs",​
"Region": "cn-beijing"​
},​
"Result": {​
"DedicatedHostClusters": [​
{​
"CreatedAt": "2023-08-11T10:30:25+08:00",​
"UpdatedAt": "2023-08-11T10:30:25+08:00",​
"DedicatedHostClusterId": "dc-ycle6b76kgv2wrsm****",​
"ZoneId": "cn-beijing-a",​
"DedicatedHostClusterName": "DDH-Cluster01",​
"Description": "Dedicated Host Cluster for testing.",​
"DedicatedHostIds": [​
"dh-3tigy72q3u3vj0x2***"​
],​
"DedicatedHostClusterCapacity": {​
"TotalVcpus": 448,​
"AvailableVcpus": 441,​
"TotalMemory": 972800,​
"AvailableMemory": 951296,​
"LocalVolumeCapacities": [ ],​
"AvailableInstanceTypes": [​
{​
"InstanceType": "ecs.ddhr2s.define.c4m16",​
"AvailableCapacity": 58​
},​
{​
"InstanceType": "ecs.ddhr2s.define.c8m16",​
"AvailableCapacity": 55​
}​
]​
}​
}​
],​
"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.MaximumDedicatedHostClusterIds​
The number of specified DedicatedHostClusterIds exceeds the maximum limit.​
The number of specified DDH cluster IDs (DedicatedHostClusterIds) 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:50