：DescribeDedicatedHosts

Usage notes

You can use one of the following methods to query the details of dedicated hosts:

• Specify DedicatedHostIds to query the details of dedicated hosts.
• Specify DedicatedHostClusterId to query the details of the dedicated hosts in a dedicated host cluster.

Request parameters

Response parameters

Examples

Sample requests

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
&<Common request parameters>

Sample success responses

XML format

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 format

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"
    }
  } ]
}

Error codes

For a list of error codes, see Service error codes.