Queries the information about one or more dedicated host clusters.
Operation description
Usage notes
You can specify multiple request parameters to filter query results. Specified request 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 ([]), this parameter is regarded as a valid filter condition and an empty result is returned.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ecs:DescribeDedicatedHostClusters | get | *DedicatedHostCluster acs:ecs:{#regionId}:{#accountId}:ddhcluster/{#ddhclusterId}*DedicatedHostCluster acs:ecs:{#regionId}:{#accountId}:ddhcluster/* |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Status | string | No | Note
This parameter is unavailable for use.
| null |
| LockReason | string | No | Note
This parameter is unavailable for use.
| null |
| ResourceGroupId | string | No | 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**** |
| Tag | array<object> | No | The tags of the dedicated host cluster. | |
| object | No | |||
| Key | string | No | 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. The tag key can be up to 64 characters in length and cannot contain If you specify a single tag to query resources, up to 1,000 resources to which the tag is added are returned. If you specify multiple tags to query resources, up to 1,000 resources to which all specified tags are added are returned. To query more than 1,000 resources that have specified tags added, call the ListTagResources operation. | TestKey |
| Value | string | No | 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. The tag value can be up to 64 characters in length and cannot contain | 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 most recent zone list. | cn-hangzhou-f |
| DedicatedHostClusterIds | string | No | 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-bp12wlf6am0vz9v2****", "dc-bp12wlf6am0vz9v3****"] |
| DedicatedHostClusterName | string | No | The name of the dedicated host cluster. | myDDHCluster |
| PageNumber | integer | No | The page number. Pages start from page 1. Default value: 1. | 1 |
| PageSize | integer | No | The number of entries per page. Valid values: 1 to 100. Default value: 10. | 5 |
Response parameters
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 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. | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|