DescribeDedicatedHosts - Elastic Compute Service - Centre de documentation Alibaba Cloud

Consulte les détails d'un ou plusieurs hôtes dédiés. Cette opération permet d'obtenir des informations telles que les métriques de performance physique, le code machine, l'état d'utilisation et la liste des instances ECS créées sur les hôtes dédiés. Vous pouvez spécifier des paramètres tels que les identifiants des hôtes dédiés, l'identifiant du cluster d'hôtes dédiés, le nom d'hôte et l'état pour interroger avec précision les détails requis des hôtes dédiés, ce qui fournit un soutien solide pour la gestion et l'optimisation efficaces des ressources de cloud computing.

Description de l'opération

Vous pouvez consulter les détails d'un ou plusieurs hôtes dédiés en utilisant l'une des méthodes suivantes :

Spécifiez DedicatedHostIds pour consulter les détails des hôtes dédiés.
Spécifiez DedicatedHostClusterId pour consulter les détails des hôtes dédiés d'un cluster d'hôtes dédiés.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

ecs:DescribeDedicatedHosts

get

DedicatedHost.

acs:ecs:{#regionId}:{#accountId}:ddh/*

DedicatedHost.

acs:ecs:{#regionId}:{#accountId}:ddh/{#ddhId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région de l'hôte dédié. Vous pouvez appeler l'opération DescribeRegions pour obtenir la liste des régions la plus récente.	cn-hangzhou
ZoneId	string	Non	L'identifiant de la zone. Vous pouvez appeler l'opération DescribeZones pour obtenir la liste des zones la plus récente.	cn-hangzhou-g
DedicatedHostIds	string	Non	Les identifiants des hôtes dédiés. Vous pouvez spécifier jusqu'à 100 identifiants. Séparez les identifiants multiples par des virgules (,).	["dh-bp165p6xk2tlw61e**", "dh-bp1f9vxmno7emy96**"]
DedicatedHostName	string	Non	Le nom de l'hôte dédié.	MyDDHTestName
Status	string	Non	L'état d'utilisation de l'hôte dédié. Valeurs valides : Available : l'hôte dédié est en cours d'exécution. Il s'agit de l'état de fonctionnement normal de l'hôte dédié. UnderAssessment : la machine physique présente des risques et se trouve dans la période d'incubation d'une défaillance. La machine physique est disponible, mais peut entraîner des problèmes pour les instances ECS sur l'hôte dédié. PermanentFailure : une défaillance permanente s'est produite et l'hôte dédié est indisponible. TempUnavailable : l'hôte dédié est temporairement indisponible. Redeploying : l'hôte dédié est en cours de récupération. Valeur par défaut : Available.	Available
DedicatedHostType	string	Non	Le type d'hôte dédié. Vous pouvez appeler l'opération DescribeDedicatedHostTypes pour obtenir la liste des types d'hôtes dédiés la plus récente.	ddh.g5
LockReason	string	Non	La raison pour laquelle l'hôte dédié est verrouillé. Valeurs valides : financial : L'hôte dédié est verrouillé en raison de paiements en retard. security : L'hôte dédié est verrouillé pour des raisons de sécurité.	financial
PageNumber	integer	Non	Remarque Ce paramètre sera bientôt obsolète. Nous vous recommandons d'utiliser NextToken et MaxResults pour la pagination.	1
PageSize	integer	Non	Remarque Ce paramètre sera bientôt obsolète. Nous vous recommandons d'utiliser NextToken et MaxResults pour la pagination.	10
ResourceGroupId	string	Non	L'identifiant du groupe de ressources auquel l'hôte dédié appartient. Lorsque vous utilisez ce paramètre pour filtrer les ressources, le nombre de ressources ne peut pas dépasser 1 000.\n\n> Le filtrage par le groupe de ressources par défaut n'est pas pris en charge.	rg-aek3b6jzp66****
NeedHostDetail	string	Non	Indique si les détails de l'hôte dédié doivent être renvoyés.	false
Tag	array<object>	Non	La liste des balises. La liste peut contenir de 0 à 20 balises.
	object	Non
Key	string	Non	La clé de balise de l'hôte dédié. Si vous spécifiez ce paramètre, il ne peut pas s'agir d'une chaîne vide. La clé de balise peut comporter jusqu'à 128 caractères et ne peut pas commencer par aliyun ou acs:. Elle ne peut pas contenir http:// ou https://.	TestKey
Value	string	Non	La valeur de balise de l'hôte dédié. Si vous spécifiez ce paramètre, il peut s'agir d'une chaîne vide. La valeur de balise peut comporter jusqu'à 128 caractères et ne peut pas contenir http:// ou https://.	TestValue
DedicatedHostClusterId	string	Non	L'identifiant du cluster d'hôtes dédiés.	dc-bp12wlf6am0vz9v2****
SocketDetails	string	Non	Indique si les informations de capacité au niveau du socket doivent être affichées. Vous pouvez consulter les informations sur les ressources restantes (utilisation des vCPU et de la mémoire, quantité restante et quantité totale) au niveau du socket afin de déterminer si des instances ECS des types correspondants peuvent être créées. Valeurs valides : true : affiche les informations. Seuls les hôtes dédiés de types spécifiques prennent en charge l'affichage des informations sur les ressources au niveau du socket. Pour plus d'informations, consultez Afficher et exporter les informations des hôtes dédiés. false : n'affiche pas les informations. Important En général, chaque hôte dédié dispose de deux processeurs, et l'identifiant de chaque processeur est Socket 0 ou Socket 1. Sur un hôte dédié exclusif, afin de garantir que les instances ECS sur l'hôte dédié offrent des performances maximales, les instances ECS ne sont pas créées sur plusieurs sockets. Cela signifie qu'une instance ECS est créée sur la base d'un seul socket. Si les ressources de calcul restantes d'un socket sont supérieures ou égales aux exigences du type d'instance ECS à créer, l'instance ECS est créée. Si les ressources de calcul restantes de chaque socket sont inférieures aux exigences du type d'instance ECS à créer, la création de l'instance ECS échoue. Même si le total des ressources restantes des deux sockets sur l'hôte dédié répond aux exigences du type d'instance ECS, l'instance ECS ne peut toujours pas être créée.	true
NextToken	string	Non	Le jeton de requête. Définissez la valeur sur la valeur NextToken renvoyée lors de l'appel précédent à cette opération. Vous n'avez pas besoin de spécifier ce paramètre lorsque vous appelez cette opération pour la première fois.	e71d8a535bd9cc11
MaxResults	integer	Non	Le nombre maximal d'entrées par page pour une requête paginée. Si vous spécifiez ce paramètre, la requête est effectuée en utilisant la combinaison de MaxResults et NextToken.\n\nValeur maximale : 100.\n\nValeur par défaut : 10.	10
QueryInventory	boolean	Non

Éléments de réponse

Élément	Type	Description	Exemple
	object
DedicatedHosts	object
DedicatedHost	array<object>	Les détails des hôtes dédiés.
	array<object>	L'identifiant de l'espace privé géré auquel l'hôte dédié appartient.
ActionOnMaintenance	string	La stratégie de migration pour les instances hébergées sur l'hôte dédié lorsqu'une panne survient. Valeurs valides : Migrate : l'hôte dédié est migré vers un autre serveur physique, et les instances qui n'ont pas été arrêtées avant la panne sont démarrées. Stop : les instances sont arrêtées sur l'hôte dédié actuel. Une fois qu'il est confirmé que l'hôte dédié ne peut pas être réparé, les instances sont migrées vers un autre serveur physique et redémarrées. Si l'hôte dédié est associé à des disques cloud, la valeur par défaut est Migrate. Si l'hôte dédié est associé à des disques locaux, la valeur par défaut est Stop.	Migrate
AutoPlacement	string	Indique si l'hôte dédié est ajouté au pool de ressources de déploiement automatique. Valeurs valides : on : l'hôte dédié est ajouté au pool de ressources de déploiement automatique. off : l'hôte dédié n'est pas ajouté au pool de ressources de déploiement automatique. Pour plus d'informations sur le déploiement automatique, consultez Déploiement automatique.	on
AutoReleaseTime	string	L'heure de libération automatique. L'heure est affichée au format `yyyy-MM-ddTHH:mmZ` en UTC, conformément à la norme ISO 8601.	2017-01-01T12:00Z
Capacity	object	Les indicateurs de performance de l'hôte dédié.
AvailableInstanceTypes	object
AvailableInstanceType	array<object>	La liste des types d'instances disponibles.
	object	Les informations sur le type d'instance disponible.
AvailableInstanceCapacity	integer	La capacité disponible pour le type d'instance.	0
InstanceType	string	Le type d'instance. Pour les valeurs valides, consultez famille d'instances. Remarque Ce paramètre est requis.
AvailableLocalStorage	integer	La capacité disponible du disque local. Unité : GiB.	65
AvailableMemory	number	La capacité de mémoire disponible. Unité : GiB.	25
AvailableVcpus	integer	Le nombre de vCPU disponibles.	5
AvailableVgpus	integer	Le nombre de vGPU disponibles.	2
LocalStorageCategory	string	La catégorie de disque local.	i2
SocketCapacities	object
SocketCapacity	array<object>	La liste des informations de capacité par socket.
	object
AvailableMemory	number	La capacité de mémoire disponible. Unité : GiB.	65
AvailableVcpu	integer	Le nombre de vCPU disponibles.	64
SocketId	integer	L'identifiant du socket.	1
TotalMemory	number	La capacité totale de mémoire. Unité : GiB.	128
TotalVcpu	integer	Le nombre total de vCPU.	128
TotalLocalStorage	integer	La capacité totale du disque local. Unité : GiB.	512
TotalMemory	number	La capacité totale de mémoire. Unité : GiB.	1024
TotalVcpus	integer	Le nombre total de vCPU.	56
TotalVgpus	integer	Le nombre total de vGPU.	10
ChargeType	string	La méthode de facturation de l'hôte dédié.	Prepaid
Cores	integer	Le nombre de cœurs par processeur.	3
CpuOverCommitRatio	number	Le ratio de surallocation du processeur. Valeurs valides : 1 à 5.	1
CreationTime	string	L'heure de création de l'hôte dédié. L'heure est affichée au format `yyyy-MM-ddTHH:mmZ` en UTC, conformément à la norme ISO 8601.	2018-01-01T12:00Z
DedicatedHostClusterId	string	L'identifiant du cluster d'hôtes dédiés auquel l'hôte dédié appartient.	dc-bp12wlf6am0vz9v2****
DedicatedHostId	string	L'identifiant de l'hôte dédié.	dh-bp165p6xk2tlw61e****
DedicatedHostName	string	Le nom de l'hôte dédié.	MyDDHTestName
DedicatedHostOwnerId	integer	L'identifiant utilisateur du propriétaire de l'hôte dédié.	100************7
DedicatedHostType	string	Le type de l'hôte dédié.	ddh.g5
Description	string	La description de l'hôte dédié.	this-is-my-DDH
ExpiredTime	string	L'heure d'expiration de l'hôte dédié par abonnement. L'heure est affichée au format `yyyy-MM-ddTHH:mmZ` en UTC, conformément à la norme ISO 8601.	2019-01-01T12:00Z
GPUSpec	string	Le modèle de GPU.	gpu
HostDetailInfo	object	Ce paramètre sera obsolète. Pour garantir la compatibilité, utilisez d'autres paramètres à la place.
SerialNumber	string	Ce paramètre sera obsolète. Pour garantir la compatibilité, utilisez d'autres paramètres à la place.	null
VgpuVersion	string	Ce paramètre sera obsolète. Pour garantir la compatibilité, utilisez d'autres paramètres à la place.	null
Instances	object
Instance	array<object>	La liste des instances ECS créées sur l'hôte dédié.
	object	L'instance ECS créée sur l'hôte dédié.
InstanceId	string	L'identifiant de l'instance ECS créée sur l'hôte dédié.	i-bp14ot0ykf8w13a1****
InstanceOwnerId	integer	L'identifiant utilisateur du propriétaire de l'instance ECS.	128************0
InstanceType	string	Les informations sur le type d'instance ECS de l'instance créée sur l'hôte dédié.	ecs.g5.large
SocketId	string	L'identifiant du socket où se trouve l'instance.	0,1
MachineId	string	L'identifiant machine de l'hôte dédié.	12aaa123456ff19dec12345d3026e****
NetworkAttributes	object	Les attributs réseau de l'hôte dédié.
SlbUdpTimeout	integer	Le délai d'attente UDP de Server Load Balancer (SLB). Unité : secondes. Seules 60 secondes sont prises en charge.	60
UdpTimeout	integer	Le délai d'attente UDP. Unité : secondes. Seules 60 secondes sont prises en charge.	60
OperationLocks	object
OperationLock	array<object>	La liste des raisons pour lesquelles l'hôte dédié est verrouillé.
	object
LockReason	string	La raison pour laquelle l'hôte dédié est verrouillé. Valeurs valides : financial : l'hôte dédié est verrouillé en raison de paiements en retard. security : l'hôte dédié est verrouillé pour des raisons de sécurité.	financial
PhysicalGpus	integer	Le nombre de GPU physiques.	10
RegionId	string	L'identifiant de la région de l'hôte dédié.	cn-hangzhou
ResourceGroupId	string	L'identifiant du groupe de ressources auquel l'hôte dédié appartient.	rg-aek3b6jzp66****
SaleCycle	string	Le cycle de facturation de l'hôte dédié par abonnement. Valeurs valides : Month Year	Month
SchedulerOptions.ManagedPrivateSpaceId	string	L'identifiant de l'espace privé géré auquel l'hôte dédié appartient.	mps-iq81z6pkbqjx61php46e
Sockets	integer	Le nombre de processeurs physiques.	5
Status	string	L'état de l'hôte dédié. Valeurs valides : Available : en cours d'exécution. L'hôte dédié fonctionne normalement. UnderAssessment : risque de serveur physique. Le serveur physique est dans une période de panne latente et reste disponible, mais cela peut entraîner des problèmes pour les instances ECS sur l'hôte dédié. PermanentFailure : en échec. Une panne permanente s'est produite et l'hôte dédié n'est pas disponible.	Available
SupportedCustomInstanceTypeFamilies	object
SupportedCustomInstanceTypeFamily	array	La famille de types d'instances personnalisées prise en charge par l'hôte dédié.
	string	La famille de types d'instances personnalisées prise en charge par l'hôte dédié.	ecs.ddh6s.custom
SupportedInstanceTypeFamilies	object
SupportedInstanceTypeFamily	array	La liste des familles de types d'instances ECS prises en charge par l'hôte dédié.
	string	La famille d'instances ECS prise en charge par l'hôte dédié.	ecs.g5
SupportedInstanceTypesList	object
SupportedInstanceTypesList	array	La liste des types d'instances ECS pris en charge par l'hôte dédié.
	string	Le type d'instance ECS pris en charge par l'hôte dédié.	ecs.g5.large
Tags	object
Tag	array<object>	La liste des balises de l'hôte dédié.
	object	La paire clé-valeur de la balise.
TagKey	string	La clé de balise de l'hôte dédié.	TestKey
TagValue	string	La valeur de balise de l'hôte dédié.	TestValue
ZoneId	string	L'identifiant de la zone.	cn-hangzhou-g
NextToken	string	Le jeton de requête renvoyé par l'appel actuel. Si vous utilisez MaxResults et NextToken pour une requête paginée et que ce jeton de pagination est vide, aucune autre donnée n'est renvoyée.	e71d8a535bd9cc11
PageNumber	integer	Le numéro de page de la liste des hôtes dédiés.	5
PageSize	integer	Le nombre d'entrées par page.	1
RequestId	string	L'identifiant de la requête.	7654525A-9964-4ABB-8BCD-98F8835E809A
TotalCount	integer	Le nombre total d'hôtes dédiés.	3

Exemples

JSON format

{
  "DedicatedHosts": {
    "DedicatedHost": [
      {
        "ActionOnMaintenance": "Migrate",
        "AutoPlacement": "on",
        "AutoReleaseTime": "2017-01-01T12:00Z",
        "Capacity": {
          "AvailableInstanceTypes": {
            "AvailableInstanceType": [
              {
                "AvailableInstanceCapacity": 0,
                "InstanceType": ""
              }
            ]
          },
          "AvailableLocalStorage": 65,
          "AvailableMemory": 25,
          "AvailableVcpus": 5,
          "AvailableVgpus": 2,
          "LocalStorageCategory": "i2",
          "SocketCapacities": {
            "SocketCapacity": [
              {
                "AvailableMemory": 65,
                "AvailableVcpu": 64,
                "SocketId": 1,
                "TotalMemory": 128,
                "TotalVcpu": 128
              }
            ]
          },
          "TotalLocalStorage": 512,
          "TotalMemory": 1024,
          "TotalVcpus": 56,
          "TotalVgpus": 10
        },
        "ChargeType": "Prepaid",
        "Cores": 3,
        "CpuOverCommitRatio": 1,
        "CreationTime": "2018-01-01T12:00Z",
        "DedicatedHostClusterId": "dc-bp12wlf6am0vz9v2****",
        "DedicatedHostId": "dh-bp165p6xk2tlw61e****",
        "DedicatedHostName": "MyDDHTestName",
        "DedicatedHostOwnerId": 0,
        "DedicatedHostType": "ddh.g5",
        "Description": "this-is-my-DDH",
        "ExpiredTime": "2019-01-01T12:00Z",
        "GPUSpec": "gpu",
        "HostDetailInfo": {
          "SerialNumber": "null",
          "VgpuVersion": "null"
        },
        "Instances": {
          "Instance": [
            {
              "InstanceId": "i-bp14ot0ykf8w13a1****",
              "InstanceOwnerId": 0,
              "InstanceType": "ecs.g5.large",
              "SocketId": "0,1"
            }
          ]
        },
        "MachineId": "12aaa123456ff19dec12345d3026e****",
        "NetworkAttributes": {
          "SlbUdpTimeout": 60,
          "UdpTimeout": 60
        },
        "OperationLocks": {
          "OperationLock": [
            {
              "LockReason": "financial"
            }
          ]
        },
        "PhysicalGpus": 10,
        "RegionId": "cn-hangzhou",
        "ResourceGroupId": "rg-aek3b6jzp66****",
        "SaleCycle": "Month",
        "SchedulerOptions.ManagedPrivateSpaceId": "mps-iq81z6pkbqjx61php46e",
        "Sockets": 5,
        "Status": "Available",
        "SupportedCustomInstanceTypeFamilies": {
          "SupportedCustomInstanceTypeFamily": [
            "ecs.ddh6s.custom"
          ]
        },
        "SupportedInstanceTypeFamilies": {
          "SupportedInstanceTypeFamily": [
            "ecs.g5"
          ]
        },
        "SupportedInstanceTypesList": {
          "SupportedInstanceTypesList": [
            "ecs.g5.large"
          ]
        },
        "Tags": {
          "Tag": [
            {
              "TagKey": "TestKey",
              "TagValue": "TestValue"
            }
          ]
        },
        "ZoneId": "cn-hangzhou-g"
      }
    ]
  },
  "NextToken": "e71d8a535bd9cc11",
  "PageNumber": 5,
  "PageSize": 1,
  "RequestId": "7654525A-9964-4ABB-8BCD-98F8835E809A",
  "TotalCount": 3
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidStatus.ValueNotSupported	The pecified dedicated host status is not supported.	L'état du disque spécifié ne prend pas en charge cette opération.
400	MissingParamter.RegionId	The regionId should not be null.	Le paramètre RegionId ne peut pas être vide.
400	InvalidParameter.DedicatedHostIds	The specified parameter dedicatedHostIds is not valid.	Le paramètre DedicatedHostIds spécifié n'est pas valide.
400	InvalidRegion.NotFound	The specified parameter RegionId is not valid.	Le paramètre RegionId n'est pas valide.
400	InvalidZone.NotFound	The specified parameter ZoneId is not valid.	Le paramètre ZoneId spécifié n'est pas valide.
403	InvalidDedicatedHostIds.Malformed	The amount of specified dedicatedHostIds exceeds the limit.	Le paramètre DedicatedHostIds peut contenir un maximum de 100 entrées.
404	InvalidLockReason.NotFound	The specified LockReason is not found.	Le type de verrou spécifié n'existe pas.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.