DescribeDedicatedHostClusters - Elastic Compute Service - Centre de documentation Alibaba Cloud

Consulte les détails d'un ou plusieurs groupes d'hôtes dédiés.

Description de l'opération

Remarques sur l'utilisation

Vous pouvez spécifier plusieurs paramètres de requête pour filtrer les résultats de la requête. Les paramètres de requête spécifiés sont liés par une relation ET logique. Seuls les paramètres spécifiés sont inclus dans les conditions de filtrage. Toutefois, si DedicatedHostClusterIds est défini sur un tableau JSON vide ([]), ce paramètre est considéré comme une condition de filtrage valide et un résultat vide est renvoyé.

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:DescribeDedicatedHostClusters

get

DedicatedHostCluster

acs:ecs:{#regionId}:{#accountId}:ddhcluster/{#ddhclusterId}

DedicatedHostCluster

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Status	string	Non	Remarque Ce paramètre n'est pas disponible.	null
LockReason	string	Non	Remarque Ce paramètre n'est pas disponible.	null
ResourceGroupId	string	Non	L'identifiant du groupe de ressources du groupe d'hôtes. Vous pouvez utiliser un identifiant de groupe de ressources pour filtrer jusqu'à 1 000 groupes d'hôtes. Remarque Le groupe de ressources par défaut n'est pas pris en charge.	rg-bp67acfmxazb4p****
Tag	array<object>	Non	Les balises du groupe d'hôtes.
	object	Non	Les balises du groupe d'hôtes.
Key	string	Non	La clé de la balise. Valeurs valides de N : 1 à 20. La clé de la balise ne peut pas être une chaîne vide. Elle peut comporter jusqu'à 64 caractères et ne peut contenir ni `http://` ni `https://`, ni `acs:` ni `aliyun`. Vous pouvez filtrer jusqu'à 1 000 groupes d'hôtes, quel que soit le nombre de balises utilisées. Pour interroger plus de 1 000 groupes d'hôtes, appelez l'opération d'API ListTagResources.	TestKey
Value	string	Non	La valeur de la balise. Valeurs valides de N : 1 à 20. La valeur de la balise ne peut pas être une chaîne vide. Elle peut comporter jusqu'à 64 caractères et ne peut pas contenir `http://` ou `https://`.	TestValue
RegionId	string	Oui	L'identifiant de la région du groupe d'hôtes. 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 du groupe d'hôtes. Vous pouvez appeler l'opération DescribeZones pour obtenir la liste des zones la plus récente.	cn-hangzhou-f
DedicatedHostClusterIds	string	Non	La liste des identifiants des groupes d'hôtes. La valeur peut être un tableau JSON composé de plusieurs identifiants au format `["dc-xxxxxxxxx", "dc-yyyyyyyyy",..., "dc-zzzzzzzzz"]`. Séparez les identifiants par des virgules (,).	["dc-bp12wlf6am0vz9v2**", "dc-bp12wlf6am0vz9v3**"]
DedicatedHostClusterName	string	Non	Le nom du groupe d'hôtes.	myDDHCluster
PageNumber	integer	Non	Le numéro de page. La numérotation des pages commence à 1. Valeur par défaut : 1	1
PageSize	integer	Non	Le nombre d'entrées à renvoyer sur chaque page. Valeurs valides : 1 à 100. Valeur par défaut : 10.	5

Éléments de réponse

Élément	Type	Description	Exemple
	object
PageSize	integer	Le nombre d'entrées par page.	5
RequestId	string	L'identifiant de la requête.	214A2187-B06F-4E49-A081-4D053466A8C7
PageNumber	integer	Le numéro de page.	1
TotalCount	integer	Le nombre total de groupes d'hôtes dédiés.	2
DedicatedHostClusters	object
DedicatedHostCluster	array<object>	Un tableau contenant les informations sur les groupes d'hôtes dédiés.
	array<object>
Description	string	The description of the dedicated host cluster.	This-is-my-DDHCluster
DedicatedHostClusterId	string	The ID of the dedicated host cluster.	dc-bp12wlf6am0vz9v2****
ResourceGroupId	string	The resource group ID of the dedicated host cluster.	rg-bp67acfmxazb4p****
ZoneId	string	The zone ID of the dedicated host cluster.	cn-hangzhou-f
RegionId	string	The region ID of the dedicated host cluster.	cn-hangzhou
DedicatedHostClusterName	string	The name of the dedicated host cluster.	myDDHCluster
Tags	object
Tag	array<object>	The tags of the dedicated host cluster.
	object
TagValue	string	The tag value of the dedicated host cluster.	TestValue
TagKey	string	The tag key of the dedicated host cluster.	TestKey
DedicatedHostIds	object
DedicatedHostId	array	The IDs of dedicated hosts in the dedicated host cluster.
	string	The ID of the dedicated host.	dh-bp181e5064b5sotr****
DedicatedHostClusterCapacity	object	The capacity of the dedicated host cluster.
AvailableVcpus	integer	The number of available vCPUs.	2
AvailableMemory	integer	The available memory size. Unit: GiB.	4
TotalMemory	integer	The total memory size. Unit: GiB.	8
TotalVcpus	integer	The total number of vCPUs.	4
LocalStorageCapacities	object
LocalStorageCapacity	array<object>	The local storage capacity.
	object
DataDiskCategory	string	The data disk type. Valid values: cloud: basic disk. cloud_efficiency: ultra disk. cloud_ssd: standard SSD. ephemeral_ssd: local SSD. cloud_essd: enterprise SSD.	cloud
AvailableDisk	integer	The available local disk size. Unit: GiB.	20
TotalDisk	integer	The total local disk size. Unit: GiB.	40
AvailableInstanceTypes	object
AvailableInstanceType	array<object>	The available capacity of ECS instance types in the dedicated host cluster.
	object
InstanceType	string	The instance type.	ecs.c6.26xlarge
AvailableInstanceCapacity	integer	The available instance type capacity.	0

Exemples

JSON format

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

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	MissingParamter.RegionId	The regionId should not be null.	The RegionId parameter is required.
400	InvalidParameter.DedicatedHostClusterIds	The specified parameter dedicatedHostClusterIds is not valid.
400	InvalidRegion.NotFound	The specified parameter RegionId is not valid.	The specified RegionId parameter is invalid.
400	InvalidZone.NotFound	The specified parameter ZoneId is not valid.	The specified ZoneId parameter is invalid.
403	InvalidDedicatedHostIds.Malformed	The amount of specified dedicatedHostClusterIds exceeds the limit.

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

Notes de version

Consultez Notes de version pour la liste complète.