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

Após criar hosts em um cluster dedicado, visualize seus detalhes. Essas informações incluem métricas de desempenho, total de núcleos de CPU, memória total e armazenamento total.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeDedicatedHosts	A operação a ser executada. Defina o valor como DescribeDedicatedHosts.
RegionId	String	Sim	cn-hangzhou	O ID da região.
DedicatedHostGroupId	String	Sim	dhg-h5i4p331f509****	O ID do cluster dedicado. Faça login no console do ApsaraDB MyBase e acesse a página Dedicated Clusters para visualizar o ID do cluster dedicado.
OrderId	Long	Não	123456789	O ID do pedido. Faça login no console de Billing Management e acesse a página Orders para visualizar o ID do pedido.
HostType	String	Não	dhg_cloud_ssd	O tipo de armazenamento do host. Valores válidos: dhg_local_ssd: SSD local dhg_cloud_ssd ou dhg_cloud_essd: SSD aprimorado (ESSD)
HostStatus	String	Não	1	O estado do host. Valores válidos: 0: O host está sendo criado. 1: O host está em execução. 2: O host apresenta falha. 3: O host está pronto para desativação. 4: O host está em manutenção. 5: O host está desativado. 6: O host está reiniciando. 7: O host está bloqueado. Nota Quando um host falha, ele é desativado. Antes da desativação, os dados das instâncias em execução nesse host são migrados para outro host.
AllocationStatus	String	Não	Allocatable	Indica se é possível criar instâncias no host. Valores válidos: Allocatable: É possível criar instâncias no host. Suspended: Não é possível criar instâncias no host.
ZoneId	String	Não	ap-southeast-1a	O ID da zona. Chame a operação DescribeRegions para consultar a lista de zonas mais recente.
DedicatedHostId	String	Não	ch-bp10a5id3boqi****	O ID do host no cluster dedicado. Faça login no console do ApsaraDB MyBase e acesse a página Hosts para visualizar o ID do host.
PageNumbers	Integer	Não	50	O número total de páginas a retornar.
PageSize	Integer	Não	20	O número de entradas a retornar por página.
Tags	String	Não	{"key1":"value1"}	As tags adicionadas ao host. Cada tag é um par chave-valor composto por TagKey e TagValue. Especifique até cinco tags por solicitação no formato: {"key1":"value1","key2":"value2"...}. Nota Para filtrar hosts por tag, não especifique o parâmetro DedicatedHostId. Caso contrário, o sistema usará o parâmetro DedicatedHostId como condição de filtro.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
TotalRecords	Integer	40	O número total de entradas retornadas.
PageSize	Integer	20	O número de entradas retornadas por página.
RequestId	String	D6E068C3-25BC-455A-85FE-45F0B22EASER	O ID da solicitação.
PageNumbers	Integer	2	O número total de páginas retornadas.
DedicatedHostGroupId	String	dhg-6w7q18iwt5jo****	O ID do cluster dedicado.
DedicatedHosts	Array of DedicatedHosts		Detalhes dos hosts.
DedicatedHosts
HostType	String	dhg_cloud_ssd	O tipo de armazenamento do host.
HostStorage	String	1234	O armazenamento total do host. Unidade: GB.
MemoryUsed	String	24576	A quantidade de memória usada pelo host. Unidade: GB.
DedicatedHostGroupId	String	dhg-6w7q18iwt5jo****	O ID do cluster dedicado onde o host foi criado.
AllocationStatus	String	Suspended	Indica se é possível criar instâncias no host. Valores válidos: Allocatable: É possível criar instâncias no host. Suspended: Não é possível criar instâncias no host.
StorageUsed	String	588800	A quantidade de armazenamento usada pelo host. Unidade: GB.
EcsClassCode	String	ecs.r5.16xlarge	O tipo da instância Elastic Compute Service (ECS). Para mais informações, consulte Visão geral das famílias de instâncias.
DedicatedHostId	String	ch-bp10a5id3boqi****	O ID do host.
MemAllocationRatio	String	90	O uso de memória do host. Unidade: %.
CreatedTime	String	2020-10-16 16:30:19	O horário de criação do host. Segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ e é exibido em UTC.
IPAddress	String	192.168.XX.XX	O endereço IP do host.
HostStatus	String	1	O estado do host. Valores válidos: 0: O host está sendo criado. 1: O host está em execução. 2: O host apresenta falha. 3: O host está pronto para desativação. 4: O host está em manutenção. 5: O host está desativado. 6: O host está reiniciando. 7: O host está bloqueado. Nota Quando um host falha, ele é desativado. Antes da desativação, os dados das instâncias em execução nesse host são migrados para outro host.
HostName	String	ch-bp15xfnp706tl****	O nome do host.
HostCPU	String	16	O número de núcleos de CPU do host.
CpuUsed	String	10	O número de núcleos de CPU usados.
InstanceNumber	String	1	O número de instâncias criadas no host.
OpenPermission	String	1	Indica se o recurso que concede permissões de SO no host está ativado. Valor padrão: 1. Valores válidos: 0: O recurso está desativado. 1: O recurso está ativado.
DistributionSymbol	String	0	O símbolo de distribuição do host. Nota Este parâmetro é retornado apenas se o host for criado em um cluster dedicado do ApsaraDB MyBase for Redis da Enhanced Edition (Tair).
VPCId	String	vpc-bp1roz55mrbj3ka1s****	O ID da virtual private cloud (VPC) onde o cluster dedicado está implantado e onde o host foi criado.
HostClass	String	rds.g6.4xlarge	O tipo de instância do host.
EndTime	String	2021-10-16 16:30:19	O horário de expiração do host. Segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ e é exibido em UTC.
VSwitchId	String	vsw-bp133c8ifzxd3iv6q****	O ID do vSwitch ao qual o host está conectado.
ZoneId	String	ap-southeast-1a	O ID da zona onde o host reside.
CPUAllocationRatio	String	10	A utilização de CPU do host.
ImageCategory	String	ALinux	O tipo de imagem do host.
Engine	String	mysql	O mecanismo de banco de dados do host.
DiskAllocationRatio	String	10	O uso de disco do host. Unidade: %.
HostMem	String	65536	A quantidade de memória do host. Unidade: GB.
BastionInstanceId	String	bastionhost-cn-i7m2fgw****	O ID do bastion host associado ao host.
AccountName	String	test	O nome personalizado da conta do host. Pode conter letras minúsculas, dígitos e sublinhados (_). Deve começar com uma letra minúscula e terminar com uma letra minúscula ou dígito. Deve ter de 2 a 16 caracteres.
AccountType	String	Normal	O tipo da conta do host. Valores válidos: Normal: conta padrão Admin: conta de administrador
DistributionTag	String	t4n9uz07h3r1tmcejtxf:1	A tag de distribuição do host.
Category	String	Standard	O tipo do cluster dedicado. Valores válidos: Pro: MyBase Proprietário Standard: MyBase Gerenciado Nota Este parâmetro é retornado apenas para o site da China (aliyun.com).
EcsId	String	i-2zec7l031p0jtru3pn7a	O ID da instância ECS. Nota Este parâmetro é retornado apenas quando o tipo de cluster dedicado é MyBase Proprietário no site da China (aliyun.com).
DiskInfo	String	{\"SystemDiskSize\":20,\"DataDiskCount\":0,\"DataDiskSize\":0,\"DataDiskCategory\":[\"\"],\"SystemDiskCategory\":\"cloud_essd\"}	As informações de disco da instância ECS. Nota Este parâmetro é retornado apenas quando o tipo de cluster dedicado é MyBase Proprietário no site da China (aliyun.com).
ChargeType	String	PREPAY	O método de faturamento do host.
MssqlSupportVersion	String	2012_std_ha,2012_std,2016_std_ha,2016_std,2017_std_ha,2017_std,2019_std_ha,2019_std	As versões compatíveis com hosts no ApsaraDB MyBase for SQL Server.
MaxAutoScaleHostStorage	Long	3661824	A capacidade máxima de armazenamento de SSDs locais para auto scaling. Unidade: GB.

Exemplos

Exemplos de solicitações

http(s)://cddc.aliyuncs.com/?Action=DescribeDedicatedHosts
&RegionId=cn-hangzhou
&DedicatedHostGroupId=dhg-h5i4p331f509****
&OrderId=123456789
&HostType=dhg_cloud_ssd
&HostStatus=1
&AllocationStatus=Allocatable
&ZoneId=ap-southeast-1a
&DedicatedHostId=ch-bp10a5id3boqi****
&PageNumbers=50
&PageSize=20
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDedicatedHostsResponse>
    <TotalRecords>40</TotalRecords>
    <PageSize>20</PageSize>
    <RequestId>D6E068C3-25BC-455A-85FE-45F0B22EASER</RequestId>
    <PageNumbers>2</PageNumbers>
    <DedicatedHostGroupId>dhg-6w7q18iwt5jo****</DedicatedHostGroupId>
    <DedicatedHosts>
        <HostType>dhg_cloud_ssd</HostType>
        <HostStorage>1234</HostStorage>
        <MemoryUsed>24576</MemoryUsed>
        <DedicatedHostGroupId>dhg-6w7q18iwt5jo****</DedicatedHostGroupId>
        <AllocationStatus>Suspended</AllocationStatus>
        <StorageUsed>588800</StorageUsed>
        <EcsClassCode>ecs.r5.16xlarge</EcsClassCode>
        <DedicatedHostId>ch-bp10a5id3boqi****</DedicatedHostId>
        <MemAllocationRatio>90</MemAllocationRatio>
        <CreatedTime>2020-10-16 16:30:19</CreatedTime>
        <IPAddress>192.168.XX.XX</IPAddress>
        <HostStatus>1</HostStatus>
        <HostName>ch-bp15xfnp706tl****</HostName>
        <HostCPU>16</HostCPU>
        <CpuUsed>10</CpuUsed>
        <InstanceNumber>1</InstanceNumber>
        <OpenPermission>1</OpenPermission>
        <DistributionSymbol>0</DistributionSymbol>
        <VPCId>vpc-bp1roz55mrbj3ka1s****</VPCId>
        <HostClass>rds.g6.4xlarge</HostClass>
        <EndTime>2021-10-16 16:30:19</EndTime>
        <VSwitchId>vsw-bp133c8ifzxd3iv6q****</VSwitchId>
        <ZoneId>ap-southeast-1a</ZoneId>
        <CPUAllocationRatio>10</CPUAllocationRatio>
        <ImageCategory>ALinux</ImageCategory>
        <Engine>mysql</Engine>
        <DiskAllocationRatio>10</DiskAllocationRatio>
        <HostMem>65536</HostMem>
        <BastionInstanceId>bastionhost-cn-i7m2fgw****</BastionInstanceId>
        <AccountName>test</AccountName>
        <AccountType>Normal</AccountType>
        <DistributionTag>t4n9uz07h3r1tmcejtxf:1</DistributionTag>
        <Category>Standard</Category>
        <EcsId>i-2zec7l031p0jtru3pn7a</EcsId>
        <DiskInfo>{\"SystemDiskSize\":20,\"DataDiskCount\":0,\"DataDiskSize\":0,\"DataDiskCategory\":[\"\"],\"SystemDiskCategory\":\"cloud_essd\"}</DiskInfo>
        <ChargeType>PREPAY</ChargeType>
    </DedicatedHosts>
    <MaxAutoScaleHostStorage>3661824</MaxAutoScaleHostStorage>
</DescribeDedicatedHostsResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalRecords" : 40,
  "PageSize" : 20,
  "RequestId" : "D6E068C3-25BC-455A-85FE-45F0B22EASER",
  "PageNumbers" : 2,
  "DedicatedHostGroupId" : "dhg-6w7q18iwt5jo****",
  "DedicatedHosts" : [ {
    "HostType" : "dhg_cloud_ssd",
    "HostStorage" : "1234",
    "MemoryUsed" : "24576",
    "DedicatedHostGroupId" : "dhg-6w7q18iwt5jo****",
    "AllocationStatus" : "Suspended",
    "StorageUsed" : "588800",
    "EcsClassCode" : "ecs.r5.16xlarge",
    "DedicatedHostId" : "ch-bp10a5id3boqi****",
    "MemAllocationRatio" : "90",
    "CreatedTime" : "2020-10-16 16:30:19",
    "IPAddress" : "192.168.XX.XX",
    "HostStatus" : "1",
    "HostName" : "ch-bp15xfnp706tl****",
    "HostCPU" : "16",
    "CpuUsed" : "10",
    "InstanceNumber" : "1",
    "OpenPermission" : "1",
    "DistributionSymbol" : "0",
    "VPCId" : "vpc-bp1roz55mrbj3ka1s****",
    "HostClass" : "rds.g6.4xlarge",
    "EndTime" : "2021-10-16 16:30:19",
    "VSwitchId" : "vsw-bp133c8ifzxd3iv6q****",
    "ZoneId" : "ap-southeast-1a",
    "CPUAllocationRatio" : "10",
    "ImageCategory" : "ALinux",
    "Engine" : "mysql",
    "DiskAllocationRatio" : "10",
    "HostMem" : "65536",
    "BastionInstanceId" : "bastionhost-cn-i7m2fgw****",
    "AccountName" : "test",
    "AccountType" : "Normal",
    "DistributionTag" : "t4n9uz07h3r1tmcejtxf:1",
    "Category" : "Standard",
    "EcsId" : "i-2zec7l031p0jtru3pn7a",
    "DiskInfo" : "{\\\"SystemDiskSize\\\":20,\\\"DataDiskCount\\\":0,\\\"DataDiskSize\\\":0,\\\"DataDiskCategory\\\":[\\\"\\\"],\\\"SystemDiskCategory\\\":\\\"cloud_essd\\\"}",
    "ChargeType" : "PREPAY"
  } ],
  "MaxAutoScaleHostStorage" : 3661824
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
403	Forbidden.RAM	User not authorized to operate on the specified resource, or this API does not support RAM.	Mensagem de erro retornada porque a operação especificada é proibida.

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