DescribeDedicatedHosts - - Centre de documentation Alibaba Cloud

Notes d'utilisation

Pour interroger les détails des hôtes dédiés, utilisez l'une des méthodes suivantes :

Spécifiez le paramètre DedicatedHostIds pour interroger les détails des hôtes dédiés.
Spécifiez le paramètre DedicatedHostClusterId pour interroger les détails des hôtes dédiés au sein d'un cluster d'hôtes dédiés.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	DescribeDedicatedHosts	Opération à effectuer. Définissez la valeur sur DescribeDedicatedHosts.
RegionId	String	Oui	cn-hangzhou	ID de région de l'hôte dédié. Appelez l'opération DescribeRegions pour obtenir la liste des régions la plus récente.
ZoneId	String	Non	cn-hangzhou-g	ID de zone de l'hôte dédié. Appelez l'opération DescribeZones pour obtenir la liste des zones la plus récente.
DedicatedHostIds	String	Non	["dh-bp165p6xk2tlw61e**", "dh-bp1f9vxmno7emy96**"]	ID des hôtes dédiés. Vous pouvez spécifier jusqu'à 100 ID d'hôtes dédiés dans une seule requête. Séparez les ID par des virgules (,).
DedicatedHostName	String	Non	MyDDHTestName	Nom de l'hôte dédié.
Status	String	Non	Available	État de service de l'hôte dédié. Valeurs valides : Available : L'hôte dédié fonctionne normalement. UnderAssessment : L'hôte dédié est disponible mais présente des risques potentiels susceptibles de provoquer des défaillances des instances ECS hébergées sur cet hôte. PermanentFailure : L'hôte dédié rencontre des pannes permanentes et n'est pas disponible. TempUnavailable : L'hôte dédié est temporairement indisponible. Redeploying : L'hôte dédié est en cours de restauration. Valeur par défaut : Available.
DedicatedHostType	String	Non	ddh.g5	Type d'hôte dédié. Appelez l'opération DescribeDedicatedHostTypes pour obtenir la liste la plus récente des types d'hôtes dédiés.
LockReason	String	Non	financial	Raison du verrouillage de l'hôte dédié. Valeurs valides : financial security
PageNumber	Integer	Non	1	Numéro de page. Valeur par défaut : 1.
PageSize	Integer	Non	10	Nombre d'entrées par page. Valeurs valides : 1 à 100. Valeur par défaut : 10.
ResourceGroupId	String	Non	rg-aek3b6jzp66****	ID du groupe de ressources auquel appartient l'hôte dédié. Lorsque ce paramètre est spécifié pour interroger des ressources, la réponse affiche jusqu'à 1 000 ressources appartenant au groupe de ressources spécifié. Remarque Les ressources du groupe de ressources par défaut sont affichées dans la réponse, quelle que soit la valeur de ce paramètre.
Tag.N.Key	String	Non	TestKey	Clé du tag N de l'hôte dédié. Valeurs valides de N : 1 à 20. La clé de tag ne peut pas être une chaîne vide. Sa longueur maximale est de 128 caractères et elle ne peut pas commencer par `acs:` ou `aliyun`. Elle ne peut pas contenir `http://` ni `https://`.
Tag.N.Value	String	Non	TestValue	Valeur du tag N de l'hôte dédié. Valeurs valides de N : 1 à 20. La valeur de tag peut être une chaîne vide. Sa longueur maximale est de 128 caractères et elle ne peut pas commencer par `acs:` ou `aliyun`. Elle ne peut pas contenir `http://` ni `https://`.
DedicatedHostClusterId	String	Non	dc-bp12wlf6am0vz9v2****	ID du cluster d'hôtes dédiés auquel appartient l'hôte dédié.
SocketDetails	String	Non	true	Indique s'il faut afficher les informations sur les sockets. Valeurs valides : true false

Paramètres de réponse

