DescribeDedicatedHosts - : Central de Documentação do Alibaba Cloud

Notas de uso

Use um dos métodos a seguir para consultar os detalhes dos hosts dedicados:

Especifique DedicatedHostIds para consultar os detalhes de hosts dedicados específicos.
Especifique DedicatedHostClusterId para obter os detalhes dos hosts dedicados em um cluster de hosts dedicados.

Parâmetros da solicitação

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeDedicatedHosts	A operação a ser executada. Defina o valor como DescribeDedicatedHosts.
RegionId	String	Yes	cn-hangzhou	O ID da região do host dedicado. Chame a operação DescribeRegions para consultar a lista mais recente de regiões.
ZoneId	String	No	cn-hangzhou-g	O ID da zona do host dedicado. Chame a operação DescribeZones para consultar a lista mais recente de zonas.
DedicatedHostIds	String	No	["dh-bp165p6xk2tlw61e**", "dh-bp1f9vxmno7emy96**"]	Os IDs dos hosts dedicados. É possível especificar até 100 IDs de hosts dedicados em uma única solicitação. Separe os IDs com vírgulas (,).
DedicatedHostName	String	No	MyDDHTestName	O nome do host dedicado.
Status	String	No	Available	O estado de serviço do host dedicado. Valores válidos: Available: O host dedicado está funcionando normalmente. UnderAssessment: O host dedicado está disponível, mas apresenta riscos potenciais que podem causar falhas nas instâncias ECS hospedadas nele. PermanentFailure: O host dedicado sofreu falhas permanentes e está indisponível. TempUnavailable: O host dedicado está temporariamente indisponível. Redeploying: O host dedicado está sendo restaurado. Valor padrão: Available.
DedicatedHostType	String	No	ddh.g5	O tipo do host dedicado. Chame a operação DescribeDedicatedHostTypes para obter a lista mais recente de tipos de hosts dedicados.
LockReason	String	No	financial	O motivo do bloqueio do host dedicado. Valores válidos: financial security
PageNumber	Integer	No	1	O número de entradas por página. Valor padrão: 1.
PageSize	Integer	No	10	O número da página. Valores válidos: 1 a 100. Valor padrão: 10.
ResourceGroupId	String	No	rg-aek3b6jzp66****	O ID do grupo de recursos ao qual o host dedicado pertence. Ao especificar este parâmetro para consultar recursos, a resposta pode exibir até 1.000 recursos pertencentes ao grupo de recursos indicado. Nota Os recursos do grupo de recursos padrão são exibidos na resposta independentemente da configuração deste parâmetro.
Tag.N.Key	String	No	TestKey	A chave da tag N do host dedicado. Valores válidos de N: 1 a 20. A chave da tag não pode ser uma string vazia. Pode ter até 128 caracteres e não pode começar com `acs:` ou `aliyun`. Não pode conter `http://` ou `https://`.
Tag.N.Value	String	No	TestValue	O valor da tag N do host dedicado. Valores válidos de N: 1 a 20. O valor da tag pode ser uma string vazia. Pode ter até 128 caracteres e não pode começar com `acs:` ou `aliyun`. Não pode conter `http://` ou `https://`.
DedicatedHostClusterId	String	No	dc-bp12wlf6am0vz9v2****	O ID do cluster de hosts dedicados ao qual o host dedicado pertence.
SocketDetails	String	No	true	Define se as informações de socket devem ser exibidas. Valores válidos: true false

Parâmetros de resposta

