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

Descrição

Você pode especificar vários parâmetros de solicitação para consulta. Os parâmetros definidos mantêm uma relação lógica AND entre si. Apenas os parâmetros informados compõem as condições de filtro. No entanto, se DedicatedHostClusterIds for definido como um array JSON vazio ([]), o sistema o tratará como uma condição de filtro válida e retornará um resultado vazio.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeDedicatedHostClusters	A operação a ser executada. Defina o valor como DescribeDedicatedHostClusters.
Status	String	Não	null	Nota Este parâmetro não está disponível para uso.
LockReason	String	Não	null	Nota Este parâmetro não está disponível para uso.
ResourceGroupId	String	Não	rg-bp67acfmxazb4p****	ID do grupo de recursos ao qual o cluster de host dedicado pertence. Se você especificar este parâmetro na consulta, a resposta poderá exibir até 1.000 recursos pertencentes ao grupo de recursos indicado. Nota Os recursos do grupo de recursos padrão aparecem na resposta independentemente da configuração deste parâmetro.
Tag.N.Key	String	Não	TestKey	Chave da tag N do cluster de host dedicado. Valores válidos para N: 1 a 20. A chave da tag não pode ser uma string vazia. Deve ter no máximo 64 caracteres e não pode começar com `acs:` ou `aliyun`. Também não deve conter `http://` ou `https://`. Ao especificar uma única tag para consultar recursos, a resposta pode exibir até 1.000 recursos associados a essa tag. Se você informar múltiplas tags, até 1.000 recursos que possuam todas essas tags poderão ser listados. Para consultar mais de 1.000 recursos com tags específicas, chame a operação ListTagResources.
Tag.N.Value	String	Não	TestValue	Valor da tag N do cluster de host dedicado. Valores válidos para N: 1 a 20. O valor da tag não pode ser uma string vazia. Pode ter até 64 caracteres e não deve iniciar com `acs:` ou `aliyun`. Não é permitido conter `http://` ou `https://`.
RegionId	String	Sim	cn-hangzhou	ID da região do cluster de host dedicado. Chame a operação DescribeRegions para obter a lista de regiões mais recente.
ZoneId	String	Não	cn-hangzhou-f	ID da zona do cluster de host dedicado. Utilize a operação DescribeZones para consultar a lista de zonas atualizada.
DedicatedHostClusterIds	String	Não	["dc-bp12wlf6am0vz9v2**", "dc-bp12wlf6am0vz9v3**"]	IDs dos clusters de host dedicado. O valor pode ser um array JSON contendo até 100 IDs de clusters de host dedicado no formato `["dc-xxxxxxxxx", "dc-yyyyyyyyy", ... "dc-zzzzzzzzz"]`. Separe os IDs por vírgulas (,).
DedicatedHostClusterName	String	Não	myDDHCluster	Nome do cluster de host dedicado.
PageNumber	Integer	Não	1	Número da página a ser retornada. A numeração das páginas começa em 1. Valor padrão: 1.
PageSize	Integer	Não	5	Quantidade de entradas a serem retornadas em cada página. Valor máximo: 100 Valor padrão: 10.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
PageSize	Integer	5	Número de entradas retornadas por página.
RequestId	String	214A2187-B06F-4E49-A081-4D053466A8C7	ID da solicitação.
PageNumber	Integer	1	Número da página retornada.
TotalCount	Integer	2	Número total de clusters de host dedicado.
DedicatedHostClusters	Array of DedicatedHostCluster		Detalhes sobre os clusters de host dedicado.
DedicatedHostCluster
Description	String	This-is-my-DDHCluster	Descrição do cluster de host dedicado.
DedicatedHostClusterId	String	dc-bp12wlf6am0vz9v2****	ID do cluster de host dedicado.
ResourceGroupId	String	rg-bp67acfmxazb4p****	ID do grupo de recursos ao qual o cluster de host dedicado pertence.
ZoneId	String	cn-hangzhou-f	ID da zona do cluster de host dedicado.
RegionId	String	cn-hangzhou	ID da região do cluster de host dedicado.
DedicatedHostClusterName	String	myDDHCluster	Nome do cluster de host dedicado.
Tags	Array of Tag		Tags do cluster de host dedicado.
Tag
TagValue	String	TestValue	Valor da tag do cluster de host dedicado.
TagKey	String	TestKey	Chave da tag do cluster de host dedicado.
DedicatedHostIds	Array of String	["dh-bp181e5064b5sotr**","dh-bp18064b5sotrr9c**"]	IDs dos hosts dedicados presentes no cluster de host dedicado.
DedicatedHostClusterCapacity	Object		Capacidade do cluster de host dedicado.
AvailableVcpus	Integer	2	Quantidade de vCPUs disponíveis.
AvailableMemory	Integer	4	Tamanho da memória disponível. Unidade: GiB.
TotalMemory	Integer	8	Tamanho total da memória. Unidade: GiB.
TotalVcpus	Integer	4	Número total de vCPUs.
LocalStorageCapacities	Array of LocalStorageCapacity		Capacidade de armazenamento local.
LocalStorageCapacity
DataDiskCategory	String	cloud	Categoria do disco de dados. Valores válidos: cloud: disco básico cloud_efficiency: disco ultra cloud_ssd: SSD padrão ephemeral_ssd: SSD local cloud_essd: SSD aprimorado (ESSD)
AvailableDisk	Integer	20	Capacidade disponível do disco local. Unidade: GiB.
TotalDisk	Integer	40	Capacidade total do disco local. Unidade: GiB.
AvailableInstanceTypes	Array of AvailableInstanceType		Capacidade disponível dos tipos de instância Elastic Compute Service (ecs) no cluster de host dedicado.
AvailableInstanceType
InstanceType	String	ecs.c6.26xlarge	Tipo de instância ecs.
AvailableInstanceCapacity	Integer	0	Capacidade disponível do tipo de instância ecs.