Paramètre	Type	Exemple	Description
PageSize	Integer	1	Nombre d'entrées par page.
RequestId	String	7654525A-9964-4ABB-8BCD-98F8835E809A	ID de la requête.
PageNumber	Integer	5	Numéro de page.
TotalCount	Integer	3	Nombre total d'hôtes dédiés.
DedicatedHosts	Array of DedicatedHost		Hôtes dédiés interrogés.
DedicatedHost
CreationTime	String	2018-01-01T12:00Z	Heure de création de l'hôte dédié. L'heure suit la norme ISO 8601 au format `yyyy-MM-ddTHH:mmZ`. L'heure est affichée en UTC.
SchedulerOptions.ManagedPrivateSpaceId	String	mps-iq81z6pkbqjx61php46e	ID de l'espace privé géré auquel appartient l'hôte dédié.
Status	String	Available	État de service de l'hôte dédié. Valeurs valides : Available : L'hôte dédié fonctionne normalement. UnderAssessment : L'hôte dédié est disponible mais présente des risques potentiels susceptibles de provoquer des défaillances des instances ECS hébergées sur cet hôte. PermanentFailure : L'hôte dédié rencontre des pannes permanentes et n'est pas disponible.
Cores	Integer	3	Nombre de cœurs physiques par CPU.
AutoPlacement	String	on	Indique si l'hôte dédié a été ajouté au pool de ressources pour le déploiement automatique. Valeurs valides : on : L'hôte dédié a été ajouté au pool de ressources pour le déploiement automatique. off : L'hôte dédié n'a pas été ajouté au pool de ressources pour le déploiement automatique. Pour plus d'informations sur le déploiement automatique, consultez la section « Automatic deployment » de la rubrique Fonctions et fonctionnalités.
GPUSpec	String	gpu	Modèle de GPU.
AutoReleaseTime	String	2017-01-01T12:00Z	Heure de libération automatique de l'hôte dédié. L'heure suit la norme ISO 8601 au format `yyyy-MM-ddTHH:mmZ`. L'heure est affichée en UTC.
ChargeType	String	Prepaid	Méthode de facturation de l'hôte dédié.
CpuOverCommitRatio	Float	1	Taux de surengagement du CPU.
ActionOnMaintenance	String	Migrate	Politique de migration des instances déployées sur l'hôte dédié en cas de panne de celui-ci. Valeurs valides : Migrate : Les instances sont migrées vers un autre serveur physique. Les instances qui ne sont pas à l'état Stopped lorsque l'hôte dédié tombe en panne sont redémarrées. Stop : Les instances sont arrêtées. Si l'hôte dédié ne peut pas être restauré, les instances sont migrées vers un autre serveur physique et redémarrées. Si l'hôte dédié dispose de disques cloud attachés, la valeur par défaut est Migrate. Si l'hôte dédié dispose de disques locaux attachés, la valeur par défaut est Stop.
SaleCycle	String	Month	Unité de la période d'abonnement. Valeurs valides : Month Year
PhysicalGpus	Integer	10	Nombre de GPU physiques.
RegionId	String	cn-hangzhou	ID de région de l'hôte dédié.
DedicatedHostName	String	MyDDHTestName	Nom de l'hôte dédié.
Description	String	this-is-my-DDH	Description de l'hôte dédié.
DedicatedHostClusterId	String	dc-bp12wlf6am0vz9v2****	ID du cluster d'hôtes dédiés auquel appartient l'hôte dédié.
ExpiredTime	String	2019-01-01T12:00Z	Heure d'expiration de l'hôte dédié prépayé. L'heure suit la norme ISO 8601 au format `yyyy-MM-ddTHH:mmZ`. L'heure est affichée en UTC.
DedicatedHostType	String	ddh.g5	Type d'hôte dédié.
ResourceGroupId	String	rg-aek3b6jzp66****	ID du groupe de ressources auquel appartient l'hôte dédié.
ZoneId	String	cn-hangzhou-g	ID de zone de l'hôte dédié.
DedicatedHostId	String	dh-bp165p6xk2tlw61e****	ID de l'hôte dédié.
Sockets	Integer	5	Nombre de CPU physiques.
MachineId	String	12aaa123456ff19dec12345d3026e****	Code machine de l'hôte dédié.
Instances	Array of Instance		Instances ECS créées sur l'hôte dédié.
Instance
InstanceType	String	ecs.g5.large	Type d'instance de l'instance ECS.
InstanceId	String	i-bp14ot0ykf8w13a1****	ID de l'instance ECS.
SocketId	String	0,1	ID du socket auquel appartient l'instance ECS.
InstanceOwnerId	Long	128************0	ID du propriétaire de l'instance ECS.
OperationLocks	Array of OperationLock		Raisons du verrouillage des ressources de l'hôte dédié.
OperationLock
LockReason	String	financial	Raison du verrouillage de l'hôte dédié. Valeurs valides : financial security
Tags	Array of Tag		Tags de l'hôte dédié.
Tag
TagValue	String	TestValue	Valeur du tag de l'hôte dédié.
TagKey	String	TestKey	Clé du tag de l'hôte dédié.
SupportedInstanceTypeFamilies	Array of String	ecs.g5	Familles d'instances ECS prises en charge par l'hôte dédié.
SupportedCustomInstanceTypeFamilies	Array of String	ecs.ddh6s.custom	Familles d'instances ECS personnalisées prises en charge par l'hôte dédié.
SupportedInstanceTypesList	Array of String	ecs.g5.large	Types d'instances ECS pris en charge par l'hôte dédié.
Capacity	Object		Spécifications de performances de l'hôte dédié.
AvailableMemory	Float	25	Quantité de mémoire disponible. Unité : GiB.
LocalStorageCategory	String	i2	Famille d'instances utilisant des disques locaux.
TotalMemory	Float	1024	Capacité totale de la mémoire. Unité : GiB.
TotalLocalStorage	Integer	512	Capacité totale des disques locaux. Unité : GiB.
TotalVcpus	Integer	56	Nombre total de vCPU.
TotalVgpus	Integer	10	Nombre total de vGPU.
AvailableLocalStorage	Integer	65	Capacité disponible sur les disques locaux. Unité : GiB.
AvailableVcpus	Integer	5	Nombre de vCPU disponibles.
AvailableVgpus	Integer	2	Nombre de vGPU disponibles.
SocketCapacities	Array of SocketCapacity		Capacités des sockets.
SocketCapacity
SocketId	Integer	1	ID du socket.
AvailableMemory	Float	65	Capacité restante de la mémoire. Unité : GiB.
TotalMemory	Float	128	Capacité totale de la mémoire. Unité : GiB.
AvailableVcpu	Integer	64	Nombre total de vCPU.
TotalVcpu	Integer	128	Nombre de vCPU disponibles.
NetworkAttributes	Object		Attributs réseau de l'hôte dédié.
UdpTimeout	Integer	60	Délai d'expiration de la session UDP établie entre un utilisateur et un service Alibaba Cloud sur l'hôte dédié. Unité : secondes. Valeur valide : 60.
SlbUdpTimeout	Integer	60	Délai d'expiration de la session UDP établie entre Server Load Balancer (SLB) et l'hôte dédié. Unité : secondes. Valeur valide : 60.
HostDetailInfo	Object		Ce paramètre sera supprimé à l'avenir. Nous vous recommandons d'utiliser d'autres paramètres pour garantir la compatibilité future.
SerialNumber	String	null	Ce paramètre sera supprimé à l'avenir. Nous vous recommandons d'utiliser d'autres paramètres pour garantir la compatibilité future.
DedicatedHostOwnerId	Long	100************7	ID du propriétaire de l'hôte dédié.

Exemples

Exemples de requêtes

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>

Exemples de réponses réussies

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

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

Codes d'erreur

Code d'état HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidStatus.ValueNotSupported	The pecified dedicated host status is not supported.	Cette opération ne peut pas être effectuée sur l'hôte dédié dans son état actuel.
400	MissingParamter.RegionId	The regionId should not be null.	RegionId est requis.
400	InvalidParameter.DedicatedHostIds	The specified parameter dedicatedHostIds is not valid.	Valeur DedicatedHostIds non valide.
400	InvalidRegion.NotFound	The specified parameter RegionId is not valid.	Valeur RegionId non valide.
400	InvalidZone.NotFound	The specified parameter ZoneId is not valid.	Valeur ZoneId non valide.
403	InvalidDedicatedHostIds.Malformed	The amount of specified dedicatedHostIds exceeds the limit.	Plus de 100 ID d'hôtes dédiés sont spécifiés dans la valeur DedicatedHostIds.
404	InvalidLockReason.NotFound	The specified LockReason is not found.	La valeur LockReason spécifiée est introuvable.

Pour obtenir la liste des codes d'erreur, consultez les Codes d'erreur de service.