Parameter	Type	Example	Description
PageSize	Integer	1	O número de entradas por página.
RequestId	String	7654525A-9964-4ABB-8BCD-98F8835E809A	O ID da solicitação.
PageNumber	Integer	5	O número da página.
TotalCount	Integer	3	O número total de hosts dedicados.
DedicatedHosts	Array of DedicatedHost		Os hosts dedicados consultados.
DedicatedHost
CreationTime	String	2018-01-01T12:00Z	O horário de criação do host dedicado. O horário segue o padrão ISO 8601 no formato `yyyy-MM-ddTHH:mmZ`. O horário é exibido em UTC.
SchedulerOptions.ManagedPrivateSpaceId	String	mps-iq81z6pkbqjx61php46e	O ID do espaço privado gerenciado ao qual o host dedicado pertence.
Status	String	Available	O estado de serviço do host dedicado. Valores válidos: Available: O host dedicado está funcionando normalmente. UnderAssessment: O host dedicado está disponível, mas apresenta riscos potenciais que podem causar falhas nas instâncias ECS hospedadas nele. PermanentFailure: O host dedicado sofreu falhas permanentes e está indisponível.
Cores	Integer	3	O número de núcleos físicos por cpu.
AutoPlacement	String	on	Indica se o host dedicado foi adicionado ao pool de recursos para implantação automática. Valores válidos: on: O host dedicado foi adicionado ao pool de recursos para implantação automática. off: O host dedicado não foi adicionado ao pool de recursos para implantação automática. Para mais informações sobre implantação automática, consulte a seção "Implantação automática" no tópico Funções e recursos.
GPUSpec	String	gpu	O modelo da GPU.
AutoReleaseTime	String	2017-01-01T12:00Z	O horário de liberação automática do host dedicado. O horário segue o padrão ISO 8601 no formato `yyyy-MM-ddTHH:mmZ`. O horário é exibido em UTC.
ChargeType	String	Prepaid	O método de faturamento do host dedicado.
CpuOverCommitRatio	Float	1	A taxa de overcommit de cpu.
ActionOnMaintenance	String	Migrate	A política usada para migrar as instâncias implantadas no host dedicado quando ocorre uma falha no host. Valores válidos: Migrate: As instâncias são migradas para outro servidor físico. Instâncias que não estiverem no estado Stopped quando o host dedicado falhar serão reiniciadas. Stop: As instâncias são paradas. Se o host dedicado não puder ser restaurado, as instâncias serão migradas para outro servidor físico e reiniciadas. Se o host dedicado tiver discos em nuvem anexados, o valor padrão será Migrate. Se o host dedicado tiver discos locais anexados, o valor padrão será Stop.
SaleCycle	String	Month	A unidade do período de assinatura. Valores válidos: Month Year
PhysicalGpus	Integer	10	O número de GPUs físicas.
RegionId	String	cn-hangzhou	O ID da região do host dedicado.
DedicatedHostName	String	MyDDHTestName	O nome do host dedicado.
Description	String	this-is-my-DDH	A descrição do host dedicado.
DedicatedHostClusterId	String	dc-bp12wlf6am0vz9v2****	O ID do cluster de hosts dedicados ao qual o host dedicado pertence.
ExpiredTime	String	2019-01-01T12:00Z	O horário de expiração do host dedicado por assinatura. O horário segue o padrão ISO 8601 no formato `yyyy-MM-ddTHH:mmZ`. O horário é exibido em UTC.
DedicatedHostType	String	ddh.g5	O tipo do host dedicado.
ResourceGroupId	String	rg-aek3b6jzp66****	O ID do grupo de recursos ao qual o host dedicado pertence.
ZoneId	String	cn-hangzhou-g	O ID da zona do host dedicado.
DedicatedHostId	String	dh-bp165p6xk2tlw61e****	O ID do host dedicado.
Sockets	Integer	5	O número de CPUs físicas.
MachineId	String	12aaa123456ff19dec12345d3026e****	O código de máquina do host dedicado.
Instances	Array of Instance		As instâncias ecs criadas no host dedicado.
Instance
InstanceType	String	ecs.g5.large	O tipo da instância ecs.
InstanceId	String	i-bp14ot0ykf8w13a1****	O ID da instância ecs.
SocketId	String	0,1	O ID do socket ao qual a instância ecs pertence.
InstanceOwnerId	Long	128************0	O ID do proprietário da instância ecs.
OperationLocks	Array of OperationLock		Os motivos pelos quais os recursos do host dedicado foram bloqueados.
OperationLock
LockReason	String	financial	O motivo do bloqueio do host dedicado. Valores válidos: financial security
Tags	Array of Tag		As tags do host dedicado.
Tag
TagValue	String	TestValue	O valor da tag do host dedicado.
TagKey	String	TestKey	A chave da tag do host dedicado.
SupportedInstanceTypeFamilies	Array of String	ecs.g5	As famílias de instâncias ecs compatíveis com o host dedicado.
SupportedCustomInstanceTypeFamilies	Array of String	ecs.ddh6s.custom	As famílias de instâncias ecs personalizadas compatíveis com o host dedicado.
SupportedInstanceTypesList	Array of String	ecs.g5.large	Os tipos de instância ecs compatíveis com o host dedicado.
Capacity	Object		As especificações de desempenho do host dedicado.
AvailableMemory	Float	25	A quantidade de memória disponível. Unidade: GiB.
LocalStorageCategory	String	i2	A família de instâncias que utiliza discos locais.
TotalMemory	Float	1024	A capacidade total de memória. Unidade: GiB.
TotalLocalStorage	Integer	512	A capacidade total dos discos locais. Unidade: GiB.
TotalVcpus	Integer	56	O número total de vCPUs.
TotalVgpus	Integer	10	O número total de vGPUs.
AvailableLocalStorage	Integer	65	A quantidade de capacidade disponível nos discos locais. Unidade: GiB.
AvailableVcpus	Integer	5	O número de vCPUs disponíveis.
AvailableVgpus	Integer	2	O número de vGPUs disponíveis.
SocketCapacities	Array of SocketCapacity		As capacidades dos sockets.
SocketCapacity
SocketId	Integer	1	O ID do socket.
AvailableMemory	Float	65	A capacidade restante de memória. Unidade: GiB.
TotalMemory	Float	128	A capacidade total de memória. Unidade: GiB.
AvailableVcpu	Integer	64	O número total de vCPUs.
TotalVcpu	Integer	128	O número de vCPUs disponíveis.
NetworkAttributes	Object		Os atributos de rede do host dedicado.
UdpTimeout	Integer	60	O tempo limite da sessão UDP estabelecida entre um usuário e um serviço Alibaba Cloud no host dedicado. Unidade: segundos. Valor válido: 60.
SlbUdpTimeout	Integer	60	O tempo limite da sessão UDP estabelecida entre o Server Load Balancer (SLB) e o host dedicado. Unidade: segundos. Valor válido: 60.
HostDetailInfo	Object		Este parâmetro será removido no futuro. Recomendamos o uso de outros parâmetros para garantir compatibilidade futura.
SerialNumber	String	null	Este parâmetro será removido no futuro. Recomendamos o uso de outros parâmetros para garantir compatibilidade futura.
DedicatedHostOwnerId	Long	100************7	O ID do proprietário do host dedicado.

Exemplos

Exemplos de solicitações

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>

Exemplos de respostas de sucesso

Formato 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>

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

Códigos de erro

HTTP status code	Error code	Error message	Description
400	InvalidStatus.ValueNotSupported	The pecified dedicated host status is not supported.	Esta operação não pode ser executada no host dedicado no estado atual.
400	MissingParamter.RegionId	The regionId should not be null.	RegionId é obrigatório.
400	InvalidParameter.DedicatedHostIds	The specified parameter dedicatedHostIds is not valid.	Valor inválido para DedicatedHostIds.
400	InvalidRegion.NotFound	The specified parameter RegionId is not valid.	Valor inválido para RegionId.
400	InvalidZone.NotFound	The specified parameter ZoneId is not valid.	Valor inválido para ZoneId.
403	InvalidDedicatedHostIds.Malformed	The amount of specified dedicatedHostIds exceeds the limit.	Mais de 100 IDs de hosts dedicados foram especificados no valor DedicatedHostIds.
404	InvalidLockReason.NotFound	The specified LockReason is not found.	O valor especificado para LockReason não foi encontrado.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.