DescribeDedicatedHostClusters - - Centro de documentación de Alibaba Cloud

Consulta los detalles de uno o varios clústeres de host dedicados.

Descripción

Puede especificar varios parámetros de solicitud para la consulta. Los parámetros especificados tienen una relación lógica AND. Solo los parámetros indicados se incluyen en las condiciones de filtro. Sin embargo, si DedicatedHostClusterIds se establece como un arreglo JSON vacío ([]), se considera una condición de filtro válida y se devuelve un resultado vacío.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos llamar a esta operación desde OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	DescribeDedicatedHostClusters	La operación que desea ejecutar. Establezca el valor en DescribeDedicatedHostClusters.
Status	String	No	null	Nota Este parámetro no está disponible.
LockReason	String	No	null	Nota Este parámetro no está disponible.
ResourceGroupId	String	No	rg-bp67acfmxazb4p****	El ID del resource group al que pertenece el clúster de host dedicados. Si se especifica este parámetro para consultar recursos, la respuesta puede mostrar hasta 1,000 recursos pertenecientes al resource group indicado. Nota Los recursos del resource group predeterminado se muestran en la respuesta independientemente de cómo se configure este parámetro.
Tag.N.Key	String	No	TestKey	La clave de la etiqueta N del clúster de host dedicados. Valores válidos de N: 1 a 20. La clave de la etiqueta no puede ser una cadena vacía. Puede tener una longitud máxima de 64 caracteres y no puede comenzar con `acs:` ni `aliyun`. Tampoco puede contener `http://` o `https://`. Si se especifica una sola etiqueta para consultar recursos, la respuesta puede mostrar hasta 1,000 recursos que tengan dicha etiqueta. Si se especifican varias etiquetas, se pueden mostrar hasta 1,000 recursos que contengan todas las etiquetas indicadas. Para consultar más de 1,000 recursos con etiquetas específicas, llame a la operación ListTagResources.
Tag.N.Value	String	No	TestValue	El valor de la etiqueta N del clúster de host dedicados. Valores válidos de N: 1 a 20. El valor de la etiqueta no puede ser una cadena vacía. Puede tener una longitud máxima de 64 caracteres y no puede comenzar con `acs:` ni `aliyun`. Tampoco puede contener `http://` o `https://`.
RegionId	String	Sí	cn-hangzhou	El ID de la región del clúster de host dedicados. Puede llamar a la operación DescribeRegions para obtener la lista de regiones más reciente.
ZoneId	String	No	cn-hangzhou-f	El ID de la zona del clúster de host dedicados. Puede llamar a la operación DescribeZones para obtener la lista de zonas más reciente.
DedicatedHostClusterIds	String	No	["dc-bp12wlf6am0vz9v2**", "dc-bp12wlf6am0vz9v3**"]	Los ID de los clústeres de host dedicados. El valor puede ser un arreglo JSON compuesto por hasta 100 ID de clústeres de host dedicados con el formato `["dc-xxxxxxxxx", "dc-yyyyyyyyy", ... "dc-zzzzzzzzz"]`. Separe los ID con comas (,).
DedicatedHostClusterName	String	No	myDDHCluster	El nombre del clúster de host dedicados.
PageNumber	Integer	No	1	El número de página que se va a devolver. Las páginas comienzan desde la página 1. Valor predeterminado: 1.
PageSize	Integer	No	5	El número de entradas que se devolverán en cada página. Valor máximo: 100 Valor predeterminado: 10.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
PageSize	Integer	5	El número de entradas devueltas por página.
RequestId	String	214A2187-B06F-4E49-A081-4D053466A8C7	El ID de la solicitud.
PageNumber	Integer	1	El número de la página devuelta.
TotalCount	Integer	2	El número total de clústeres de host dedicados.
DedicatedHostClusters	Array of DedicatedHostCluster		Detalles sobre los clústeres de host dedicados.
DedicatedHostCluster
Description	String	This-is-my-DDHCluster	La descripción del clúster de host dedicados.
DedicatedHostClusterId	String	dc-bp12wlf6am0vz9v2****	El ID del clúster de host dedicados.
ResourceGroupId	String	rg-bp67acfmxazb4p****	El ID del resource group al que pertenece el clúster de host dedicados.
ZoneId	String	cn-hangzhou-f	El ID de la zona del clúster de host dedicados.
RegionId	String	cn-hangzhou	El ID de la región del clúster de host dedicados.
DedicatedHostClusterName	String	myDDHCluster	El nombre del clúster de host dedicados.
Tags	Array of Tag		Las etiquetas del clúster de host dedicados.
Tag
TagValue	String	TestValue	El valor de la etiqueta del clúster de host dedicados.
TagKey	String	TestKey	La clave de la etiqueta del clúster de host dedicados.
DedicatedHostIds	Array of String	["dh-bp181e5064b5sotr**","dh-bp18064b5sotrr9c**"]	Los ID de los hosts dedicados en el clúster de host dedicados.
DedicatedHostClusterCapacity	Object		La capacidad del clúster de host dedicados.
AvailableVcpus	Integer	2	El número de vCPU disponibles.
AvailableMemory	Integer	4	El tamaño de la memoria disponible. Unidad: GiB.
TotalMemory	Integer	8	El tamaño total de la memoria. Unidad: GiB.
TotalVcpus	Integer	4	El número total de vCPU.
LocalStorageCapacities	Array of LocalStorageCapacity		La capacidad de almacenamiento local.
LocalStorageCapacity
DataDiskCategory	String	cloud	La categoría del disco de datos. Valores válidos: cloud: disco básico cloud_efficiency: disco ultra cloud_ssd: SSD estándar ephemeral_ssd: SSD local cloud_essd: SSD mejorado (ESSD)
AvailableDisk	Integer	20	La capacidad disponible del disco local. Unidad: GiB.
TotalDisk	Integer	40	La capacidad total del disco local. Unidad: GiB.
AvailableInstanceTypes	Array of AvailableInstanceType		La capacidad disponible de los tipos de instancia de Elastic Compute Service (ECS) en el clúster de host dedicados.
AvailableInstanceType
InstanceType	String	ecs.c6.26xlarge	El tipo de instancia ECS.
AvailableInstanceCapacity	Integer	0	La capacidad disponible del tipo de instancia ECS.

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

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 error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	MissingParamter.RegionId	The regionId should not be null.	El mensaje de error devuelto porque no se especificó el parámetro RegionId.
400	InvalidRegion.NotFound	The specified parameter RegionId is not valid.	El mensaje de error devuelto porque el parámetro RegionId especificado no es válido.
400	InvalidZone.NotFound	The specified parameter ZoneId is not valid.	El mensaje de error devuelto porque el parámetro ZoneId especificado no es válido.

Para consultar una lista de códigos de error, visite el Centro de errores de API.