Exemplos

Solicitações de exemplo

https://ecs.aliyuncs.com/?Action=DescribeDedicatedHostClusters
&RegionId=cn-hangzhou
&ZoneId=cn-hangzhou-f
&DedicatedHostClusterName=myDDHCluster
&PageNumber=1
&PageSize=5
&<Common request parameters>

Respostas de sucesso de exemplo

Formato XML

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

<DescribeDedicatedHostClustersResponse>
    <PageSize>5</PageSize>
    <RequestId>214A2187-B06F-4E49-A081-4D053466A8C7</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>2</TotalCount>
    <DedicatedHostClusters>
        <Description>This-is-my-DDHCluster</Description>
        <DedicatedHostClusterId>dc-bp12wlf6am0vz9v2****</DedicatedHostClusterId>
        <ResourceGroupId>rg-bp67acfmxazb4p****</ResourceGroupId>
        <ZoneId>cn-hangzhou-f</ZoneId>
        <RegionId>cn-hangzhou</RegionId>
        <DedicatedHostClusterName>myDDHCluster</DedicatedHostClusterName>
        <Tags>
            <TagValue>TestValue</TagValue>
            <TagKey>TestKey</TagKey>
        </Tags>
        <DedicatedHostIds>dh-bp181e5064b5sotr****</DedicatedHostIds>
        <DedicatedHostClusterCapacity>
            <AvailableVcpus>2</AvailableVcpus>
            <AvailableMemory>4</AvailableMemory>
            <TotalMemory>8</TotalMemory>
            <TotalVcpus>4</TotalVcpus>
            <LocalStorageCapacities>
                <DataDiskCategory>cloud</DataDiskCategory>
                <AvailableDisk>20</AvailableDisk>
                <TotalDisk>40</TotalDisk>
            </LocalStorageCapacities>
            <AvailableInstanceTypes>
                <InstanceType>ecs.c6.26xlarge</InstanceType>
                <AvailableInstanceCapacity>0</AvailableInstanceCapacity>
            </AvailableInstanceTypes>
        </DedicatedHostClusterCapacity>
    </DedicatedHostClusters>
</DescribeDedicatedHostClustersResponse>

Formato JSON

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

{
  "PageSize" : 5,
  "RequestId" : "214A2187-B06F-4E49-A081-4D053466A8C7",
  "PageNumber" : 1,
  "TotalCount" : 2,
  "DedicatedHostClusters" : [ {
    "Description" : "This-is-my-DDHCluster",
    "DedicatedHostClusterId" : "dc-bp12wlf6am0vz9v2****",
    "ResourceGroupId" : "rg-bp67acfmxazb4p****",
    "ZoneId" : "cn-hangzhou-f",
    "RegionId" : "cn-hangzhou",
    "DedicatedHostClusterName" : "myDDHCluster",
    "Tags" : [ {
      "TagValue" : "TestValue",
      "TagKey" : "TestKey"
    } ],
    "DedicatedHostIds" : [ "dh-bp181e5064b5sotr****" ],
    "DedicatedHostClusterCapacity" : {
      "AvailableVcpus" : 2,
      "AvailableMemory" : 4,
      "TotalMemory" : 8,
      "TotalVcpus" : 4,
      "LocalStorageCapacities" : [ {
        "DataDiskCategory" : "cloud",
        "AvailableDisk" : 20,
        "TotalDisk" : 40
      } ],
      "AvailableInstanceTypes" : [ {
        "InstanceType" : "ecs.c6.26xlarge",
        "AvailableInstanceCapacity" : 0
      } ]
    }
  } ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	MissingParamter.RegionId	The regionId should not be null.	Mensagem de erro retornada porque o parâmetro RegionId não foi especificado.
400	InvalidRegion.NotFound	The specified parameter RegionId is not valid.	Mensagem de erro retornada porque o parâmetro RegionId especificado é inválido.
400	InvalidZone.NotFound	The specified parameter ZoneId is not valid.	Mensagem de erro retornada porque o parâmetro ZoneId especificado é inválido.

Para obter uma lista de códigos de erro, visite o API Error Center.