调用DescribeDedicatedHosts查询一台或多台专有宿主机的详细信息,包括物理性能指标、机器码、使用状态和已创建的ECS实例列表等。
接口说明
您可以通过以下任一方式查询一台或多台专有宿主机的详细信息:
- 指定
DedicatedHostIds
查询专有宿主机的详细信息。 - 指定
DedicatedHostClusterId
查询专有宿主机集群内专有宿主机的详细信息。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDedicatedHosts | 系统规定参数。取值:DescribeDedicatedHosts。 |
RegionId | String | 是 | cn-hangzhou | 专有宿主机所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。 |
ZoneId | String | 否 | cn-hangzhou-g | 可用区ID。您可以调用DescribeZones查看最新的阿里云可用区列表。 |
DedicatedHostIds | String | 否 | ["dh-bp165p6xk2tlw61e****", "dh-bp1f9vxmno7emy96****"] | 专有宿主机ID列表。单次最多支持100个ID ,ID之间用半角逗号(,)隔开。 |
DedicatedHostName | String | 否 | MyDDHTestName | 专有宿主机的名称。 |
Status | String | 否 | Available | 专有宿主机的使用状态。取值范围:
默认值:Available。 |
DedicatedHostType | String | 否 | ddh.g5 | 专有宿主机的规格。您可以调用DescribeDedicatedHostTypes接口获得最新的专有宿主机规格表。 |
LockReason | String | 否 | financial | 专有宿主机被锁定的原因。取值范围:
|
PageNumber | Integer | 否 | 1 | 响应信息的页码数。 默认值:1。 |
PageSize | Integer | 否 | 10 | 响应信息的每页行数。 最大值:100。 默认值:10。 |
ResourceGroupId | String | 否 | rg-aek3b6jzp66**** | 专有宿主机所在资源组ID。使用该参数过滤资源时,资源数量不能超过1000个。 说明 不支持默认资源组过滤。 |
Tag.N.Key | String | 否 | TestKey | 专有宿主机的标签键。N的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持128个字符,不能以 |
Tag.N.Value | String | 否 | TestValue | 专有宿主机的标签值。N的取值范围:1~20。一旦传入该值,可以为空字符串。最多支持128个字符,不能以 |
DedicatedHostClusterId | String | 否 | dc-bp12wlf6am0vz9v2**** | 专有宿主机集群ID。 |
SocketDetails | String | 否 | true | 是否展示Socket维度容量信息。取值范围:
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageSize | Integer | 1 | 输入时设置的每页行数。 |
RequestId | String | 7654525A-9964-4ABB-8BCD-98F8835E809A | 请求ID。 |
PageNumber | Integer | 5 | 专有宿主机列表的页码。 |
TotalCount | Integer | 3 | 专有宿主机总数。 |
DedicatedHosts | Array of DedicatedHost | 专有宿主机的详细信息集合。 |
|
DedicatedHost | |||
CreationTime | String | 2018-01-01T12:00Z | 专有宿主机的创建时间。按照ISO 8601标准表示,并需要使用UTC+0时间,格式为 |
SchedulerOptions.ManagedPrivateSpaceId | String | mps-iq81z6pkbqjx61php46e | 专有宿主机所属托管资源池(Managed Private Space)ID。 |
Status | String | Available | 专有宿主机的使用状态。可能值:
|
Cores | Integer | 3 | 单个CPU的核数。 |
AutoPlacement | String | on | 专有宿主机是否加入自动部署资源池。取值范围:
关于自动部署的更多信息,请参见自动部署功能介绍。 |
GPUSpec | String | gpu | GPU型号。 |
AutoReleaseTime | String | 2017-01-01T12:00Z | 自动释放时间。按照ISO 8601标准表示,并需要使用UTC+0时间,格式为 |
ChargeType | String | Prepaid | 专有宿主机的计费方式。 |
CpuOverCommitRatio | Float | 1 | CPU超卖比。 |
ActionOnMaintenance | String | Migrate | 当专有宿主机发生故障时,为其所宿实例设置迁移方案。取值范围:
当专有宿主机上挂载云盘存储时,默认值为Migrate;当专有宿主机上挂载本地盘存储时默认值为Stop。 |
SaleCycle | String | Month | 包年包月单位。可能值:
|
PhysicalGpus | Integer | 10 | 物理GPU数量。 |
RegionId | String | cn-hangzhou | 专有宿主机所在地域ID。 |
DedicatedHostName | String | MyDDHTestName | 专有宿主机的名称。 |
Description | String | this-is-my-DDH | 专有宿主机的描述信息。 |
DedicatedHostClusterId | String | dc-bp12wlf6am0vz9v2**** | 专有宿主机所在的专有宿主机集群ID。 |
ExpiredTime | String | 2019-01-01T12:00Z | 包年包月专有宿主机的到期时间。按照ISO 8601标准表示,并需要使用UTC+0时间,格式为 |
DedicatedHostType | String | ddh.g5 | 专有宿主机的规格类型。 |
ResourceGroupId | String | rg-aek3b6jzp66**** | 专有宿主机所在资源组ID。 |
ZoneId | String | cn-hangzhou-g | 可用区ID。 |
DedicatedHostId | String | dh-bp165p6xk2tlw61e**** | 专有宿主机ID。 |
Sockets | Integer | 5 | 物理处理器(CPU)数量。 |
MachineId | String | 12aaa123456ff19dec12345d3026e**** | 专有宿主机机器码。 |
Instances | Array of Instance | 专有宿主机上创建的ECS实例。 |
|
Instance | |||
InstanceType | String | ecs.g5.large | 专有宿主机上创建的ECS实例规格信息。 |
InstanceId | String | i-bp14ot0ykf8w13a1**** | 专有宿主机上创建的ECS实例ID。 |
SocketId | String | 0,1 | 实例所处的Socket的序号。 |
InstanceOwnerId | Long | 128************0 | ECS实例所有者的用户ID。 |
OperationLocks | Array of OperationLock | 专有宿主机资源被锁定原因。 |
|
OperationLock | |||
LockReason | String | financial | 专有宿主机被锁定的原因。可能值:
|
Tags | Array of Tag | 专有宿主机的标签。 |
|
Tag | |||
TagValue | String | TestValue | 专有宿主机的标签值。 |
TagKey | String | TestKey | 专有宿主机的标签键。 |
SupportedInstanceTypeFamilies | Array of String | ecs.g5 | 专有宿主机支持的ECS实例规格族。 |
SupportedCustomInstanceTypeFamilies | Array of String | ecs.ddh6s.custom | 专有宿主机支持的自定义实例规格族。 |
SupportedInstanceTypesList | Array of String | ecs.g5.large | 专有宿主机支持的ECS实例规格。 |
Capacity | Object | 专有宿主机性能指标集合。 |
|
AvailableMemory | Float | 25 | 剩余的内存容量,单位:GiB。 |
LocalStorageCategory | String | i2 | 本地盘类型。 |
TotalMemory | Float | 1024 | 内存总容量,单位:GiB。 |
TotalLocalStorage | Integer | 512 | 本地盘总容量,单位:GiB。 |
TotalVcpus | Integer | 56 | vCPU总核数。 |
TotalVgpus | Integer | 10 | 总虚拟GPU数量。 |
AvailableLocalStorage | Integer | 65 | 剩余的本地盘容量。单位:GiB。 |
AvailableVcpus | Integer | 5 | 剩余的vCPU核数。 |
AvailableVgpus | Integer | 2 | 可用虚拟GPU数量。 |
SocketCapacities | Array of SocketCapacity | Socket维度容量信息。 |
|
SocketCapacity | |||
SocketId | Integer | 1 | Socket序号。 |
AvailableMemory | Float | 65 | 剩余内存容量,单位:GiB。 |
TotalMemory | Float | 128 | 内存总容量,单位:GiB。 |
AvailableVcpu | Integer | 64 | vCPU总核数。 |
TotalVcpu | Integer | 128 |
剩余的vCPU核数。 |
NetworkAttributes | Object | 专有宿主机的网络属性值。 |
|
UdpTimeout | Integer | 60 | UDP超时时间。单位:S。当前仅支持60S。 |
SlbUdpTimeout | Integer | 60 | SLB UDP超时时间。单位:S。当前仅支持60S。 |
HostDetailInfo | Object | 该参数即将被弃用,为提高兼容性,建议您尽量使用其他参数。 |
|
SerialNumber | String | null | 该参数即将被弃用,为提高兼容性,建议您尽量使用其他参数。 |
DedicatedHostOwnerId | Long | 100************7 | 专有宿主机所有者的用户ID。 |
示例
请求示例
http(s)://ecs.aliyuncs.com/?Action=DescribeDedicatedHosts
&RegionId=cn-hangzhou
&ZoneId=cn-hangzhou-g
&DedicatedHostIds=["dh-bp165p6xk2tlw61e****", "dh-bp1f9vxmno7emy96****"]
&DedicatedHostName=MyDDHTestName
&Status=Available
&DedicatedHostType=ddh.g5
&LockReason=financial
&PageNumber=1
&PageSize=10
&ResourceGroupId=rg-aek3b6jzp66****
&Tag=[{"Key":"TestKey","Value":"TestValue"}]
&DedicatedHostClusterId=dc-bp12wlf6am0vz9v2****
&SocketDetails=true
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDedicatedHostsResponse>
<PageSize>1</PageSize>
<RequestId>7654525A-9964-4ABB-8BCD-98F8835E809A</RequestId>
<PageNumber>5</PageNumber>
<TotalCount>3</TotalCount>
<DedicatedHosts>
<CreationTime>2018-01-01T12:00Z</CreationTime>
<SchedulerOptions.ManagedPrivateSpaceId>mps-iq81z6pkbqjx61php46e</SchedulerOptions.ManagedPrivateSpaceId>
<Status>Available</Status>
<Cores>3</Cores>
<AutoPlacement>on</AutoPlacement>
<GPUSpec>gpu</GPUSpec>
<AutoReleaseTime>2017-01-01T12:00Z</AutoReleaseTime>
<ChargeType>Prepaid</ChargeType>
<CpuOverCommitRatio>1</CpuOverCommitRatio>
<ActionOnMaintenance>Migrate</ActionOnMaintenance>
<SaleCycle>Month</SaleCycle>
<PhysicalGpus>10</PhysicalGpus>
<RegionId>cn-hangzhou</RegionId>
<DedicatedHostName>MyDDHTestName</DedicatedHostName>
<Description>this-is-my-DDH</Description>
<DedicatedHostClusterId>dc-bp12wlf6am0vz9v2****</DedicatedHostClusterId>
<ExpiredTime>2019-01-01T12:00Z</ExpiredTime>
<DedicatedHostType>ddh.g5</DedicatedHostType>
<ResourceGroupId>rg-aek3b6jzp66****</ResourceGroupId>
<ZoneId>cn-hangzhou-g</ZoneId>
<DedicatedHostId>dh-bp165p6xk2tlw61e****</DedicatedHostId>
<Sockets>5</Sockets>
<MachineId>12aaa123456ff19dec12345d3026e****</MachineId>
<Instances>
<InstanceType>ecs.g5.large</InstanceType>
<InstanceId>i-bp14ot0ykf8w13a1****</InstanceId>
<SocketId>0,1</SocketId>
</Instances>
<OperationLocks>
<LockReason>financial</LockReason>
</OperationLocks>
<Tags>
<TagValue>TestValue</TagValue>
<TagKey>TestKey</TagKey>
</Tags>
<SupportedInstanceTypeFamilies>ecs.g5</SupportedInstanceTypeFamilies>
<SupportedCustomInstanceTypeFamilies>ecs.ddh6s.custom</SupportedCustomInstanceTypeFamilies>
<SupportedInstanceTypesList>ecs.g5.large</SupportedInstanceTypesList>
<Capacity>
<AvailableMemory>25</AvailableMemory>
<LocalStorageCategory>i2</LocalStorageCategory>
<TotalMemory>1024</TotalMemory>
<TotalLocalStorage>512</TotalLocalStorage>
<TotalVcpus>56</TotalVcpus>
<TotalVgpus>10</TotalVgpus>
<AvailableLocalStorage>65</AvailableLocalStorage>
<AvailableVcpus>5</AvailableVcpus>
<AvailableVgpus>2</AvailableVgpus>
<SocketCapacities>
<SocketId>1</SocketId>
<AvailableMemory>65</AvailableMemory>
<TotalMemory>128</TotalMemory>
<AvailableVcpu>64</AvailableVcpu>
<TotalVcpu>128</TotalVcpu>
</SocketCapacities>
</Capacity>
<NetworkAttributes>
<UdpTimeout>60</UdpTimeout>
<SlbUdpTimeout>60</SlbUdpTimeout>
</NetworkAttributes>
<HostDetailInfo>
<SerialNumber>null</SerialNumber>
</HostDetailInfo>
</DedicatedHosts>
</DescribeDedicatedHostsResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"PageSize" : 1,
"RequestId" : "7654525A-9964-4ABB-8BCD-98F8835E809A",
"PageNumber" : 5,
"TotalCount" : 3,
"DedicatedHosts" : [ {
"CreationTime" : "2018-01-01T12:00Z",
"SchedulerOptions.ManagedPrivateSpaceId" : "mps-iq81z6pkbqjx61php46e",
"Status" : "Available",
"Cores" : 3,
"AutoPlacement" : "on",
"GPUSpec" : "gpu",
"AutoReleaseTime" : "2017-01-01T12:00Z",
"ChargeType" : "Prepaid",
"CpuOverCommitRatio" : 1,
"ActionOnMaintenance" : "Migrate",
"SaleCycle" : "Month",
"PhysicalGpus" : 10,
"RegionId" : "cn-hangzhou",
"DedicatedHostName" : "MyDDHTestName",
"Description" : "this-is-my-DDH",
"DedicatedHostClusterId" : "dc-bp12wlf6am0vz9v2****",
"ExpiredTime" : "2019-01-01T12:00Z",
"DedicatedHostType" : "ddh.g5",
"ResourceGroupId" : "rg-aek3b6jzp66****",
"ZoneId" : "cn-hangzhou-g",
"DedicatedHostId" : "dh-bp165p6xk2tlw61e****",
"Sockets" : 5,
"MachineId" : "12aaa123456ff19dec12345d3026e****",
"Instances" : [ {
"InstanceType" : "ecs.g5.large",
"InstanceId" : "i-bp14ot0ykf8w13a1****",
"SocketId" : "0,1"
} ],
"OperationLocks" : [ {
"LockReason" : "financial"
} ],
"Tags" : [ {
"TagValue" : "TestValue",
"TagKey" : "TestKey"
} ],
"SupportedInstanceTypeFamilies" : [ "ecs.g5" ],
"SupportedCustomInstanceTypeFamilies" : [ "ecs.ddh6s.custom" ],
"SupportedInstanceTypesList" : [ "ecs.g5.large" ],
"Capacity" : {
"AvailableMemory" : 25,
"LocalStorageCategory" : "i2",
"TotalMemory" : 1024,
"TotalLocalStorage" : 512,
"TotalVcpus" : 56,
"TotalVgpus" : 10,
"AvailableLocalStorage" : 65,
"AvailableVcpus" : 5,
"AvailableVgpus" : 2,
"SocketCapacities" : [ {
"SocketId" : 1,
"AvailableMemory" : 65,
"TotalMemory" : 128,
"AvailableVcpu" : 64,
"TotalVcpu" : 128
} ]
},
"NetworkAttributes" : {
"UdpTimeout" : 60,
"SlbUdpTimeout" : 60
},
"HostDetailInfo" : {
"SerialNumber" : "null"
}
} ]
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidStatus.ValueNotSupported | The pecified dedicated host status is not supported. | 当前宿主机状态不支持此操作。 |
400 | MissingParamter.RegionId | The regionId should not be null. | 参数 RegionId 不得为空。 |
400 | InvalidParameter.DedicatedHostIds | The specified parameter dedicatedHostIds is not valid. | 指定的参数 DedicatedHostIds 无效。 |
400 | InvalidRegion.NotFound | The specified parameter RegionId is not valid. | RegionId 参数不合法。 |
400 | InvalidZone.NotFound | The specified parameter ZoneId is not valid. | 指定的ZoneId不合法。 |
403 | InvalidDedicatedHostIds.Malformed | The amount of specified dedicatedHostIds exceeds the limit. | 参数 DedicatedHostIds 中的数据最多设置100个。 |
404 | InvalidLockReason.NotFound | The specified LockReason is not found. | 所指定的锁定原因不存在 |
访问错误中心查看更多错误码。